panzer::ResponseBase Class Reference

#include <Panzer_ResponseBase.hpp>

Inheritance diagram for panzer::ResponseBase:

Public Member Functions
	ResponseBase (const std::string &responseName)
virtual	~ResponseBase ()
std::string	getName () const
std::string	getLookupName () const
virtual void	ghostToGlobal (int)
	Inherited from GlobalEvaluationData,. More...
virtual void	initializeData ()
virtual void	scatterResponse ()=0
	Prepare the response for access by the user (do global communication) More...
virtual void	initializeResponse ()=0
Public Member Functions inherited from panzer::GlobalEvaluationData_Default
	GlobalEvaluationData_Default ()
	GlobalEvaluationData_Default (const GlobalEvaluationData_Default &s)
virtual void	globalToGhost (int)
void	setRequiresDirichletAdjustment (bool b)
bool	requiresDirichletAdjustment () const
Public Member Functions inherited from panzer::GlobalEvaluationData
virtual	~GlobalEvaluationData ()=0
virtual void	print (std::ostream &os) const
	Diagnostic function for determinning what's in this object. More...

Static Public Member Functions
static std::string	buildLookupName (const std::string &responseName)

Private Member Functions
	ResponseBase ()
	ResponseBase (const ResponseBase &)

Private Attributes
std::string	responseName_

Detailed Description

This object serves as the base class which the user derives from to build there response. Note that by itself the interface for this is not useful for storing data.

Definition at line 27 of file Panzer_ResponseBase.hpp.

Constructor & Destructor Documentation

panzer::ResponseBase::ResponseBase ( const std::string &  responseName )

inline

Only available constructor for this object. This gurantees that the reponse object is instantiatied with a name, and gives us basic capability for name lookups.

Definition at line 35 of file Panzer_ResponseBase.hpp.

virtual panzer::ResponseBase::~ResponseBase ( )

inlinevirtual

Definition at line 38 of file Panzer_ResponseBase.hpp.

panzer::ResponseBase::ResponseBase ( )

private

panzer::ResponseBase::ResponseBase ( const ResponseBase &  )

private

Member Function Documentation

std::string panzer::ResponseBase::getName ( ) const

inline

Get the unmodified name for this response.

Definition at line 42 of file Panzer_ResponseBase.hpp.

std::string panzer::ResponseBase::getLookupName ( ) const

inline

Get the name of this response useful for looking up data containers.

Definition at line 47 of file Panzer_ResponseBase.hpp.

static std::string panzer::ResponseBase::buildLookupName ( const std::string &  responseName )

inlinestatic

Static member to build consistent look up names based on a response name.

Definition at line 52 of file Panzer_ResponseBase.hpp.

virtual void panzer::ResponseBase::ghostToGlobal ( int  )

inlinevirtual

Inherited from GlobalEvaluationData,.

Reimplemented from panzer::GlobalEvaluationData_Default.

Definition at line 56 of file Panzer_ResponseBase.hpp.

virtual void panzer::ResponseBase::initializeData ( )

inlinevirtual

Reimplemented from panzer::GlobalEvaluationData_Default.

Definition at line 59 of file Panzer_ResponseBase.hpp.

virtual void panzer::ResponseBase::scatterResponse ( )

pure virtual

Prepare the response for access by the user (do global communication)

Implemented in panzer::Response_Residual< panzer::Traits::Hessian >, panzer::Response_Residual< panzer::Traits::Jacobian >, panzer::Response_Probe< EvalT >, panzer::Response_Probe< EvalT >, panzer::Response_Functional< EvalT >, panzer::Response_ExtremeValue< EvalT >, panzer::Response_Probe< EvalT >, panzer::Response_Residual< panzer::Traits::Residual >, panzer::Response_Functional< EvalT >, panzer::Response_ExtremeValue< EvalT >, panzer::Response_ExtremeValue< EvalT >, panzer::Response_Functional< EvalT >, panzer::Response_ExtremeValue< EvalT >, panzer::Response_Probe< EvalT >, panzer::Response_Functional< EvalT >, panzer::Response_IPCoordinates< EvalT >, and panzer::Response_Residual< EvalT >.

virtual void panzer::ResponseBase::initializeResponse ( )

pure virtual

Implemented in panzer::Response_Residual< panzer::Traits::Hessian >, panzer::Response_Residual< panzer::Traits::Jacobian >, panzer::Response_Residual< panzer::Traits::Residual >, panzer::Response_ExtremeValue< EvalT >, panzer::Response_Functional< EvalT >, panzer::Response_Probe< EvalT >, panzer::Response_IPCoordinates< EvalT >, and panzer::Response_Residual< EvalT >.

Member Data Documentation

std::string panzer::ResponseBase::responseName_

private

Definition at line 69 of file Panzer_ResponseBase.hpp.

---

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

• Panzer_ResponseBase.hpp