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

#include <Panzer_BlockedVector_Write_GlobalEvaluationData.hpp>

Inheritance diagram for panzer::BlockedVector_Write_GlobalEvaluationData:

[legend]

Public Member Functions
	BlockedVector_Write_GlobalEvaluationData ()
	Default Constructor.

	BlockedVector_Write_GlobalEvaluationData (const BlockedVector_Write_GlobalEvaluationData &src)
	Copy Constructor.

	BlockedVector_Write_GlobalEvaluationData (const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ghostedSpace, const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > ownedSpace, const std::vector< Teuchos::RCP< WriteVector_GlobalEvaluationData > > &gedBlocks)
	Initializing Constructor.

virtual	~BlockedVector_Write_GlobalEvaluationData ()
	Destructor.

void	initialize (const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &ghostedSpace, const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &ownedSpace, const std::vector< Teuchos::RCP< WriteVector_GlobalEvaluationData > > &gedBlocks)
	Initialize this object using the sub-`GlobalEvaluationData` objects.

virtual bool	isInitialized () const
	Is this object initialized?

virtual void	ghostToGlobal (int mem)
	Communicate the ghosted data to the owned vector.

virtual void	initializeData ()
	Initialize internal data for communication.

virtual void	setOwnedVector (const Teuchos::RCP< Thyra::VectorBase< double > > &ownedVector)
	Set the owned vector.

virtual Teuchos::RCP< Thyra::VectorBase< double > >	getOwnedVector () const
	Get the owned vector.

virtual Teuchos::RCP< Thyra::VectorBase< double > >	getGhostedVector () const
	Get the ghosted vector.

size_t	getBlockCount () const
	How many blocks do we have?

Teuchos::RCP< WriteVector_GlobalEvaluationData >	getGEDBlock (int i)
	Get the `i`-th block (non const version).

Teuchos::RCP< const WriteVector_GlobalEvaluationData >	getGEDBlock (int i) const
	Get the `i`-th block (const version).

bool	requiresDirichletAdjustment () const
	Determine if a Dirichlet adjustment is necessary.

Public Member Functions inherited from panzer::WriteVector_GlobalEvaluationData
	WriteVector_GlobalEvaluationData ()
	Default constructor, set combine mode to sum right away.

virtual	~WriteVector_GlobalEvaluationData ()
	Virtual d.

void	setCombineMode (CombineMode cm)
	Allow the user to set the combine mode (at any time)

CombineMode	getCombineMode () const
	Get the combine mode, to be used by sub classes.

virtual void	globalToGhost (int)

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.

Private Attributes
bool	isInitialized_
	A flag indicating whether or not the object has been initialized.

std::vector< Teuchos::RCP< WriteVector_GlobalEvaluationData > >	gedBlocks_
	A `vector` of the `GlobalEvaluationData` blocks.

Teuchos::RCP< Thyra::VectorBase< double > >	ownedVector_
	The owned vector.

Teuchos::RCP< const Thyra::DefaultProductVectorSpace< double > >	ghostedSpace_
	The vector space corresponding to the ghosted vector.

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...

Detailed Description

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

// JMG: What all needs to change for this class?

Definition at line 40 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

◆ BlockedVector_Write_GlobalEvaluationData() [1/3]

panzer::BlockedVector_Write_GlobalEvaluationData::BlockedVector_Write_GlobalEvaluationData ( )

Default Constructor.

Definition at line 33 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ BlockedVector_Write_GlobalEvaluationData() [2/3]

panzer::BlockedVector_Write_GlobalEvaluationData::BlockedVector_Write_GlobalEvaluationData ( const BlockedVector_Write_GlobalEvaluationData & src )

Copy Constructor.

Parameters

[in] src The object to be copied.

Definition at line 44 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ BlockedVector_Write_GlobalEvaluationData() [3/3]

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

Initializing Constructor.

Parameters

[in]	ghostedSpace	A `DefaultProductVectorSpace` corresponding to the ghosted vector.
[in]	ownedSpace	A `DefaultProductVectorSpace` corresponding to the owned vector. It's currently ignored, but it's included for future changes.
[in]	gedBlocks	`GlobalEvaluationData` objects that handle each block of the vector.

Definition at line 58 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ ~BlockedVector_Write_GlobalEvaluationData()

virtual panzer::BlockedVector_Write_GlobalEvaluationData::~BlockedVector_Write_GlobalEvaluationData ( )

inlinevirtual

Destructor.

Definition at line 79 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

Member Function Documentation

◆ initialize()

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

