Panzer Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
panzer::ResponseBase Class Referenceabstract

#include <Panzer_ResponseBase.hpp>

Inheritance diagram for panzer::ResponseBase:
Inheritance graph
[legend]

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,.
 
virtual void initializeData ()
 
virtual void scatterResponse ()=0
 Prepare the response for access by the user (do global communication)
 
virtual void initializeResponse ()=0
 
- Public Member Functions inherited from panzer::GlobalEvaluationData_Default
 GlobalEvaluationData_Default ()
 
 GlobalEvaluationData_Default (const GlobalEvaluationData_Default &s)
 
virtual void ghostToGlobal (int)
 
virtual void globalToGhost (int)
 
virtual void initializeData ()
 
void setRequiresDirichletAdjustment (bool b)
 
bool requiresDirichletAdjustment () const
 
- Public Member Functions inherited from panzer::GlobalEvaluationData
virtual ~GlobalEvaluationData ()=0
 
virtual void ghostToGlobal (int mem)=0
 
virtual void globalToGhost (int mem)=0
 
virtual bool requiresDirichletAdjustment () const =0
 
virtual void initializeData ()=0
 
virtual void print (std::ostream &os) const
 Diagnostic function for determinning what's in this object.
 

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 59 of file Panzer_ResponseBase.hpp.

Constructor & Destructor Documentation

◆ ResponseBase() [1/3]

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 67 of file Panzer_ResponseBase.hpp.

◆ ~ResponseBase()

virtual panzer::ResponseBase::~ResponseBase ( )
inlinevirtual

Definition at line 70 of file Panzer_ResponseBase.hpp.

◆ ResponseBase() [2/3]

panzer::ResponseBase::ResponseBase ( )
private

◆ ResponseBase() [3/3]

panzer::ResponseBase::ResponseBase ( const ResponseBase )
private

Member Function Documentation

◆ getName()

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

Get the unmodified name for this response.

Definition at line 74 of file Panzer_ResponseBase.hpp.

◆ getLookupName()

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

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

Definition at line 79 of file Panzer_ResponseBase.hpp.

◆ buildLookupName()

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 84 of file Panzer_ResponseBase.hpp.

◆ ghostToGlobal()

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

Inherited from GlobalEvaluationData,.

Reimplemented from panzer::GlobalEvaluationData_Default.

Definition at line 88 of file Panzer_ResponseBase.hpp.

◆ initializeData()

virtual void panzer::ResponseBase::initializeData ( )
inlinevirtual

Reimplemented from panzer::GlobalEvaluationData_Default.

Definition at line 91 of file Panzer_ResponseBase.hpp.

◆ scatterResponse()

virtual void panzer::ResponseBase::scatterResponse ( )
pure virtual

◆ initializeResponse()

virtual void panzer::ResponseBase::initializeResponse ( )
pure virtual

Member Data Documentation

◆ responseName_

std::string panzer::ResponseBase::responseName_
private

Definition at line 101 of file Panzer_ResponseBase.hpp.


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