panzer::CellAverage< EvalT, Traits > Class Template Reference

#include <Panzer_CellAverage.hpp>

Inheritance diagram for panzer::CellAverage< EvalT, Traits >:

Public Member Functions
	CellAverage (const Teuchos::ParameterList &p)
void	postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
void	evaluateFields (typename Traits::EvalData d)
const PHX::FieldTag &	getFieldTag () const
Public Member Functions inherited from panzer::EvaluatorWithBaseImpl< Traits >
void	setDetailsIndex (const int di)
	An evaluator builder sets the details index. More...
Public Member Functions inherited from PHX::EvaluatorWithBaseImpl< Traits >
virtual void	evaluateFields (typename Traits::EvalData d) override=0
Public Member Functions inherited from PHX::Evaluator< Traits >
	Evaluator ()
virtual	~Evaluator ()
virtual void	postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &vm)=0
virtual const std::vector < Teuchos::RCP< FieldTag > > &	evaluatedFields () const =0
virtual const std::vector < Teuchos::RCP< FieldTag > > &	contributedFields () const =0
virtual const std::vector < Teuchos::RCP< FieldTag > > &	dependentFields () const =0
virtual const std::vector < Teuchos::RCP< FieldTag > > &	unsharedFields () const =0
virtual void	preEvaluate (typename Traits::PreEvalData d)=0
virtual void	postEvaluate (typename Traits::PostEvalData d)=0
virtual const std::string &	getName () const =0
virtual void	bindField (const PHX::FieldTag &ft, const std::any &f)=0
virtual PHX::DeviceEvaluator < Traits > *	createDeviceEvaluator () const =0
virtual void	rebuildDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0
virtual void	deleteDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0
virtual void	printFieldValues (std::ostream &os) const =0
Public Member Functions inherited from panzer::DomainEvaluator
	DomainEvaluator (DomainType domain=ALL)
	Constructor. More...
virtual	~DomainEvaluator ()=default
	Default destructor. More...
void	setDomain (const DomainType domain)
	Set the domain for the evaluator. More...
DomainType	getDomain ()
	Get the domain for the evaluator. More...
virtual int	cellStartIndex (const panzer::Workset &workset) const
	Returns the starting cell for the specified domain for a given workset. More...
virtual int	cellEndIndex (const panzer::Workset &workset) const
	Returns the non-inclusive end cell for the specified domain for a given workset. More...

Private Types
using	ScalarT = typename EvalT::ScalarT

Private Member Functions
Teuchos::RCP < Teuchos::ParameterList >	getValidParameters () const

Private Attributes
PHX::MDField< ScalarT, Cell >	average
PHX::MDField< const ScalarT, Cell, IP >	scalar
std::vector< PHX::MDField < const ScalarT, Cell, IP > >	field_multipliers
double	multiplier
std::size_t	num_qp
std::size_t	quad_index
int	quad_order

Additional Inherited Members
Public Types inherited from panzer::DomainEvaluator
enum	DomainType : int {   OWNED =0, GHOST =1, REAL =2, VIRTUAL =3,   EXTERNAL =4, ALL =5 }
	Domain types supported by worksets. More...
Protected Attributes inherited from panzer::EvaluatorWithBaseImpl< Traits >
WorksetDetailsAccessor	wda

Detailed Description

template<typename EvalT, typename Traits>
class panzer::CellAverage< EvalT, Traits >

This integrates a scalar quanity over each cell. It is useful for comptuing integral responses.

  <ParameterList>
    <Parameter name="Average Name" type="string" value="<Name to give to the average field>"/>
    <Parameter name="Field Name" type="string" value="<Name of field to find average of>"/>
    <Parameter name="IR" type="RCP<IntegrationRule>" value="<user specified IntegrationRule>"/>
    <Parameter name="Multiplier" type="double" value="<Scaling factor, default=1>"/>
    <Parameter name="Field Multipliers" type="RCP<const vector<string> >" value="<Other scalar multiplier fields>"/>
  </ParameterList>

Definition at line 38 of file Panzer_CellAverage.hpp.

Member Typedef Documentation

template<typename EvalT , typename Traits >

using panzer::CellAverage< EvalT, Traits >::ScalarT = typename EvalT::ScalarT

private

Definition at line 59 of file Panzer_CellAverage.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename Traits >

panzer::CellAverage< EvalT, Traits >::CellAverage

(

const Teuchos::ParameterList &

p

)

Definition at line 26 of file Panzer_CellAverage_impl.hpp.

Member Function Documentation

template<typename EvalT , typename Traits >

void panzer::CellAverage< EvalT, Traits >::postRegistrationSetup	(	typename Traits::SetupData	d,
		PHX::FieldManager< Traits > &	fm
	)

Definition at line 70 of file Panzer_CellAverage_impl.hpp.

template<typename EvalT , typename Traits >

void panzer::CellAverage< EvalT, Traits >::evaluateFields

(

typename Traits::EvalData

d

)

Definition at line 82 of file Panzer_CellAverage_impl.hpp.

template<typename EvalT , typename Traits >

const PHX::FieldTag& panzer::CellAverage< EvalT, Traits >::getFieldTag ( ) const

inline

Definition at line 74 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename TRAITS >

Teuchos::RCP< Teuchos::ParameterList > panzer::CellAverage< EvalT, TRAITS >::getValidParameters ( ) const

private

Definition at line 106 of file Panzer_CellAverage_impl.hpp.

Member Data Documentation

template<typename EvalT , typename Traits >

PHX::MDField<ScalarT,Cell> panzer::CellAverage< EvalT, Traits >::average

private

Definition at line 61 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

PHX::MDField<const ScalarT,Cell,IP> panzer::CellAverage< EvalT, Traits >::scalar

private

Definition at line 63 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

std::vector<PHX::MDField<const ScalarT,Cell,IP> > panzer::CellAverage< EvalT, Traits >::field_multipliers

private

Definition at line 65 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

double panzer::CellAverage< EvalT, Traits >::multiplier

private

Definition at line 66 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

std::size_t panzer::CellAverage< EvalT, Traits >::num_qp

private

Definition at line 68 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

std::size_t panzer::CellAverage< EvalT, Traits >::quad_index

private

Definition at line 69 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >

int panzer::CellAverage< EvalT, Traits >::quad_order

private

Definition at line 70 of file Panzer_CellAverage.hpp.

---

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

• Panzer_CellAverage.hpp
• Panzer_CellAverage_impl.hpp