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

#include <Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp>

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

Public Member Functions

 BlockedVector_ReadOnly_GlobalEvaluationData ()
 
 BlockedVector_ReadOnly_GlobalEvaluationData (const BlockedVector_ReadOnly_GlobalEvaluationData &src)
 
 BlockedVector_ReadOnly_GlobalEvaluationData (const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ghostedSpace, const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ownedSpace, const std::vector< Teuchos::RCP< ReadOnlyVector_GlobalEvaluationData > > &gedBlocks)
 
virtual ~BlockedVector_ReadOnly_GlobalEvaluationData ()
 Virtual destructor. More...
 
void initialize (const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &ghostedSpace, const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &ownedSpace, const std::vector< Teuchos::RCP< ReadOnlyVector_GlobalEvaluationData > > &gedBlocks)
 
virtual bool isInitialized () const
 Is this object initialized. More...
 
virtual void globalToGhost (int mem)
 
virtual void initializeData ()
 Initialize internal data for communication (clear the ghosted vector) More...
 
virtual void setOwnedVector (const Teuchos::RCP< const Thyra::VectorBase< double > > &ownedVector)
 Set the owned vector. More...
 
virtual Teuchos::RCP< const Thyra::VectorBase< double > > getOwnedVector () const
 Get the owned vector. More...
 
virtual Teuchos::RCP< Thyra::VectorBase< double > > getGhostedVector () const
 Get the ghosted vector. More...
 
size_t getBlockCount () const
 How many blocks are in this GED. More...
 
Teuchos::RCP< ReadOnlyVector_GlobalEvaluationDatagetGEDBlock (int i)
 Get GED block (non const version) More...
 
Teuchos::RCP< const ReadOnlyVector_GlobalEvaluationDatagetGEDBlock (int i) const
 Get GED block (const version) More...
 
bool requiresDirichletAdjustment () const
 No Dirichlet adjustment required. More...
 
- Public Member Functions inherited from panzer::ReadOnlyVector_GlobalEvaluationData
virtual ~ReadOnlyVector_GlobalEvaluationData ()
 Virtual d. More...
 
virtual void ghostToGlobal (int mem)
 
- 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

bool isInitialized_
 
std::vector< Teuchos::RCP< ReadOnlyVector_GlobalEvaluationData > > gedBlocks_
 
Teuchos::RCP< const Thyra::VectorBase< double > > ownedVector_
 
Teuchos::RCP< const Thyra::DefaultProductVectorSpace< double > > ghostedSpace_
 

Detailed Description

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

Definition at line 16 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

◆ BlockedVector_ReadOnly_GlobalEvaluationData() [1/3]

panzer::BlockedVector_ReadOnly_GlobalEvaluationData::BlockedVector_ReadOnly_GlobalEvaluationData ( )

◆ BlockedVector_ReadOnly_GlobalEvaluationData() [2/3]

panzer::BlockedVector_ReadOnly_GlobalEvaluationData::BlockedVector_ReadOnly_GlobalEvaluationData ( const BlockedVector_ReadOnly_GlobalEvaluationData src)

◆ BlockedVector_ReadOnly_GlobalEvaluationData() [3/3]

panzer::BlockedVector_ReadOnly_GlobalEvaluationData::BlockedVector_ReadOnly_GlobalEvaluationData ( const Teuchos::RCP< const Thyra::VectorSpaceBase< double > >  ghostedSpace,
const Teuchos::RCP< const Thyra::VectorSpaceBase< double > >  ownedSpace,
const std::vector< Teuchos::RCP< ReadOnlyVector_GlobalEvaluationData > > &  gedBlocks 
)

◆ ~BlockedVector_ReadOnly_GlobalEvaluationData()

virtual panzer::BlockedVector_ReadOnly_GlobalEvaluationData::~BlockedVector_ReadOnly_GlobalEvaluationData ( )
inlinevirtual

Virtual destructor.

Definition at line 28 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

Member Function Documentation

◆ initialize()

void panzer::BlockedVector_ReadOnly_GlobalEvaluationData::initialize ( const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &  ghostedSpace,
const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &  ownedSpace,
const std::vector< Teuchos::RCP< ReadOnlyVector_GlobalEvaluationData > > &  gedBlocks 
)

Initialize this object using the sub GED objects. Also you must specify ghosted and owned spaces. At completion isInitialized_ will be set to true.

Parameters
[in]ghostedSpaceMust be a default product vector space defining the ghosted vector
[in]ghostedSpaceMust be a default product vector space defining the owned vector (currently ignored, included for future changes)
[in]gedBlocksGED objects that handle each block of the vector.

Definition at line 35 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ isInitialized()

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

Is this object initialized.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 44 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

◆ globalToGhost()

void panzer::BlockedVector_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 59 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ initializeData()

void panzer::BlockedVector_ReadOnly_GlobalEvaluationData::initializeData ( )
virtual

Initialize internal data for communication (clear the ghosted vector)

Implements panzer::GlobalEvaluationData.

Definition at line 70 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ setOwnedVector()

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

Set the owned vector.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 81 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getOwnedVector()

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

Get the owned vector.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 96 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getGhostedVector()

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

Get the ghosted vector.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 103 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.cpp.

◆ getBlockCount()

size_t panzer::BlockedVector_ReadOnly_GlobalEvaluationData::getBlockCount ( ) const
inline

How many blocks are in this GED.

Definition at line 64 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

◆ getGEDBlock() [1/2]

Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData> panzer::BlockedVector_ReadOnly_GlobalEvaluationData::getGEDBlock ( int  i)
inline

Get GED block (non const version)

Definition at line 68 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

◆ getGEDBlock() [2/2]

Teuchos::RCP<const ReadOnlyVector_GlobalEvaluationData> panzer::BlockedVector_ReadOnly_GlobalEvaluationData::getGEDBlock ( int  i) const
inline

Get GED block (const version)

Definition at line 72 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

◆ requiresDirichletAdjustment()

bool panzer::BlockedVector_ReadOnly_GlobalEvaluationData::requiresDirichletAdjustment ( ) const
inlinevirtual

No Dirichlet adjustment required.

Implements panzer::GlobalEvaluationData.

Definition at line 76 of file Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp.

Member Data Documentation

◆ isInitialized_

bool panzer::BlockedVector_ReadOnly_GlobalEvaluationData::isInitialized_
private

◆ gedBlocks_

std::vector<Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData> > panzer::BlockedVector_ReadOnly_GlobalEvaluationData::gedBlocks_
private

◆ ownedVector_

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

◆ ghostedSpace_

Teuchos::RCP<const Thyra::DefaultProductVectorSpace<double> > panzer::BlockedVector_ReadOnly_GlobalEvaluationData::ghostedSpace_
private

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