Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
panzer::Response_Residual< panzer::Traits::Residual > Class Template Reference

#include <Panzer_Response_Residual.hpp>

Inheritance diagram for panzer::Response_Residual< panzer::Traits::Residual >:
Inheritance graph
[legend]

Public Member Functions

 Response_Residual (const std::string &responseName, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof)
 
virtual ~Response_Residual ()
 
Teuchos::RCP
< Thyra::VectorBase
< panzer::Traits::RealType > > 
getGhostedResidual () const
 
Teuchos::RCP
< Thyra::VectorBase
< panzer::Traits::RealType > > 
getResidual () const
 
void setResidual (const Teuchos::RCP< Thyra::VectorBase< panzer::Traits::RealType > > &res)
 
Teuchos::RCP
< Thyra::VectorBase
< panzer::Traits::RealType > > 
allocateResidualVector () const
 
virtual void initializeResponse ()
 
virtual void scatterResponse ()
 Prepare the response for access by the user (do global communication) More...
 
- Public Member Functions inherited from panzer::ResponseBase
 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 ()
 
- 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...
 

Private Attributes

Teuchos::RCP< const
panzer::LinearObjFactory
< panzer::Traits > > 
linObjFactory_
 
Teuchos::RCP
< Thyra::VectorBase
< panzer::Traits::RealType > > 
residual_
 
Teuchos::RCP
< Thyra::VectorBase
< panzer::Traits::RealType > > 
ghostedResidual_
 

Additional Inherited Members

- Static Public Member Functions inherited from panzer::ResponseBase
static std::string buildLookupName (const std::string &responseName)
 

Detailed Description

template<>
class panzer::Response_Residual< panzer::Traits::Residual >

This is the response object used for calculation of the residual. This class uses the LOF to construct a ghosted residual object. A user can uses class members to construct a compatible residual object and then set it as the residual for this response to fill.

Definition at line 81 of file Panzer_Response_Residual.hpp.

Constructor & Destructor Documentation

Definition at line 90 of file Panzer_Response_Residual.hpp.

Definition at line 94 of file Panzer_Response_Residual.hpp.

Member Function Documentation

Access the ghosted residual object. Note that this method will not return null. When called for the first time this will use the LOF to construct a ghosted residual.

Definition at line 15 of file Panzer_Response_Residual.cpp.

Access the residual. This method can return null, but will only return the residual class set by setResidual.

Definition at line 36 of file Panzer_Response_Residual.cpp.

Set the residual to use. If set to null, the internal residual will be lost. This is assumed to be correctly sized.

Definition at line 43 of file Panzer_Response_Residual.cpp.

Build a correctly sized residual vector. This is a conenience, it wraps the linear object factory.

Definition at line 50 of file Panzer_Response_Residual.cpp.

virtual void panzer::Response_Residual< panzer::Traits::Residual >::initializeResponse ( )
inlinevirtual

Implements panzer::ResponseBase.

Definition at line 117 of file Panzer_Response_Residual.hpp.

virtual void panzer::Response_Residual< panzer::Traits::Residual >::scatterResponse ( )
inlinevirtual

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

Implements panzer::ResponseBase.

Definition at line 118 of file Panzer_Response_Residual.hpp.

Member Data Documentation

Definition at line 83 of file Panzer_Response_Residual.hpp.

Definition at line 85 of file Panzer_Response_Residual.hpp.

Definition at line 86 of file Panzer_Response_Residual.hpp.


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