Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
panzer::CellAverage< EvalT, Traits > Class Template Reference

#include <Panzer_CellAverage.hpp>

Inheritance diagram for panzer::CellAverage< EvalT, Traits >:
Inheritance graph
[legend]

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 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,
  ALL =4
}
 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 70 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 91 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 58 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 102 of file Panzer_CellAverage_impl.hpp.

template<typename EvalT , typename Traits >
void panzer::CellAverage< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  d)

Definition at line 114 of file Panzer_CellAverage_impl.hpp.

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

Definition at line 106 of file Panzer_CellAverage.hpp.

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

Definition at line 138 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 93 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 95 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 97 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >
double panzer::CellAverage< EvalT, Traits >::multiplier
private

Definition at line 98 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >
std::size_t panzer::CellAverage< EvalT, Traits >::num_qp
private

Definition at line 100 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >
std::size_t panzer::CellAverage< EvalT, Traits >::quad_index
private

Definition at line 101 of file Panzer_CellAverage.hpp.

template<typename EvalT , typename Traits >
int panzer::CellAverage< EvalT, Traits >::quad_order
private

Definition at line 102 of file Panzer_CellAverage.hpp.


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