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...
bool	hasGenerator () const
	Check if the point descriptor has a generator for generating point values. More...
const PointGenerator &	getGenerator () 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 26 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]	type	String that defines the "type" of this point descriptor, used to generate unique hashes
[in]	generator	PointGenerator object for the points.

Definition at line 21 of file Panzer_PointDescriptor.cpp.

virtual panzer::PointDescriptor::~PointDescriptor ( )

virtualdefault

Destructor.

Member Function Documentation

bool panzer::PointDescriptor::hasGenerator ( ) const

inline

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

Definition at line 48 of file Panzer_PointDescriptor.hpp.

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

inline

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

Parameters

[in]

The

cell topology to build the coordinates on

Definition at line 56 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 64 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 71 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]	type	String that defines the "type" of this point descriptor, used to generate unique hashes
[in]	generator	PointGenerator object for the points.

Definition at line 28 of file Panzer_PointDescriptor.cpp.

Member Data Documentation

std::string panzer::PointDescriptor::_type

protected

Type string.

Definition at line 84 of file Panzer_PointDescriptor.hpp.

std::size_t panzer::PointDescriptor::_key

protected

Unique key associated with integrator.

Definition at line 87 of file Panzer_PointDescriptor.hpp.

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

protected

PointGenerator object to build the points.

Definition at line 90 of file Panzer_PointDescriptor.hpp.

---

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

• Panzer_PointDescriptor.hpp
• Panzer_PointDescriptor.cpp