Intrepid2
Public Types | Public Member Functions | Private Types | List of all members
Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE > Class Template Reference

Implementation of H(vol) basis on the quadrilateral that is templated on H(vol) on the line. More...

#include <Intrepid2_DerivedBasis_HVOL_QUAD.hpp>

Inheritance diagram for Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE >:
Intrepid2::Basis_TensorBasis< HVOL_LINE, HVOL_LINE > Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >

Public Types

using ExecutionSpace = typename HVOL_LINE::ExecutionSpace
 
using OutputValueType = typename HVOL_LINE::OutputValueType
 
using PointValueType = typename HVOL_LINE::PointValueType
 
using OutputViewType = typename HVOL_LINE::OutputViewType
 
using PointViewType = typename HVOL_LINE::PointViewType
 
using ScalarViewType = typename HVOL_LINE::ScalarViewType
 
- Public Types inherited from Intrepid2::Basis_TensorBasis< HVOL_LINE, HVOL_LINE >
using BasisSuper = ::Intrepid2::Basis< typename HVOL_LINE ::ExecutionSpace, typename HVOL_LINE ::OutputValueType, typename HVOL_LINE ::PointValueType >
 
using ExecutionSpace = typename BasisSuper::ExecutionSpace
 
using OutputValueType = typename BasisSuper::OutputValueType
 
using PointValueType = typename BasisSuper::PointValueType
 
using OrdinalTypeArray1DHost = typename BasisSuper::OrdinalTypeArray1DHost
 
using OrdinalTypeArray2DHost = typename BasisSuper::OrdinalTypeArray2DHost
 
using OutputViewType = typename BasisSuper::OutputViewType
 
using PointViewType = typename BasisSuper::PointViewType
 
- Public Types inherited from Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >
using ExecutionSpace = HVOL_LINE ::ExecutionSpace
 (Kokkos) Execution space for basis.
 
using OutputValueType = HVOL_LINE ::OutputValueType
 Output value type for basis; default is double.
 
using PointValueType = HVOL_LINE ::PointValueType
 Point value type for basis; default is double.
 
using OrdinalViewType = Kokkos::View< ordinal_type, HVOL_LINE ::ExecutionSpace >
 View type for ordinal.
 
using EBasisViewType = Kokkos::View< EBasis, HVOL_LINE ::ExecutionSpace >
 View for basis type.
 
using ECoordinatesViewType = Kokkos::View< ECoordinates, HVOL_LINE ::ExecutionSpace >
 View for coordinate system type.
 
using OrdinalTypeArray1DHost = Kokkos::View< ordinal_type *, typename HVOL_LINE ::ExecutionSpace ::array_layout, Kokkos::HostSpace >
 View type for 1d host array.
 
using OrdinalTypeArray2DHost = Kokkos::View< ordinal_type **, typename HVOL_LINE ::ExecutionSpace ::array_layout, Kokkos::HostSpace >
 View type for 2d host array.
 
using OrdinalTypeArray3DHost = Kokkos::View< ordinal_type ***, typename HVOL_LINE ::ExecutionSpace ::array_layout, Kokkos::HostSpace >
 View type for 3d host array.
 
using OrdinalTypeArrayStride1DHost = Kokkos::View< ordinal_type *, Kokkos::LayoutStride, Kokkos::HostSpace >
 View type for 1d host array.
 
using OrdinalTypeArray1D = Kokkos::View< ordinal_type *, HVOL_LINE ::ExecutionSpace >
 View type for 1d device array.
 
using OrdinalTypeArray2D = Kokkos::View< ordinal_type **, HVOL_LINE ::ExecutionSpace >
 View type for 2d device array.
 
using OrdinalTypeArray3D = Kokkos::View< ordinal_type ***, HVOL_LINE ::ExecutionSpace >
 View type for 3d device array.
 
using OrdinalTypeArrayStride1D = Kokkos::View< ordinal_type *, Kokkos::LayoutStride, HVOL_LINE ::ExecutionSpace >
 View type for 1d device array.
 
typedef ScalarTraits< HVOL_LINE ::PointValueType >::scalar_type scalarType
 Scalar type for point values.
 
using OutputViewType = Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, HVOL_LINE ::ExecutionSpace >
 View type for basis value output.
 
using PointViewType = Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, HVOL_LINE ::ExecutionSpace >
 View type for input points.
 
using ScalarViewType = Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, HVOL_LINE ::ExecutionSpace >
 View type for scalars.
 

Public Member Functions

 Basis_Derived_HVOL_QUAD (int polyOrder_x, int polyOrder_y)
 Constructor. More...
 
 Basis_Derived_HVOL_QUAD (int polyOrder)
 Constructor. More...
 
virtual const char * getName () const
 Returns basis name. More...
 
virtual bool requireOrientation () const
 True if orientation is required.
 
