Intrepid2
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
Intrepid2::Basis_TensorBasis3< BasisBaseClass > Class Template Referenceabstract
Inheritance diagram for Intrepid2::Basis_TensorBasis3< BasisBaseClass >:
Intrepid2::Basis_TensorBasis< BasisBaseClass >

Public Types

using OutputViewType = typename BasisBase::OutputViewType
 
using PointViewType = typename BasisBase::PointViewType
 
using ScalarViewType = typename BasisBase::ScalarViewType
 
using OutputValueType = typename BasisBase::OutputValueType
 
using PointValueType = typename BasisBase::PointValueType
 
using BasisPtr = Teuchos::RCP< BasisBase >
 
- Public Types inherited from Intrepid2::Basis_TensorBasis< BasisBaseClass >
using BasisBase = BasisBaseClass
 
using BasisPtr = Teuchos::RCP< BasisBase >
 
using DeviceType = typename BasisBase::DeviceType
 
using ExecutionSpace = typename BasisBase::ExecutionSpace
 
using OutputValueType = typename BasisBase::OutputValueType
 
using PointValueType = typename BasisBase::PointValueType
 
using OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost
 
using OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost
 
using OutputViewType = typename BasisBase::OutputViewType
 
using PointViewType = typename BasisBase::PointViewType
 
using TensorBasis = Basis_TensorBasis< BasisBaseClass >
 

Public Member Functions

 Basis_TensorBasis3 (BasisPtr basis1, BasisPtr basis2, BasisPtr basis3)
 
virtual OperatorTensorDecomposition getOperatorDecomposition (const EOperator operatorType) const override
 Returns a full decomposition of the specified operator. (Full meaning that all TensorBasis components are expanded into their non-TensorBasis components.) More...
 
virtual void getValues (OutputViewType outputValues, const EOperator operatorType, const PointViewType inputPoints12, const PointViewType inputPoints3, bool tensorPoints) const override
 Evaluation of a tensor FEM basis on a reference cell. More...
 
virtual void getValues (OutputViewType outputValues, const EOperator operatorType, const PointViewType inputPoints1, const PointViewType inputPoints2, const PointViewType inputPoints3, bool tensorPoints) const =0
 Evaluation of a tensor FEM basis on a reference cell; subclasses should override this. More...
 
void getValues (OutputViewType outputValues, const PointViewType inputPoints1, const EOperator operatorType1, const PointViewType inputPoints2, const EOperator operatorType2, const PointViewType inputPoints3, const EOperator operatorType3, bool tensorPoints, double weight=1.0) const
 Evaluation of a tensor FEM basis on a reference cell; subclasses should override this. More...
 
virtual HostBasisPtr< OutputValueType, PointValueType > getHostBasis () const override
 Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this. More...
 
