Intrepid2
Public Types | Public Member Functions | Public Attributes | List of all members
Intrepid2::TransformedVectorData< Scalar, DeviceType > Class Template Reference

Structure-preserving representation of transformed vector data; reference space values and transformations are stored separately. More...

#include <Intrepid2_TransformedVectorData.hpp>

Public Types

using Transform = Data< Scalar, DeviceType >
 

Public Member Functions

 TransformedVectorData (const Data< Scalar, DeviceType > &transform, const VectorData< Scalar, DeviceType > &vectorData)
 Standard constructor. More...
 
 TransformedVectorData (const VectorData< Scalar, DeviceType > &vectorData)
 Constructor for the case of an identity transform. More...
 
template<typename OtherDeviceType , class = typename std::enable_if<!std::is_same<DeviceType, OtherDeviceType>::value>::type>
 TransformedVectorData (const TransformedVectorData< Scalar, OtherDeviceType > &transformedVectorData)
 copy-like constructor for differing device types. This may do a deep_copy of underlying views, depending on the memory spaces involved. More...
 
KOKKOS_INLINE_FUNCTION bool axisAligned () const
 Returns true if the transformation matrix is diagonal. More...
 
KOKKOS_INLINE_FUNCTION int cellDataExtent () const
 Returns the true data extent in the cell dimension (e.g., will be 1 for transform matrices that do not vary from one cell to the next). More...
 
KOKKOS_INLINE_FUNCTION DataVariationType cellVariationType () const
 Returns the variation type corresponding to the cell dimension. More...
 
KOKKOS_INLINE_FUNCTION int numCells () const
 Returns the logical extent in the cell dimension, which is the 0 dimension in this container. More...
 
KOKKOS_INLINE_FUNCTION int numFields () const
 Returns the logical extent in the fields dimension, which is the 1 dimension in this container. More...
 
KOKKOS_INLINE_FUNCTION int numPoints () const
 Returns the logical extent in the points dimension, which is the 2 dimension in this container. More...
 
KOKKOS_INLINE_FUNCTION int spaceDim () const
 Returns the logical extent in the space dimension, which is the 3 dimension in this container. More...
 
KOKKOS_INLINE_FUNCTION Scalar operator() (const int &cellOrdinal, const int &fieldOrdinal, const int &pointOrdinal, const int &dim) const
 Accessor, with arguments (C,F,P,D). More...
 
KOKKOS_INLINE_FUNCTION Scalar transformWeight (const int &cellOrdinal, const int &pointOrdinal, const int &dim1, const int &dim2) const
 Returns the specified entry in the transform matrix. More...
 
const Data< Scalar, DeviceType > & transform () const
 Returns the transform matrix. An invalid/empty container indicates the identity transform. More...
 
const VectorData< Scalar, DeviceType > & vectorData () const
 Returns the reference-space vector data. More...
 
KOKKOS_INLINE_FUNCTION constexpr unsigned rank () const
 Returns the rank of the container, which is 4. More...
 
KOKKOS_INLINE_FUNCTION int extent_int (const int &r) const
 Returns the extent in the specified dimension as an int. More...
 

Public Attributes

Data< Scalar, DeviceType > transform_
 
VectorData< Scalar, DeviceType > vectorData_
 

Detailed Description

template<class Scalar, typename DeviceType>
class Intrepid2::TransformedVectorData< Scalar, DeviceType >

Structure-preserving representation of transformed vector data; reference space values and transformations are stored separately.

TransformedVectorData provides a View-like interface of rank 4, with shape (C,F,P,D). When the corresponding accessor is used, the transformed value is determined from corresponding reference space values and the transformation.

Definition at line 64 of file Intrepid2_TransformedVectorData.hpp.

Member Typedef Documentation

◆ Transform

template<class Scalar , typename DeviceType >
using Intrepid2::TransformedVectorData< Scalar, DeviceType >::Transform = Data<Scalar,DeviceType>

Definition at line 67 of file Intrepid2_TransformedVectorData.hpp.

Constructor & Destructor Documentation

◆ TransformedVectorData() [1/3]

template<class Scalar , typename DeviceType >
Intrepid2::TransformedVectorData< Scalar, DeviceType >::TransformedVectorData ( const Data< Scalar, DeviceType > &  transform,
const VectorData< Scalar, DeviceType > &  vectorData 
)
inline

Standard constructor.

Parameters
[in]transform- the transformation matrix, with logical shape (C,P,D,D)
[in]vectorData- the reference-space data to be transformed, with logical shape (F,P,D)

Definition at line 78 of file Intrepid2_TransformedVectorData.hpp.

◆ TransformedVectorData() [2/3]

template<class Scalar , typename DeviceType >
Intrepid2::TransformedVectorData< Scalar, DeviceType >::TransformedVectorData ( const VectorData< Scalar, DeviceType > &  vectorData)
inline

Constructor for the case of an identity transform.

Parameters
[in]vectorData- the reference-space data, with logical shape (F,P,D)

Definition at line 90 of file Intrepid2_TransformedVectorData.hpp.

◆ TransformedVectorData() [3/3]

