Phalanx  Development
Public Member Functions | List of all members
PHX::UnmanagedFieldDummy< EvalT, Traits, FieldT > Class Template Reference

Evalautor that performs no computations. Typically used to satisfy DAG dependencies for unmanaged fields that are evalatued external to the DAG. More...

#include <Phalanx_Evaluator_UnmanagedFieldDummy.hpp>

Inheritance diagram for PHX::UnmanagedFieldDummy< EvalT, Traits, FieldT >:
Inheritance graph
[legend]
Collaboration diagram for PHX::UnmanagedFieldDummy< EvalT, Traits, FieldT >:
Collaboration graph
[legend]

Public Member Functions

 UnmanagedFieldDummy (const FieldT &f)
 
void evaluateFields (typename Traits::EvalData workset) override
 Evaluate all fields that the provider supplies. More...
 
- Public Member Functions inherited from PHX::EvaluatorWithBaseImpl< Traits >
 EvaluatorWithBaseImpl (const std::string &evaluator_name)
 
virtual void addEvaluatedField (const PHX::FieldTag &ft)
 
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 , 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 , 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) override
 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 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 , 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)
 
- Public Member Functions inherited from PHX::Evaluator< Traits >
 Evaluator ()
 Ctor.
 
virtual ~Evaluator ()
 Dtor.
 

Additional Inherited Members

- Public Types inherited from PHX::Evaluator< Traits >
typedef PHX::Device execution_space
 
- Protected Attributes inherited from PHX::EvaluatorDerived< EvalT, Traits >
PHX::EvaluatorUtilities< EvalT, Traits > utils
 

Detailed Description

template<typename EvalT, typename Traits, typename FieldT>
class PHX::UnmanagedFieldDummy< EvalT, Traits, FieldT >

Evalautor that performs no computations. Typically used to satisfy DAG dependencies for unmanaged fields that are evalatued external to the DAG.

Member Function Documentation

◆ evaluateFields()

template<typename EvalT , typename Traits , typename FieldT >
void PHX::UnmanagedFieldDummy< EvalT, Traits, FieldT >::evaluateFields ( typename Traits::EvalData  d)
inlineoverridevirtual

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


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