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

#include <Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp>

Inheritance diagram for panzer::EpetraVector_ReadOnly_GlobalEvaluationData:

[legend]

Public Member Functions
	EpetraVector_ReadOnly_GlobalEvaluationData ()
	Default Constructor.

	EpetraVector_ReadOnly_GlobalEvaluationData (const EpetraVector_ReadOnly_GlobalEvaluationData &src)
	Copy Constructor.

	EpetraVector_ReadOnly_GlobalEvaluationData (const Teuchos::RCP< const Epetra_Import > &importer, const Teuchos::RCP< const Epetra_Map > &ghostedMap, const Teuchos::RCP< const Epetra_Map > &ownedMap)
	Initializing Constructor.

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

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

virtual void	globalToGhost (int mem=0)
	Communicate the owned data to the ghosted vector.

virtual void	initializeData ()
	Clear out the ghosted vector.

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

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

void	setOwnedVector_Epetra (const Teuchos::RCP< const 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< const Thyra::VectorBase< double > > &ownedVector)
	Set the owned vector (`Thyra` version).

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

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

bool	isInitialized () const
	Is this object initialized?

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

Public Member Functions inherited from panzer::ReadOnlyVector_GlobalEvaluationData
virtual	~ReadOnlyVector_GlobalEvaluationData ()
	Virtual d.

Public Member Functions inherited from panzer::GlobalEvaluationData
virtual	~GlobalEvaluationData ()=0

Private Types
typedef std::pair< std::vector< int >, double >	FilteredPair
	A list of global IDs (which will be translated to local IDs), paired with a value to be assigned in the `ghostedVector_`.

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_Import >	importer_
	The importer used to communicate between the owned and ghosted vectors.

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

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

std::vector< FilteredPair >	filteredPairs_
	The list of filtered pairs, used to initialize values on the `ghostedVector_`.

Detailed Description

This class provides a boundary exchange communication mechanism for vectors.

Note: This provides a read-only (RO) interface for parameters (so vectors are write protected).

Definition at line 46 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

Member Typedef Documentation

◆ FilteredPair

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

private

A list of global IDs (which will be translated to local IDs), paired with a value to be assigned in the ghostedVector_.

Definition at line 288 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

Constructor & Destructor Documentation

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [1/3]

panzer::EpetraVector_ReadOnly_GlobalEvaluationData::EpetraVector_ReadOnly_GlobalEvaluationData ( )

inline

Default Constructor.

Definition at line 55 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

Copy Constructor.

Parameters

[in] src The object to be copied.

Definition at line 66 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ 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

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]	importer	Importer 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 85 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: This is only useful for GIDs in the ghosted map.; This must be called before initialize().; No attempt to synchronize these values across a processor is made, so it's up to the user to be consistent.

Parameters

[in]	indices	A `std::vector` of global IDs.
[in]	value	The value to be assigned to the entries given by indices.

Definition at line 38 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]	importer	Importer 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 61 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ globalToGhost()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::globalToGhost ( int mem = 0 )

virtual

Communicate the owned data to the ghosted 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::ReadOnlyVector_GlobalEvaluationData.

Definition at line 118 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 145 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ ghostToGlobal()

void panzer::EpetraVector_ReadOnly_GlobalEvaluationData::ghostToGlobal ( int mem = 0 )

virtual

Communicate the ghosted data to the owned vector.

For this class this method does nothing.

Parameters

[in] mem Not needed for this class, but part of the GlobalEvaluationData interface.

Reimplemented from panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 171 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ requiresDirichletAdjustment()

virtual bool panzer::EpetraVector_ReadOnly_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.

Implements panzer::GlobalEvaluationData.

Definition at line 168 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).

Parameters

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

Definition at line 183 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).

Returns: The ghosted vector as an Epetra_Vector.

Definition at line 203 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).

Parameters

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

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 222 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).

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

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 241 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).

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

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 257 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

◆ isInitialized()

bool panzer::EpetraVector_ReadOnly_GlobalEvaluationData::isInitialized ( ) const

inlinevirtual

Is this object initialized?

Returns: Whether or not the object is initialized.

Implements panzer::ReadOnlyVector_GlobalEvaluationData.

Definition at line 223 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ print()

void panzer::EpetraVector_ReadOnly_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 277 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.cpp.

Member Data Documentation

◆ isInitialized_

bool panzer::EpetraVector_ReadOnly_GlobalEvaluationData::isInitialized_

private

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

Definition at line 246 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ghostedMap_

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

private

The map corresponding to the ghosted vector.

Definition at line 251 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ownedMap_

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

private

The map corresponding to the owned vector.

Definition at line 256 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ghostedSpace_

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

private

The vector space corresponding to the ghosted vector.

Definition at line 261 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ownedSpace_

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

private

The vector space corresponding to the owned vector.

Definition at line 266 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ importer_

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

private

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

Definition at line 272 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ghostedVector_

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

private

The ghosted vector.

Definition at line 277 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ ownedVector_

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

private

The owned vector.

Definition at line 282 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

◆ filteredPairs_

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

private

The list of filtered pairs, used to initialize values on the ghostedVector_.

Definition at line 294 of file Panzer_EpetraVector_ReadOnly_GlobalEvaluationData.hpp.

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

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FilteredPair

Constructor & Destructor Documentation

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [1/3]

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [2/3]

◆ EpetraVector_ReadOnly_GlobalEvaluationData() [3/3]

Member Function Documentation

◆ useConstantValues()

◆ initialize()

◆ globalToGhost()

◆ initializeData()

◆ ghostToGlobal()

◆ requiresDirichletAdjustment()

◆ setOwnedVector_Epetra()

◆ getGhostedVector_Epetra()

◆ setOwnedVector()

◆ getOwnedVector()

◆ getGhostedVector()

◆ isInitialized()

◆ print()

Member Data Documentation

◆ isInitialized_

◆ ghostedMap_

◆ ownedMap_

◆ ghostedSpace_

◆ ownedSpace_

◆ importer_

◆ ghostedVector_

◆ ownedVector_

◆ filteredPairs_