Phalanx
Development
|
Class that implements helper functions for the pure virtual PHX::Evaluator class. More...
#include <Phalanx_Evaluator_WithBaseImpl.hpp>
Public Member Functions | |
EvaluatorWithBaseImpl (const std::string &evaluator_name) | |
virtual void | addEvaluatedField (const PHX::FieldTag &ft) |
template<typename DataT > | |
void | addEvaluatedField (const PHX::Field< DataT > &f) |
template<typename DataT , typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addEvaluatedField (const PHX::MDField< DataT, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
virtual void | addContributedField (const PHX::FieldTag &ft) |
template<typename DataT > | |
void | addContributedField (const PHX::Field< DataT > &f) |
template<typename DataT , typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addContributedField (const PHX::MDField< DataT, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
virtual void | addDependentField (const PHX::FieldTag &ft) |
template<typename DataT > | |
PHALANX_DEPRECATED void | addDependentField (const PHX::Field< DataT > &f) |
template<typename DataT > | |
void | addDependentField (const PHX::Field< const DataT > &f) |
template<typename DataT , typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
PHALANX_DEPRECATED void | addDependentField (const PHX::MDField< DataT, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
template<typename DataT , typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addDependentField (const PHX::MDField< const DataT, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
virtual void | setName (const std::string &name) |
virtual void | postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &vm)=0 |
Allows providers to grab pointers to data arrays. More... | |
virtual const std::vector< Teuchos::RCP< FieldTag > > & | evaluatedFields () const override |
Returns vector of fields that this object evaluates. | |
virtual const std::vector< Teuchos::RCP< FieldTag > > & | contributedFields () const override |
Returns vector of fields that contribute partially to the evaluation of a field. This allows users to spread the evaluation of a field over multiple evaluators. | |
virtual const std::vector< Teuchos::RCP< FieldTag > > & | dependentFields () const override |
Returns vector of fields needed to compute the evaluated fields. | |
virtual void | evaluateFields (typename Traits::EvalData d)=0 |
Evaluate all fields that the provider supplies. More... | |
virtual void | preEvaluate (typename Traits::PreEvalData d) override |
This routine is called before each residual/Jacobian fill. More... | |
virtual void | postEvaluate (typename Traits::PostEvalData d) override |
This routine is called after each residual/Jacobian fill. More... | |
virtual const std::string & | getName () const override |
Returns the name/identifier of this provider. | |
virtual void | bindField (const PHX::FieldTag &ft, const PHX::any &f) override |
Binds memory to a field. WARNING: this is a POWER-USER function. Only use this if you understand the memory binding sequence (see detailed description for more information). More... | |
template<typename DataT > | |
void | addDependentField (const PHX::Field< DataT > &f) |
template<typename DataT , typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addDependentField (const PHX::MDField< DataT, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
![]() | |
Evaluator () | |
Ctor. | |
virtual | ~Evaluator () |
Dtor. | |
Additional Inherited Members | |
![]() | |
typedef PHX::Device | execution_space |
Class that implements helper functions for the pure virtual PHX::Evaluator class.
This class implements code that would essentially be repeated in each Evaluator class, making it quicker for developers to add new evaluators. All field evaluators should inherit from this class if possible instead of the base class so they don't have to code the same boilerplate in all evaluators, but this is not mandatory.
|
overridevirtual |
Binds memory to a field. WARNING: this is a POWER-USER function. Only use this if you understand the memory binding sequence (see detailed description for more information).
WARNING: This is a power user function. It sets/swaps the field memory for the suppied field (either an externally defined user managed field or a internally managed from the FieldManager). All evaluators that evaluate or depend on this field should be bound to the same memory. Otherwise you will get undefined results. To use this consistently, do not call this directly. Instead, bind all memory through calls to the PHX::FieldManager class.
Implements PHX::Evaluator< Traits >.
References PHX::FieldTag::identifier().
|
pure virtual |
Evaluate all fields that the provider supplies.
Input:
d | - user defined data object defined by the EvalData typedef in the traits class. |
Implements PHX::Evaluator< Traits >.
|
overridevirtual |
This routine is called after each residual/Jacobian fill.
This routine is called ONCE on the provider after the fill loop over cells is completed. This allows us to evaluate any post fill data. An example is to print out some statistics such as the maximum grid peclet number in a cell.
Implements PHX::Evaluator< Traits >.
|
pure virtual |
Allows providers to grab pointers to data arrays.
Called once all providers are registered with the manager.
Once the field manager has allocated all data arrays, this method passes the field manager to the providers to allow each provider to grab and store pointers to the field data arrays. Grabbing the data arrays from the variable manager during an actual call to evaluateFields call is too slow due to the map lookup and FieldTag comparison (which uses a string compare). So lookups on field data are only allowed during this setup phase.
Implements PHX::Evaluator< Traits >.
|
overridevirtual |
This routine is called before each residual/Jacobian fill.
This routine is called ONCE on the provider before the fill loop over cells is started. This allows us to reset global objects between each fill. An example is to reset a provider that monitors the maximum grid peclet number in a cell. This call would zero out the maximum for a new fill.
Implements PHX::Evaluator< Traits >.