Panzer  Version of the Day
Public Member Functions | Private Types | Private Attributes | List of all members
panzer::EpetraVector_ReadOnly_GlobalEvaluationData Class Reference

#include <Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp>

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

Public Member Functions

 EpetraVector_ReadOnly_GlobalEvaluationData ()
 Default constructor. More...
 
 EpetraVector_ReadOnly_GlobalEvaluationData (const EpetraVector_ReadOnly_GlobalEvaluationData &src)
 
 EpetraVector_ReadOnly_GlobalEvaluationData (const Teuchos::RCP< const Epetra_Import > &importer, const Teuchos::RCP< const Epetra_Map > &ghostedMap, const Teuchos::RCP< const Epetra_Map > &ownedMap)
 
void useConstantValues (const std::vector< int > &indices, double value)
 
void initialize (const Teuchos::RCP< const Epetra_Import > &importer, const Teuchos::RCP< const Epetra_Map > &ghostedMap, const Teuchos::RCP< const Epetra_Map > &ownedMap)
 
virtual void globalToGhost (int mem)
 
virtual void initializeData ()
 Clear out the ghosted vector. More...
 
virtual void ghostToGlobal (int mem)
 For this class this method does nothing. More...
 
virtual bool requiresDirichletAdjustment () const
 Nothing to do (its read only) More...
 
void setOwnedVector_Epetra (const Teuchos::RCP< const 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< const Thyra::VectorBase< double > > &ownedVector)
 Set the owned vector (Thyra version) More...
 
Teuchos::RCP< const 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...
 
bool isInitialized () const
 Is this object initialized. More...
 
void print (std::ostream &os) const
 Diagnostic function. More...
 
- Public Member Functions inherited from panzer::ReadOnlyVector_GlobalEvaluationData
virtual ~ReadOnlyVector_GlobalEvaluationData ()
 Virtual d. More...
 
- Public Member Functions inherited from panzer::GlobalEvaluationData
virtual ~GlobalEvaluationData ()=0
 

Private Types

typedef std::pair< std::vector< int >, double > FilteredPair
 

Private Attributes

bool isInitialized_
 
Teuchos::RCP< const Epetra_MapghostedMap_
 
Teuchos::RCP< const Epetra_MapownedMap_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ghostedSpace_
 
Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ownedSpace_
 
Teuchos::RCP< const Epetra_Importimporter_
 
Teuchos::RCP< Epetra_VectorghostedVector_
 
Teuchos::RCP< const Thyra::VectorBase< double > > ownedVector_
 
std::vector< FilteredPairfilteredPairs_
 

Detailed Description

This class provides a boundary exchange communication mechanism for vectors. Not this provides a "read only" (RO) interface for parameters (so vectors are write protected).

Definition at line 63 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

Member Typedef Documentation

◆ FilteredPair

typedef std::pair<std::vector<int>,double> panzer::EpetraVector_ReadOnly_GlobalEvaluationData::FilteredPair
private

Constructor & Destructor Documentation

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [1/3]

panzer::EpetraVector_ReadOnly_GlobalEvaluationData::EpetraVector_ReadOnly_GlobalEvaluationData ( )
inline

Default constructor.

Definition at line 67 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [2/3]

panzer::EpetraVector_ReadOnly_GlobalEvaluationData::EpetraVector_ReadOnly_GlobalEvaluationData ( const EpetraVector_ReadOnly_GlobalEvaluationData src)
inline

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [3/3]

panzer::EpetraVector_ReadOnly_GlobalEvaluationData::EpetraVector_ReadOnly_GlobalEvaluationData ( const Teuchos::RCP< const Epetra_Import > &  importer,
const Teuchos::RCP< const Epetra_Map > &  ghostedMap,
const Teuchos::RCP< const Epetra_Map > &  ownedMap 
)
inline

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

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

Definition at line 81 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

Member Function Documentation

◆ useConstantValues()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::useConstantValues ( const std::vector< int > &  indices,
double  value 
)

Choose a few GIDs and instead of zeroing them out in the ghosted vector set them to a specified value. Note that this is only useful for GIDs in the ghosted map that are not in the owned map.

This must be called before initialize. Also note that no attempt to synchronize these values a cross a processor is made. So its up to the user to be consistent.

Definition at line 16 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ initialize()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::initialize ( const Teuchos::RCP< const Epetra_Import > &  importer,
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]importerImporter for doing communication from the owned to the ghosted vector.
[in]ghostedMapMap describing the ghosted vector.
[in]ownedMapMap describing the ghosted vector.

Definition at line 30 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ globalToGhost()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::globalToGhost ( int  mem)
virtual

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

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 67 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ initializeData()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::initializeData ( )
virtual

Clear out the ghosted vector.

Implements panzer::GlobalEvaluationData.

Definition at line 84 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ ghostToGlobal()

virtual void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::ghostToGlobal ( int  mem)
inlinevirtual

For this class this method does nothing.

Reimplemented from panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 116 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ requiresDirichletAdjustment()

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

Nothing to do (its read only)

Implements panzer::GlobalEvaluationData.

Definition at line 119 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ setOwnedVector_Epetra()

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

Set the owned vector (Epetra version)

Definition at line 102 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getGhostedVector_Epetra()

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

Get the ghosted vector (Epetra version)

Definition at line 110 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ setOwnedVector()

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

Set the owned vector (Thyra version)

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 120 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getOwnedVector()

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

Get the owned vector (Thyra version)

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 136 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getGhostedVector()

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

Get the ghosted vector (Thyra version)

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 146 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ isInitialized()

bool panzer::EpetraVector_ReadOnly_GlobalEvaluationData::isInitialized ( ) const
inlinevirtual

Is this object initialized.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 139 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ print()

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

Diagnostic function.

Reimplemented from panzer::GlobalEvaluationData.

Definition at line 156 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

Member Data Documentation

◆ isInitialized_

bool panzer::EpetraVector_ReadOnly_GlobalEvaluationData::isInitialized_
private

◆ ghostedMap_

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

◆ ownedMap_

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

◆ ghostedSpace_

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

◆ ownedSpace_

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

◆ importer_

Teuchos::RCP<const Epetra_Import> panzer::EpetraVector_ReadOnly_GlobalEvaluationData::importer_
private

◆ ghostedVector_

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

◆ ownedVector_

Teuchos::RCP<const Thyra::VectorBase<double> > panzer::EpetraVector_ReadOnly_GlobalEvaluationData::ownedVector_
private

◆ filteredPairs_

std::vector<FilteredPair> panzer::EpetraVector_ReadOnly_GlobalEvaluationData::filteredPairs_
private

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