#include <Panzer_ResponseScatterEvaluator_Functional.hpp>

Inheritance diagram for panzer::ResponseScatterEvaluator_Functional< EvalT, Traits >:

[legend]

Public Member Functions
	ResponseScatterEvaluator_Functional (const std::string &name, const CellData &cd, const Teuchos::RCP< FunctionalScatterBase > &functionalScatter)
	A constructor with concrete arguments instead of a parameter list.

	ResponseScatterEvaluator_Functional (const std::string &integrandName, const std::string &responseName, const CellData &cd, const Teuchos::RCP< FunctionalScatterBase > &functionalScatter)
	Construct with distinct names for the upstream integrand field and the response it feeds.

void	evaluateFields (typename Traits::EvalData d)
	Sums this workset's per-cell integrand values (and scatters derivatives, via scatterObj_) into the response.

void	preEvaluate (typename Traits::PreEvalData d)
	Looks up the Response_Functional to accumulate into for the upcoming fill.

void	evaluateFields (panzer::Traits::EvalData d)

void	evaluateFields (panzer::Traits::EvalData d)

Public Member Functions inherited from panzer::EvaluatorWithBaseImpl< Traits >
void	setDetailsIndex (const int di)
	An evaluator builder sets the details index.

Public Member Functions inherited from panzer::DomainEvaluator
	DomainEvaluator (DomainType domain=ALL)
	Constructor.

virtual	~DomainEvaluator ()=default
	Default destructor.

void	setDomain (const DomainType domain)
	Set the domain for the evaluator.

DomainType	getDomain ()
	Get the domain for the evaluator.

virtual int	cellStartIndex (const panzer::Workset &workset) const
	Returns the starting cell for the specified domain for a given workset.

virtual int	cellEndIndex (const panzer::Workset &workset) const
	Returns the non-inclusive end cell for the specified domain for a given workset.

Private Types
typedef EvalT::ScalarT	ScalarT

Private Attributes
std::string	responseName_
	Name of the response this evaluator contributes to.

Teuchos::RCP< Response_Functional< EvalT > >	responseObj_
	The response object accumulated into by evaluateFields().

Teuchos::RCP< PHX::FieldTag >	scatterHolder_

PHX::MDField< const ScalarT, panzer::Cell >	cellIntegral_

Teuchos::RCP< FunctionalScatterBase >	scatterObj_
	Used to scatter derivative/Hessian information into the response's global vectors.

Additional Inherited Members
Public Types inherited from panzer::DomainEvaluator
enum	DomainType : int { OWNED =0 , GHOST =1 , REAL =2 , VIRTUAL =3 , EXTERNAL =4 , ALL =5 }
	Domain types supported by worksets. More...

Protected Attributes inherited from panzer::EvaluatorWithBaseImpl< Traits >
WorksetDetailsAccessor	wda

Detailed Description

template<typename EvalT, typename Traits>
class panzer::ResponseScatterEvaluator_Functional< EvalT, Traits >

This class handles responses with values aggregated on each finite element cell.

It depends on a "Cell Integral" field (an integrand already integrated over each cell) having been computed upstream in the evaluation DAG under the integrand name; evaluateFields() sums that field into the associated Response_Functional, and for the Jacobian/Hessian evaluation types, hands its derivatives off to a FunctionalScatterBase to accumulate into the response's global gradient / Hessian-vector product.

Definition at line 123 of file Panzer_ResponseScatterEvaluator_Functional.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalT , typename Traits >

typedef EvalT::ScalarT panzer::ResponseScatterEvaluator_Functional< EvalT, Traits >::ScalarT

private

Definition at line 153 of file Panzer_ResponseScatterEvaluator_Functional.hpp.

Constructor & Destructor Documentation

◆ ResponseScatterEvaluator_Functional() [1/2]

template<typename EvalT , typename Traits >

panzer::ResponseScatterEvaluator_Functional< EvalT, Traits >::ResponseScatterEvaluator_Functional	(	const std::string &	name,
		const CellData &	cd,
		const Teuchos::RCP< FunctionalScatterBase > &	functionalScatter
	)

A constructor with concrete arguments instead of a parameter list.

Construct where the response name and the upstream integrand field name are the same.

Parameters

[in]	name	name of both the upstream "Cell Integral" field to sum and the response it feeds.
[in]	cd	cell data (dimension, workset size) for the field data layout.
[in]	functionalScatter	used to scatter derivative/Hessian information into the response's global vectors.

This class handles responses with values aggregated on each finite element cell.

Definition at line 39 of file Panzer_ResponseScatterEvaluator_Functional_impl.hpp.

◆ ResponseScatterEvaluator_Functional() [2/2]

template<typename EvalT , typename Traits >

panzer::ResponseScatterEvaluator_Functional< EvalT, Traits >::ResponseScatterEvaluator_Functional	(	const std::string &	integrandName,
		const std::string &	responseName,
		const CellData &	cd,
		const Teuchos::RCP< FunctionalScatterBase > &	functionalScatter
	)

Construct with distinct names for the upstream integrand field and the response it feeds.

Parameters

[in]	integrandName	name of the upstream "Cell Integral" field to sum.
[in]	responseName	name of the response this evaluator contributes to.
[in]	cd	cell data (dimension, workset size) for the field data layout.
[in]	functionalScatter	used to scatter derivative/Hessian information into the response's global vectors.