template<class Scalar , typename DeviceType >
template<typename OtherDeviceType , class = typename std::enable_if<!std::is_same<DeviceType, OtherDeviceType>::value>::type>
Intrepid2::TransformedVectorData< Scalar, DeviceType >::TransformedVectorData ( const TransformedVectorData< Scalar, OtherDeviceType > &  transformedVectorData)
inline

copy-like constructor for differing device types. This may do a deep_copy of underlying views, depending on the memory spaces involved.

Definition at line 97 of file Intrepid2_TransformedVectorData.hpp.

Member Function Documentation

◆ axisAligned()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION bool Intrepid2::TransformedVectorData< Scalar, DeviceType >::axisAligned ( ) const
inline

Returns true if the transformation matrix is diagonal.

Definition at line 104 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::Data< DataScalar, DeviceType >::isDiagonal(), and Intrepid2::Data< DataScalar, DeviceType >::isValid().

◆ cellDataExtent()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::cellDataExtent ( ) const
inline

Returns the true data extent in the cell dimension (e.g., will be 1 for transform matrices that do not vary from one cell to the next).

Definition at line 118 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::Data< DataScalar, DeviceType >::getDataExtent().

◆ cellVariationType()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION DataVariationType Intrepid2::TransformedVectorData< Scalar, DeviceType >::cellVariationType ( ) const
inline

Returns the variation type corresponding to the cell dimension.

Definition at line 124 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::Data< DataScalar, DeviceType >::getVariationTypes().

◆ extent_int()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::extent_int ( const int &  r) const
inline

◆ numCells()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::numCells ( ) const
inline

Returns the logical extent in the cell dimension, which is the 0 dimension in this container.

Definition at line 130 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::Data< DataScalar, DeviceType >::extent_int().

Referenced by Intrepid2::IntegrationTools< DeviceType >::allocateIntegralData(), and Intrepid2::TransformedVectorData< Scalar, DeviceType >::extent_int().

◆ numFields()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::numFields ( ) const
inline

◆ numPoints()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::numPoints ( ) const
inline

Returns the logical extent in the points dimension, which is the 2 dimension in this container.

Definition at line 142 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::VectorData< Scalar, DeviceType >::numPoints().

Referenced by Intrepid2::TransformedVectorData< Scalar, DeviceType >::extent_int().

◆ operator()()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION Scalar Intrepid2::TransformedVectorData< Scalar, DeviceType >::operator() ( const int &  cellOrdinal,
const int &  fieldOrdinal,
const int &  pointOrdinal,
const int &  dim 
) const
inline

◆ rank()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION constexpr unsigned Intrepid2::TransformedVectorData< Scalar, DeviceType >::rank ( ) const
inlineconstexpr

Returns the rank of the container, which is 4.

Definition at line 204 of file Intrepid2_TransformedVectorData.hpp.

◆ spaceDim()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION int Intrepid2::TransformedVectorData< Scalar, DeviceType >::spaceDim ( ) const
inline

Returns the logical extent in the space dimension, which is the 3 dimension in this container.

Definition at line 148 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::VectorData< Scalar, DeviceType >::spaceDim().

Referenced by Intrepid2::TransformedVectorData< Scalar, DeviceType >::extent_int(), and Intrepid2::IntegrationTools< DeviceType >::integrate().

◆ transform()

template<class Scalar , typename DeviceType >
const Data< Scalar, DeviceType > & Intrepid2::TransformedVectorData< Scalar, DeviceType >::transform ( ) const
inline

Returns the transform matrix. An invalid/empty container indicates the identity transform.

Definition at line 191 of file Intrepid2_TransformedVectorData.hpp.

Referenced by Intrepid2::IntegrationTools< DeviceType >::allocateIntegralData().

◆ transformWeight()

template<class Scalar , typename DeviceType >
KOKKOS_INLINE_FUNCTION Scalar Intrepid2::TransformedVectorData< Scalar, DeviceType >::transformWeight ( const int &  cellOrdinal,
const int &  pointOrdinal,
const int &  dim1,
const int &  dim2 
) const
inline

Returns the specified entry in the transform matrix.

Definition at line 177 of file Intrepid2_TransformedVectorData.hpp.

References Intrepid2::Data< DataScalar, DeviceType >::isValid().

◆ vectorData()

template<class Scalar , typename DeviceType >
const VectorData< Scalar, DeviceType > & Intrepid2::TransformedVectorData< Scalar, DeviceType >::vectorData ( ) const
inline

Returns the reference-space vector data.

Definition at line 197 of file Intrepid2_TransformedVectorData.hpp.

Member Data Documentation

◆ transform_

template<class Scalar , typename DeviceType >
Data<Scalar,DeviceType> Intrepid2::TransformedVectorData< Scalar, DeviceType >::transform_

Definition at line 69 of file Intrepid2_TransformedVectorData.hpp.

◆ vectorData_

template<class Scalar , typename DeviceType >
VectorData<Scalar, DeviceType> Intrepid2::TransformedVectorData< Scalar, DeviceType >::vectorData_

Definition at line 71 of file Intrepid2_TransformedVectorData.hpp.


The documentation for this class was generated from the following file: