Intrepid2
Public Types | Public Member Functions | List of all members
Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE > Class Template Reference
Inheritance diagram for Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE >:
Intrepid2::Basis_TensorBasis3< HGRAD_LINE::BasisBase > Intrepid2::Basis_TensorBasis< HGRAD_LINE::BasisBase >

Public Types

using OutputViewType = typename HGRAD_LINE::OutputViewType
 
using PointViewType = typename HGRAD_LINE::PointViewType
 
using ScalarViewType = typename HGRAD_LINE::ScalarViewType
 
using LineGradBasis = HGRAD_LINE
 
using LineVolBasis = HVOL_LINE
 
using TensorBasis3 = Basis_TensorBasis3< typename HGRAD_LINE::BasisBase >
 
- Public Types inherited from Intrepid2::Basis_TensorBasis3< HGRAD_LINE::BasisBase >
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< HGRAD_LINE::BasisBase >
using BasisBase = HGRAD_LINE::BasisBase
 
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< HGRAD_LINE::BasisBase >
 

Public Member Functions

 Basis_Derived_HCURL_Family2_HEX (int polyOrder_x, int polyOrder_y, int polyOrder_z, const EPointType pointType=POINTTYPE_DEFAULT)
 Constructor. More...
 
virtual OperatorTensorDecomposition getSimpleOperatorDecomposition (const EOperator operatorType) const override
 Returns a simple decomposition of the specified operator: what operator(s) should be applied to basis1, basis2, and basis3. A one-element vector corresponds to a single TensorData entry; a multiple-element vector corresponds to a VectorData object with axialComponents = false.
 
virtual void getValues (OutputViewType outputValues, const EOperator operatorType, const PointViewType inputPoints1, const PointViewType inputPoints2, const PointViewType inputPoints3, bool tensorPoints) const override
 multi-component getValues() method (required/called by TensorBasis3) More...
 
virtual void getDofCoeffs (ScalarViewType dofCoeffs) const override
 Fills in coefficients of degrees of freedom for Lagrangian basis on the reference cell. 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...
 
- Public Member Functions inherited from Intrepid2::Basis_TensorBasis3< HGRAD_LINE::BasisBase >
 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 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...
 
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...
 
- Public Member Functions inherited from Intrepid2::Basis_TensorBasis< HGRAD_LINE::BasisBase >
 Basis_TensorBasis (BasisPtr basis1, BasisPtr basis2, EFunctionSpace functionSpace=FUNCTION_SPACE_MAX)
 Constructor. 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...
 

Additional Inherited Members

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

Detailed Description

template<class HGRAD_LINE, class HVOL_LINE>
class Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE >

Definition at line 224 of file Intrepid2_DerivedBasis_HCURL_HEX.hpp.

Constructor & Destructor Documentation

◆ Basis_Derived_HCURL_Family2_HEX()

template<class HGRAD_LINE , class HVOL_LINE >
Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE >::Basis_Derived_HCURL_Family2_HEX ( int  polyOrder_x,
int  polyOrder_y,
int  polyOrder_z,
const EPointType  pointType = POINTTYPE_DEFAULT 
)
inline

Constructor.

Parameters
[in]polyOrder_x- the polynomial order in the x dimension.
[in]polyOrder_y- the polynomial order in the y dimension.
[in]polyOrder_z- the polynomial order in the z dimension.
[in]pointType- type of lattice used for creating the DoF coordinates.

Definition at line 243 of file Intrepid2_DerivedBasis_HCURL_HEX.hpp.

Member Function Documentation

◆ getDofCoeffs()

template<class HGRAD_LINE , class HVOL_LINE >
virtual void Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE >::getDofCoeffs ( ScalarViewType  dofCoeffs) const
inlineoverridevirtual

Fills in coefficients of degrees of freedom for Lagrangian basis on the reference cell.

Parameters
[out]dofCoeffs- the container into which to place the degrees of freedom.

dofCoeffs have shape (F,D), field dimension matches the cardinality of the basis, and D is the basis dimension.

Degrees of freedom coefficients are such that (dofCoords_(j)) dofCoeffs_(j) = , where are the basis and the Kronecker delta. Note that getDofCoeffs() is supported only for Lagrangian bases.

Definition at line 373 of file Intrepid2_DerivedBasis_HCURL_HEX.hpp.

References Intrepid2::Basis_TensorBasis< BasisBaseClass >::getDofCoeffs().

◆ getValues() [1/4]

template<class HGRAD_LINE , class HVOL_LINE >
virtual void Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getValues

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() [2/4]

template<class HGRAD_LINE , class HVOL_LINE >
virtual void Intrepid2::Basis_TensorBasis3< BasisBaseClass >::getValues
inlineoverride

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.

Definition at line 1684 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [3/4]

template<class HGRAD_LINE , class HVOL_LINE >
void Intrepid2::Basis_TensorBasis3< 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
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.

◆ getValues() [4/4]

template<class HGRAD_LINE , class HVOL_LINE >
virtual void Intrepid2::Basis_Derived_HCURL_Family2_HEX< HGRAD_LINE, HVOL_LINE >::getValues ( OutputViewType  outputValues,
const EOperator  operatorType,
const PointViewType  inputPoints1,
const PointViewType  inputPoints2,
const PointViewType  inputPoints3,
bool  tensorPoints 
) const
inlineoverridevirtual

multi-component getValues() method (required/called by TensorBasis3)

Parameters
[out]outputValues- the view into which to place the output values
[in]operatorType- the operator on the basis
[in]inputPoints1- input points in the x dimension
[in]inputPoints2- input points in the y dimension
[in]inputPoints3- input points in the z dimension
[in]tensorPoints- if true, inputPoints1, inputPoints2, and inputPoints3 should be understood as tensorial components of the points in outputValues (i.e., the evaluation points are the tensor product of the three inputPoints containers). If false, each inputPoints container should correspond elementwise to the evaluation points.

Definition at line 299 of file Intrepid2_DerivedBasis_HCURL_HEX.hpp.


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