Panzer  Version of the Day
Public Types | Public Member Functions | Private Attributes | List of all members
panzer::BasisInformation Class Reference

Description and data layouts associated with a particular basis. More...

#include <Panzer_BasisInformation.hpp>

Public Types

enum  EElementSpace { HGRAD =0, HCURL =1, HDIV =2, CONST =3 }
 

Public Member Functions

 BasisInformation (const std::string &basis_type, const int basis_order, const shards::CellTopology &cell_topo)
 
std::string type () const
 Returns the basis type. More...
 
int order () const
 Returns the polynomial order of the basis. More...
 
const shards::CellTopology & getCellTopology () const
 
int dimension () const
 Returns the dimension of the basis from the topology. More...
 
EElementSpace getElementSpace () const
 
bool requiresOrientations () const
 
bool supportsGrad () const
 
bool supportsCurl () const
 
bool supportsDiv () const
 
bool isVectorBasis () const
 
bool isScalarBasis () const
 

Private Attributes

shards::CellTopology topology_
 
std::string basis_type_
 
int basis_order_
 
EElementSpace element_space_
 

Detailed Description

Description and data layouts associated with a particular basis.

Definition at line 56 of file Panzer_BasisInformation.hpp.

Member Enumeration Documentation

◆ EElementSpace

Enumerator
HGRAD 
HCURL 
HDIV 
CONST 

Definition at line 59 of file Panzer_BasisInformation.hpp.

Constructor & Destructor Documentation

◆ BasisInformation()

panzer::BasisInformation::BasisInformation ( const std::string &  basis_type,
const int  basis_order,
const shards::CellTopology &  cell_topo 
)

Build a basis information given a type and order

Parameters
[in]basis_typeString name that describes the type of basis
[in]basis_orderOrder of the basis
[in]cell_topoA shards topology description

Definition at line 52 of file Panzer_BasisInformation.cpp.

Member Function Documentation

◆ type()

std::string panzer::BasisInformation::type ( ) const
inline

Returns the basis type.

Definition at line 70 of file Panzer_BasisInformation.hpp.

◆ order()

int panzer::BasisInformation::order ( ) const
inline

Returns the polynomial order of the basis.

Definition at line 74 of file Panzer_BasisInformation.hpp.

◆ getCellTopology()

const shards::CellTopology& panzer::BasisInformation::getCellTopology ( ) const
inline

Definition at line 77 of file Panzer_BasisInformation.hpp.

◆ dimension()

int panzer::BasisInformation::dimension ( ) const
inline

Returns the dimension of the basis from the topology.

Definition at line 81 of file Panzer_BasisInformation.hpp.

◆ getElementSpace()

EElementSpace panzer::BasisInformation::getElementSpace ( ) const
inline

Definition at line 84 of file Panzer_BasisInformation.hpp.

◆ requiresOrientations()

bool panzer::BasisInformation::requiresOrientations ( ) const
inline

Definition at line 87 of file Panzer_BasisInformation.hpp.

◆ supportsGrad()

bool panzer::BasisInformation::supportsGrad ( ) const
inline

Definition at line 90 of file Panzer_BasisInformation.hpp.

◆ supportsCurl()

bool panzer::BasisInformation::supportsCurl ( ) const
inline

Definition at line 93 of file Panzer_BasisInformation.hpp.

◆ supportsDiv()

bool panzer::BasisInformation::supportsDiv ( ) const
inline

Definition at line 96 of file Panzer_BasisInformation.hpp.

◆ isVectorBasis()

bool panzer::BasisInformation::isVectorBasis ( ) const
inline

Definition at line 99 of file Panzer_BasisInformation.hpp.

◆ isScalarBasis()

bool panzer::BasisInformation::isScalarBasis ( ) const
inline

Definition at line 102 of file Panzer_BasisInformation.hpp.

Member Data Documentation

◆ topology_

shards::CellTopology panzer::BasisInformation::topology_
private

Definition at line 107 of file Panzer_BasisInformation.hpp.

◆ basis_type_

std::string panzer::BasisInformation::basis_type_
private

Definition at line 109 of file Panzer_BasisInformation.hpp.

◆ basis_order_

int panzer::BasisInformation::basis_order_
private

Definition at line 110 of file Panzer_BasisInformation.hpp.

◆ element_space_

EElementSpace panzer::BasisInformation::element_space_
private

Definition at line 112 of file Panzer_BasisInformation.hpp.


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