Constant< EvalT, Traits > Class Template Reference

#include <Evaluator_Constant.hpp>

Inheritance diagram for Constant< EvalT, Traits >:

Inheritance graph
[legend]
Collaboration diagram for Constant< EvalT, Traits >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Constant (Teuchos::ParameterList &p)
void postRegistrationSetup (PHX::FieldManager< Traits > &vm)
 Allows providers to grab pointers to data arrays.
void evaluateFields (typename Traits::EvalData ud)
 Evaluate all fields that the provider supplies.
 Constant (Teuchos::ParameterList &p)
void postRegistrationSetup (PHX::FieldManager< Traits > &vm)
 Allows providers to grab pointers to data arrays.
void evaluateFields (typename Traits::EvalData ud)
 Evaluate all fields that the provider supplies.

Private Types

typedef EvalT::ScalarT ScalarT
typedef EvalT::ScalarT ScalarT

Private Attributes

ScalarT value
PHX::Field< ScalarTconstant
PHX::MDField< ScalarT,
PHX::NaturalOrder, Cell, Point
constant

template<typename EvalT, typename Traits>
class Constant< EvalT, Traits >


Member Typedef Documentation

template<typename EvalT , typename Traits >
typedef EvalT::ScalarT Constant< EvalT, Traits >::ScalarT [private]

template<typename EvalT , typename Traits >
typedef EvalT::ScalarT Constant< EvalT, Traits >::ScalarT [private]


Constructor & Destructor Documentation

template<typename EvalT , typename Traits >
Constant< EvalT, Traits >::Constant ( Teuchos::ParameterList &  p  )  [inline]

template<typename EvalT , typename Traits >
Constant< EvalT, Traits >::Constant ( Teuchos::ParameterList &  p  ) 


Member Function Documentation

template<typename EvalT , typename Traits >
void Constant< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  d  )  [virtual]

Evaluate all fields that the provider supplies.

Input:

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

Implements PHX::EvaluatorWithBaseImpl< Traits >.

template<typename EvalT , typename Traits >
void Constant< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  d  )  [inline, virtual]

Evaluate all fields that the provider supplies.

Input:

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

Implements PHX::EvaluatorWithBaseImpl< Traits >.

template<typename EvalT , typename Traits >
void Constant< EvalT, Traits >::postRegistrationSetup ( PHX::FieldManager< Traits > &  vm  )  [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::EvaluatorWithBaseImpl< Traits >.

template<typename EvalT , typename Traits >
void Constant< EvalT, Traits >::postRegistrationSetup ( PHX::FieldManager< Traits > &  vm  )  [inline, 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::EvaluatorWithBaseImpl< Traits >.

References Constant< EvalT, Traits >::constant, PHX::Field< DataT >::size(), PHX::EvaluatorDerived< EvalT, Traits >::utils, and Constant< EvalT, Traits >::value.

Here is the call graph for this function:


Member Data Documentation

template<typename EvalT , typename Traits >
PHX::MDField<ScalarT,PHX::NaturalOrder,Cell,Point> Constant< EvalT, Traits >::constant [private]

template<typename EvalT , typename Traits >
PHX::Field<ScalarT> Constant< EvalT, Traits >::constant [private]

template<typename EvalT , typename Traits >
ScalarT Constant< EvalT, Traits >::value [private]


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

Generated on Thu Dec 17 11:05:47 2009 for Phalanx by  doxygen 1.5.9