Evaluator to help set dependencies for aliased fields. More...

#include <Phalanx_Evaluator_AliasField.hpp>

Inheritance diagram for PHX::AliasField< EvalT, Traits >:

Collaboration diagram for PHX::AliasField< EvalT, Traits >:

Public Member Functions
	AliasField (const PHX::FieldTag &aliasedField, const PHX::FieldTag &targetField)

void	postRegistrationSetup (typename Traits::SetupData, PHX::FieldManager< Traits > &)
	Allows providers to grab pointers to data arrays. More...

void	evaluateFields (typename Traits::EvalData)
	Evaluate all fields that the provider supplies. More...

KOKKOS_INLINE_FUNCTION void	operator() (const int) const

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... Props>
void	addEvaluatedField (const PHX::MDField< DataT, Props...> &f)

template<typename DataT , int Rank, typename Layout >
void	addEvaluatedField (const PHX::Field< DataT, Rank, Layout > &f)

template<typename DataT , typename... Props>
void	addEvaluatedField (const PHX::FieldTag &ft, const Kokkos::View< DataT, Props...> &f)

virtual void	addContributedField (const PHX::FieldTag &ft)

template<typename DataT , typename... Props>
void	addContributedField (const PHX::MDField< DataT, Props...> &f)

template<typename DataT , int Rank, typename Layout >
void	addContributedField (const PHX::Field< DataT, Rank, Layout > &f)

template<typename DataT , typename... Properties>
void	addContributedField (const PHX::FieldTag &ft, const Kokkos::View< DataT, Properties...> &f)

virtual void	addDependentField (const PHX::FieldTag &ft)

template<typename DataT , typename... Props>
PHALANX_DEPRECATED void	addDependentField (const PHX::MDField< DataT, Props...> &f)

template<typename DataT , typename... Props>
void	addDependentField (const PHX::MDField< const DataT, Props...> &f)

template<typename DataT , int Rank, typename Layout >
void	addDependentField (const PHX::Field< const DataT, Rank, Layout > &f)

template<typename DataT , typename... Properties>
void	addDependentField (const PHX::FieldTag &ft, const Kokkos::View< DataT, Properties...> &f)

void	addUnsharedField (const Teuchos::RCP< PHX::FieldTag > &ft)

virtual void	setName (const std::string &name)

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 const std::vector < Teuchos::RCP< FieldTag > > &	unsharedFields () const override
	Returns vector of fields that are not allowed to share memory with other 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...

virtual PHX::DeviceEvaluator < Traits > *	createDeviceEvaluator () const override
	Returns a DeviceEvaluator object instantiated on the Device using malloc and placement new so that vtable works properly. Only used for Device DAG support.

virtual void	rebuildDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const override
	Call dtor and then call placement new on the memory to rebind data. Needed to rebind unmanaged fields that are set after DeviceEvaluator is constructed in postRegistrationSetup(). Only used for Device DAG support.

virtual void	deleteDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const override
	Call dtor and delete device memory. Only used for Device DAG support.

virtual void	printFieldValues (std::ostream &os) const override
	Print the field values for all fields in the evaluator.

template<typename DataT , typename... Props>
void	addDependentField (const PHX::MDField< DataT, Props...> &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

Detailed Description

template<typename EvalT, typename Traits>
class PHX::AliasField< EvalT, Traits >

Evaluator to help set dependencies for aliased fields.

Member Function Documentation

template<typename EvalT , typename Traits >

void PHX::AliasField< EvalT, Traits >::evaluateFields ( typename Traits::EvalData d )

inlinevirtual

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 PHX::AliasField< EvalT, Traits >::postRegistrationSetup	(	typename Traits::SetupData	d,
		PHX::FieldManager< Traits > &	vm
	)

inlinevirtual

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

Reimplemented from PHX::EvaluatorWithBaseImpl< Traits >.

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

Phalanx_Evaluator_AliasField.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename EvalT, typename Traits> class PHX::AliasField< EvalT, Traits >

Member Function Documentation

template<typename EvalT, typename Traits>
class PHX::AliasField< EvalT, Traits >