virtual void getValues (BasisValues< OutputValueType, DeviceType > outputValues, const TensorPoints< PointValueType, DeviceType > inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
 Evaluation of a FEM basis on a reference cell, using point and output value containers that allow preservation of tensor-product structure. More...
 
void getValues (OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
 Evaluation of a FEM basis on a reference cell. More...
 
virtual void getValues (OutputViewType outputValues, const EOperator operatorType, const PointViewType inputPoints1, const PointViewType inputPoints2, bool tensorPoints) const
 Evaluation of a tensor FEM basis on a reference cell; subclasses should override this. More...
 
void getValues (OutputViewType outputValues, const PointViewType inputPoints1, const EOperator operatorType1, const PointViewType inputPoints2, const EOperator operatorType2, bool tensorPoints, double weight=1.0) const
 Evaluation of a tensor FEM basis on a reference cell. More...
 
- Public Member Functions inherited from Intrepid2::Basis_TensorBasis< BasisBaseClass >
 Basis_TensorBasis (BasisPtr basis1, BasisPtr basis2, EFunctionSpace functionSpace=FUNCTION_SPACE_MAX)
 Constructor. More...
 
virtual OperatorTensorDecomposition getSimpleOperatorDecomposition (const EOperator operatorType) const
 Returns a simple decomposition of the specified operator: what operator(s) should be applied to basis1, and what operator(s) to basis2. A one-element OperatorTensorDecomposition corresponds to a single TensorData entry; a multiple-element OperatorTensorDecomposition corresponds to a VectorData object with axialComponents = false. More...
 
virtual BasisValues< OutputValueType, DeviceType > allocateBasisValues (TensorPoints< PointValueType, DeviceType > points, const EOperator operatorType=OPERATOR_VALUE) const override
 Allocate BasisValues container suitable for passing to the getValues() variant that takes a TensorPoints container as argument. More...
 
void getComponentPoints (const PointViewType inputPoints, const bool attemptTensorDecomposition, PointViewType &inputPoints1, PointViewType &inputPoints2, bool &tensorDecompositionSucceeded) const
 Method to extract component points from composite points. More...
 
virtual void getDofCoords (typename BasisBase::ScalarViewType dofCoords) const override
 Fills in spatial locations (coordinates) of degrees of freedom (nodes) on the reference cell. More...
 
virtual void getDofCoeffs (typename BasisBase::ScalarViewType dofCoeffs) const override
 Fills in coefficients of degrees of freedom on the reference cell. More...
 
virtual const char * getName () const override
 Returns basis name. More...
 
ordinal_type getTensorDkEnumeration (ordinal_type dkEnum1, ordinal_type operatorOrder1, ordinal_type dkEnum2, ordinal_type operatorOrder2) const
 Given "Dk" enumeration indices for the component bases, returns a Dk enumeration index for the composite basis. More...
 
std::vector< BasisPtr > getTensorBasisComponents () const
 
virtual void getValues (BasisValues< OutputValueType, DeviceType > outputValues, const TensorPoints< PointValueType, DeviceType > inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
 Evaluation of a FEM basis on a reference cell, using point and output value containers that allow preservation of tensor-product structure. More...
 
void getValues (OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
 Evaluation of a FEM basis on a reference cell. More...
 
void getValues (OutputViewType outputValues, const PointViewType inputPoints1, const EOperator operatorType1, const PointViewType inputPoints2, const EOperator operatorType2, bool tensorPoints, double weight=1.0) const
 Evaluation of a tensor FEM basis on a reference cell. More...
 

Protected Attributes

BasisPtr basis1_
 
BasisPtr basis2_
 
BasisPtr basis3_
 
- Protected Attributes inherited from Intrepid2::Basis_TensorBasis< BasisBaseClass >
BasisPtr basis1_
 
BasisPtr basis2_
 
std::vector< BasisPtr > tensorComponents_
 
std::string name_
 

Private Types

using BasisBase = BasisBaseClass
 
using TensorBasis = Basis_TensorBasis< BasisBase >
 

Detailed Description

template<typename BasisBaseClass = void>
class Intrepid2::Basis_TensorBasis3< BasisBaseClass >

Definition at line 1618 of file Intrepid2_TensorBasis.hpp.

Member Function Documentation

◆ getHostBasis()

template<typename BasisBaseClass = void>
virtual HostBasisPtr<OutputValueType, PointValueType> Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getHostBasis ( ) const
inlineoverridevirtual

Creates and returns a Basis object whose DeviceType template argument is Kokkos::HostSpace::device_type, but is otherwise identical to this.

Returns
Pointer to the new Basis object.

Reimplemented from Intrepid2::Basis_TensorBasis< BasisBaseClass >.

Definition at line 1875 of file Intrepid2_TensorBasis.hpp.

◆ getOperatorDecomposition()

template<typename BasisBaseClass = void>
virtual OperatorTensorDecomposition Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getOperatorDecomposition ( const EOperator  operatorType) const
inlineoverridevirtual

Returns a full decomposition of the specified operator. (Full meaning that all TensorBasis components are expanded into their non-TensorBasis components.)

The outer container has a length that corresponds to the number of vector components in output; the inner container has one entry per basis component.

A one-element outer container corresponds to a single TensorData entry; a multiple-element outer container corresponds to a VectorData object with axialComponents = false.

Reimplemented from Intrepid2::Basis_TensorBasis< BasisBaseClass >.

Definition at line 1651 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [1/7]

template<typename BasisBaseClass = void>
void Intrepid2::Basis_TensorBasis< BasisBaseClass >::getValues
inline

Evaluation of a tensor FEM basis on a reference cell.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
inputPoints1[in] - rank-2 array (P1,D1) with the evaluation points for basis1
operatorType1[in] - the operator acting on basis1
inputPoints2[in] - rank-2 array (P2,D2) with the evaluation points for basis2
operatorType2[in] - the operator acting on basis2
tensorPoints[in] - whether the points should be interpreted as tensor components of the evaluation points, or in a one-to-one correspondence
weight[in] - optional weight (typically 1.0 or -1.0)

If tensorPoints is true, then the points dimension of outputValues should be (P1*P2). If tensorPoints is false, then P1 should equal P2, and these should match the points dimension of outputValues.

There are three variants of getValues:

  1. The three-argument version defined by Intrepid2::Basis. TensorBasis provides an implementation of this, which calls the five-argument version (this one).
  2. The five-argument version (above), which provides separate point sets for the component bases, and must be specified by subclasses. Typical implementations call the seven-argument version.
  3. The seven-argument version (this method), implemented by TensorBasis, which provides separate point sets and operators for the component bases, as well as an optional weight.

Subclasses should override the five-argument version above; in their implementation, they need to do little else than call this seven-argument version.

Definition at line 1282 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [2/7]

template<typename BasisBaseClass = void>
void Intrepid2::Basis_TensorBasis< BasisBaseClass >::getValues
inlineoverride

Evaluation of a FEM basis on a reference cell.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
inputPoints[in] - rank-2 array (P,D) with the evaluation points
operatorType[in] - the operator acting on the basis functions
Remarks
For rank and dimension specifications of the output array see Section MD array template arguments for basis methods. Dimensions of ArrayScalar arguments are checked at runtime if HAVE_INTREPID2_DEBUG is defined.
A FEM basis spans a COMPLETE or INCOMPLETE polynomial space on the reference cell which is a smooth function space. Thus, all operator types that are meaningful for the approximated function space are admissible. When the order of the operator exceeds the degree of the basis, the output array is filled with the appropriate number of zeros.

Definition at line 1123 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [3/7]

template<typename BasisBaseClass = void>
virtual void Intrepid2::Basis_TensorBasis< BasisBaseClass >::getValues
inline

Evaluation of a tensor FEM basis on a reference cell; subclasses should override this.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
operatorType[in] - the operator acting on the basis functions
inputPoints1[in] - rank-2 array (P1,D1) with the evaluation points for basis1
inputPoints2[in] - rank-2 array (P2,D2) with the evaluation points for basis2
tensorPoints[in] - whether the points should be interpreted as tensor components of the evaluation points, or in a one-to-one correspondence

Subclasses should override this method; this gives them an opportunity to specify how operatorType should be decomposed into operators on the component bases.

If tensorPoints is true, then the points dimension of outputValues should be (P1*P2). If tensorPoints is false, then P1 should equal P2, and these should match the points dimension of outputValues.

There are three variants of getValues:

  1. The three-argument version defined by Intrepid2::Basis. TensorBasis provides an implementation of this, which calls the five-argument version (this one).
  2. The five-argument version (this method), which provides separate point sets for the component bases, and must be specified by subclasses. Typical implementations call the seven-argument version.
  3. The seven-argument version (below), implemented by TensorBasis, which provides separate point sets and operators for the component bases, as well as an optional weight.

The intent is that subclasses implement this five-argument version; in that implementation, they need to do little else than call the seven-argument version below.

Note that the three-argument implementation handles the OPERATOR_Dn operators directly; that is, subclasses can omit any consideration of OPERATOR_Dn operators in their implementation of the five-argument version.

Definition at line 1252 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [4/7]

template<typename BasisBaseClass = void>
virtual void Intrepid2::Basis_TensorBasis< BasisBaseClass >::getValues
inlineoverride

Evaluation of a FEM basis on a reference cell, using point and output value containers that allow preservation of tensor-product structure.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values. Should be allocated using Basis::allocateBasisValues().
inputPoints[in] - rank-2 array (P,D) with the evaluation points. This should be allocated using Cubature::allocateCubaturePoints() and filled using Cubature::getCubature().
operatorType[in] - the operator acting on the basis function

This is the preferred getValues() method for TensorBasis and DirectSumBasis and their subclasses. It allows a reduced memory footprint and optimized integration, etc.

Definition at line 1044 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [5/7]

template<typename BasisBaseClass = void>
virtual void Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getValues ( OutputViewType  outputValues,
const EOperator  operatorType,
const PointViewType  inputPoints12,
const PointViewType  inputPoints3,
bool  tensorPoints 
) const
inlineoverridevirtual

Evaluation of a tensor FEM basis on a reference cell.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
operatorType[in] - the operator acting on the basis functions
inputPoints12[in] - rank-2 array (P12,D12) with the evaluation points for basis12
inputPoints3[in] - rank-2 array (P3,D3) with the evaluation points for basis3
tensorPoints[in] - whether the points should be interpreted as tensor components of the evaluation points, or in a one-to-one correspondence

If tensorPoints is true, then the points dimension of outputValues should be (P12*P3). If tensorPoints is false, then P12 should equal P3, and these should match the points dimension of outputValues.

There are four variants of getValues:

  1. The three-argument version defined by Intrepid2::Basis. TensorBasis provides an implementation of this, which calls the five-argument version (this one).
  2. The five-argument version (this method), which provides partially separated point sets for the component bases. TensorBasis3 provides an implementation of this, which calls the six-argument version.
  3. The six-argument version, which fully separates the point sets for the component bases. Subclasses should implement this; they essentially specify the decomposition of the operator.
  4. The nine-argument version (below), implemented by TensorBasis3, which provides separate point sets and operators for the component bases, as well as an optional weight.

The intent is that subclasses implement the six-argument version; in that implementation, they need to do little else than call the nine-argument version below.

Note that the three-argument implementation handles the OPERATOR_Dn operators directly; that is, subclasses can omit any consideration of OPERATOR_Dn operators in their implementation of the six-argument version.

Reimplemented from Intrepid2::Basis_TensorBasis< BasisBaseClass >.

Definition at line 1684 of file Intrepid2_TensorBasis.hpp.

Referenced by Intrepid2::Basis_TensorBasis3< HGRAD_LINE::BasisBase >::getValues().

◆ getValues() [6/7]

template<typename BasisBaseClass = void>
virtual void Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getValues ( OutputViewType  outputValues,
const EOperator  operatorType,
const PointViewType  inputPoints1,
const PointViewType  inputPoints2,
const PointViewType  inputPoints3,
bool  tensorPoints 
) const
pure virtual

Evaluation of a tensor FEM basis on a reference cell; subclasses should override this.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
operatorType[in] - the operator acting on the basis functions
inputPoints1[in] - rank-2 array (P1,D1) with the evaluation points for basis1
inputPoints1[in] - rank-2 array (P2,D2) with the evaluation points for basis2
inputPoints3[in] - rank-2 array (P3,D3) with the evaluation points for basis3
tensorPoints[in] - whether the points should be interpreted as tensor components of the evaluation points, or in a one-to-one correspondence

Subclasses should override this method; this gives them an opportunity to specify how operatorType should be decomposed into operators on the component bases.

If tensorPoints is true, then the points dimension of outputValues should be (P1*P2*P3). If tensorPoints is false, then P1 should equal P2 and P2 should equal P3, and these should match the points dimension of outputValues.

There are four variants of getValues:

  1. The three-argument version defined by Intrepid2::Basis. TensorBasis provides an implementation of this, which calls the five-argument version (this one).
  2. The five-argument version (above), which provides partially separated point sets for the component bases. TensorBasis3 provides an implementation of this, which calls the six-argument version.
  3. The six-argument version (this method), which fully separates the point sets for the component bases. Subclasses should implement this; they essentially specify the decomposition of the operator.
  4. The nine-argument version (below), implemented by TensorBasis3, which provides separate point sets and operators for the component bases, as well as an optional weight.

The intent is that subclasses implement this six-argument version; in that implementation, they need to do little else than call the nine-argument version below.

Note that the three-argument implementation handles the OPERATOR_Dn operators directly; that is, subclasses can omit any consideration of OPERATOR_Dn operators in their implementation of the five-argument version.

◆ getValues() [7/7]

template<typename BasisBaseClass = void>
void Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getValues ( OutputViewType  outputValues,
const PointViewType  inputPoints1,
const EOperator  operatorType1,
const PointViewType  inputPoints2,
const EOperator  operatorType2,
const PointViewType  inputPoints3,
const EOperator  operatorType3,
bool  tensorPoints,
double  weight = 1.0 
) const
inline

Evaluation of a tensor FEM basis on a reference cell; subclasses should override this.

Returns values of operatorType acting on FEM basis functions for a set of points in the reference cell for which the basis is defined.

Parameters
outputValues[out] - variable rank array with the basis values
inputPoints1[in] - rank-2 array (P1,D1) with the evaluation points for basis1
operatorType1[in] - the operator acting on basis1
inputPoints2[in] - rank-2 array (P2,D2) with the evaluation points for basis2
operatorType2[in] - the operator acting on basis2
inputPoints3[in] - rank-2 array (P3,D3) with the evaluation points for basis3
operatorType3[in] - the operator acting on basis3
tensorPoints[in] - whether the points should be interpreted as tensor components of the evaluation points, or in a one-to-one correspondence

If tensorPoints is true, then the points dimension of outputValues should be (P1*P2*P3). If tensorPoints is false, then P1 should equal P2 and P2 should equal P3, and these should match the points dimension of outputValues.

There are four variants of getValues:

  1. The three-argument version defined by Intrepid2::Basis. TensorBasis provides an implementation of this, which calls the five-argument version (this one).
  2. The five-argument version (above), which provides partially separated point sets for the component bases. TensorBasis3 provides an implementation of this, which calls the six-argument version.
  3. The six-argument version (this method), which fully separates the point sets for the component bases. Subclasses should implement this; they essentially specify the decomposition of the operator.
  4. The nine-argument version (below), implemented by TensorBasis3, which provides separate point sets and operators for the component bases, as well as an optional weight.

The intent is that subclasses implement this six-argument version; in that implementation, they need to do little else than call the nine-argument version below.

Note that the three-argument implementation handles the OPERATOR_Dn operators directly; that is, subclasses can omit any consideration of OPERATOR_Dn operators in their implementation of the five-argument version.

Definition at line 1771 of file Intrepid2_TensorBasis.hpp.


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