Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
panzer::WriteVector_GlobalEvaluationData Class Referenceabstract

#include <Panzer_WriteVector_GlobalEvaluationData.hpp>

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

Public Types

enum  CombineMode { CM_Sum, CM_Max, CM_Min, CM_Insert }
 when you gho from ghost to global, combine with a particular mode More...
 

Public Member Functions

 WriteVector_GlobalEvaluationData ()
 Default constructor, set combine mode to sum right away. More...
 
virtual ~WriteVector_GlobalEvaluationData ()
 Virtual d. More...
 
void setCombineMode (CombineMode cm)
 Allow the user to set the combine mode (at any time) More...
 
CombineMode getCombineMode () const
 Get the combine mode, to be used by sub classes. More...
 
virtual bool isInitialized () const =0
 Is this object initialized. More...
 
virtual void globalToGhost (int)
 
virtual void ghostToGlobal (int mem)=0
 
virtual void setOwnedVector (const Teuchos::RCP< Thyra::VectorBase< double > > &ownedVector)=0
 Set the owned vector. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< double > > 
getOwnedVector () const =0
 Get the owned vector. More...
 
virtual Teuchos::RCP
< Thyra::VectorBase< double > > 
getGhostedVector () const =0
 Get the ghosted vector. More...
 
- Public Member Functions inherited from panzer::GlobalEvaluationData
virtual ~GlobalEvaluationData ()=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. More...
 

Private Attributes

CombineMode combineMode_
 

Detailed Description

This class encapsulates the needs of a gather operation to do a halo exchange.

Definition at line 33 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

Member Enumeration Documentation

when you gho from ghost to global, combine with a particular mode

Enumerator
CM_Sum 
CM_Max 
CM_Min 
CM_Insert 

Definition at line 37 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

panzer::WriteVector_GlobalEvaluationData::WriteVector_GlobalEvaluationData ( )
inline

Default constructor, set combine mode to sum right away.

Definition at line 40 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

virtual panzer::WriteVector_GlobalEvaluationData::~WriteVector_GlobalEvaluationData ( )
inlinevirtual

Virtual d.

Definition at line 43 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

Member Function Documentation

void panzer::WriteVector_GlobalEvaluationData::setCombineMode ( CombineMode  cm)
inline

Allow the user to set the combine mode (at any time)

Definition at line 46 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

CombineMode panzer::WriteVector_GlobalEvaluationData::getCombineMode ( ) const
inline

Get the combine mode, to be used by sub classes.

Definition at line 49 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

virtual bool panzer::WriteVector_GlobalEvaluationData::isInitialized ( ) const
pure virtual
virtual void panzer::WriteVector_GlobalEvaluationData::globalToGhost ( int  )
inlinevirtual

For this class, this method does nothing.

Implements panzer::GlobalEvaluationData.

Definition at line 57 of file Panzer_WriteVector_GlobalEvaluationData.hpp.

virtual void panzer::WriteVector_GlobalEvaluationData::ghostToGlobal ( int  mem)
pure virtual

For this class, this method does the halo exchange for the vector.

Implements panzer::GlobalEvaluationData.

Implemented in panzer::BlockedVector_Write_GlobalEvaluationData, and panzer::EpetraVector_Write_GlobalEvaluationData.

virtual void panzer::WriteVector_GlobalEvaluationData::setOwnedVector ( const Teuchos::RCP< Thyra::VectorBase< double > > &  ownedVector)
pure virtual

Set the owned vector.

virtual Teuchos::RCP<Thyra::VectorBase<double> > panzer::WriteVector_GlobalEvaluationData::getOwnedVector ( ) const
pure virtual
virtual Teuchos::RCP<Thyra::VectorBase<double> > panzer::WriteVector_GlobalEvaluationData::getGhostedVector ( ) const
pure virtual

Member Data Documentation

CombineMode panzer::WriteVector_GlobalEvaluationData::combineMode_
private

Definition at line 113 of file Panzer_WriteVector_GlobalEvaluationData.hpp.


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