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

#include <Panzer_EpetraVector_Write_GlobalEvaluationData.hpp>

Inheritance diagram for panzer::EpetraVector_Write_GlobalEvaluationData:

[legend]

Public Member Functions
	EpetraVector_Write_GlobalEvaluationData ()
	Default Constructor.

	EpetraVector_Write_GlobalEvaluationData (const EpetraVector_Write_GlobalEvaluationData &src)
	Copy Constructor.

	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.

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.

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

virtual void	initializeData ()
	Clear out the ghosted vector. // JMG: Is this right?

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

void	setOwnedVector_Epetra (const Teuchos::RCP< Epetra_Vector > &ownedVector)
	Set the owned vector (`Epetra` version).

Teuchos::RCP< Epetra_Vector >	getGhostedVector_Epetra () const
	Get the ghosted vector (`Epetra` version).

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

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

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

virtual bool	isInitialized () const
	Is this object initialized?

void	print (std::ostream &os) const
	Print the object.

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

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

Teuchos::RCP< const Epetra_Map >	ghostedMap_
	The map corresponding to the ghosted vector.

Teuchos::RCP< const Epetra_Map >	ownedMap_
	The map corresponding to the owned vector.

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

Teuchos::RCP< const Thyra::VectorSpaceBase< double > >	ownedSpace_
	The vector space corresponding to the owned vector.

Teuchos::RCP< const Epetra_Export >	exporter_
	The exporter used to communicate between the owned and ghosted vectors.

Teuchos::RCP< Epetra_Vector >	ghostedVector_
	The ghosted vector.

Teuchos::RCP< Thyra::VectorBase< double > >	ownedVector_
	The owned 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 provides a boundary exchange communication mechanism for vectors.

Note: This provides a "write" interface for parameters.

Definition at line 44 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

◆ EpetraVector_Write_GlobalEvaluationData() [1/3]

panzer::EpetraVector_Write_GlobalEvaluationData::EpetraVector_Write_GlobalEvaluationData ( )

inline

Default Constructor.

Definition at line 53 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ EpetraVector_Write_GlobalEvaluationData() [2/3]

panzer::EpetraVector_Write_GlobalEvaluationData::EpetraVector_Write_GlobalEvaluationData ( const EpetraVector_Write_GlobalEvaluationData & src )

inline

Copy Constructor.

Parameters

[in] src The object to be copied.

Definition at line 64 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ EpetraVector_Write_GlobalEvaluationData() [3/3]

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]	exporter	Exporter for doing communication from the owned to the ghosted vector.
[in]	ghostedMap	Map describing the ghosted vector.
[in]	ownedMap	Map describing the owned vector.

Definition at line 83 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

Member Function Documentation

◆ initialize()

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]	exporter	Exporter for doing communication from the owned to the ghosted vector.
[in]	ghostedMap	Map describing the ghosted vector.
[in]	ownedMap	Map describing the owned vector.

Definition at line 39 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ ghostToGlobal()

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

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 76 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ initializeData()

void panzer::EpetraVector_Write_GlobalEvaluationData::initializeData ( )

virtual

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

Implements panzer::GlobalEvaluationData.

Definition at line 123 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ requiresDirichletAdjustment()

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 134 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ setOwnedVector_Epetra()

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

Set the owned vector (Epetra version).

Parameters

[in] ownedVector An Epetra_Vector that you would like to set as the owned vector.

Definition at line 140 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ getGhostedVector_Epetra()

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 160 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ setOwnedVector()

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

virtual

Set the owned vector (Thyra version).

Parameters

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

Implements panzer::WriteVector_GlobalEvaluationData.

Definition at line 179 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ getOwnedVector()

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 198 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ getGhostedVector()

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 214 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

◆ isInitialized()

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 189 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ print()

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] os The output stream to which the data should be printed.

Reimplemented from panzer::GlobalEvaluationData.

Definition at line 234 of file Panzer_EpetraVector_Write_GlobalEvaluationData.cpp.

Member Data Documentation

◆ isInitialized_

bool panzer::EpetraVector_Write_GlobalEvaluationData::isInitialized_

private

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

Definition at line 212 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ghostedMap_

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

private

The map corresponding to the ghosted vector.

Definition at line 217 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ownedMap_

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

private

The map corresponding to the owned vector.

Definition at line 222 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ghostedSpace_

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

private

The vector space corresponding to the ghosted vector.

Definition at line 227 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ownedSpace_

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

private

The vector space corresponding to the owned vector.

Definition at line 232 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ exporter_

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 238 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ghostedVector_

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

private

The ghosted vector.

Definition at line 243 of file Panzer_EpetraVector_Write_GlobalEvaluationData.hpp.

◆ ownedVector_

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

private

The owned vector.

Definition at line 248 of file Panzer_EpetraVector_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

◆ EpetraVector_Write_GlobalEvaluationData() [1/3]

◆ EpetraVector_Write_GlobalEvaluationData() [2/3]

◆ EpetraVector_Write_GlobalEvaluationData() [3/3]

Member Function Documentation

◆ initialize()

◆ ghostToGlobal()

◆ initializeData()

◆ requiresDirichletAdjustment()

◆ setOwnedVector_Epetra()

◆ getGhostedVector_Epetra()

◆ setOwnedVector()

◆ getOwnedVector()

◆ getGhostedVector()

◆ isInitialized()

◆ print()

Member Data Documentation

◆ isInitialized_

◆ ghostedMap_

◆ ownedMap_

◆ ghostedSpace_

◆ ownedSpace_

◆ exporter_

◆ ghostedVector_

◆ ownedVector_