Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
panzer::BasisDescriptor Class Reference

#include <Panzer_BasisDescriptor.hpp>

Public Member Functions

 BasisDescriptor ()
 Constructor for empty basis. More...
 
virtual ~BasisDescriptor ()=default
 Destructor. More...
 
 BasisDescriptor (const int basis_order, const std::string &basis_type)
 Constructor for basis description. More...
 
const std::string & getType () const
 Get type of basis. More...
 
int getOrder () const
 Get order of basis. More...
 
std::size_t getKey () const
 Get unique key associated with basis of this order and type The key is used to sort through a map of BasisDescriptors. More...
 
PointDescriptor getPointDescriptor () const
 Build a point descriptor that builds reference points for the DOF locations. This method throws if no points exist for this basis. More...
 

Protected Attributes

std::string _basis_type
 Basis type (HGrad, HDiv, HCurl,...) More...
 
int _basis_order
 
std::size_t _key
 

Detailed Description

Definition at line 53 of file Panzer_BasisDescriptor.hpp.

Constructor & Destructor Documentation

panzer::BasisDescriptor::BasisDescriptor ( )

Constructor for empty basis.

Definition at line 101 of file Panzer_BasisDescriptor.cpp.

virtual panzer::BasisDescriptor::~BasisDescriptor ( )
virtualdefault

Destructor.

panzer::BasisDescriptor::BasisDescriptor ( const int  basis_order,
const std::string &  basis_type 
)

Constructor for basis description.

Parameters
[in]basis_orderBasis order (e.g. 1 could be piecewise linear)
[in]basis_typeBasis type (e.g. HGrad, HDiv, HCurl, ...)

Definition at line 108 of file Panzer_BasisDescriptor.cpp.

Member Function Documentation

const std::string& panzer::BasisDescriptor::getType ( ) const
inline

Get type of basis.

Returns
Type of basis

Definition at line 78 of file Panzer_BasisDescriptor.hpp.

int panzer::BasisDescriptor::getOrder ( ) const
inline

Get order of basis.

Returns
Order of basis

Definition at line 84 of file Panzer_BasisDescriptor.hpp.

std::size_t panzer::BasisDescriptor::getKey ( ) const
inline

Get unique key associated with basis of this order and type The key is used to sort through a map of BasisDescriptors.

Returns
Unique basis key

Definition at line 91 of file Panzer_BasisDescriptor.hpp.

PointDescriptor panzer::BasisDescriptor::getPointDescriptor ( ) const

Build a point descriptor that builds reference points for the DOF locations. This method throws if no points exist for this basis.

Definition at line 117 of file Panzer_BasisDescriptor.cpp.

Member Data Documentation

std::string panzer::BasisDescriptor::_basis_type
protected

Basis type (HGrad, HDiv, HCurl,...)

Definition at line 104 of file Panzer_BasisDescriptor.hpp.

int panzer::BasisDescriptor::_basis_order
protected

Definition at line 107 of file Panzer_BasisDescriptor.hpp.

std::size_t panzer::BasisDescriptor::_key
protected

Definition at line 110 of file Panzer_BasisDescriptor.hpp.


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