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::EpetraVector_Write_GlobalEvaluationData Class Reference

This class provides a boundary exchange communication mechanism for vectors. More...

#include <Panzer_EpetraVector_Write_GlobalEvaluationData.hpp>

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

Public Member Functions

 EpetraVector_Write_GlobalEvaluationData ()
 Default Constructor. More...
 
 EpetraVector_Write_GlobalEvaluationData (const EpetraVector_Write_GlobalEvaluationData &src)
 Copy Constructor. More...
 
 EpetraVector_Write_GlobalEvaluationData (const Teuchos::RCP< const Epetra_Export > &exporter, const Teuchos::RCP< const Epetra_Map > &ghostedMap, const Teuchos::RCP< const Epetra_Map > &ownedMap)
 Initializing Constructor. More...
 
void initialize (const Teuchos::RCP< const Epetra_Export > &exporter, const Teuchos::RCP< const Epetra_Map > &ghostedMap, const Teuchos::RCP< const Epetra_Map > &ownedMap)
 Initialize this object with some Epetra communication objects. More...
 
virtual void ghostToGlobal (int mem)
 Communicate the ghosted data to the owned vector. More...
 
virtual void initializeData ()
 Clear out the ghosted vector. // JMG: Is this right? More...
 
virtual bool requiresDirichletAdjustment () const
 Determine if a Dirichlet adjustment is necessary. More...
 
void setOwnedVector_Epetra (const Teuchos::RCP< Epetra_Vector > &ownedVector)
 Set the owned vector (Epetra version). More...
 
Teuchos::RCP< Epetra_VectorgetGhostedVector_Epetra () const
 Get the ghosted vector (Epetra version). More...
 
void setOwnedVector (const Teuchos::RCP< Thyra::VectorBase< double >> &ownedVector)
 Set the owned vector (Thyra version). More...
 
Teuchos::RCP
< Thyra::VectorBase< double > > 
getOwnedVector () const
 Get the owned vector (Thyra version). More...
 
Teuchos::RCP
< Thyra::VectorBase< double > > 
getGhostedVector () const
 Get the ghosted vector (Thyra version). More...
 
virtual bool isInitialized () const
 Is this object initialized? More...
 
void print (std::ostream &os) const
 Print the object. More...
 
- Public Member Functions inherited from panzer::WriteVector_GlobalEvaluationData
 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 void globalToGhost (int)
 
virtual void setOwnedVector (const Teuchos::RCP< Thyra::VectorBase< double > > &ownedVector)=0
 Set the owned vector. More...
 
double & operator[] (const int &lid)
 Element access. More...
 
- Public Member Functions inherited from panzer::GlobalEvaluationData
virtual ~GlobalEvaluationData ()=0
 

Private Attributes

bool isInitialized_
 A flag indicating whether or not the object has been initialized. More...
 
Teuchos::RCP< const Epetra_MapghostedMap_
 The map corresponding to the ghosted vector. More...
 
Teuchos::RCP< const Epetra_MapownedMap_
 The map corresponding to the owned vector. More...
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< double > > 
ghostedSpace_
 The vector space corresponding to the ghosted vector. More...
 
Teuchos::RCP< const
Thyra::VectorSpaceBase< double > > 
ownedSpace_
 The vector space corresponding to the owned vector. More...
 
Teuchos::RCP< const Epetra_Exportexporter_
 The exporter used to communicate between the owned and ghosted vectors. More...
 
Teuchos::RCP< Epetra_VectorghostedVector_
 The ghosted vector. More...
 
Teuchos::RCP
< Thyra::VectorBase< double > > 
ownedVector_
 The owned vector. More...
 

Additional Inherited Members

- Public Types inherited from panzer::WriteVector_GlobalEvaluationData
enum  CombineMode { CM_Sum, CM_Max, CM_Min, CM_Insert }
 when you gho from ghost to global, combine with a particular mode More...
 
- Protected Attributes inherited from panzer::WriteVector_GlobalEvaluationData
panzer::kokkos_utils::VectorToViewTraits
< Epetra_Vector >::View 
ownedView_
 The Kokkos::View of the owned vector. More...
 
panzer::kokkos_utils::VectorToViewTraits
< Epetra_Vector >::View 
ghostedView_
 The Kokkos::View of the ghosted vector. More...
 

Detailed Description

This class provides a boundary exchange communication mechanism for vectors.

Note
This provides a "write" interface for parameters.

Definition at line 76 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

panzer::EpetraVector_Write_GlobalEvaluationData::EpetraVector_Write_GlobalEvaluationData ( )
inline

Default Constructor.

Definition at line 85 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

panzer::EpetraVector_Write_GlobalEvaluationData::EpetraVector_Write_GlobalEvaluationData ( const EpetraVector_Write_GlobalEvaluationData src)
inline

Copy Constructor.

Parameters
[in]srcThe object to be copied.

Definition at line 96 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

panzer::EpetraVector_Write_GlobalEvaluationData::EpetraVector_Write_GlobalEvaluationData ( const Teuchos::RCP< const Epetra_Export > &  exporter,
const Teuchos::RCP< const Epetra_Map > &  ghostedMap,
const Teuchos::RCP< const Epetra_Map > &  ownedMap 
)
inline

