Wrapper around a Kokkos::View that allows data that is constant or repeating in various logical dimensions to be stored just once, while providing a similar interface to that of View. More...
#include <Intrepid2_Data.hpp>
Classes | |
| struct | bool_pack |
Public Types | |
| using | value_type = DataScalar |
| using | execution_space = typename DeviceType::execution_space |
| using | reference_type = typename ScalarView<DataScalar,DeviceType>::reference_type |
| using | const_reference_type = typename ScalarView<const DataScalar,DeviceType>::reference_type |
| template<bool... v> | |
| using | all_true = std::is_same<bool_pack<true, v...>, bool_pack<v..., true>> |
| template<class ... IntArgs> | |
| using | valid_args = all_true<std::is_integral<IntArgs>{}...> |
Public Member Functions | |
| template<class UnaryOperator> | |
| void | applyOperator (UnaryOperator unaryOperator) |
| applies the specified unary operator to each entry | |
| template<class ... IntArgs> | |
| KOKKOS_INLINE_FUNCTION reference_type | getWritableEntryWithPassThroughOption (const bool &passThroughBlockDiagonalArgs, const IntArgs... intArgs) const |
| Returns an l-value reference to the specified logical entry in the underlying view. Note that for variation types other than GENERAL, multiple valid argument sets will refer to the same memory location. Intended for Intrepid2 developers and expert users only. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column. | |
| template<class ... IntArgs> | |
| KOKKOS_INLINE_FUNCTION reference_type | getWritableEntry (const IntArgs... intArgs) const |
| Returns an l-value reference to the specified logical entry in the underlying view. Note that for variation types other than GENERAL, multiple valid argument sets will refer to the same memory location. Intended for Intrepid2 developers and expert users only. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column. | |
| void | allocateAndCopyFromDynRankView (ScalarView< DataScalar, DeviceType > data) |
| allocate an underlying View that matches the provided DynRankView in dimensions, and copy. Called by constructors that accept a DynRankView as argument. | |
| Data (std::vector< DimensionInfo > dimInfoVector) | |
| Constructor in terms of DimensionInfo for each logical dimension; does not require a View to be specified. Will allocate a View of appropriate rank, zero-filled. | |
| Data (const ScalarView< DataScalar, DeviceType > &data, int rank, Kokkos::Array< int, 7 > extents, Kokkos::Array< DataVariationType, 7 > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| DynRankView constructor. Will copy to a View of appropriate rank. | |
| template<typename OtherDeviceType, class = typename std::enable_if< std::is_same<typename DeviceType::memory_space, typename OtherDeviceType::memory_space>::value>::type, class = typename std::enable_if<!std::is_same<DeviceType,OtherDeviceType>::value>::type> | |
| Data (const Data< DataScalar, OtherDeviceType > &data) | |
| copy-like constructor for differing device type, but same memory space. This does a shallow copy of the underlying view. | |
| template<typename OtherDeviceType, class = typename std::enable_if<!std::is_same<typename DeviceType::memory_space, typename OtherDeviceType::memory_space>::value>::type> | |
| Data (const Data< DataScalar, OtherDeviceType > &data) | |
| copy-like constructor for differing execution spaces. This does a deep_copy of the underlying view. | |
| Data (ScalarView< DataScalar, DeviceType > data) | |
| copy constructor modeled after the copy-like constructor above. Not as efficient as the implicit copy constructor, so this should only be uncommented to emulate the copy-like constructor above in situations where host and device space are the same, and the copy-like constructor does not exist, or to provide a debugging breakpoint to assess when copies are being constructed. | |
| template<size_t rank, class ... DynRankViewProperties> | |
| Data (const Kokkos::DynRankView< DataScalar, DeviceType, DynRankViewProperties... > &data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| Constructor that accepts a DynRankView as an argument. The data belonging to the DynRankView will be copied into a new View of matching dimensions. | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar *, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar **, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar ***, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar ****, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar *****, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar ******, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<size_t rank, class ... ViewProperties> | |
| Data (Kokkos::View< DataScalar *******, DeviceType, ViewProperties... > data, Kokkos::Array< int, rank > extents, Kokkos::Array< DataVariationType, rank > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| template<class ViewScalar, class ... ViewProperties> | |
| Data (const unsigned rank, Kokkos::View< ViewScalar, DeviceType, ViewProperties... > data, Kokkos::Array< int, 7 > extents, Kokkos::Array< DataVariationType, 7 > variationType, const int blockPlusDiagonalLastNonDiagonal=-1) | |
| constructor with run-time rank (requires full-length extents, variationType inputs; those beyond the rank will be ignored). | |
| template<size_t rank> | |
| Data (DataScalar constantValue, Kokkos::Array< int, rank > extents) | |
| constructor for everywhere-constant data | |
| Data () | |
| default constructor (empty data) | |
| KOKKOS_INLINE_FUNCTION const int & | blockPlusDiagonalLastNonDiagonal () const |
| For a Data object containing data with variation type BLOCK_PLUS_DIAGONAL, returns the row and column (which must match) of the last non-diagonal entry. For fully diagonal matrices, this is -1. | |
| KOKKOS_INLINE_FUNCTION Kokkos::Array< int, 7 > | getExtents () const |
| Returns an array containing the logical extents in each dimension. | |
| KOKKOS_INLINE_FUNCTION DimensionInfo | getDimensionInfo (const int &dim) const |
| Returns an object fully specifying the indicated dimension. This is used in determining appropriate sizing of Data objects that depend on other Data objects (e.g., when two matrix Data objects are multiplied together). | |
| KOKKOS_INLINE_FUNCTION DimensionInfo | combinedDataDimensionInfo (const Data &otherData, const int &dim) const |
| Returns (DataVariationType, data extent) in the specified dimension for a Data container that combines (through multiplication, say, or addition) this container with otherData. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==1, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 1. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==2, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 2. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==3, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 3. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==4, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 4. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==5, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 5. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==6, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 6. | |
| template<int rank> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< rank==7, const Kokkos::View< typename RankExpander< DataScalar, rank >::value_type, DeviceType > & > | getUnderlyingView () const |
| Returns the underlying view. Throws an exception if the underlying view is not rank 7. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar *, DeviceType > & | getUnderlyingView1 () const |
| returns the View that stores the unique data. For rank-1 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar **, DeviceType > & | getUnderlyingView2 () const |
| returns the View that stores the unique data. For rank-2 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar ***, DeviceType > & | getUnderlyingView3 () const |
| returns the View that stores the unique data. For rank-3 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar ****, DeviceType > & | getUnderlyingView4 () const |
| returns the View that stores the unique data. For rank-4 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar *****, DeviceType > & | getUnderlyingView5 () const |
| returns the View that stores the unique data. For rank-5 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar ******, DeviceType > & | getUnderlyingView6 () const |
| returns the View that stores the unique data. For rank-6 underlying containers. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::View< DataScalar *******, DeviceType > & | getUnderlyingView7 () const |
| returns the View that stores the unique data. For rank-7 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView1 (const Kokkos::View< DataScalar *, DeviceType > &view) |
| sets the View that stores the unique data. For rank-1 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView2 (const Kokkos::View< DataScalar **, DeviceType > &view) |
| sets the View that stores the unique data. For rank-2 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView3 (const Kokkos::View< DataScalar ***, DeviceType > &view) |
| sets the View that stores the unique data. For rank-3 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView4 (const Kokkos::View< DataScalar ****, DeviceType > &view) |
| sets the View that stores the unique data. For rank-4 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView5 (const Kokkos::View< DataScalar *****, DeviceType > &view) |
| sets the View that stores the unique data. For rank-5 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView6 (const Kokkos::View< DataScalar ******, DeviceType > &view) |
| sets the View that stores the unique data. For rank-6 underlying containers. | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView7 (const Kokkos::View< DataScalar *******, DeviceType > &view) |
| sets the View that stores the unique data. For rank-7 underlying containers. | |
| template<int underlyingRank, class ViewScalar> | |
| KOKKOS_INLINE_FUNCTION void | setUnderlyingView (const Kokkos::View< ViewScalar, DeviceType > &view) |
| ScalarView< DataScalar, DeviceType > | getUnderlyingView () const |
| Returns a DynRankView constructed atop the same underlying data as the fixed-rank Kokkos::View used internally. | |
| KOKKOS_INLINE_FUNCTION ordinal_type | getUnderlyingViewRank () const |
| returns the rank of the View that stores the unique data | |
| KOKKOS_INLINE_FUNCTION ordinal_type | getUnderlyingViewSize () const |
| returns the number of entries in the View that stores the unique data | |
| ScalarView< DataScalar, DeviceType > | allocateDynRankViewMatchingUnderlying () const |
| Returns a DynRankView that matches the underlying Kokkos::View object in value_type, layout, and dimension. | |
| template<class ... DimArgs> | |
| ScalarView< DataScalar, DeviceType > | allocateDynRankViewMatchingUnderlying (DimArgs... dims) const |
| Returns a DynRankView that matches the underlying Kokkos::View object value_type and layout, but with the specified dimensions. | |
| void | clear () const |
| Copies 0.0 to the underlying View. | |
| void | copyDataFromDynRankViewMatchingUnderlying (const ScalarView< DataScalar, DeviceType > &dynRankView) const |
| Copies from the provided DynRankView into the underlying Kokkos::View container storing the unique data. | |
| KOKKOS_INLINE_FUNCTION int | getDataExtent (const ordinal_type &d) const |
| returns the true extent of the data corresponding to the logical dimension provided; if the data does not vary in that dimension, returns 1 | |
| KOKKOS_INLINE_FUNCTION int | getVariationModulus (const int &d) const |
| Variation modulus accessor. | |
| KOKKOS_INLINE_FUNCTION const Kokkos::Array< DataVariationType, 7 > & | getVariationTypes () const |
| Returns an array with the variation types in each logical dimension. | |
| template<class ... IntArgs> | |
| KOKKOS_INLINE_FUNCTION return_type | getEntryWithPassThroughOption (const bool &passThroughBlockDiagonalArgs, const IntArgs &... intArgs) const |
| Returns a (read-only) value corresponding to the specified logical data location. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column. | |
| template<class ... IntArgs> | |
| KOKKOS_INLINE_FUNCTION return_type | getEntry (const IntArgs &... intArgs) const |
| Returns a (read-only) value corresponding to the specified logical data location. | |
| template<class ... IntArgs> | |
| KOKKOS_INLINE_FUNCTION enable_if_t< valid_args< IntArgs... >::value &&(sizeof...(IntArgs)<=7), return_type > | operator() (const IntArgs &... intArgs) const |
| Returns a value corresponding to the specified logical data location. | |
| KOKKOS_INLINE_FUNCTION int | extent_int (const int &r) const |
| Returns the logical extent in the specified dimension. | |
| template<typename iType> | |
| KOKKOS_INLINE_FUNCTION constexpr std::enable_if< std::is_integral< iType >::value, size_t >::type | extent (const iType &r) const |
| KOKKOS_INLINE_FUNCTION bool | isDiagonal () const |
| returns true for containers that have two dimensions marked as BLOCK_PLUS_DIAGONAL for which the non-diagonal block is empty or size 1. | |
| Data< DataScalar, DeviceType > | allocateConstantData (const DataScalar &value) |
| template<int rank> | |
| enable_if_t<(rank!=1) &&(rank!=7), Kokkos::MDRangePolicy< typename DeviceType::execution_space, Kokkos::Rank< rank > > > | dataExtentRangePolicy () |
| returns an MDRangePolicy over the underlying data extents (but with the logical shape). | |
| template<int rank> | |
| enable_if_t< rank==7, Kokkos::MDRangePolicy< typename DeviceType::execution_space, Kokkos::Rank< 6 > > > | dataExtentRangePolicy () |
| returns an MDRangePolicy over the first six underlying data extents (but with the logical shape). | |
| template<int rank> | |
| enable_if_t< rank==1, Kokkos::RangePolicy< typename DeviceType::execution_space > > | dataExtentRangePolicy () |
| Data | shallowCopy (const int rank, const Kokkos::Array< int, 7 > &extents, const Kokkos::Array< DataVariationType, 7 > &variationTypes) const |
| Creates a new Data object with the same underlying view, but with the specified logical rank, extents, and variation types. | |
| void | storeDotProduct (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| Places the result of a contraction along the final dimension of A and B into this data container. | |
| template<class BinaryOperator> | |
| void | storeInPlaceCombination (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B, BinaryOperator binaryOperator) |
| Places the result of an in-place combination (e.g., entrywise sum) into this data container. | |
| void | storeInPlaceSum (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| stores the in-place (entrywise) sum, A .+ B, into this container. | |
| void | storeInPlaceProduct (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| stores the in-place (entrywise) product, A .* B, into this container. | |
| void | storeInPlaceDifference (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| stores the in-place (entrywise) difference, A .- B, into this container. | |
| void | storeInPlaceQuotient (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| stores the in-place (entrywise) quotient, A ./ B, into this container. | |
| void | storeMatVec (const Data< DataScalar, DeviceType > &matData, const Data< DataScalar, DeviceType > &vecData, const bool transposeMatrix=false) |
| Places the result of a matrix-vector multiply corresponding to the two provided containers into this Data container. This Data container should have been constructed by a call to allocateMatVecResult(), or should match such a container in underlying data extent and variation types. | |
| void | storeMatMat (const bool transposeA, const Data< DataScalar, DeviceType > &A_MatData, const bool transposeB, const Data< DataScalar, DeviceType > &B_MatData) |
| KOKKOS_INLINE_FUNCTION constexpr bool | isValid () const |
| returns true for containers that have data; false for those that don't (namely, those that have been constructed by the default constructor). | |
| KOKKOS_INLINE_FUNCTION unsigned | rank () const |
| Returns the logical rank of the Data container. | |
| void | setExtent (const ordinal_type &d, const ordinal_type &newExtent) |
| sets the logical extent in the specified dimension. If needed, the underlying data container is resized. | |
| KOKKOS_INLINE_FUNCTION bool | underlyingMatchesLogical () const |
| Returns true if the underlying container has exactly the same rank and extents as the logical container. | |
Static Public Member Functions | |
| template<class ToContainer, class FromContainer> | |
| static void | copyContainer (ToContainer to, FromContainer from) |
| Generic data copying method to allow construction of Data object from DynRankViews for which deep_copy() to the underlying view would be disallowed. This method made public to allow CUDA compilation (because it contains a Kokkos lambda). | |
| static Data< DataScalar, DeviceType > | allocateInPlaceCombinationResult (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| static Data< DataScalar, DeviceType > | allocateMatMatResult (const bool transposeA, const Data< DataScalar, DeviceType > &A_MatData, const bool transposeB, const Data< DataScalar, DeviceType > &B_MatData) |
| static Data< DataScalar, DeviceType > | allocateContractionResult (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B, const int &numContractionDims) |
| static Data< DataScalar, DeviceType > | allocateDotProductResult (const Data< DataScalar, DeviceType > &A, const Data< DataScalar, DeviceType > &B) |
| static Data< DataScalar, DeviceType > | allocateMatVecResult (const Data< DataScalar, DeviceType > &matData, const Data< DataScalar, DeviceType > &vecData, const bool transposeMatrix=false) |
Private Types | |
| using | return_type = const_reference_type |
Private Member Functions | |
| KOKKOS_INLINE_FUNCTION int | getUnderlyingViewExtent (const int &dim) const |
| Returns the extent of the underlying view in the specified dimension. | |
| void | setActiveDims () |
| class initialization method. Called by constructors. | |
Static Private Member Functions | |
| static KOKKOS_INLINE_FUNCTION int | blockPlusDiagonalNumNondiagonalEntries (const int &lastNondiagonal) |
| Returns the number of non-diagonal entries based on the last non-diagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType. | |
| static KOKKOS_INLINE_FUNCTION int | blockPlusDiagonalBlockEntryIndex (const int &lastNondiagonal, const int &numNondiagonalEntries, const int &i, const int &j) |
| //! Returns flattened index of the specified (i,j) matrix entry, assuming that i,j ≤ lastNondiagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType. | |
| static KOKKOS_INLINE_FUNCTION int | blockPlusDiagonalDiagonalEntryIndex (const int &lastNondiagonal, const int &numNondiagonalEntries, const int &i) |
| Returns flattened index of the specified (i,i) matrix entry, assuming that i > lastNondiagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType. | |
Private Attributes | |
| ordinal_type | dataRank_ |
| Kokkos::View< DataScalar *, DeviceType > | data1_ |
| Kokkos::View< DataScalar **, DeviceType > | data2_ |
| Kokkos::View< DataScalar ***, DeviceType > | data3_ |
| Kokkos::View< DataScalar ****, DeviceType > | data4_ |
| Kokkos::View< DataScalar *****, DeviceType > | data5_ |
| Kokkos::View< DataScalar ******, DeviceType > | data6_ |
| Kokkos::View< DataScalar *******, DeviceType > | data7_ |
| Kokkos::Array< int, 7 > | extents_ |
| Kokkos::Array< DataVariationType, 7 > | variationType_ |
| Kokkos::Array< int, 7 > | variationModulus_ |
| int | blockPlusDiagonalLastNonDiagonal_ = -1 |
| bool | hasNontrivialModulusUNUSED_ |
| bool | underlyingMatchesLogical_ |
| Kokkos::Array< ordinal_type, 7 > | activeDims_ |
| int | numActiveDims_ |
| ordinal_type | rank_ |
| ScalarView< DataScalar, DeviceType > | zeroView_ |
Detailed Description
class Intrepid2::Data< DataScalar, DeviceType >
Wrapper around a Kokkos::View that allows data that is constant or repeating in various logical dimensions to be stored just once, while providing a similar interface to that of View.
The Data class distinguishes between the logical extent and the data extent. For example, one could construct a data container corresponding to constant (cell, point) data with 100 cells and 25 points per cell as follows: auto cpData = Data(value, Kokkos::Array<int>{100,25}); The data extent of the container is 1 in every dimension, while the logical extent is 100 in the first dimension, and 25 in the second. Similarly, the logical rank of the container is 2, but the rank of the underlying View is 1.
There are four possible variation types in a logical dimension:
- GENERAL: the data varies arbitrarily. The underlying View will have the same extent in its corresponding dimension (which may be distinct from the logical dimension).
- CONSTANT: the data does not vary. The underlying View will not have a dimension corresponding to this dimension.
- MODULAR: the data varies with a modulus. The underlying View will have a corresponding dimension with extent corresponding to the modulus.
- BLOCK_PLUS_DIAGONAL: the data varies in this logical dimension and one other, corresponding to a square matrix that has some (possibly trivial) full block, with diagonal entries in the remaining dimensions. The underlying View will have one dimension corresponding to the two logical dimensions, with extent corresponding to the number of nonzeros in the matrix.
Definition at line 77 of file Intrepid2_Data.hpp.
Member Typedef Documentation
◆ all_true
| using Intrepid2::Data< DataScalar, DeviceType >::all_true = std::is_same<bool_pack<true, v...>, bool_pack<v..., true>> |
Definition at line 1271 of file Intrepid2_Data.hpp.
◆ const_reference_type
| using Intrepid2::Data< DataScalar, DeviceType >::const_reference_type = typename ScalarView<const DataScalar,DeviceType>::reference_type |
Definition at line 83 of file Intrepid2_Data.hpp.
◆ execution_space
| using Intrepid2::Data< DataScalar, DeviceType >::execution_space = typename DeviceType::execution_space |
Definition at line 80 of file Intrepid2_Data.hpp.
◆ reference_type
| using Intrepid2::Data< DataScalar, DeviceType >::reference_type = typename ScalarView<DataScalar,DeviceType>::reference_type |
Definition at line 82 of file Intrepid2_Data.hpp.
◆ return_type
|
private |
Definition at line 106 of file Intrepid2_Data.hpp.
◆ valid_args
| using Intrepid2::Data< DataScalar, DeviceType >::valid_args = all_true<std::is_integral<IntArgs>{}...> |
Definition at line 1274 of file Intrepid2_Data.hpp.
◆ value_type
| using Intrepid2::Data< DataScalar, DeviceType >::value_type = DataScalar |
Definition at line 79 of file Intrepid2_Data.hpp.
Constructor & Destructor Documentation
◆ Data() [1/16]
|
inline |
Constructor in terms of DimensionInfo for each logical dimension; does not require a View to be specified. Will allocate a View of appropriate rank, zero-filled.
Definition at line 520 of file Intrepid2_Data.hpp.
Referenced by allocateConstantData(), allocateContractionResult(), allocateDotProductResult(), allocateInPlaceCombinationResult(), allocateMatMatResult(), allocateMatVecResult(), combinedDataDimensionInfo(), Data(), Data(), shallowCopy(), storeDotProduct(), storeInPlaceCombination(), storeInPlaceDifference(), storeInPlaceProduct(), storeInPlaceQuotient(), storeInPlaceSum(), storeMatMat(), and storeMatVec().
◆ Data() [2/16]
|
inline |
DynRankView constructor. Will copy to a View of appropriate rank.
Definition at line 571 of file Intrepid2_Data.hpp.
References allocateAndCopyFromDynRankView(), blockPlusDiagonalLastNonDiagonal(), rank(), and setActiveDims().
◆ Data() [3/16]
|
inline |
copy-like constructor for differing device type, but same memory space. This does a shallow copy of the underlying view.
Definition at line 582 of file Intrepid2_Data.hpp.
References Data(), and setActiveDims().
◆ Data() [4/16]
|
inline |
copy-like constructor for differing execution spaces. This does a deep_copy of the underlying view.
Definition at line 607 of file Intrepid2_Data.hpp.
References blockPlusDiagonalLastNonDiagonal(), copyContainer(), Data(), getExtents(), getUnderlyingView(), getUnderlyingView1(), getUnderlyingView2(), getUnderlyingView3(), getUnderlyingView4(), getUnderlyingView5(), getUnderlyingView6(), getUnderlyingView7(), getUnderlyingViewRank(), getVariationTypes(), rank(), and setActiveDims().
◆ Data() [5/16]
|
inline |
copy constructor modeled after the copy-like constructor above. Not as efficient as the implicit copy constructor, so this should only be uncommented to emulate the copy-like constructor above in situations where host and device space are the same, and the copy-like constructor does not exist, or to provide a debugging breakpoint to assess when copies are being constructed.
constructor for fully varying data container, no expressed redundancy/repetition. Copies the data to a new Kokkos::View of matching rank.
Definition at line 688 of file Intrepid2_Data.hpp.
◆ Data() [6/16]
|
inline |
Constructor that accepts a DynRankView as an argument. The data belonging to the DynRankView will be copied into a new View of matching dimensions.
Definition at line 698 of file Intrepid2_Data.hpp.
References blockPlusDiagonalLastNonDiagonal(), and rank().
◆ Data() [7/16]
|
inline |
Definition at line 713 of file Intrepid2_Data.hpp.
◆ Data() [8/16]
|
inline |
Definition at line 727 of file Intrepid2_Data.hpp.
◆ Data() [9/16]
|
inline |
Definition at line 741 of file Intrepid2_Data.hpp.
◆ Data() [10/16]
|
inline |
Definition at line 755 of file Intrepid2_Data.hpp.
◆ Data() [11/16]
|
inline |
Definition at line 769 of file Intrepid2_Data.hpp.
◆ Data() [12/16]
|
inline |
Definition at line 783 of file Intrepid2_Data.hpp.
◆ Data() [13/16]
|
inline |
Definition at line 797 of file Intrepid2_Data.hpp.
◆ Data() [14/16]
|
inline |
constructor with run-time rank (requires full-length extents, variationType inputs; those beyond the rank will be ignored).
Definition at line 812 of file Intrepid2_Data.hpp.
References blockPlusDiagonalLastNonDiagonal(), and rank().
◆ Data() [15/16]
|
inline |
constructor for everywhere-constant data
Definition at line 827 of file Intrepid2_Data.hpp.
◆ Data() [16/16]
|
inline |
default constructor (empty data)
Definition at line 841 of file Intrepid2_Data.hpp.
Referenced by allocateConstantData(), allocateMatMatResult(), allocateMatVecResult(), and shallowCopy().
Member Function Documentation
◆ allocateAndCopyFromDynRankView()
|
inline |
allocate an underlying View that matches the provided DynRankView in dimensions, and copy. Called by constructors that accept a DynRankView as argument.
Definition at line 491 of file Intrepid2_Data.hpp.
References copyContainer().
Referenced by Data().
◆ allocateConstantData()
|
inline |
Constructs a container with extents matching this, with a single-value underlying View, CONSTANT in each dimension.
- Parameters
-
value [in] - the constant value.
- Returns
- A container with the same logical shape as this, with a single-value underlying View.
Definition at line 1327 of file Intrepid2_Data.hpp.
References Data(), Data(), and getExtents().
Referenced by Intrepid2::CellTools< DeviceType >::setJacobianDetInv().
◆ allocateContractionResult()
|
inlinestatic |
Constructs a container suitable for storing the result of a contraction over the final dimensions of the two provided containers. The two containers must have the same logical shape.
- See also
- storeInPlaceCombination()
- Parameters
-
A [in] - the first data container. B [in] - the second data container. Must have the same logical shape as A. numContractionDims [in] - the number of dimensions over which the contraction should take place.
- Returns
- A numContractionDims-rank-lower container with the same logical shape as A and B in all but the last dimensions.
Definition at line 1537 of file Intrepid2_Data.hpp.
References combinedDataDimensionInfo(), Data(), extent_int(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by allocateDotProductResult().
◆ allocateDotProductResult()
|
inlinestatic |
Constructs a container suitable for storing the result of a contraction over the final dimension of the two provided containers. The two containers must have the same logical shape.
- See also
- storeInPlaceCombination()
- Parameters
-
A [in] - the first data container. B [in] - the second data container. Must have the same logical shape as A.
- Returns
- A 1-rank-lower container with the same logical shape as A and B in all but the last dimension.
Definition at line 1557 of file Intrepid2_Data.hpp.
References allocateContractionResult(), and Data().
◆ allocateDynRankViewMatchingUnderlying() [1/2]
|
inline |
Returns a DynRankView that matches the underlying Kokkos::View object in value_type, layout, and dimension.
Definition at line 1146 of file Intrepid2_Data.hpp.
Referenced by allocateMatVecResult().
◆ allocateDynRankViewMatchingUnderlying() [2/2]
|
inline |
Returns a DynRankView that matches the underlying Kokkos::View object value_type and layout, but with the specified dimensions.
Definition at line 1163 of file Intrepid2_Data.hpp.
◆ allocateInPlaceCombinationResult()
|
inlinestatic |
Constructs a container suitable for storing the result of an in-place combination of the two provided data containers. The two containers must have the same logical shape.
- See also
- storeInPlaceCombination()
- Parameters
-
A [in] - the first data container. B [in] - the second data container. Must have the same logical shape as A.
- Returns
- A container with the same logical shape as A and B, with underlying View storage sufficient to store the result of A + B (or any other in-place combination).
Definition at line 1337 of file Intrepid2_Data.hpp.
References combinedDataDimensionInfo(), Data(), extent_int(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), and Intrepid2::TransformedBasisValues< Scalar, DeviceType >::multiplyByPointwiseWeights().
◆ allocateMatMatResult()
|
inlinestatic |
Constructs a container suitable for storing the result of a matrix-vector multiply corresponding to the two provided containers.
- See also
- storeMatMat()
- Parameters
-
A_MatData [in] - logically (...,D1,D2)-dimensioned container, where D1,D2 correspond to matrix dimensions. transposeA [in] - if true, A will be transposed prior to being multiplied by B (or B's transpose). B_MatData [in] - logically (...,D3,D4)-dimensioned container, where D3,D4 correspond to matrix dimensions. transposeB [in] - if true, B will be transposed prior to the multiplication by A (or A's transpose).
Definition at line 1357 of file Intrepid2_Data.hpp.
References blockPlusDiagonalLastNonDiagonal(), Data(), Data(), extent_int(), getUnderlyingView(), getVariationModulus(), getVariationTypes(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate(), and Intrepid2::DataTools::transposeMatrix().
◆ allocateMatVecResult()
|
inlinestatic |
Constructs a container suitable for storing the result of a matrix-vector multiply corresponding to the two provided containers.
- See also
- storeMatVec()
Definition at line 1564 of file Intrepid2_Data.hpp.
References allocateDynRankViewMatchingUnderlying(), Data(), Data(), extent_int(), getVariationModulus(), getVariationTypes(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by Intrepid2::ProjectedGeometry< spaceDim, PointScalar, DeviceType >::projectOntoHGRADBasis().
◆ applyOperator()
|
inline |
applies the specified unary operator to each entry
Definition at line 251 of file Intrepid2_Data.hpp.
References dataExtentRangePolicy(), getDataExtent(), and getUnderlyingView().
◆ blockPlusDiagonalBlockEntryIndex()
|
inlinestaticprivate |
//! Returns flattened index of the specified (i,j) matrix entry, assuming that i,j ≤ lastNondiagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType.
Definition at line 119 of file Intrepid2_Data.hpp.
Referenced by getWritableEntryWithPassThroughOption().
◆ blockPlusDiagonalDiagonalEntryIndex()
|
inlinestaticprivate |
Returns flattened index of the specified (i,i) matrix entry, assuming that i > lastNondiagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType.
Definition at line 126 of file Intrepid2_Data.hpp.
Referenced by getWritableEntryWithPassThroughOption().
◆ blockPlusDiagonalLastNonDiagonal()
|
inline |
For a Data object containing data with variation type BLOCK_PLUS_DIAGONAL, returns the row and column (which must match) of the last non-diagonal entry. For fully diagonal matrices, this is -1.
Definition at line 850 of file Intrepid2_Data.hpp.
Referenced by allocateMatMatResult(), Data(), Data(), Data(), Data(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), and Intrepid2::CellTools< DeviceType >::setJacobianInv().
◆ blockPlusDiagonalNumNondiagonalEntries()
|
inlinestaticprivate |
Returns the number of non-diagonal entries based on the last non-diagonal. Only applicable for BLOCK_PLUS_DIAGONAL DataVariationType.
Definition at line 112 of file Intrepid2_Data.hpp.
Referenced by getWritableEntryWithPassThroughOption(), and setActiveDims().
◆ clear()
|
inline |
Copies 0.0 to the underlying View.
Definition at line 1179 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate().
◆ combinedDataDimensionInfo()
|
inline |
Returns (DataVariationType, data extent) in the specified dimension for a Data container that combines (through multiplication, say, or addition) this container with otherData.
Definition at line 882 of file Intrepid2_Data.hpp.
References Data(), and getDimensionInfo().
Referenced by allocateContractionResult(), and allocateInPlaceCombinationResult().
◆ copyContainer()
|
inlinestatic |
Generic data copying method to allow construction of Data object from DynRankViews for which deep_copy() to the underlying view would be disallowed. This method made public to allow CUDA compilation (because it contains a Kokkos lambda).
Definition at line 476 of file Intrepid2_Data.hpp.
Referenced by allocateAndCopyFromDynRankView(), copyDataFromDynRankViewMatchingUnderlying(), and Data().
◆ copyDataFromDynRankViewMatchingUnderlying()
|
inline |
Copies from the provided DynRankView into the underlying Kokkos::View container storing the unique data.
Definition at line 1195 of file Intrepid2_Data.hpp.
References copyContainer().
◆ dataExtentRangePolicy() [1/3]
|
inline |
Definition at line 1734 of file Intrepid2_Data.hpp.
◆ dataExtentRangePolicy() [2/3]
|
inline |
returns an MDRangePolicy over the first six underlying data extents (but with the logical shape).
Definition at line 1716 of file Intrepid2_Data.hpp.
References getDataExtent().
◆ dataExtentRangePolicy() [3/3]
|
inline |
returns an MDRangePolicy over the underlying data extents (but with the logical shape).
Definition at line 1698 of file Intrepid2_Data.hpp.
References getDataExtent(), and rank().
Referenced by applyOperator().
◆ extent()
|
inlineconstexpr |
Definition at line 1303 of file Intrepid2_Data.hpp.
◆ extent_int()
|
inline |
Returns the logical extent in the specified dimension.
Definition at line 1295 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::allocateCellMeasure(), allocateContractionResult(), allocateInPlaceCombinationResult(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::allocateJacobianData(), allocateMatMatResult(), allocateMatVecResult(), Intrepid2::Impl::F_Integrate< Scalar, DeviceType, integralViewRank >::approximateFlopCountPerCell(), getDimensionInfo(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::Impl::F_Integrate< Scalar, DeviceType, integralViewRank >::runSpecialized3(), Intrepid2::Impl::F_IntegratePointValueCache< Scalar, DeviceType, integralViewRank >::runSpecialized3(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), storeDotProduct(), storeMatMat(), storeMatVec(), and Intrepid2::TensorArgumentIterator::TensorArgumentIterator().
◆ getDataExtent()
|
inline |
returns the true extent of the data corresponding to the logical dimension provided; if the data does not vary in that dimension, returns 1
Definition at line 1212 of file Intrepid2_Data.hpp.
References getUnderlyingViewExtent().
Referenced by Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::allocateCellMeasure(), applyOperator(), dataExtentRangePolicy(), getDimensionInfo(), Intrepid2::IntegrationTools< DeviceType >::integrate(), storeDotProduct(), Intrepid2::DataCombiner< DataScalar, DeviceType, BinaryOperator >::storeInPlaceCombination(), storeMatMat(), and storeMatVec().
◆ getDimensionInfo()
|
inline |
Returns an object fully specifying the indicated dimension. This is used in determining appropriate sizing of Data objects that depend on other Data objects (e.g., when two matrix Data objects are multiplied together).
Definition at line 864 of file Intrepid2_Data.hpp.
References extent_int(), and getDataExtent().
Referenced by Intrepid2::IntegrationTools< DeviceType >::allocateIntegralData(), and combinedDataDimensionInfo().
◆ getEntry()
|
inline |
Returns a (read-only) value corresponding to the specified logical data location.
Definition at line 1263 of file Intrepid2_Data.hpp.
References getEntryWithPassThroughOption().
Referenced by operator()().
◆ getEntryWithPassThroughOption()
|
inline |
Returns a (read-only) value corresponding to the specified logical data location. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column.
Definition at line 1255 of file Intrepid2_Data.hpp.
References getWritableEntryWithPassThroughOption().
Referenced by getEntry().
◆ getExtents()
|
inline |
Returns an array containing the logical extents in each dimension.
Definition at line 857 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::allocateCellMeasure(), allocateConstantData(), Intrepid2::CellTools< DeviceType >::allocateJacobianDet(), Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Data(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::DataTools::multiplyByCPWeights(), and Intrepid2::DataTools::transposeMatrix().
◆ getUnderlyingView() [1/8]
|
inline |
Returns a DynRankView constructed atop the same underlying data as the fixed-rank Kokkos::View used internally.
Definition at line 1111 of file Intrepid2_Data.hpp.
◆ getUnderlyingView() [2/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 7.
Definition at line 966 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [3/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 6.
Definition at line 954 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [4/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 5.
Definition at line 942 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [5/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 4.
Definition at line 930 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [6/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 3.
Definition at line 918 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [7/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 2.
Definition at line 906 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ getUnderlyingView() [8/8]
|
inline |
Returns the underlying view. Throws an exception if the underlying view is not rank 1.
Definition at line 894 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by allocateMatMatResult(), applyOperator(), Data(), getUnderlyingView1(), getUnderlyingView2(), getUnderlyingView3(), getUnderlyingView4(), getUnderlyingView5(), getUnderlyingView6(), getUnderlyingView7(), Intrepid2::Basis< DeviceType, outputValueType, pointValueType >::getValues(), Intrepid2::Basis_TensorBasis< BasisBase >::getValues(), getWritableEntryWithPassThroughOption(), Intrepid2::IntegrationTools< DeviceType >::integrate(), and Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate().
◆ getUnderlyingView1()
|
inline |
returns the View that stores the unique data. For rank-1 underlying containers.
Definition at line 976 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Intrepid2::CellTools< DeviceType >::allocateJacobianDet(), Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::computeCellMeasure(), Data(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), and Intrepid2::CellTools< DeviceType >::setJacobianInv().
◆ getUnderlyingView2()
|
inline |
returns the View that stores the unique data. For rank-2 underlying containers.
Definition at line 983 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::computeCellMeasure(), Data(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), and Intrepid2::CellTools< DeviceType >::setJacobianInv().
◆ getUnderlyingView3()
|
inline |
returns the View that stores the unique data. For rank-3 underlying containers.
Definition at line 990 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Intrepid2::CellTools< DeviceType >::allocateJacobianDet(), Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Data(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), and Intrepid2::CellTools< DeviceType >::setJacobianInv().
◆ getUnderlyingView4()
|
inline |
returns the View that stores the unique data. For rank-4 underlying containers.
Definition at line 997 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Intrepid2::CellTools< DeviceType >::allocateJacobianDet(), Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Data(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), Intrepid2::CellTools< DeviceType >::setJacobianInv(), and storeMatMat().
◆ getUnderlyingView5()
|
inline |
returns the View that stores the unique data. For rank-5 underlying containers.
Definition at line 1004 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Data().
◆ getUnderlyingView6()
|
inline |
returns the View that stores the unique data. For rank-6 underlying containers.
Definition at line 1011 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Data().
◆ getUnderlyingView7()
|
inline |
returns the View that stores the unique data. For rank-7 underlying containers.
Definition at line 1018 of file Intrepid2_Data.hpp.
References getUnderlyingView().
Referenced by Data().
◆ getUnderlyingViewExtent()
|
inlineprivate |
Returns the extent of the underlying view in the specified dimension.
Definition at line 133 of file Intrepid2_Data.hpp.
Referenced by getDataExtent(), getUnderlyingViewSize(), setActiveDims(), and setExtent().
◆ getUnderlyingViewRank()
|
inline |
returns the rank of the View that stores the unique data
Definition at line 1128 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), Data(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), Intrepid2::CellTools< DeviceType >::setJacobianInv(), and Intrepid2::DataCombiner< DataScalar, DeviceType, BinaryOperator >::storeInPlaceCombination().
◆ getUnderlyingViewSize()
|
inline |
returns the number of entries in the View that stores the unique data
Definition at line 1135 of file Intrepid2_Data.hpp.
References getUnderlyingViewExtent().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate(), and Intrepid2::DataCombiner< DataScalar, DeviceType, BinaryOperator >::storeInPlaceCombination().
◆ getVariationModulus()
|
inline |
Variation modulus accessor.
- Parameters
-
[in] d - the logical dimension whose variation modulus is requested.
- Returns
- the variation modulus.
The variation modulus is defined as the number of unique entries in the specified dimension. This is defined as follows:
- for CONSTANT variation, the variation modulus is 1
- for MODULAR variation, the variation modulus is exactly the modulus by which the data repeats in the specified dimension
- for GENERAL variation, the variation modulus is the extent in the specified dimension
- for BLOCK_PLUS_DIAGONAL, the variation modulus in the first logical dimension of the matrix is the number of nonzeros in the matrix; in the second logical dimension the variation modulus is 1.
Definition at line 1240 of file Intrepid2_Data.hpp.
Referenced by allocateMatMatResult(), and allocateMatVecResult().
◆ getVariationTypes()
|
inline |
Returns an array with the variation types in each logical dimension.
Definition at line 1247 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::allocateCellMeasure(), Intrepid2::CellTools< DeviceType >::allocateJacobianDet(), Intrepid2::CellTools< DeviceType >::allocateJacobianInv(), allocateMatMatResult(), allocateMatVecResult(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::computeCellMeasure(), Data(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::CellTools< DeviceType >::setJacobianDet(), Intrepid2::CellTools< DeviceType >::setJacobianInv(), and Intrepid2::DataTools::transposeMatrix().
◆ getWritableEntry()
|
inline |
Returns an l-value reference to the specified logical entry in the underlying view. Note that for variation types other than GENERAL, multiple valid argument sets will refer to the same memory location. Intended for Intrepid2 developers and expert users only. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column.
Definition at line 469 of file Intrepid2_Data.hpp.
References getWritableEntryWithPassThroughOption().
Referenced by storeDotProduct(), storeMatMat(), and storeMatVec().
◆ getWritableEntryWithPassThroughOption()
|
inline |
Returns an l-value reference to the specified logical entry in the underlying view. Note that for variation types other than GENERAL, multiple valid argument sets will refer to the same memory location. Intended for Intrepid2 developers and expert users only. If passThroughBlockDiagonalArgs is TRUE, the corresponding arguments are interpreted as entries in the 1D packed matrix rather than as logical 2D matrix row and column.
Definition at line 356 of file Intrepid2_Data.hpp.
References blockPlusDiagonalBlockEntryIndex(), blockPlusDiagonalDiagonalEntryIndex(), blockPlusDiagonalNumNondiagonalEntries(), getUnderlyingView(), and INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE.
Referenced by getEntryWithPassThroughOption(), and getWritableEntry().
◆ isDiagonal()
|
inline |
returns true for containers that have two dimensions marked as BLOCK_PLUS_DIAGONAL for which the non-diagonal block is empty or size 1.
Definition at line 1308 of file Intrepid2_Data.hpp.
References INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE.
◆ isValid()
|
inlineconstexpr |
returns true for containers that have data; false for those that don't (namely, those that have been constructed by the default constructor).
Definition at line 2047 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::IntegrationTools< DeviceType >::allocateIntegralData(), Intrepid2::IntegrationTools< DeviceType >::integrate(), and Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate().
◆ operator()()
|
inline |
Returns a value corresponding to the specified logical data location.
Definition at line 1289 of file Intrepid2_Data.hpp.
References getEntry().
◆ rank()
|
inline |
Returns the logical rank of the Data container.
Definition at line 2054 of file Intrepid2_Data.hpp.
Referenced by allocateContractionResult(), allocateInPlaceCombinationResult(), allocateMatMatResult(), allocateMatVecResult(), Data(), Data(), Data(), Data(), Data(), dataExtentRangePolicy(), getUnderlyingView(), Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::DataTools::multiplyByCPWeights(), Intrepid2::Impl::F_Integrate< Scalar, DeviceType, integralViewRank >::runSpecialized3(), Intrepid2::Impl::F_IntegratePointValueCache< Scalar, DeviceType, integralViewRank >::runSpecialized3(), Intrepid2::CellGeometry< PointScalar, spaceDim, DeviceType >::setJacobianDataPrivate(), shallowCopy(), storeDotProduct(), storeMatMat(), storeMatVec(), and Intrepid2::DataTools::transposeMatrix().
◆ setActiveDims()
|
inlineprivate |
class initialization method. Called by constructors.
Definition at line 149 of file Intrepid2_Data.hpp.
References blockPlusDiagonalNumNondiagonalEntries(), and getUnderlyingViewExtent().
◆ setExtent()
|
inline |
sets the logical extent in the specified dimension. If needed, the underlying data container is resized.
- Parameters
-
[in] d - the logical dimension in which the extent is to be changed [in] newExtent - the new extent
- Note
- Not supported for dimensions in which the variation type is BLOCK_PLUS_DIAGONAL.
- If the variation type is MODULAR, the existing modulus must evenly divide the new extent; the underlying data structure will not be resized in this case.
Definition at line 2065 of file Intrepid2_Data.hpp.
References getUnderlyingViewExtent().
◆ setUnderlyingView()
|
inline |
Definition at line 1074 of file Intrepid2_Data.hpp.
◆ setUnderlyingView1()
|
inline |
sets the View that stores the unique data. For rank-1 underlying containers.
Definition at line 1025 of file Intrepid2_Data.hpp.
◆ setUnderlyingView2()
|
inline |
sets the View that stores the unique data. For rank-2 underlying containers.
Definition at line 1032 of file Intrepid2_Data.hpp.
◆ setUnderlyingView3()
|
inline |
sets the View that stores the unique data. For rank-3 underlying containers.
Definition at line 1039 of file Intrepid2_Data.hpp.
◆ setUnderlyingView4()
|
inline |
sets the View that stores the unique data. For rank-4 underlying containers.
Definition at line 1046 of file Intrepid2_Data.hpp.
◆ setUnderlyingView5()
|
inline |
sets the View that stores the unique data. For rank-5 underlying containers.
Definition at line 1053 of file Intrepid2_Data.hpp.
◆ setUnderlyingView6()
|
inline |
sets the View that stores the unique data. For rank-6 underlying containers.
Definition at line 1060 of file Intrepid2_Data.hpp.
◆ setUnderlyingView7()
|
inline |
sets the View that stores the unique data. For rank-7 underlying containers.
Definition at line 1067 of file Intrepid2_Data.hpp.
◆ shallowCopy()
|
inline |
Creates a new Data object with the same underlying view, but with the specified logical rank, extents, and variation types.
Definition at line 1742 of file Intrepid2_Data.hpp.
References Data(), Data(), and rank().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate(), Intrepid2::DataTools::multiplyByCPWeights(), and Intrepid2::DataTools::multiplyByCPWeights().
◆ storeDotProduct()
|
inline |
Places the result of a contraction along the final dimension of A and B into this data container.
Definition at line 1759 of file Intrepid2_Data.hpp.
References Data(), extent_int(), getDataExtent(), getWritableEntry(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ storeInPlaceCombination()
| void Intrepid2::Data< DataScalar, DeviceType >::storeInPlaceCombination | ( | const Data< DataScalar, DeviceType > & | A, |
| const Data< DataScalar, DeviceType > & | B, | ||
| BinaryOperator | binaryOperator ) |
Places the result of an in-place combination (e.g., entrywise sum) into this data container.
Definition at line 31 of file Intrepid2_DataDef.hpp.
References Data().
Referenced by storeInPlaceDifference(), storeInPlaceProduct(), storeInPlaceQuotient(), and storeInPlaceSum().
◆ storeInPlaceDifference()
|
inline |
stores the in-place (entrywise) difference, A .- B, into this container.
Definition at line 1835 of file Intrepid2_Data.hpp.
References Data(), and storeInPlaceCombination().
◆ storeInPlaceProduct()
|
inline |
stores the in-place (entrywise) product, A .* B, into this container.
Definition at line 1828 of file Intrepid2_Data.hpp.
References Data(), and storeInPlaceCombination().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate(), and Intrepid2::DataTools::multiplyByCPWeights().
◆ storeInPlaceQuotient()
|
inline |
stores the in-place (entrywise) quotient, A ./ B, into this container.
Definition at line 1842 of file Intrepid2_Data.hpp.
References Data(), and storeInPlaceCombination().
Referenced by Intrepid2::CellTools< DeviceType >::setJacobianDetInv().
◆ storeInPlaceSum()
|
inline |
stores the in-place (entrywise) sum, A .+ B, into this container.
Definition at line 1821 of file Intrepid2_Data.hpp.
References Data(), and storeInPlaceCombination().
◆ storeMatMat()
|
inline |
Places the result of a matrix-matrix multiply corresponding to the two provided containers into this Data container. This Data container should have been constructed by a call to allocateMatMatResult(), or should match such a container in underlying data extent and variation types.
- See also
- allocateMatMat()
- Parameters
-
A_MatData [in] - logically (...,D1,D2)-dimensioned container, where D1,D2 correspond to matrix dimensions. transposeA [in] - if true, A will be transposed prior to being multiplied by B (or B's transpose). B_MatData [in] - logically (...,D3,D4)-dimensioned container, where D3,D4 correspond to matrix dimensions. transposeB [in] - if true, B will be transposed prior to the multiplication by A (or A's transpose).
Definition at line 1926 of file Intrepid2_Data.hpp.
References Data(), extent_int(), getDataExtent(), getUnderlyingView4(), getWritableEntry(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
Referenced by Intrepid2::IntegrationTools< DeviceType >::integrate().
◆ storeMatVec()
|
inline |
Places the result of a matrix-vector multiply corresponding to the two provided containers into this Data container. This Data container should have been constructed by a call to allocateMatVecResult(), or should match such a container in underlying data extent and variation types.
Definition at line 1849 of file Intrepid2_Data.hpp.
References Data(), extent_int(), getDataExtent(), getWritableEntry(), INTREPID2_TEST_FOR_EXCEPTION_DEVICE_SAFE, and rank().
◆ underlyingMatchesLogical()
|
inline |
Returns true if the underlying container has exactly the same rank and extents as the logical container.
Definition at line 2118 of file Intrepid2_Data.hpp.
Referenced by Intrepid2::DataCombiner< DataScalar, DeviceType, BinaryOperator >::storeInPlaceCombination().
Member Data Documentation
◆ activeDims_
|
private |
Definition at line 100 of file Intrepid2_Data.hpp.
◆ blockPlusDiagonalLastNonDiagonal_
|
private |
Definition at line 96 of file Intrepid2_Data.hpp.
◆ data1_
|
private |
Definition at line 86 of file Intrepid2_Data.hpp.
◆ data2_
|
private |
Definition at line 87 of file Intrepid2_Data.hpp.
◆ data3_
|
private |
Definition at line 88 of file Intrepid2_Data.hpp.
◆ data4_
|
private |
Definition at line 89 of file Intrepid2_Data.hpp.
◆ data5_
|
private |
Definition at line 90 of file Intrepid2_Data.hpp.
◆ data6_
|
private |
Definition at line 91 of file Intrepid2_Data.hpp.
◆ data7_
|
private |
Definition at line 92 of file Intrepid2_Data.hpp.
◆ dataRank_
|
private |
Definition at line 85 of file Intrepid2_Data.hpp.
◆ extents_
|
private |
Definition at line 93 of file Intrepid2_Data.hpp.
◆ hasNontrivialModulusUNUSED_
|
private |
Definition at line 98 of file Intrepid2_Data.hpp.
◆ numActiveDims_
|
private |
Definition at line 101 of file Intrepid2_Data.hpp.
◆ rank_
|
private |
Definition at line 103 of file Intrepid2_Data.hpp.
◆ underlyingMatchesLogical_
|
private |
Definition at line 99 of file Intrepid2_Data.hpp.
◆ variationModulus_
|
private |
Definition at line 95 of file Intrepid2_Data.hpp.
◆ variationType_
|
private |
Definition at line 94 of file Intrepid2_Data.hpp.
◆ zeroView_
|
private |
Definition at line 108 of file Intrepid2_Data.hpp.
The documentation for this class was generated from the following files:
- /build/trilinos-oIrXZh/trilinos-16.1.0/packages/intrepid2/src/Shared/Intrepid2_Data.hpp
- /build/trilinos-oIrXZh/trilinos-16.1.0/packages/intrepid2/src/Shared/Intrepid2_DataDef.hpp
Generated by
1.15.0