virtual void getValues (OutputViewType outputValues, const EOperator operatorType, const PointViewType inputPoints1, const PointViewType inputPoints2, bool tensorPoints) const override
 multi-component getValues() method (required/called by TensorBasis) 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< HVOL_LINE, HVOL_LINE >
 Basis_TensorBasis (HVOL_LINE basis1, HVOL_LINE basis2)
 Constructor. 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 BasisSuper::ScalarViewType dofCoords) const override
 Fills in spatial locations (coordinates) of degrees of freedom (nodes) on the reference cell. 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...
 
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 void getValues (OutputViewType, const PointViewType, const EOperator=OPERATOR_VALUE) const
 Evaluation of a FEM basis on a reference cell. More...
 
virtual void getValues (OutputViewType, const PointViewType, const PointViewType, const EOperator=OPERATOR_VALUE) const
 Evaluation of an FVD basis evaluation on a physical cell. More...
 
- Public Member Functions inherited from Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >
OutputValueType getDummyOutputValue ()
 Dummy array to receive input arguments.
 
PointValueType getDummyPointValue ()
 Dummy array to receive input arguments.
 
virtual void getValues (OutputViewType, const PointViewType, const PointViewType, const EOperator=OPERATOR_VALUE) const
 Evaluation of an FVD basis evaluation on a physical cell. More...
 
virtual void getDofCoords (ScalarViewType) const
 Returns spatial locations (coordinates) of degrees of freedom on the reference cell.
 
virtual void getDofCoeffs (ScalarViewType) const
 Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space spanned by the basis, := P(dofCoords(i)) dofCoeffs(i) are the nodal coefficients associated to basis function i. More...
 
OrdinalTypeArray1DHost getFieldOrdinalsForDegree (OrdinalTypeArray1DHost &degrees) const
 For hierarchical bases, returns the field ordinals that have at most the specified degree in each dimension. Assuming that these are less than or equal to the polynomial orders provided at Basis construction, the corresponding polynomials will form a superset of the Basis of the same type constructed with polynomial orders corresponding to the specified degrees. More...
 
std::vector< int > getFieldOrdinalsForDegree (std::vector< int > &degrees) const
 For hierarchical bases, returns the field ordinals that have at most the specified degree in each dimension. Assuming that these are less than or equal to the polynomial orders provided at Basis construction, the corresponding polynomials will form a superset of the Basis of the same type constructed with polynomial orders corresponding to the specified degrees. More...
 
OrdinalTypeArray1DHost getPolynomialDegreeOfField (int fieldOrdinal) const
 For hierarchical bases, returns the polynomial degree (which may have multiple values in higher spatial dimensions) for the specified basis ordinal as a host array. More...
 
std::vector< int > getPolynomialDegreeOfFieldAsVector (int fieldOrdinal) const
 For hierarchical bases, returns the polynomial degree (which may have multiple values in higher spatial dimensions) for the specified basis ordinal as a host array. More...
 
int getPolynomialDegreeLength () const
 For hierarchical bases, returns the number of entries required to specify the polynomial degree of a basis function.
 
ordinal_type getCardinality () const
 Returns cardinality of the basis. More...
 
ordinal_type getDegree () const
 Returns the degree of the basis. More...
 
EFunctionSpace getFunctionSpace () const
 Returns the function space for the basis. More...
 
shards::CellTopology getBaseCellTopology () const
 Returns the base cell topology for which the basis is defined. See Shards documentation https://trilinos.org/packages/shards for definition of base cell topology. More...
 
EBasis getBasisType () const
 Returns the basis type. More...
 
ECoordinates getCoordinateSystem () const
 Returns the type of coordinate system for which the basis is defined. More...
 
ordinal_type getDofCount (const ordinal_type subcDim, const ordinal_type subcOrd) const
 DoF count for specified subcell. More...
 
ordinal_type getDofOrdinal (const ordinal_type subcDim, const ordinal_type subcOrd, const ordinal_type subcDofOrd) const
 DoF tag to ordinal lookup. More...
 
const OrdinalTypeArray3DHost getAllDofOrdinal () const
 DoF tag to ordinal data structure.
 
const OrdinalTypeArrayStride1DHost getDofTag (const ordinal_type dofOrd) const
 DoF ordinal to DoF tag lookup. More...
 
const OrdinalTypeArray2DHost getAllDofTags () const
 Retrieves all DoF tags. More...
 

Private Types

using LineBasis = HVOL_LINE
 
using TensorBasis = Basis_TensorBasis< LineBasis, LineBasis >
 

Additional Inherited Members

- Protected Member Functions inherited from Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >
void setOrdinalTagData (OrdinalTypeView3D &tagToOrdinal, OrdinalTypeView2D &ordinalToTag, const OrdinalTypeView1D tags, const ordinal_type basisCard, const ordinal_type tagSize, const ordinal_type posScDim, const ordinal_type posScOrd, const ordinal_type posDfOrd)
 Fills ordinalToTag_ and tagToOrdinal_ by basis-specific tag data. More...
 
