#include <Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp>

Inheritance diagram for panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >:

[legend]

Classes
struct	RemovedFieldsSearchUnaryFunctor

Public Member Functions
	ResponseEvaluatorFactory_SolutionWriter (const Teuchos::RCP< STK_Interface > &mesh)
	Construct with the mesh to write solutions to. Solution and coordinate fields are added by default.

virtual	~ResponseEvaluatorFactory_SolutionWriter ()

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

virtual Teuchos::RCP< panzer::ResponseBase >	buildResponseObject (const std::string &responseName, const std::vector< panzer::WorksetDescriptor > &) const
	Equivalent to buildResponseObject(responseName); the workset descriptor list is not used.

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

void	scaleField (const std::string &fieldName, double fieldScalar)

void	addAdditionalField (const std::string &fieldName, const Teuchos::RCP< const panzer::PureBasis > &basis)

void	setAddSolutionFields (bool asf)

void	setAddCoordinateFields (bool acf)

void	removeField (const std::string &fieldName)

void	computeReferenceCentroid (const std::map< std::string, Teuchos::RCP< const panzer::PureBasis > > &bases, int baseDimension, Kokkos::DynRankView< double, PHX::Device > &centroid) const
	Computes the reference-cell centroid coordinates for each of the given bases.

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.

Static Public Member Functions
static void	bucketByBasisType (const std::vector< std::pair< std::string, Teuchos::RCP< const panzer::PureBasis > > > &providedDofs, std::map< std::string, std::vector< std::string > > &basisBucket)

Private Member Functions
void	deleteRemovedFields (const std::vector< std::string > &removedFields, std::vector< std::pair< std::string, Teuchos::RCP< const panzer::PureBasis > > > &fields) const
	Delete from the argument all the fields that are in the removedFields array.

Private Attributes
Teuchos::RCP< STK_Interface >	mesh_

std::unordered_map< std::string, double >	fieldToScalar_

std::unordered_set< std::string >	scaledFieldsHash_

std::vector< std::pair< std::string, Teuchos::RCP< const panzer::PureBasis > > >	additionalFields_

std::vector< std::string >	removedFields_

bool	addSolutionFields_

bool	addCoordinateFields_

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

virtual	~EvaluatorsRegistrar ()

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

Detailed Description

template<typename EvalT>
class panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >

This class defines a response based solution writer.

Definition at line 35 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

Constructor & Destructor Documentation

◆ ResponseEvaluatorFactory_SolutionWriter()

template<typename EvalT >

panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::ResponseEvaluatorFactory_SolutionWriter ( const Teuchos::RCP< STK_Interface > & mesh )

inline

Construct with the mesh to write solutions to. Solution and coordinate fields are added by default.

Definition at line 39 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

◆ ~ResponseEvaluatorFactory_SolutionWriter()

template<typename EvalT >

virtual panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::~ResponseEvaluatorFactory_SolutionWriter ( )

inlinevirtual

Definition at line 42 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

Member Function Documentation

◆ buildResponseObject() [1/2]

template<typename EvalT >

Teuchos::RCP< panzer::ResponseBase > panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::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 41 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ buildResponseObject() [2/2]

template<typename EvalT >

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

inlinevirtual

Equivalent to buildResponseObject(responseName); the workset descriptor list is not used.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 56 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

◆ buildAndRegisterEvaluators()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::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 48 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ typeSupported()

template<typename EvalT >

bool panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::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 330 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ bucketByBasisType()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::bucketByBasisType	(	const std::vector< std::pair< std::string, Teuchos::RCP< const panzer::PureBasis > > > &	providedDofs,
		std::map< std::string, std::vector< std::string > > &	basisBucket
	)

static

Take a vector of (std::string (field name), RCP<PureBasis>) pairs and bucket them by basis name. What is returned is a map pairing the basis to a vector of field names.

Definition at line 270 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ scaleField()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::scaleField	(	const std::string &	fieldName,
		double	fieldScalar
	)

Scale a field before writing out to STK by a prescribed value (the implicit default is 1.0). A warning will be printed if no field is found of that name when buildAndRegisterEvaluators is called.

Note: Currently only works for HGRAD fields.

Parameters

[in]	fieldName	HGRAD field to scale.
[in]	fieldScalar	Value to scale the field by.

Definition at line 322 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ addAdditionalField()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::addAdditionalField	(	const std::string &	fieldName,
		const Teuchos::RCP< const panzer::PureBasis > &	basis
	)

Add an additional (solution) field to write out that is not in the physics blocks.

Definition at line 340 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ setAddSolutionFields()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::setAddSolutionFields ( bool asf )

inline

Enable/disable addition of solution fields. Note that this "true" by default.

Definition at line 108 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

◆ setAddCoordinateFields()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::setAddCoordinateFields ( bool acf )

inline

Enable/disable addition of coordinate fields. Note that this "true" by default.

Definition at line 113 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

◆ removeField()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::removeField ( const std::string & fieldName )

inline

Remove a field (even a solution field) from the response. Note that even if a field has not been added, it will be removed by any previous or following call to removeField. This implies that removeField takes precedence.

Definition at line 120 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter.hpp.

◆ computeReferenceCentroid()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::computeReferenceCentroid	(	const std::map< std::string, Teuchos::RCP< const panzer::PureBasis > > &	bases,
		int	baseDimension,
		Kokkos::DynRankView< double, PHX::Device > &	centroid
	)		const

Computes the reference-cell centroid coordinates for each of the given bases.

Definition at line 284 of file Panzer_STK_ResponseEvaluatorFactory_SolutionWriter_impl.hpp.

◆ deleteRemovedFields()

template<typename EvalT >

void panzer_stk::ResponseEvaluatorFactory_SolutionWriter< EvalT >::deleteRemovedFields	(	const std::vector< std::string > &	removedFields,
		std::vector< std::pair< std::string, Teuchos::RCP< const panzer::PureBasis > > > &	fields
	)		const