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

Build a field using a specified data layout, and set it to zero. More...

#include <Panzer_ZeroContributedField.hpp>

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

Public Member Functions

 ZeroContributedField (const std::string &fieldName, PHX::DataLayout &layout)
 Constructor. More...
 
void evaluateFields (typename Traits::EvalData d) override
 Evaluate the field. More...
 
- 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
 The scalar data type. More...
 

Private Attributes

PHX::MDField< ScalarTfield_
 The field being initialized to zero. More...
 

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::ZeroContributedField< EvalT, Traits >

Build a field using a specified data layout, and set it to zero.

Used to initialize a field to zero before other Evaluators contribute to it.

Definition at line 68 of file Panzer_ZeroContributedField.hpp.

Member Typedef Documentation

template<typename EvalT , typename Traits >
using panzer::ZeroContributedField< EvalT, Traits >::ScalarT = typename EvalT::ScalarT
private

The scalar data type.

Definition at line 102 of file Panzer_ZeroContributedField.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename Traits >
panzer::ZeroContributedField< EvalT, Traits >::ZeroContributedField ( const std::string &  fieldName,
PHX::DataLayout &  layout 
)

Constructor.

Given the field name and layout, create the field to be initialized to zero.

Parameters
[in]fieldNameThe name of the field to be initialized to zero.
[in]layoutThe data layout to use when creating the field.

Definition at line 55 of file Panzer_ZeroContributedField_impl.hpp.

Member Function Documentation

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

Evaluate the field.

Set the field to zero.

Definition at line 74 of file Panzer_ZeroContributedField_impl.hpp.

Member Data Documentation

template<typename EvalT , typename Traits >
PHX::MDField<ScalarT> panzer::ZeroContributedField< EvalT, Traits >::field_
private

The field being initialized to zero.

Definition at line 107 of file Panzer_ZeroContributedField.hpp.


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