#include <Panzer_ResponseEvaluatorFactory_Functional.hpp>

Inheritance diagram for panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >:

Public Member Functions
	ResponseEvaluatorFactory_Functional (MPI_Comm comm, int cubatureDegree=1, bool requiresCellIntegral=true, const std::string &quadPointField="", const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &linearObjFactory=Teuchos::null, bool applyDirichletToDerivative=false)

virtual	~ResponseEvaluatorFactory_Functional ()

virtual Teuchos::RCP < ResponseBase >	buildResponseObject (const std::string &responseName) const

virtual Teuchos::RCP < ResponseBase >	buildResponseObject (const std::string &responseName, const std::vector< WorksetDescriptor > &) const

virtual void	buildAndRegisterEvaluators (const std::string &responseName, PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &physicsBlock, const Teuchos::ParameterList &user_data) const

virtual bool	typeSupported () const

Public Member Functions inherited from panzer::ResponseEvaluatorFactory< EvalT >
	ResponseEvaluatorFactory ()

virtual	~ResponseEvaluatorFactory ()

Public Member Functions inherited from panzer::ResponseEvaluatorFactoryBase
	ResponseEvaluatorFactoryBase ()

virtual	~ResponseEvaluatorFactoryBase ()

Public Member Functions inherited from panzer::EvaluatorsRegistrar
int	setDetailsIndex (const int details_index)

int	getDetailsIndex () const
	Get the WorksetDetails index. More...

Protected Member Functions
int	getCubatureDegree () const
	Accessor method for Cubature degree (can be used by sub classes) More...

Protected Member Functions inherited from panzer::EvaluatorsRegistrar
	EvaluatorsRegistrar ()
	Default ctor initializes WorksetDetails index to 0. More...

virtual	~EvaluatorsRegistrar ()

template<typename EvalT >
void	registerEvaluator (PHX::FieldManager< panzer::Traits > &fm, const Teuchos::RCP< PHX::Evaluator< panzer::Traits > > &op) const

Private Attributes
MPI_Comm	comm_

int	cubatureDegree_

bool	requiresCellIntegral_

std::string	quadPointField_

Teuchos::RCP< const panzer::LinearObjFactory < panzer::Traits > >	linearObjFactory_

bool	applyDirichletToDerivative_

Detailed Description

template<typename EvalT, typename LO, typename GO>
class panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >

This class defines a response based on a functional.

Definition at line 31 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename LO , typename GO >

panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::ResponseEvaluatorFactory_Functional	(	MPI_Comm	comm,
		int	cubatureDegree = `1`,
		bool	requiresCellIntegral = `true`,
		const std::string &	quadPointField = `""`,
		const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &	linearObjFactory = `Teuchos::null`,
		bool	applyDirichletToDerivative = `false`
	)

inline

Definition at line 34 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

virtual panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::~ResponseEvaluatorFactory_Functional ( )

inlinevirtual

Definition at line 42 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

Member Function Documentation

template<typename EvalT , typename LO , typename GO >

Teuchos::RCP< ResponseBase > panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::buildResponseObject ( const std::string & responseName ) const

virtual

Build the response object used by this factory. This object assumes the role of the scatter target and will be accessible by all the evaluators in the field managers.

Parameters

[in] responseName Name of response to be built. This name will be used for looking up the response in the GlobalEvaluationDataContainer object.

Definition at line 30 of file Panzer_ResponseEvaluatorFactory_Functional_impl.hpp.

template<typename EvalT , typename LO , typename GO >

virtual Teuchos::RCP<ResponseBase> panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::buildResponseObject	(	const std::string &	responseName,
		const std::vector< WorksetDescriptor > &	wkstdescs
	)		const

inlinevirtual

Build the response object used by this factory. This object assumes the role of the scatter target and will be accessible by all the evaluators in the field managers. This is the sideset version of the buildResponseObject function.

Parameters

[in]	responseName	Name of response to be built. This name will be used for looking up the response in the `GlobalEvaluationDataContainer` object.
[in]	wkstdescs	A vector of descriptors for the elements this response is over.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 55 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

void panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::buildAndRegisterEvaluators	(	const std::string &	responseName,
		PHX::FieldManager< panzer::Traits > &	fm,
		const panzer::PhysicsBlock &	physicsBlock,
		const Teuchos::ParameterList &	user_data
	)		const

virtual

Build and register evaluators for a response on a particular physics block.

Parameters

[in]	responseName	The name of the response to be constructed by these evaluators.
[in,out]	fm	Field manager to be fuild with the evaluators.
[in]	physicsBlock	What physics block is being used for constructing the evaluators
[in]	user_data	The user data parameter list, this stores things that the user may find useful.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 40 of file Panzer_ResponseEvaluatorFactory_Functional_impl.hpp.

template<typename EvalT , typename LO , typename GO >

bool panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::typeSupported ( ) const

virtual

Is this evaluation type supported by the factory. This is used to determine cases where a response may support a particular evaluation type, however at runtime the user decides not to enable the (say) Jacobian evaluation of this response.

Note that use of this mechanism is complementary to having the builder return Teuchos::null for a particular evaluation type.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 107 of file Panzer_ResponseEvaluatorFactory_Functional_impl.hpp.

template<typename EvalT , typename LO , typename GO >

int panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::getCubatureDegree ( ) const

inlineprotected

Accessor method for Cubature degree (can be used by sub classes)

Definition at line 86 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

Member Data Documentation

template<typename EvalT , typename LO , typename GO >

MPI_Comm panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::comm_

private

Definition at line 89 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

int panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::cubatureDegree_

private

Definition at line 90 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

bool panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::requiresCellIntegral_

private

Definition at line 91 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

std::string panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::quadPointField_

private

Definition at line 92 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::linearObjFactory_

private

Definition at line 93 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

template<typename EvalT , typename LO , typename GO >

bool panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >::applyDirichletToDerivative_

private

Definition at line 94 of file Panzer_ResponseEvaluatorFactory_Functional.hpp.

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<typename EvalT, typename LO, typename GO> class panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename EvalT, typename LO, typename GO>
class panzer::ResponseEvaluatorFactory_Functional< EvalT, LO, GO >