- Protected Attributes inherited from Intrepid2::Basis_TensorBasis< HVOL_LINE, HVOL_LINE >
HVOL_LINE basis1_
 
HVOL_LINE basis2_
 
std::string name_
 
- Protected Attributes inherited from Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >
ordinal_type basisCardinality_
 Cardinality of the basis, i.e., the number of basis functions/degrees-of-freedom.
 
ordinal_type basisDegree_
 Degree of the largest complete polynomial space that can be represented by the basis.
 
shards::CellTopology basisCellTopology_
 Base topology of the cells for which the basis is defined. See the Shards package for definition of base cell topology.
 
EBasis basisType_
 Type of the basis.
 
ECoordinates basisCoordinates_
 The coordinate system for which the basis is defined.
 
EFunctionSpace functionSpace_
 The function space in which the basis is defined.
 
OrdinalTypeArray2DHost ordinalToTag_
 "true" if tagToOrdinal_ and ordinalToTag_ have been initialized More...
 
OrdinalTypeArray3DHost tagToOrdinal_
 DoF tag to ordinal lookup table. More...
 
Kokkos::DynRankView< scalarType, HVOL_LINE ::ExecutionSpacedofCoords_
 Coordinates of degrees-of-freedom for basis functions defined in physical space.
 
Kokkos::DynRankView< scalarType, HVOL_LINE ::ExecutionSpacedofCoeffs_
 Coefficients for computing degrees of freedom for Lagrangian basis If P is an element of the space spanned by the basis, := P(dofCoords_(i)) dofCoeffs_(i) are the nodal coefficients associated to basis functions i. More...
 
OrdinalTypeArray2DHost fieldOrdinalPolynomialDegree_
 Polynomial degree for each degree of freedom. Only defined for hierarchical bases right now. The number of entries per degree of freedom in this table depends on the basis type. For hypercubes, this will be the spatial dimension. We have not yet determined what this will be for simplices beyond 1D; there are not yet hierarchical simplicial bases beyond 1D in Intrepid2. More...
 

Detailed Description

template<class HVOL_LINE>
class Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE >

Implementation of H(vol) basis on the quadrilateral that is templated on H(vol) on the line.

Definition at line 65 of file Intrepid2_DerivedBasis_HVOL_QUAD.hpp.

Constructor & Destructor Documentation

◆ Basis_Derived_HVOL_QUAD() [1/2]

template<class HVOL_LINE >
Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE >::Basis_Derived_HVOL_QUAD ( int  polyOrder_x,
int  polyOrder_y 
)
inline

Constructor.

Parameters
[in]polyOrder_x- the polynomial order in the x dimension.
[in]polyOrder_y- the polynomial order in the y dimension.

Definition at line 86 of file Intrepid2_DerivedBasis_HVOL_QUAD.hpp.

References Intrepid2::Basis< HVOL_LINE ::ExecutionSpace, HVOL_LINE ::OutputValueType, HVOL_LINE ::PointValueType >::functionSpace_.

◆ Basis_Derived_HVOL_QUAD() [2/2]

template<class HVOL_LINE >
Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE >::Basis_Derived_HVOL_QUAD ( int  polyOrder)
inline

Constructor.

Parameters
[in]polyOrder- the polynomial order to use in both dimensions.

Definition at line 97 of file Intrepid2_DerivedBasis_HVOL_QUAD.hpp.

Member Function Documentation

◆ getName()

template<class HVOL_LINE >
virtual const char* Intrepid2::Basis_Derived_HVOL_QUAD< HVOL_LINE >::getName ( ) const
inlinevirtual

Returns basis name.

Returns
the name of the basis

Reimplemented from Intrepid2::Basis_TensorBasis< HVOL_LINE, HVOL_LINE >.

Definition at line 105 of file Intrepid2_DerivedBasis_HVOL_QUAD.hpp.

◆ getValues() [1/4]

template<class HVOL_LINE >
void Intrepid2::Basis_TensorBasis< Basis1, Basis2 >::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 637 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [2/4]

template<class HVOL_LINE >
virtual void Intrepid2::Basis_TensorBasis< Basis1, Basis2 >::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 766 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [3/4]

template<class HVOL_LINE >
void Intrepid2::Basis_TensorBasis< Basis1, Basis2 >::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 796 of file Intrepid2_TensorBasis.hpp.

◆ getValues() [4/4]

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

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

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]tensorPoints- if true, inputPoints1 and inputPoints2 should be understood as tensorial components of the points in outputValues (i.e., the evaluation points are the tensor product of inputPoints1 and inputPoints2). If false, inputPoints1 and inputPoints2 should correspond elementwise to the evaluation points.

Definition at line 124 of file Intrepid2_DerivedBasis_HVOL_QUAD.hpp.


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