PHX::Evaluator< Traits > Class Template Reference

#include <Phalanx_Evaluator.hpp>

Inheritance diagram for PHX::Evaluator< Traits >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Evaluator ()
 Ctor.
virtual ~Evaluator ()
 Dtor.
virtual void postRegistrationSetup (typename Traits::SetupData d, 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.

Detailed Description

template<typename Traits>
class PHX::Evaluator< Traits >

Pure virtual base class that provides field evaluation routines to the FieldManager.


Member Function Documentation

template<typename Traits >
virtual void PHX::Evaluator< Traits >::evaluateFields ( typename Traits::EvalData  d  )  [pure virtual]

Evaluate all fields that the provider supplies.

Input:

Parameters:
d - user defined data object defined by the EvalData typedef in the traits class.

Implemented in PHX::EvaluatorWithBaseImpl< Traits >.

template<typename 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 >.

template<typename Traits >
virtual void PHX::Evaluator< Traits >::postRegistrationSetup ( typename Traits::SetupData  d,
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 >.

template<typename 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 >.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Friends
Generated on Wed Apr 13 10:05:54 2011 for Phalanx by  doxygen 1.6.3