#include <Phalanx_Evaluator_WithBaseImpl.hpp>
Public Member Functions | |
EvaluatorWithBaseImpl (const std::string &evaluator_name) | |
EvaluatorWithBaseImpl () | |
virtual | ~EvaluatorWithBaseImpl () |
virtual void | addEvaluatedField (const PHX::FieldTag &ft) |
template<typename DataT > | |
void | addEvaluatedField (const PHX::Field< DataT > &f) |
template<typename DataT , PHX::ArrayOrder Order, typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addEvaluatedField (const PHX::MDField< DataT, Order, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
virtual void | addDependentField (const PHX::FieldTag &ft) |
template<typename DataT > | |
void | addDependentField (const PHX::Field< DataT > &f) |
template<typename DataT , PHX::ArrayOrder Order, typename Tag0 , typename Tag1 , typename Tag2 , typename Tag3 , typename Tag4 , typename Tag5 , typename Tag6 , typename Tag7 > | |
void | addDependentField (const PHX::MDField< DataT, Order, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &f) |
virtual void | setName (const std::string &name) |
virtual void | postRegistrationSetup (PHX::FieldManager< Traits > &vm)=0 |
Allows providers to grab pointers to data arrays. | |
virtual const std::vector < Teuchos::RCP< FieldTag > > & | evaluatedFields () const |
Returns vector of fields that this object evaluates. | |
virtual const std::vector < Teuchos::RCP< FieldTag > > & | dependentFields () const |
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. | |
virtual void | preEvaluate (typename Traits::PreEvalData d) |
This routine is called before each residual/Jacobian fill. | |
virtual void | postEvaluate (typename Traits::PostEvalData d) |
This routine is called after each residual/Jacobian fill. | |
virtual const std::string & | getName () const |
Returns the name/identifier of this provider. | |
Private Attributes | |
std::vector< Teuchos::RCP < FieldTag > > | evaluated_ |
std::vector< Teuchos::RCP < FieldTag > > | required_ |
std::string | name_ |
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.
PHX::EvaluatorWithBaseImpl< Traits >::EvaluatorWithBaseImpl | ( | const std::string & | evaluator_name | ) | [inline] |
PHX::EvaluatorWithBaseImpl< Traits >::EvaluatorWithBaseImpl | ( | ) | [inline] |
PHX::EvaluatorWithBaseImpl< Traits >::~EvaluatorWithBaseImpl | ( | ) | [inline, virtual] |
void PHX::EvaluatorWithBaseImpl< Traits >::addDependentField | ( | const PHX::MDField< DataT, Order, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > & | f | ) | [inline] |
References PHX::EvaluatorWithBaseImpl< Traits >::addDependentField().
void PHX::EvaluatorWithBaseImpl< Traits >::addDependentField | ( | const PHX::Field< DataT > & | f | ) | [inline] |
References PHX::EvaluatorWithBaseImpl< Traits >::addDependentField(), and PHX::Field< DataT >::fieldTag().
void PHX::EvaluatorWithBaseImpl< Traits >::addDependentField | ( | const PHX::FieldTag & | ft | ) | [inline, virtual] |
References PHX::FieldTag::clone(), and PHX::EvaluatorWithBaseImpl< Traits >::required_.
Referenced by PHX::EvaluatorWithBaseImpl< Traits >::addDependentField().
void PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField | ( | const PHX::MDField< DataT, Order, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > & | f | ) | [inline] |
References PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField().
void PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField | ( | const PHX::Field< DataT > & | f | ) | [inline] |
References PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField(), and PHX::Field< DataT >::fieldTag().
void PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField | ( | const PHX::FieldTag & | ft | ) | [inline, virtual] |
References PHX::FieldTag::clone(), and PHX::EvaluatorWithBaseImpl< Traits >::evaluated_.
Referenced by PHX::EvaluatorWithBaseImpl< Traits >::addEvaluatedField().
const std::vector< Teuchos::RCP< PHX::FieldTag > > & PHX::EvaluatorWithBaseImpl< Traits >::dependentFields | ( | ) | const [inline, virtual] |
Returns vector of fields needed to compute the evaluated fields.
Implements PHX::Evaluator< Traits >.
References PHX::EvaluatorWithBaseImpl< Traits >::required_.
const std::vector< Teuchos::RCP< PHX::FieldTag > > & PHX::EvaluatorWithBaseImpl< Traits >::evaluatedFields | ( | ) | const [inline, virtual] |
Returns vector of fields that this object evaluates.
Implements PHX::Evaluator< Traits >.
References PHX::EvaluatorWithBaseImpl< Traits >::evaluated_.
virtual void PHX::EvaluatorWithBaseImpl< Traits >::evaluateFields | ( | typename Traits::EvalData | d | ) | [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 >.
Implemented in Constant< EvalT, Traits >, Density< EvalT, Traits >, Fourier< EvalT, Traits >, FEInterpolation< EvalT, Traits >, NonlinearSource< EvalT, Traits >, Constant< EvalT, Traits >, Density< EvalT, Traits >, Fourier< EvalT, Traits >, FEInterpolation< EvalT, Traits >, and NonlinearSource< EvalT, Traits >.
const std::string & PHX::EvaluatorWithBaseImpl< Traits >::getName | ( | ) | const [inline, virtual] |
Returns the name/identifier of this provider.
Implements PHX::Evaluator< Traits >.
References PHX::EvaluatorWithBaseImpl< Traits >::name_.
void PHX::EvaluatorWithBaseImpl< Traits >::postEvaluate | ( | typename Traits::PostEvalData | d | ) | [inline, virtual] |
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 >.
Reimplemented in NonlinearSource< EvalT, Traits >, and NonlinearSource< EvalT, Traits >.
virtual void PHX::EvaluatorWithBaseImpl< Traits >::postRegistrationSetup | ( | PHX::FieldManager< Traits > & | vm | ) | [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 varible 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 >.
Implemented in Constant< EvalT, Traits >, Density< EvalT, Traits >, Fourier< EvalT, Traits >, FEInterpolation< EvalT, Traits >, NonlinearSource< EvalT, Traits >, Constant< EvalT, Traits >, Density< EvalT, Traits >, Fourier< EvalT, Traits >, FEInterpolation< EvalT, Traits >, and NonlinearSource< EvalT, Traits >.
void PHX::EvaluatorWithBaseImpl< Traits >::preEvaluate | ( | typename Traits::PreEvalData | d | ) | [inline, virtual] |
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 >.
Reimplemented in NonlinearSource< EvalT, Traits >, and NonlinearSource< EvalT, Traits >.
void PHX::EvaluatorWithBaseImpl< Traits >::setName | ( | const std::string & | name | ) | [inline, virtual] |
References PHX::EvaluatorWithBaseImpl< Traits >::name_.
std::vector< Teuchos::RCP<FieldTag> > PHX::EvaluatorWithBaseImpl< Traits >::evaluated_ [private] |
std::string PHX::EvaluatorWithBaseImpl< Traits >::name_ [private] |
std::vector< Teuchos::RCP<FieldTag> > PHX::EvaluatorWithBaseImpl< Traits >::required_ [private] |