Serendipity Basis, defined as the sub-basis of a provided basis, consisting of basis elements for which tensorial component polynomial orders satisfy the Serendipity criterion. More...

#include <Intrepid2_SerendipityBasis.hpp>

Inheritance diagram for Intrepid2::SerendipityBasis< BasisBaseClass >:

Public Types
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	OrdinalTypeArray1D = typename BasisBase::OrdinalTypeArray1D

using	OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost

using	OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost

using	OutputViewType = typename BasisBase::OutputViewType

using	PointViewType = typename BasisBase::PointViewType

Public Member Functions
	SerendipityBasis (BasisPtr fullBasis)
	Constructor.

virtual int	getNumTensorialExtrusions () const override

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.

virtual const char *	getName () const override
	Returns basis name.

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.

virtual void	getValues (OutputViewType outputValues, const PointViewType inputPoints, const EOperator operatorType=OPERATOR_VALUE) const override
	Evaluation of a FEM basis on a reference cell.

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.

BasisPtr	getUnderlyingBasis () const
	Returns a pointer to the underlying full basis.

OrdinalTypeArray1D	ordinalMap () const
	Returns the ordinal map from the Serendipity basis ordinal to the ordinal in the underlying full basis.

Protected Attributes
BasisPtr	fullBasis_

std::string	name_

int	numTensorialExtrusions_

OrdinalTypeArray1D	ordinalMap_

Detailed Description

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

Serendipity Basis, defined as the sub-basis of a provided basis, consisting of basis elements for which tensorial component polynomial orders satisfy the Serendipity criterion.

Definition at line 28 of file Intrepid2_SerendipityBasis.hpp.

Member Typedef Documentation

◆ BasisBase

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::BasisBase = BasisBaseClass

Definition at line 33 of file Intrepid2_SerendipityBasis.hpp.

◆ BasisPtr

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::BasisPtr = Teuchos::RCP<BasisBase>

Definition at line 34 of file Intrepid2_SerendipityBasis.hpp.

◆ DeviceType

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::DeviceType = typename BasisBase::DeviceType

Definition at line 43 of file Intrepid2_SerendipityBasis.hpp.

◆ ExecutionSpace

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::ExecutionSpace = typename BasisBase::ExecutionSpace

Definition at line 44 of file Intrepid2_SerendipityBasis.hpp.

◆ OrdinalTypeArray1D

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::OrdinalTypeArray1D = typename BasisBase::OrdinalTypeArray1D

Definition at line 48 of file Intrepid2_SerendipityBasis.hpp.

◆ OrdinalTypeArray1DHost

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::OrdinalTypeArray1DHost = typename BasisBase::OrdinalTypeArray1DHost

Definition at line 49 of file Intrepid2_SerendipityBasis.hpp.

◆ OrdinalTypeArray2DHost

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::OrdinalTypeArray2DHost = typename BasisBase::OrdinalTypeArray2DHost

Definition at line 50 of file Intrepid2_SerendipityBasis.hpp.

◆ OutputValueType

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::OutputValueType = typename BasisBase::OutputValueType

Definition at line 45 of file Intrepid2_SerendipityBasis.hpp.

◆ OutputViewType

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::OutputViewType = typename BasisBase::OutputViewType

Definition at line 51 of file Intrepid2_SerendipityBasis.hpp.

◆ PointValueType

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::PointValueType = typename BasisBase::PointValueType

Definition at line 46 of file Intrepid2_SerendipityBasis.hpp.

◆ PointViewType

template<typename BasisBaseClass = void>

using Intrepid2::SerendipityBasis< BasisBaseClass >::PointViewType = typename BasisBase::PointViewType

Definition at line 52 of file Intrepid2_SerendipityBasis.hpp.

Constructor & Destructor Documentation

◆ SerendipityBasis()

template<typename BasisBaseClass = void>

Intrepid2::SerendipityBasis< BasisBaseClass >::SerendipityBasis ( BasisPtr fullBasis )

inline

Constructor.

Parameters

[in] basis - the full, hierarchical basis

Definition at line 59 of file Intrepid2_SerendipityBasis.hpp.

References Intrepid2::CellTopology::cellTopology().

Member Function Documentation

◆ allocateBasisValues()

template<typename BasisBaseClass = void>

virtual BasisValues< OutputValueType, DeviceType > Intrepid2::SerendipityBasis< BasisBaseClass >::allocateBasisValues	(	TensorPoints< PointValueType, DeviceType >	points,
		const EOperator	operatorType = `OPERATOR_VALUE`
	)		const

inlineoverridevirtual

Allocate BasisValues container suitable for passing to the getValues() variant that takes a TensorPoints container as argument.

The basic exact-sequence operators are supported (VALUE, GRAD, DIV, CURL), as are the Dn operators (OPERATOR_D1 through OPERATOR_D10).

