panzer::IntegrationDescriptor Class Reference

#include <Panzer_IntegrationDescriptor.hpp>

Inheritance diagram for panzer::IntegrationDescriptor:

Public Types
enum	{   NONE , VOLUME , SURFACE , SIDE ,   CV_VOLUME , CV_SIDE , CV_BOUNDARY }
	Possible integration types. More...

Public Member Functions
	IntegrationDescriptor ()
	Constructor for empty integrator.
virtual	~IntegrationDescriptor ()=default
	Destructor.
	IntegrationDescriptor (const int cubature_order, const int integration_type, const int side=-1)
	Constructor for integrator description.
const int &	getType () const
	Get type of integrator.
const int &	getOrder () const
	Get order of integrator.
const int &	getSide () const
	Get side associated with integration - this is for backward compatibility.
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 int cubature_order, const int integration_type, const int side=-1)
	Setup function.

Protected Attributes
int	_integration_type
	Type of integration.
int	_cubature_order
	Order of integration (Order of polynomial this integrator is designed for)
int	_side
	Side associated with integration - this is for backward compatibility.
std::size_t	_key
	Unique key associated with integrator.

Detailed Description

Definition at line 18 of file Panzer_IntegrationDescriptor.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Possible integration types.

Enumerator
NONE
VOLUME	No integral specified - default state.
SURFACE	Integral over volume.
SIDE	Integral over all sides of cells (closed surface integral)
CV_VOLUME	Integral over a specific side of cells (side must be set)
CV_SIDE	Control volume integral.
CV_BOUNDARY	Control volume side integral. Control volume boundary integral (side must be set)

Definition at line 25 of file Panzer_IntegrationDescriptor.hpp.

Constructor & Destructor Documentation

IntegrationDescriptor() [1/2]

panzer::IntegrationDescriptor::IntegrationDescriptor

(

)

Constructor for empty integrator.

Definition at line 20 of file Panzer_IntegrationDescriptor.cpp.

~IntegrationDescriptor()

virtual panzer::IntegrationDescriptor::~IntegrationDescriptor ( )

virtualdefault

Destructor.

IntegrationDescriptor() [2/2]

panzer::IntegrationDescriptor::IntegrationDescriptor	(	const int	cubature_order,
		const int	integration_type,
		const int	side = -1
	)

Constructor for integrator description.

Parameters

[in]	cubature_order	Order of polynomial to integrate (e.g. 2 could integrate a quadratic equation)
[in]	integration_type	Type of integration (e.g. Volume integral, Surface integral, Side integral...)
[in]	side	Side of cell to integrate over (default to -1 -> ignore sides)

Definition at line 25 of file Panzer_IntegrationDescriptor.cpp.

Member Function Documentation

getType()

const int & panzer::IntegrationDescriptor::getType ( ) const

inline

Get type of integrator.

Returns

Type of integrator

Definition at line 55 of file Panzer_IntegrationDescriptor.hpp.

getOrder()

const int & panzer::IntegrationDescriptor::getOrder ( ) const

inline

Get order of integrator.

Returns

Order of integrator

Definition at line 61 of file Panzer_IntegrationDescriptor.hpp.

getSide()

const int & panzer::IntegrationDescriptor::getSide ( ) const

inline

Get side associated with integration - this is for backward compatibility.

Returns

Side of cell (= Subcell index)

Definition at line 67 of file Panzer_IntegrationDescriptor.hpp.

getKey()

std::size_t panzer::IntegrationDescriptor::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 74 of file Panzer_IntegrationDescriptor.hpp.

setup()

void panzer::IntegrationDescriptor::setup ( const int  cubature_order, const int  integration_type, const int  side = -1  )

protected

Setup function.

Parameters

[in]	cubature_order	Order of polynomial to integrate (e.g. 2 could integrate a quadratic equation)
[in]	integration_type	Type of integration (e.g. Volume integral, Surface integral, Side integral...)
[in]	side	Side of cell to integrate over (default to -1 -> ignore sides)

Definition at line 31 of file Panzer_IntegrationDescriptor.cpp.

Member Data Documentation

_integration_type

int panzer::IntegrationDescriptor::_integration_type

protected

Type of integration.

Definition at line 87 of file Panzer_IntegrationDescriptor.hpp.

_cubature_order

int panzer::IntegrationDescriptor::_cubature_order

protected

Order of integration (Order of polynomial this integrator is designed for)

Definition at line 90 of file Panzer_IntegrationDescriptor.hpp.

_side

int panzer::IntegrationDescriptor::_side

protected

Side associated with integration - this is for backward compatibility.

Definition at line 93 of file Panzer_IntegrationDescriptor.hpp.

_key

std::size_t panzer::IntegrationDescriptor::_key

protected

Unique key associated with integrator.

Definition at line 96 of file Panzer_IntegrationDescriptor.hpp.

---

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

• Panzer_IntegrationDescriptor.hpp
• Panzer_IntegrationDescriptor.cpp