Initializing Constructor.

Initialize this object with some Epetra communication objects. This method must be called before an object of this type can be used.

Parameters
[in]exporterExporter for doing communication from the owned to the ghosted vector.
[in]ghostedMapMap describing the ghosted vector.
[in]ownedMapMap describing the owned vector.

Definition at line 115 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Member Function Documentation

void panzer::EpetraVector_Write_GlobalEvaluationData::initialize ( const Teuchos::RCP< const Epetra_Export > &  exporter,
const Teuchos::RCP< const Epetra_Map > &  ghostedMap,
const Teuchos::RCP< const Epetra_Map > &  ownedMap 
)

Initialize this object with some Epetra communication objects.

This method must be called before an object of this type can be used.

Parameters
[in]exporterExporter for doing communication from the owned to the ghosted vector.
[in]ghostedMapMap describing the ghosted vector.
[in]ownedMapMap describing the owned vector.

Definition at line 72 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

void panzer::EpetraVector_Write_GlobalEvaluationData::ghostToGlobal ( int  mem)
virtual

Communicate the ghosted data to the owned vector.

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

Parameters
[in]memNot needed for this class, but part of the GlobalEvaluationData interface.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 109 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

void panzer::EpetraVector_Write_GlobalEvaluationData::initializeData ( )
virtual

Clear out the ghosted vector. // JMG: Is this right?

Implements panzer::GlobalEvaluationData.

Definition at line 156 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

virtual bool panzer::EpetraVector_Write_GlobalEvaluationData::requiresDirichletAdjustment ( ) const
inlinevirtual

Determine if a Dirichlet adjustment is necessary.

Returns
False. // JMG: But why?

Implements panzer::GlobalEvaluationData.

Definition at line 166 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

void panzer::EpetraVector_Write_GlobalEvaluationData::setOwnedVector_Epetra ( const Teuchos::RCP< Epetra_Vector > &  ownedVector)

Set the owned vector (Epetra version).

Parameters
[in]ownedVectorAn Epetra_Vector that you would like to set as the owned vector.

Definition at line 173 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

Teuchos::RCP< Epetra_Vector > panzer::EpetraVector_Write_GlobalEvaluationData::getGhostedVector_Epetra ( ) const

Get the ghosted vector (Epetra version).

Returns
The ghosted vector as an Epetra_Vector.

Definition at line 193 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

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

Set the owned vector (Thyra version).

Parameters
[in]ownedVectorA Thyra::VectorBase<double> that you would like to set as the owned vector.

Definition at line 212 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

Teuchos::RCP< Thyra::VectorBase< double > > panzer::EpetraVector_Write_GlobalEvaluationData::getOwnedVector ( ) const
virtual

Get the owned vector (Thyra version).

Returns
The owned vector as a Thyra::VectorBase<double>.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 231 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

Teuchos::RCP< Thyra::VectorBase< double > > panzer::EpetraVector_Write_GlobalEvaluationData::getGhostedVector ( ) const
virtual

Get the ghosted vector (Thyra version).

Returns
The ghosted vector as a Thyra::VectorBase<double>.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 247 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

virtual bool panzer::EpetraVector_Write_GlobalEvaluationData::isInitialized ( ) const
inlinevirtual

Is this object initialized?

Returns
Whether or not this object is initialized.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 221 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

void panzer::EpetraVector_Write_GlobalEvaluationData::print ( std::ostream &  os) const
virtual

Print the object.

This is a diagnostic function for debugging purposes.

Parameters
[in,out]osThe output stream to which the data should be printed.

Reimplemented from panzer::GlobalEvaluationData.

Definition at line 267 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

Member Data Documentation

bool panzer::EpetraVector_Write_GlobalEvaluationData::isInitialized_
private

A flag indicating whether or not the object has been initialized.

Definition at line 244 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<const Epetra_Map> panzer::EpetraVector_Write_GlobalEvaluationData::ghostedMap_
private

The map corresponding to the ghosted vector.

Definition at line 249 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<const Epetra_Map> panzer::EpetraVector_Write_GlobalEvaluationData::ownedMap_
private

The map corresponding to the owned vector.

Definition at line 254 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<const Thyra::VectorSpaceBase<double> > panzer::EpetraVector_Write_GlobalEvaluationData::ghostedSpace_
private

The vector space corresponding to the ghosted vector.

Definition at line 259 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<const Thyra::VectorSpaceBase<double> > panzer::EpetraVector_Write_GlobalEvaluationData::ownedSpace_
private

The vector space corresponding to the owned vector.

Definition at line 264 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<const Epetra_Export> panzer::EpetraVector_Write_GlobalEvaluationData::exporter_
private

The exporter used to communicate between the owned and ghosted vectors.

Definition at line 270 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<Epetra_Vector> panzer::EpetraVector_Write_GlobalEvaluationData::ghostedVector_
private

The ghosted vector.

Definition at line 275 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Teuchos::RCP<Thyra::VectorBase<double> > panzer::EpetraVector_Write_GlobalEvaluationData::ownedVector_
private

The owned vector.

Definition at line 280 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.


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