Panzer Version of the Day
Loading...
Searching...
No Matches
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.
 
 PointDescriptor (const std::string &type, const Teuchos::RCP< PointGenerator > &generator)
 Constructor for the point descriptor.
 
virtual ~PointDescriptor ()=default
 Destructor.
 
bool hasGenerator () const
 Check if the point descriptor has a generator for generating point values.
 
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.
 
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.
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Definition at line 59 of file Panzer_PointDescriptor.hpp.

Constructor & Destructor Documentation

◆ PointDescriptor() [1/2]

panzer::PointDescriptor::PointDescriptor ( )
delete

Default constructor, no version.

◆ PointDescriptor() [2/2]

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 52 of file Panzer_PointDescriptor.cpp.

◆ ~PointDescriptor()

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

Destructor.

Member Function Documentation

◆ hasGenerator()

bool panzer::PointDescriptor::hasGenerator ( ) const
inline

Check if the point descriptor has a generator for generating point values.

Definition at line 81 of file Panzer_PointDescriptor.hpp.

◆ getGenerator()

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 89 of file Panzer_PointDescriptor.hpp.

◆ getType()

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 97 of file Panzer_PointDescriptor.hpp.

◆ getKey()

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 104 of file Panzer_PointDescriptor.hpp.

◆ setup()

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 59 of file Panzer_PointDescriptor.cpp.

Member Data Documentation

◆ _type

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

Type string.

Definition at line 117 of file Panzer_PointDescriptor.hpp.

◆ _key

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

Unique key associated with integrator.

Definition at line 120 of file Panzer_PointDescriptor.hpp.

◆ _generator

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

PointGenerator object to build the points.

Definition at line 123 of file Panzer_PointDescriptor.hpp.


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