#include <Phalanx_Evaluator.hpp>
Public Member Functions | |
Evaluator () | |
Ctor. | |
virtual | ~Evaluator () |
Dtor. | |
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 =0 |
Returns vector of fields that this object evaluates. | |
virtual const std::vector < Teuchos::RCP< FieldTag > > & | dependentFields () const =0 |
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)=0 |
This routine is called before each residual/Jacobian fill. | |
virtual void | postEvaluate (typename Traits::PostEvalData d)=0 |
This routine is called after each residual/Jacobian fill. | |
virtual const std::string & | getName () const =0 |
Returns the name/identifier of this provider. |
PHX::Evaluator< Traits >::Evaluator | ( | ) | [inline] |
Ctor.
virtual PHX::Evaluator< Traits >::~Evaluator | ( | ) | [inline, virtual] |
Dtor.
virtual const std::vector< Teuchos::RCP<FieldTag> >& PHX::Evaluator< Traits >::dependentFields | ( | ) | const [pure virtual] |
Returns vector of fields needed to compute the evaluated fields.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual const std::vector< Teuchos::RCP<FieldTag> >& PHX::Evaluator< Traits >::evaluatedFields | ( | ) | const [pure virtual] |
Returns vector of fields that this object evaluates.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual void PHX::Evaluator< 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. |
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, 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 >, NonlinearSource< EvalT, Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual const std::string& PHX::Evaluator< Traits >::getName | ( | ) | const [pure virtual] |
Returns the name/identifier of this provider.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual void PHX::Evaluator< Traits >::postEvaluate | ( | typename Traits::PostEvalData | d | ) | [pure 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.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, NonlinearSource< EvalT, Traits >, NonlinearSource< EvalT, Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual void PHX::Evaluator< 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.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, 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 >, NonlinearSource< EvalT, Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.
virtual void PHX::Evaluator< Traits >::preEvaluate | ( | typename Traits::PreEvalData | d | ) | [pure 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.
Implemented in PHX::EvaluatorWithBaseImpl< Traits >, NonlinearSource< EvalT, Traits >, NonlinearSource< EvalT, Traits >, and PHX::EvaluatorWithBaseImpl< Traits >.