Definition at line 197 of file Intrepid2_SerendipityBasis.hpp.

◆ getHostBasis()

template<typename BasisBaseClass = void>

virtual HostBasisPtr< OutputValueType, PointValueType > Intrepid2::SerendipityBasis< 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.

Definition at line 271 of file Intrepid2_SerendipityBasis.hpp.

◆ getName()

template<typename BasisBaseClass = void>

virtual const char * Intrepid2::SerendipityBasis< BasisBaseClass >::getName ( ) const

inlineoverridevirtual

Returns basis name.

Returns: the name of the basis

Definition at line 215 of file Intrepid2_SerendipityBasis.hpp.

◆ getNumTensorialExtrusions()

template<typename BasisBaseClass = void>

virtual int Intrepid2::SerendipityBasis< BasisBaseClass >::getNumTensorialExtrusions ( ) const

inlineoverridevirtual

Definition at line 188 of file Intrepid2_SerendipityBasis.hpp.

◆ getUnderlyingBasis()

template<typename BasisBaseClass = void>

BasisPtr Intrepid2::SerendipityBasis< BasisBaseClass >::getUnderlyingBasis ( ) const

inline

Returns a pointer to the underlying full basis.

Returns: Pointer to the underlying full basis.

Definition at line 282 of file Intrepid2_SerendipityBasis.hpp.

◆ getValues() [1/2]

template<typename BasisBaseClass = void>

virtual void Intrepid2::SerendipityBasis< BasisBaseClass >::getValues	(	BasisValues< OutputValueType, DeviceType >	outputValues,
		const TensorPoints< PointValueType, DeviceType >	inputPoints,
		const EOperator	operatorType = `OPERATOR_VALUE`
	)		const

inlineoverridevirtual

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 SerendipityBasis. It allows a reduced memory footprint and optimized integration, etc.

Definition at line 232 of file Intrepid2_SerendipityBasis.hpp.

◆ getValues() [2/2]

template<typename BasisBaseClass = void>

virtual void Intrepid2::SerendipityBasis< BasisBaseClass >::getValues	(	OutputViewType	outputValues,
		const PointViewType	inputPoints,
		const EOperator	operatorType = `OPERATOR_VALUE`
	)		const

inlineoverridevirtual

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 259 of file Intrepid2_SerendipityBasis.hpp.

◆ ordinalMap()

template<typename BasisBaseClass = void>

OrdinalTypeArray1D Intrepid2::SerendipityBasis< BasisBaseClass >::ordinalMap ( ) const

inline

Returns the ordinal map from the Serendipity basis ordinal to the ordinal in the underlying full basis.

Returns: Ordinal map from the Serendipity basis ordinal to the ordinal in the underlying full basis. (Indices to the container are Serendipity basis ordinals; values are full basis ordinals.)

Definition at line 291 of file Intrepid2_SerendipityBasis.hpp.

Member Data Documentation

◆ fullBasis_

template<typename BasisBaseClass = void>

BasisPtr Intrepid2::SerendipityBasis< BasisBaseClass >::fullBasis_

protected

Definition at line 37 of file Intrepid2_SerendipityBasis.hpp.

◆ name_

template<typename BasisBaseClass = void>

std::string Intrepid2::SerendipityBasis< BasisBaseClass >::name_

protected

Definition at line 39 of file Intrepid2_SerendipityBasis.hpp.

◆ numTensorialExtrusions_

template<typename BasisBaseClass = void>

int Intrepid2::SerendipityBasis< BasisBaseClass >::numTensorialExtrusions_

protected

Definition at line 41 of file Intrepid2_SerendipityBasis.hpp.

◆ ordinalMap_

template<typename BasisBaseClass = void>

OrdinalTypeArray1D Intrepid2::SerendipityBasis< BasisBaseClass >::ordinalMap_

protected

Definition at line 54 of file Intrepid2_SerendipityBasis.hpp.

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

/home/runner/work/trilinos.github.io/trilinos.github.io/Trilinos/packages/intrepid2/src/Discretization/Basis/Intrepid2_SerendipityBasis.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BasisBase

◆ BasisPtr

◆ DeviceType

◆ ExecutionSpace

◆ OrdinalTypeArray1D

◆ OrdinalTypeArray1DHost

◆ OrdinalTypeArray2DHost

◆ OutputValueType

◆ OutputViewType

◆ PointValueType

◆ PointViewType

Constructor & Destructor Documentation

◆ SerendipityBasis()

Member Function Documentation

◆ allocateBasisValues()

◆ getHostBasis()

◆ getName()

◆ getNumTensorialExtrusions()

◆ getUnderlyingBasis()

◆ getValues() [1/2]

◆ getValues() [2/2]

◆ ordinalMap()

Member Data Documentation

◆ fullBasis_

◆ name_

◆ numTensorialExtrusions_

◆ ordinalMap_