A basis that is the direct sum of two other bases. More...

#include <Intrepid2_DirectSumBasis.hpp>

Inheritance diagram for Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >:

Public Types
using	OrdinalTypeArray1DHost = typename Basis1::OrdinalTypeArray1DHost

using	OrdinalTypeArray2DHost = typename Basis1::OrdinalTypeArray2DHost

using	ExecutionSpace = typename Basis1::ExecutionSpace

using	OutputValueType = typename Basis1::OutputValueType

using	PointValueType = typename Basis1::PointValueType

using	OutputViewType = typename Basis1::OutputViewType

using	PointViewType = typename Basis1::PointViewType

using	ScalarViewType = typename Basis1::ScalarViewType

Public Types inherited from Intrepid2::Basis< Basis1::ExecutionSpace, Basis1::OutputValueType, Basis1::PointValueType >
using	ExecutionSpace = Basis1::ExecutionSpace
	(Kokkos) Execution space for basis.

using	OutputValueType = Basis1::OutputValueType
	Output value type for basis; default is double.

using	PointValueType = Basis1::PointValueType
	Point value type for basis; default is double.

using	OrdinalViewType = Kokkos::View< ordinal_type, Basis1::ExecutionSpace >
	View type for ordinal.

using	EBasisViewType = Kokkos::View< EBasis, Basis1::ExecutionSpace >
	View for basis type.

using	ECoordinatesViewType = Kokkos::View< ECoordinates, Basis1::ExecutionSpace >
	View for coordinate system type.

using	OrdinalTypeArray1DHost = Kokkos::View< ordinal_type *, typename Basis1::ExecutionSpace::array_layout, Kokkos::HostSpace >
	View type for 1d host array.

using	OrdinalTypeArray2DHost = Kokkos::View< ordinal_type **, typename Basis1::ExecutionSpace::array_layout, Kokkos::HostSpace >
	View type for 2d host array.

using	OrdinalTypeArray3DHost = Kokkos::View< ordinal_type ***, typename Basis1::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 *, Basis1::ExecutionSpace >
	View type for 1d device array.

using	OrdinalTypeArray2D = Kokkos::View< ordinal_type **, Basis1::ExecutionSpace >
	View type for 2d device array.

using	OrdinalTypeArray3D = Kokkos::View< ordinal_type ***, Basis1::ExecutionSpace >
	View type for 3d device array.

using	OrdinalTypeArrayStride1D = Kokkos::View< ordinal_type *, Kokkos::LayoutStride, Basis1::ExecutionSpace >
	View type for 1d device array.

typedef ScalarTraits < Basis1::PointValueType > ::scalar_type	scalarType
	Scalar type for point values.

using	OutputViewType = Kokkos::DynRankView< OutputValueType, Kokkos::LayoutStride, Basis1::ExecutionSpace >
	View type for basis value output.

using	PointViewType = Kokkos::DynRankView< PointValueType, Kokkos::LayoutStride, Basis1::ExecutionSpace >
	View type for input points.

using	ScalarViewType = Kokkos::DynRankView< scalarType, Kokkos::LayoutStride, Basis1::ExecutionSpace >
	View type for scalars.

Public Member Functions
	Basis_DirectSumBasis (Basis1 basis1, Basis2 basis2)
	Constructor. More...

virtual void	getDofCoords (ScalarViewType dofCoords) const override
	Fills in spatial locations (coordinates) of degrees of freedom (nodes) on the reference cell. More...

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

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

Public Member Functions inherited from Intrepid2::Basis< Basis1::ExecutionSpace, Basis1::OutputValueType, Basis1::PointValueType >
OutputValueType	getDummyOutputValue ()
	Dummy array to receive input arguments.

PointValueType	getDummyPointValue ()
	Dummy array to receive input arguments.

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...

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.

virtual bool	requireOrientation () const
	True if orientation is required.

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...

Protected Attributes
Basis1	basis1_

Basis2	basis2_

std::string	name_

Protected Attributes inherited from Intrepid2::Basis< Basis1::ExecutionSpace, Basis1::OutputValueType, Basis1::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, Basis1::ExecutionSpace >	dofCoords_
	Coordinates of degrees-of-freedom for basis functions defined in physical space.

Kokkos::DynRankView < scalarType, Basis1::ExecutionSpace >	dofCoeffs_
	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...

Additional Inherited Members
Protected Member Functions inherited from Intrepid2::Basis< Basis1::ExecutionSpace, Basis1::OutputValueType, Basis1::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...

Detailed Description

template<typename Basis1, typename Basis2>
class Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >

A basis that is the direct sum of two other bases.

The direct-sum basis is ordered such that the Basis1 members come first (and in the same order as they exist in Basis1), followed by the members of Basis2, in the same order as they exist in Basis2.

The two bases must agree in their BasisType (the return value of getBasisType()).

Definition at line 68 of file Intrepid2_DirectSumBasis.hpp.

Constructor & Destructor Documentation

template<typename Basis1, typename Basis2>

Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >::Basis_DirectSumBasis	(	Basis1	basis1,
		Basis2	basis2
	)

inline

Constructor.

Parameters

[in]	basis1	- the instance of Basis1
[in]	basis2	- the instance of Basis2

Definition at line 94 of file Intrepid2_DirectSumBasis.hpp.

Member Function Documentation

template<typename Basis1, typename Basis2>

virtual void Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >::getDofCoords ( ScalarViewType dofCoords ) const

inlineoverridevirtual

Fills in spatial locations (coordinates) of degrees of freedom (nodes) on the reference cell.

Parameters

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

dofCoords should have shape (F,D), where the field dimension matches the cardinality of the basis, and D is the spatial dimension of the topology on which the basis is defined.

Note that getDofCoords() is not supported by all bases; in particular, hierarchical bases do not generally support this.

Definition at line 213 of file Intrepid2_DirectSumBasis.hpp.

template<typename Basis1, typename Basis2>

virtual const char* Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >::getName ( ) const

inlineoverridevirtual

Returns basis name.

Returns: the name of the basis

Reimplemented from Intrepid2::Basis< Basis1::ExecutionSpace, Basis1::OutputValueType, Basis1::PointValueType >.

Definition at line 231 of file Intrepid2_DirectSumBasis.hpp.

template<typename Basis1, typename Basis2>

virtual void Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >::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 258 of file Intrepid2_DirectSumBasis.hpp.

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

http://docs.trilinos.org/r13.0/packages/intrepid2/src/Discretization/Basis/Intrepid2_DirectSumBasis.hpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename Basis1, typename Basis2> class Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >

Constructor & Destructor Documentation

Member Function Documentation

template<typename Basis1, typename Basis2>
class Intrepid2::Basis_DirectSumBasis< Basis1, Basis2 >