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

#include <Panzer_PointDescriptor.hpp>

Public Member Functions

 PointDescriptor ()=delete
 Default constructor, no version. More...
 
 PointDescriptor (const std::string &type, const Teuchos::RCP< PointGenerator > &generator)
 Constructor for the point descriptor. More...
 
virtual ~PointDescriptor ()=default
 Destructor. More...
 
const PointGeneratorgetGenerator () const
 
const std::string & getType () const
 Get unique string associated with the type of point descriptor. This will be used generate a hash to sort through a map of PointDescriptors. More...
 
std::size_t getKey () const
 Get unique key associated with integrator of this order and type The key is used to sort through a map of IntegrationDescriptors. More...
 

Protected Member Functions

void setup (const std::string &type, const Teuchos::RCP< PointGenerator > &generator)
 Setup the point descriptor. Protected and used by constructors. More...
 

Protected Attributes

std::string _type
 Type string. More...
 
std::size_t _key
 Unique key associated with integrator. More...
 
Teuchos::RCP< PointGenerator_generator
 PointGenerator object to build the points. More...
 

Detailed Description

Definition at line 59 of file Panzer_PointDescriptor.hpp.

Constructor & Destructor Documentation

panzer::PointDescriptor::PointDescriptor ( )
delete

Default constructor, no version.

panzer::PointDescriptor::PointDescriptor ( const std::string &  type,
const Teuchos::RCP< PointGenerator > &  generator 
)

Constructor for the point descriptor.

Parameters
[in]typeString that defines the "type" of this point descriptor, used to generate unique hashes
[in]generatorPointGenerator object for the points.

Definition at line 53 of file Panzer_PointDescriptor.cpp.

virtual panzer::PointDescriptor::~PointDescriptor ( )
virtualdefault

Destructor.

Member Function Documentation

const PointGenerator& panzer::PointDescriptor::getGenerator ( ) const
inline

Build a generator class that generates any reference points on a specified topology.

Parameters
[in]Thecell topology to build the coordinates on

Definition at line 82 of file Panzer_PointDescriptor.hpp.

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

Get unique string associated with the type of point descriptor. This will be used generate a hash to sort through a map of PointDescriptors.

Returns
A string that uniquely describes this point descriptor

Definition at line 90 of file Panzer_PointDescriptor.hpp.

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

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

Returns
Unique basis key

Definition at line 97 of file Panzer_PointDescriptor.hpp.

void panzer::PointDescriptor::setup ( const std::string &  type,
const Teuchos::RCP< PointGenerator > &  generator 
)
protected

Setup the point descriptor. Protected and used by constructors.

Parameters
[in]typeString that defines the "type" of this point descriptor, used to generate unique hashes
[in]generatorPointGenerator object for the points.

Definition at line 60 of file Panzer_PointDescriptor.cpp.

Member Data Documentation

std::string panzer::PointDescriptor::_type
protected

Type string.

Definition at line 110 of file Panzer_PointDescriptor.hpp.

std::size_t panzer::PointDescriptor::_key
protected

Unique key associated with integrator.

Definition at line 113 of file Panzer_PointDescriptor.hpp.

Teuchos::RCP<PointGenerator> panzer::PointDescriptor::_generator
protected

PointGenerator object to build the points.

Definition at line 116 of file Panzer_PointDescriptor.hpp.


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