Initialize this object using the sub-GlobalEvaluationData objects.

You must specify the owned and ghosted spaces. At completion, isInitialized_ will be set to true.

Parameters

[in]	ghostedSpace	A `DefaultProductVectorSpace` corresponding to the ghosted vector.
[in]	ownedSpace	A `DefaultProductVectorSpace` corresponding to the owned vector. It's currently ignored, but it's included for future changes.
[in]	gedBlocks	`GlobalEvaluationData` objects that handle each block of the vector.

Definition at line 76 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ isInitialized()

virtual bool panzer::BlockedVector_Write_GlobalEvaluationData::isInitialized ( ) const

inlinevirtual

Is this object initialized?

Returns: Whether or not the object is initialized.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 111 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ ghostToGlobal()

void panzer::BlockedVector_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] mem Not needed for this class, but part of the GlobalEvaluationData interface.

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 108 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ initializeData()

void panzer::BlockedVector_Write_GlobalEvaluationData::initializeData ( )

virtual

Initialize internal data for communication.

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

Implements panzer::GlobalEvaluationData.

Definition at line 127 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ setOwnedVector()

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

virtual

Set the owned vector.

Parameters

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

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 145 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ getOwnedVector()

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

virtual

Get the owned vector.

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

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 172 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ getGhostedVector()

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

virtual

Get the ghosted vector.

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

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 184 of file Panzer_BlockedVector_Write_GlobalEvaluationData.cpp.

◆ getBlockCount()

size_t panzer::BlockedVector_Write_GlobalEvaluationData::getBlockCount ( ) const

inline

How many blocks do we have?

Returns: The number of blocks in this GlobalEvaluationData object.

Definition at line 168 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ getGEDBlock() [1/2]

Teuchos::RCP< WriteVector_GlobalEvaluationData > panzer::BlockedVector_Write_GlobalEvaluationData::getGEDBlock ( int i )

inline

Get the i-th block (non const version).

Returns: This object's i-th GlobalEvaluationData block.

Definition at line 179 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ getGEDBlock() [2/2]

Teuchos::RCP< const WriteVector_GlobalEvaluationData > panzer::BlockedVector_Write_GlobalEvaluationData::getGEDBlock ( int i ) const

inline

Get the i-th block (const version).

Returns: This object's i-th GlobalEvaluationData block.

Definition at line 191 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ requiresDirichletAdjustment()

bool panzer::BlockedVector_Write_GlobalEvaluationData::requiresDirichletAdjustment ( ) const

inlinevirtual

Determine if a Dirichlet adjustment is necessary.

For this class, there's nothing to do because it's read-only.

Returns: False. // JMG: But why?

Implements panzer::GlobalEvaluationData.

Definition at line 205 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

Member Data Documentation

◆ isInitialized_

bool panzer::BlockedVector_Write_GlobalEvaluationData::isInitialized_

private

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

Definition at line 216 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ gedBlocks_

std::vector<Teuchos::RCP<WriteVector_GlobalEvaluationData> > panzer::BlockedVector_Write_GlobalEvaluationData::gedBlocks_

private

A vector of the GlobalEvaluationData blocks.

Definition at line 221 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ ownedVector_

Teuchos::RCP<Thyra::VectorBase<double> > panzer::BlockedVector_Write_GlobalEvaluationData::ownedVector_

private

The owned vector.

Definition at line 226 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

◆ ghostedSpace_

Teuchos::RCP<const Thyra::DefaultProductVectorSpace<double> > panzer::BlockedVector_Write_GlobalEvaluationData::ghostedSpace_

private

The vector space corresponding to the ghosted vector.

Definition at line 232 of file Panzer_BlockedVector_Write_GlobalEvaluationData.hpp.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlockedVector_Write_GlobalEvaluationData() [1/3]

◆ BlockedVector_Write_GlobalEvaluationData() [2/3]

◆ BlockedVector_Write_GlobalEvaluationData() [3/3]

◆ ~BlockedVector_Write_GlobalEvaluationData()

Member Function Documentation

◆ initialize()

◆ isInitialized()

◆ ghostToGlobal()

◆ initializeData()

◆ setOwnedVector()

◆ getOwnedVector()

◆ getGhostedVector()

◆ getBlockCount()

◆ getGEDBlock() [1/2]

◆ getGEDBlock() [2/2]

◆ requiresDirichletAdjustment()

Member Data Documentation

◆ isInitialized_

◆ gedBlocks_

◆ ownedVector_

◆ ghostedSpace_