#include <GhostDataHelper.h>

Inheritance diagram for AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >:

[legend]

Public Types
using	intAllocator_t = typename std::allocator_traits< Allocator >::template rebind_alloc< int >

using	ScalarAllocator_t = typename std::allocator_traits< Allocator >::template rebind_alloc< TYPE >

using	sizetAllocator_t = typename std::allocator_traits< Allocator >::template rebind_alloc< size_t >

Public Member Functions
template<class TYPE >
void	addGhostValuesByGlobalID (size_t num, const size_t indices, const TYPE vals)
	Add shared values using global identifier.

void	addGhostValuesByGlobalID (size_t num, const size_t indices, const void vals, const typeID &id) override
	Add shared values using global identifier.

virtual void	addGhostValuesByGlobalID (size_t num, const size_t indices, const void vals, const typeID &id)=0
	Add shared values using global identifier.

template<class TYPE >
void	addValuesByGlobalID (size_t num, const size_t indices, const TYPE vals)
	Add owned or shared values using global identifier.

template<class TYPE >
void	addValuesByLocalID (size_t num, const size_t indices, const TYPE vals)
	Add values to vector entities by their local offset.

virtual void	addValuesByLocalID (size_t num, const size_t indices, const void vals, const typeID &id)=0
	Add values to vector entities by their local offset.

virtual void	assemble ()
	This method is used to implement the assemble interface of PETSc.

template<class TYPE = double>
VectorDataIterator< TYPE >	begin ()
	Return an iterator to the beginning of the data.

template<class TYPE = double>
VectorDataIterator< const TYPE >	begin () const
	Return an iterator to the beginning of the data.

virtual std::shared_ptr< VectorData >	cloneData (const std::string &name="") const =0
	Clone the data.

template<class TYPE = double>
VectorDataIterator< const TYPE >	constBegin () const
	Return an iterator to the beginning of the data.

template<class TYPE = double>
VectorDataIterator< const TYPE >	constEnd () const
	Return an iterator to the end of the data.

bool	containsGlobalElement (size_t) const override

void	copyGhostValues (const VectorData &rhs) override
	Copy ghosted vlues to a vector.

void	dataChanged () override
	Notify listeners that data has changed in this vector.

virtual void	deregisterListener (DataChangeListener *listener)
	Deregister a listener with this DataChangeFirer.

void	dumpGhostedData (std::ostream &out, size_t offset) const override
	Write data owned by other processors to an std::ostream.

virtual void	dumpOwnedData (std::ostream &out, size_t GIDoffset=0, size_t LIDoffset=0) const
	Write owned data to an std::ostream.

template<class TYPE = double>
VectorDataIterator< TYPE >	end ()
	Return an iterator to the end of the data.

template<class TYPE = double>
VectorDataIterator< const TYPE >	end () const
	Return an iterator to the end of the data.

void	fillGhosts (const Scalar &) override
	Zero all ghost data (does not modify consistent status)

virtual void	fireDataChange ()
	Notify all listeners of a data change event.

template<class TYPE >
size_t	getAllGhostValues (TYPE *vals) const
	Get all ghost values.

size_t	getAllGhostValues (void *vals, const typeID &id) const override
	Get all ghost values in the vector.

const AMP_MPI &	getComm () const override
	Get the communicator.

std::shared_ptr< CommunicationList >	getCommunicationList () const override
	Get the CommunicationList for this Vector.

virtual std::shared_ptr< VectorData >	getComponent (size_t i=0)
	Number of elements in the ith component.

virtual std::shared_ptr< const VectorData >	getComponent (size_t i=0) const
	Number of elements in the ith component.

virtual uint64_t	getDataID () const =0
	A unique id for the underlying data allocation.

template<class TYPE >
void	getGhostAddValuesByGlobalID (size_t num, const size_t indices, TYPE vals) const
	get ghosted values to add to off-proc elements

void	getGhostAddValuesByGlobalID (size_t num, const size_t indices, void vals, const typeID &id) const override
	get ghosted values to add to off-proc elements

virtual void	getGhostAddValuesByGlobalID (size_t num, const size_t indices, void vals, const typeID &id) const=0
	get ghosted values to add to off-proc elements

size_t	getGhostSize () const override
	Number of entries "owned" by other cores stored on this core.

template<class TYPE >
void	getGhostValuesByGlobalID (size_t num, const size_t indices, TYPE vals) const
	Get ghost values in the vector by their global offset.

void	getGhostValuesByGlobalID (size_t num, const size_t indices, void vals, const typeID &id) const override
	Get ghost values in the vector by their global offset.

virtual void	getGhostValuesByGlobalID (size_t num, const size_t indices, void vals, const typeID &id) const=0
	Get ghost values in the vector by their global offset.

void	getGhostValuesByGlobalIDUnsorted (size_t num, const size_t indices, void vals, const typeID &id) const

size_t	getGlobalSize () const
	Number of total entries in this vector across all cores.

UpdateState	getGlobalUpdateStatus () const
	Return the current update state of the Vector.

uint64_t	getID () const
	Get a unique id hash for the vector.

size_t	getLocalSize () const
	Number of elements "owned" by this core.

virtual std::vector< size_t >	getLocalSizes () const
	The local sizes on each rank.

size_t	getLocalStartID () const
	get local start id core.

UpdateState	getLocalUpdateStatus () const override
	Return the current update state of the Vector.

virtual AMP::Utilities::MemoryType	getMemoryLocation () const
	returns the memory location for data

virtual size_t	getNumberOfComponents () const
	Return integer number of data components.

template<class TYPE >
void	getRawData (TYPE *buf) const
	Copy data out of this vector.

virtual void	getRawData (void *buf, const typeID &id) const =0
	Copy data out of this vector.

template<typename RETURN_TYPE >
RETURN_TYPE *	getRawDataBlock (size_t i=0)
	Obtain a particular contiguous block of data cast to RETURN_TYPE.

template<typename RETURN_TYPE >
const RETURN_TYPE *	getRawDataBlock (size_t i=0) const
	Obtain a particular contiguous block of data cast to RETURN_TYPE.

virtual const void *	getRawDataBlockAsVoid (size_t i) const =0
	Return a pointer to a particular block of memory in the vector.

virtual void *	getRawDataBlockAsVoid (size_t i)=0
	Return a pointer to a particular block of memory in the vector.

virtual typeID	getType (size_t block) const =0
	Return the typeid of the given block.

std::shared_ptr< UpdateState >	getUpdateStatusPtr () const override
	Return the current update state of this Vector.

template<class TYPE >
void	getValuesByGlobalID (size_t num, const size_t indices, TYPE vals) const
	get values in the vector by their local offset

template<class TYPE >
void	getValuesByLocalID (size_t num, const size_t indices, TYPE vals) const
	Get local values in the vector by their global offset.

virtual void	getValuesByLocalID (size_t num, const size_t indices, void vals, const typeID &id) const =0
	Get local values in the vector by their global offset.

	GhostDataHelper ()

	GhostDataHelper (int64_t fid, AMP::IO::RestartManager *manager)

	GhostDataHelper (std::shared_ptr< CommunicationList >)

virtual bool	hasContiguousData () const
	returns whether all data for the vector on a single process is contiguous

bool	hasGhosts () const override
	Check if any entries "owned" by other cores are stored on this core.

virtual bool	isAnAliasOf (const VectorData &rhs) const
	Check if the two VectorData objects are alias of each other.

template<typename TYPE >
bool	isBlockType (size_t i=0) const
	Check if the data is of the given type.

template<typename TYPE >
bool	isType () const
	Check if the data is of the given type.

bool	isType (const typeID &id, size_t block) const
	Is the data of the given type.

virtual void	makeConsistent ()
	Update shared values on entire communicator.

void	makeConsistent (ScatterType t) override
	Update shared values on entire communicator.

virtual void	makeConsistent (ScatterType t)=0
	Update shared values on entire communicator.

virtual size_t	numberOfDataBlocks () const =0
	Number of blocks of contiguous data in the Vector.

virtual void	print (std::ostream &os, const std::string &name="A", const std::string &prefix="") const

template<class TYPE >
void	putRawData (const TYPE *buf)
	Copy data into this vector.

virtual void	putRawData (const void *buf, const typeID &id)=0
	Copy data into this vector.

void	registerChildObjects (AMP::IO::RestartManager *manager) const override
	Register any child objects.

virtual void	registerListener (DataChangeListener *listener)
	Register a listener with this DataChangeFirer.

virtual void	registerListener (std::shared_ptr< DataChangeListener > listener)
	Register a listener with this DataChangeFirer.

virtual void	reset ()
	reset the vector data object

void	setCommunicationList (std::shared_ptr< CommunicationList > comm) override
	Set the CommunicationList for this Vector.

template<class TYPE >
void	setGhostValuesByGlobalID (size_t num, const size_t indices, const TYPE vals)
	Set ghost values using global identifier.

void	setGhostValuesByGlobalID (size_t num, const size_t indices, const void vals, const typeID &id) override
	Set ghost values using global identifier.

virtual void	setGhostValuesByGlobalID (size_t num, const size_t indices, const void vals, const typeID &id)=0
	Set ghost values using global identifier.

void	setNoGhosts () override
	Ensure this vector has no ghosts.

void	setUpdateStatus (UpdateState state) override
	Sets the current update state of the Vector.

void	setUpdateStatusPtr (std::shared_ptr< UpdateState > rhs) override
	Tie the current update state to another.

template<class TYPE >
void	setValuesByGlobalID (size_t num, const size_t indices, const TYPE vals)
	Set owned or shared values using global identifier.

template<class TYPE >
void	setValuesByLocalID (size_t num, const size_t indices, const TYPE vals)
	Set values in the vector by their local offset.

virtual void	setValuesByLocalID (size_t num, const size_t indices, const void vals, const typeID &id)=0
	Set values in the vector by their local offset.

std::shared_ptr< VectorData >	shared_from_this ()

std::shared_ptr< const VectorData >	shared_from_this () const

virtual size_t	sizeOfDataBlock (size_t i=0) const =0
	Number of elements in a data block.

virtual size_t	sizeofDataBlockType (size_t i) const =0
	Return the result of sizeof(TYPE) for the given data block.

virtual void	swapData (VectorData &rhs)=0
	Swap the data with another VectorData object.

virtual std::string	VectorDataName () const =0
	Get the type name.

void	writeRestart (int64_t fid) const override
	Write restart data to file.

	~GhostDataHelper ()

Protected Member Functions
virtual bool	allGhostIndices (size_t N, const size_t *ndx) const

void	allocateBuffers (size_t len)

void	deallocateBuffers ()

void	scatter_add ()

void	scatter_set ()

Protected Attributes
TYPE *	d_AddBuffer = nullptr

std::vector< TYPE >	d_AddBuffer_h

ScalarAllocator_t	d_alloc

std::shared_ptr< CommunicationList >	d_CommList = nullptr

TYPE *	d_Ghosts = nullptr

std::vector< TYPE >	d_Ghosts_h

size_t	d_ghostSize = 0
	size/length of ghost and add buffers

size_t	d_globalSize = 0
	Number of local values.

intAllocator_t	d_int_alloc

size_t *	d_localRemote = nullptr
	list of local ids that are remote

size_t	d_localSize = 0

size_t	d_localStart = 0
	Number of global values.

size_t	d_numRemote = 0
	number of local ids that are remote

size_t *	d_ReceiveDOFList = nullptr

int *	d_recvDisplacements = nullptr

int *	d_recvSizes = nullptr

int	d_scatter_tag

int *	d_sendDisplacements = nullptr

TYPE *	d_SendRecv = nullptr
	Buffers for sending/receiving data.

std::vector< TYPE >	d_SendRecv_h

int *	d_sendSizes = nullptr

sizetAllocator_t	d_size_t_alloc

std::shared_ptr< UpdateState >	d_UpdateState = nullptr

std::weak_ptr< VectorData >	weak_ptr_

Private Attributes
std::vector< DataChangeListener * >	d_listeners

Detailed Description

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>
class AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >

Definition at line 12 of file GhostDataHelper.h.

Member Typedef Documentation

◆ intAllocator_t

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

using AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::intAllocator_t = typename std::allocator_traits<Allocator>::template rebind_alloc<int>

Definition at line 19 of file GhostDataHelper.h.

◆ ScalarAllocator_t

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

using AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::ScalarAllocator_t = typename std::allocator_traits<Allocator>::template rebind_alloc<TYPE>

Definition at line 15 of file GhostDataHelper.h.

◆ sizetAllocator_t

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

using AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::sizetAllocator_t = typename std::allocator_traits<Allocator>::template rebind_alloc<size_t>

Definition at line 17 of file GhostDataHelper.h.

Constructor & Destructor Documentation

◆ GhostDataHelper() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::GhostDataHelper ( )

◆ GhostDataHelper() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::GhostDataHelper ( std::shared_ptr< CommunicationList > )

◆ ~GhostDataHelper()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::~GhostDataHelper ( )

◆ GhostDataHelper() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::GhostDataHelper	(	int64_t	fid,
		AMP::IO::RestartManager *	manager
	)

Member Function Documentation

◆ addGhostValuesByGlobalID() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

template<class TYPE >

void AMP::LinearAlgebra::VectorData::addGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

Add shared values using global identifier.

Parameters

[in]	num	number of values to add
[in]	indices	the indices of the values to add
[in]	vals	the values to place in the vector

◆ addGhostValuesByGlobalID() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::addGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

overridevirtual

Add shared values using global identifier.

Parameters

[in]	num	number of values to add
[in]	indices	the indices of the values to add
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ addGhostValuesByGlobalID() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::addGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

virtual

Add shared values using global identifier.

Parameters

[in]	num	number of values to add
[in]	indices	the indices of the values to add
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ addValuesByGlobalID()

template<class TYPE >

void AMP::LinearAlgebra::VectorData::addValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

inherited

Add owned or shared values using global identifier.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

Since the shared buffer and owned buffer are separate, this function must sort the data by buffer before setting values.

◆ addValuesByLocalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::VectorData::addValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

inherited

Add values to vector entities by their local offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

This will set the owned values for this core. All indices are from 0. \( \mathit{this}_{\mathit{indices}_i} = \mathit{this}_{\mathit{indices}_i} + \mathit{vals}_i \)

◆ addValuesByLocalID() [2/2]

virtual void AMP::LinearAlgebra::VectorData::addValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

pure virtualinherited

Add values to vector entities by their local offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will set the owned values for this core. All indices are from 0. \( \mathit{this}_{\mathit{indices}_i} = \mathit{this}_{\mathit{indices}_i} + \mathit{vals}_i \)

◆ allGhostIndices()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual bool AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::allGhostIndices	(	size_t	N,
		const size_t *	ndx
	)		const

protectedvirtual

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >.

◆ allocateBuffers()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::allocateBuffers ( size_t len )

protected

◆ assemble()

virtual void AMP::LinearAlgebra::VectorData::assemble ( )

inlinevirtualinherited

This method is used to implement the assemble interface of PETSc.

This method is empty except for instantiations of NativePetscVectorData

Reimplemented in AMP::LinearAlgebra::ManagedVectorData, AMP::LinearAlgebra::MultiVectorData, and AMP::LinearAlgebra::NativePetscVectorData.

Definition at line 631 of file VectorData.h.

◆ begin() [1/2]

template<class TYPE = double>

VectorDataIterator< TYPE > AMP::LinearAlgebra::VectorData::begin ( )

inlineinherited

Return an iterator to the beginning of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ begin() [2/2]

template<class TYPE = double>

VectorDataIterator< const TYPE > AMP::LinearAlgebra::VectorData::begin ( ) const

inlineinherited

Return an iterator to the beginning of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ cloneData()

virtual std::shared_ptr< VectorData > AMP::LinearAlgebra::VectorData::cloneData ( const std::string & name = "" ) const

pure virtualinherited

Clone the data.

◆ constBegin()

template<class TYPE = double>

VectorDataIterator< const TYPE > AMP::LinearAlgebra::VectorData::constBegin ( ) const

inlineinherited

Return an iterator to the beginning of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ constEnd()

template<class TYPE = double>

VectorDataIterator< const TYPE > AMP::LinearAlgebra::VectorData::constEnd ( ) const

inlineinherited

Return an iterator to the end of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ containsGlobalElement()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

bool AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::containsGlobalElement ( size_t ) const

overridevirtual

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >.

◆ copyGhostValues()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::copyGhostValues ( const VectorData & rhs )

overridevirtual

Copy ghosted vlues to a vector.

Parameters

[in] rhs Vector to copy ghost values from

This ensures that ghosted values on this and rhs are the same without a call to makeConsistent.

See also: makeConsistent

Implements AMP::LinearAlgebra::VectorData.

◆ dataChanged()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::dataChanged ( )

overridevirtual

Notify listeners that data has changed in this vector.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData.

◆ deallocateBuffers()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::deallocateBuffers ( )

protected

◆ deregisterListener()

virtual void AMP::LinearAlgebra::DataChangeFirer::deregisterListener ( DataChangeListener * listener )

virtualinherited

Deregister a listener with this DataChangeFirer.

Parameters

[in] listener The listener to remove from the list

Removes a listener from itself.

◆ dumpGhostedData()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::dumpGhostedData	(	std::ostream &	out,
		size_t	offset
	)		const

overridevirtual

Write data owned by other processors to an std::ostream.

Parameters

[in]	out	The output stream to write to.
[in]	offset	A number to add to the global ID when writing information

Implements AMP::LinearAlgebra::VectorData.

◆ dumpOwnedData()

virtual void AMP::LinearAlgebra::VectorData::dumpOwnedData	(	std::ostream &	out,
		size_t	GIDoffset = `0`,
		size_t	LIDoffset = `0`
	)		const

virtualinherited

Write owned data to an std::ostream.

Parameters

[in]	out	The output stream to write to.
[in]	GIDoffset	A number to add to the global ID when writing information
[in]	LIDoffset	A number to add to the local ID when writing information

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ end() [1/2]

template<class TYPE = double>

VectorDataIterator< TYPE > AMP::LinearAlgebra::VectorData::end ( )

inlineinherited

Return an iterator to the end of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ end() [2/2]

template<class TYPE = double>

VectorDataIterator< const TYPE > AMP::LinearAlgebra::VectorData::end ( ) const

inlineinherited

Return an iterator to the end of the data.

Returns: A VectorDataIterator

Since the Vector presents an interface to a contiguous block of data, it is natural for it to provide a random access iterator.

Warning: The non-const version of the iterators will automatically leave the vector in a non-consistent state. The user may be required to call makeConsistent.

◆ fillGhosts()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::fillGhosts ( const Scalar & x )

overridevirtual

Zero all ghost data (does not modify consistent status)

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >.

◆ fireDataChange()

virtual void AMP::LinearAlgebra::DataChangeFirer::fireDataChange ( )

virtualinherited

Notify all listeners of a data change event.

Iterates through the list of DataChangeListeners and invokes the receiveDataChanged() method.

Referenced by AMP::LinearAlgebra::ManagedVectorData::receiveDataChanged(), and AMP::LinearAlgebra::MultiVectorData::receiveDataChanged().

◆ getAllGhostValues() [1/2]

template<class TYPE >

size_t AMP::LinearAlgebra::VectorData::getAllGhostValues ( TYPE * vals ) const

inherited

Get all ghost values.

Parameters

[out] vals the values to place in the vector

This will get any value owned by this core.

◆ getAllGhostValues() [2/2]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getAllGhostValues	(	void *	vals,
		const typeID &	id
	)		const

overridevirtual

Get all ghost values in the vector.

Parameters

[out]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get any value owned by this core.

Returns: Returns the number of ghost values

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData.

◆ getComm()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

const AMP_MPI & AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getComm ( ) const

overridevirtual

Get the communicator.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::SubsetVectorData.

◆ getCommunicationList()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::shared_ptr< CommunicationList > AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getCommunicationList ( ) const

overridevirtual

Get the CommunicationList for this Vector.

Implements AMP::LinearAlgebra::VectorData.

◆ getComponent() [1/2]

virtual std::shared_ptr< VectorData > AMP::LinearAlgebra::VectorData::getComponent ( size_t i = 0 )

virtualinherited

Number of elements in the ith component.

Parameters

[in] i particular data block

Returns: The number of elements in the ith component

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ getComponent() [2/2]

virtual std::shared_ptr< const VectorData > AMP::LinearAlgebra::VectorData::getComponent ( size_t i = 0 ) const

virtualinherited

Number of elements in the ith component.

Parameters

[in] i particular data block

Returns: The number of elements in the ith component

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ getDataID()

virtual uint64_t AMP::LinearAlgebra::VectorData::getDataID ( ) const

pure virtualinherited

A unique id for the underlying data allocation.

This is a unique id that is associated with the data data allocation. Views of a vector should preserve the id of the original vector. Vectors that are not allocated, or contain multiple vectors (such as Multivector) should return 0. Note: this id is not consistent across multiple processors.

◆ getGhostAddValuesByGlobalID() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

template<class TYPE >

void AMP::LinearAlgebra::VectorData::getGhostAddValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		TYPE *	vals
	)		const

get ghosted values to add to off-proc elements

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

This will get the ghosted updates this processor has made. All indices are from global 0.

◆ getGhostAddValuesByGlobalID() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getGhostAddValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

overridevirtual

get ghosted values to add to off-proc elements

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get the ghosted updates this processor has made. All indices are from global 0.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >.

◆ getGhostAddValuesByGlobalID() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::getGhostAddValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

virtual

get ghosted values to add to off-proc elements

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get the ghosted updates this processor has made. All indices are from global 0.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >.

◆ getGhostSize()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getGhostSize ( ) const

overridevirtual

Number of entries "owned" by other cores stored on this core.

Returns: Number of entries "owned" by other cores stored on this core

Implements AMP::LinearAlgebra::VectorData.

◆ getGhostValuesByGlobalID() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

template<class TYPE >

void AMP::LinearAlgebra::VectorData::getGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		TYPE *	vals
	)		const

Get ghost values in the vector by their global offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector

This will get any value owned by this core.

◆ getGhostValuesByGlobalID() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

overridevirtual

Get ghost values in the vector by their global offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get any value owned by this core.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ getGhostValuesByGlobalID() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::getGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

virtual

Get ghost values in the vector by their global offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get any value owned by this core.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ getGhostValuesByGlobalIDUnsorted()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getGhostValuesByGlobalIDUnsorted	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

◆ getGlobalSize()

size_t AMP::LinearAlgebra::VectorData::getGlobalSize ( ) const

inlineinherited

Number of total entries in this vector across all cores.

Returns: Number of entries stored across all cores in this

Definition at line 71 of file VectorData.h.

References AMP::LinearAlgebra::VectorData::d_globalSize.

◆ getGlobalUpdateStatus()

UpdateState AMP::LinearAlgebra::VectorData::getGlobalUpdateStatus ( ) const

inherited

Return the current update state of the Vector.

This returns the effective update state of the vector, including any vectors it contains. The effective state is defined as: UNCHANGED - All data and sub vectors are unchanged LOCAL_CHANGED - Local data may be modified, sub vectors must either be UNCHANGED or LOCAL_CHANGED. ADDING - Local and ghost data may be modified through add operations, sub vectors must be UNCHANGED, LOCAL_CHANGED, or ADDING SETTING - Local and ghost data may be modified through set operations, sub vectors must be UNCHANGED, LOCAL_CHANGED, or SETTING If different subvectors have incompatible states ADDING and SETTING, this function will return MIXED This version returns the global state and requires a collective communication

◆ getID()

uint64_t AMP::LinearAlgebra::VectorData::getID ( ) const

inherited

Get a unique id hash for the vector.

◆ getLocalSize()

size_t AMP::LinearAlgebra::VectorData::getLocalSize ( ) const

inlineinherited

Number of elements "owned" by this core.

Returns: Number of entries stored on this processor

This function returns the number of locally stored values under contiguous indexing.

Definition at line 66 of file VectorData.h.

◆ getLocalSizes()

virtual std::vector< size_t > AMP::LinearAlgebra::VectorData::getLocalSizes ( ) const

virtualinherited

The local sizes on each rank.

Returns: The local sizes on each rank

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ getLocalStartID()

size_t AMP::LinearAlgebra::VectorData::getLocalStartID ( ) const

inlineinherited

get local start id core.

Returns: The first entry "owned" by this core

Definition at line 76 of file VectorData.h.

References AMP::LinearAlgebra::VectorData::d_localStart.

◆ getLocalUpdateStatus()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

UpdateState AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getLocalUpdateStatus ( ) const

overridevirtual

Return the current update state of the Vector.

This returns the effective update state of the vector, including any vectors it contains. The effective state is defined as: UNCHANGED - All data and sub vectors are unchanged LOCAL_CHANGED - Local data may be modified, sub vectors must either be UNCHANGED or LOCAL_CHANGED. ADDING - Local and ghost data may be modified through add operations, sub vectors must be UNCHANGED, LOCAL_CHANGED, or ADDING SETTING - Local and ghost data may be modified through set operations, sub vectors must be UNCHANGED, LOCAL_CHANGED, or SETTING If different subvectors have incompatible states ADDING and SETTING, this function will return MIXED This version returns the local state only and does not involve communication

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData.

◆ getMemoryLocation()

virtual AMP::Utilities::MemoryType AMP::LinearAlgebra::VectorData::getMemoryLocation ( ) const

inlinevirtualinherited

returns the memory location for data

Reimplemented in AMP::LinearAlgebra::MultiVectorData, AMP::LinearAlgebra::VectorDataDefault< TYPE, Allocator >, and AMP::LinearAlgebra::VectorDataDefault< double, AMP::HostAllocator< void > >.

Definition at line 528 of file VectorData.h.

References AMP::Utilities::host.

◆ getNumberOfComponents()

virtual size_t AMP::LinearAlgebra::VectorData::getNumberOfComponents ( ) const

virtualinherited

Return integer number of data components.

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ getRawData() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::VectorData::getRawData ( TYPE * buf ) const

inherited

Copy data out of this vector.

Parameters

[out] buf Buffer to copy to

The Vector should be pre-allocated to the correct size (getLocalSize())

◆ getRawData() [2/2]

virtual void AMP::LinearAlgebra::VectorData::getRawData	(	void *	buf,
		const typeID &	id
	)		const

pure virtualinherited

Copy data out of this vector.

Parameters

[out]	buf	Buffer to copy to
[in]	id	typeID of raw data

The Vector should be pre-allocated to the correct size (getLocalSize())

◆ getRawDataBlock() [1/2]

template<typename RETURN_TYPE >

RETURN_TYPE * AMP::LinearAlgebra::VectorData::getRawDataBlock ( size_t i = 0 )

inherited

Obtain a particular contiguous block of data cast to RETURN_TYPE.

Template Parameters

RETURN_TYPE The pointer type of the return

Parameters

[in] i Which block

Returns: A contiguous array of type RETURN_TYPE

◆ getRawDataBlock() [2/2]

template<typename RETURN_TYPE >

const RETURN_TYPE * AMP::LinearAlgebra::VectorData::getRawDataBlock ( size_t i = 0 ) const

inherited

Obtain a particular contiguous block of data cast to RETURN_TYPE.

Template Parameters

RETURN_TYPE The pointer type of the return

Parameters

[in] i Which block

Returns: A const contiguous array of type RETURN_TYPE

◆ getRawDataBlockAsVoid() [1/2]

virtual const void * AMP::LinearAlgebra::VectorData::getRawDataBlockAsVoid ( size_t i ) const

pure virtualinherited

Return a pointer to a particular block of memory in the vector.

Parameters

i	The block to return

◆ getRawDataBlockAsVoid() [2/2]

virtual void * AMP::LinearAlgebra::VectorData::getRawDataBlockAsVoid ( size_t i )

pure virtualinherited

Return a pointer to a particular block of memory in the vector.

Parameters

i	The block to return

◆ getType()

virtual typeID AMP::LinearAlgebra::VectorData::getType ( size_t block ) const

pure virtualinherited

Return the typeid of the given block.

Parameters

block The block id to check

◆ getUpdateStatusPtr()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::shared_ptr< UpdateState > AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::getUpdateStatusPtr ( ) const

overridevirtual

Return the current update state of this Vector.

This returns the pointer to the update state of the current vector only (not vectors it contains). It should NOT be used by users.

Implements AMP::LinearAlgebra::VectorData.

◆ getValuesByGlobalID()

template<class TYPE >

void AMP::LinearAlgebra::VectorData::getValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		TYPE *	vals
	)		const

inherited

get values in the vector by their local offset

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector

This will get the owned values for this core. All indices are from 0.

◆ getValuesByLocalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::VectorData::getValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		TYPE *	vals
	)		const

inherited

Get local values in the vector by their global offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector

This will get any value used by this core.

◆ getValuesByLocalID() [2/2]

virtual void AMP::LinearAlgebra::VectorData::getValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		void *	vals,
		const typeID &	id
	)		const

pure virtualinherited

Get local values in the vector by their global offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[out]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will get any value used by this core.

◆ hasContiguousData()

virtual bool AMP::LinearAlgebra::VectorData::hasContiguousData ( ) const

inlinevirtualinherited

returns whether all data for the vector on a single process is contiguous

Reimplemented in AMP::LinearAlgebra::ManagedVectorData, AMP::LinearAlgebra::MultiVectorData, AMP::LinearAlgebra::SubsetCommSelfVectorData, and AMP::LinearAlgebra::SubsetVectorData.

Definition at line 113 of file VectorData.h.

◆ hasGhosts()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

bool AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::hasGhosts ( ) const

inlineoverridevirtual

Check if any entries "owned" by other cores are stored on this core.

Returns: True if any entries "owned" by other cores are stored on this core

Implements AMP::LinearAlgebra::VectorData.

Definition at line 26 of file GhostDataHelper.h.

References AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_ghostSize.

◆ isAnAliasOf()

virtual bool AMP::LinearAlgebra::VectorData::isAnAliasOf ( const VectorData & rhs ) const

virtualinherited

Check if the two VectorData objects are alias of each other.

This function checks if two VectorData objects are alias of each other. Two VectorData objects are alias if their data blocks are the same size and point to the same memory blocks.

Parameters

[in] rhs VectorData to compare

See also: makeConsistent

Reimplemented in AMP::LinearAlgebra::ManagedVectorData.

◆ isBlockType()

template<typename TYPE >

bool AMP::LinearAlgebra::VectorData::isBlockType ( size_t i = 0 ) const

inherited

Check if the data is of the given type.

Returns: true if the ith block of data is of the given type

◆ isType() [1/2]

template<typename TYPE >

bool AMP::LinearAlgebra::VectorData::isType ( ) const

inherited

Check if the data is of the given type.

Returns: true if all data is of the given type

◆ isType() [2/2]

bool AMP::LinearAlgebra::VectorData::isType	(	const typeID &	id,
		size_t	block
	)		const

inlineinherited

Is the data of the given type.

Parameters

id	The typeid
block	The block id to check

◆ makeConsistent() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::makeConsistent ( )

virtual

Update shared values on entire communicator.

This version will check the state of the vector and then call the appropriate version of makeConsistent

Reimplemented from AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData, and AMP::LinearAlgebra::NativePetscVectorData.

◆ makeConsistent() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::makeConsistent ( ScatterType t )

overridevirtual

Update shared values on entire communicator.

Parameters

t	The type of scatter used to compute values

There are two algorithms used by makeConsistent

If t = CONSISTENT_SET, then owned values are sent to processors that share the value. Shared values are overwritten
If t = CONSISTENT_ADD, then shared values are accumulated on the core that owns it and applied as determined, either add or set. Then, the values are broadcast out.

Generally, when adding to a vector, the GATHER_SCATTER should be used to make consistent. When setting entries in a vector the BROADCAST should be used.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData, AMP::LinearAlgebra::NativePetscVectorData, and AMP::LinearAlgebra::ManagedVectorData.

◆ makeConsistent() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::makeConsistent ( ScatterType t )

virtual

Update shared values on entire communicator.

Parameters

t	The type of scatter used to compute values

There are two algorithms used by makeConsistent

If t = CONSISTENT_SET, then owned values are sent to processors that share the value. Shared values are overwritten
If t = CONSISTENT_ADD, then shared values are accumulated on the core that owns it and applied as determined, either add or set. Then, the values are broadcast out.

Generally, when adding to a vector, the GATHER_SCATTER should be used to make consistent. When setting entries in a vector the BROADCAST should be used.

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData, AMP::LinearAlgebra::NativePetscVectorData, and AMP::LinearAlgebra::ManagedVectorData.

◆ numberOfDataBlocks()

virtual size_t AMP::LinearAlgebra::VectorData::numberOfDataBlocks ( ) const

pure virtualinherited

Number of blocks of contiguous data in the Vector.

Returns: Number of blocks in the Vector

A vector is not necessarily contiguous in memory. This method returns the number of contiguous blocks in memory used by this vector

◆ print()

virtual void AMP::LinearAlgebra::VectorData::print	(	std::ostream &	os,
		const std::string &	name = `"A"`,
		const std::string &	prefix = `""`
	)		const

virtualinherited

◆ putRawData() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::VectorData::putRawData ( const TYPE * buf )

inherited

Copy data into this vector.

Parameters

[in] buf Buffer to copy from

◆ putRawData() [2/2]

virtual void AMP::LinearAlgebra::VectorData::putRawData	(	const void *	buf,
		const typeID &	id
	)

pure virtualinherited

Copy data into this vector.

Parameters

[in]	buf	Buffer to copy from
[in]	id	typeID of raw data

◆ registerChildObjects()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::registerChildObjects ( AMP::IO::RestartManager * manager ) const

overridevirtual

Register any child objects.

This function will register child objects with the manager

Parameters

manager Restart manager

Reimplemented from AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDefault< TYPE, Allocator >, and AMP::LinearAlgebra::VectorDataDefault< double, AMP::HostAllocator< void > >.

◆ registerListener() [1/2]

virtual void AMP::LinearAlgebra::DataChangeFirer::registerListener ( DataChangeListener * listener )

virtualinherited

Register a listener with this DataChangeFirer.

Parameters

[in] listener The listener to be alerted to data change events

Adds a listener to itself.

◆ registerListener() [2/2]

virtual void AMP::LinearAlgebra::DataChangeFirer::registerListener ( std::shared_ptr< DataChangeListener > listener )

virtualinherited

Register a listener with this DataChangeFirer.

Parameters

[in] listener The listener to be alerted to data change events

Adds a listener to itself.

◆ reset()

virtual void AMP::LinearAlgebra::VectorData::reset ( )

virtualinherited

reset the vector data object

At present this interface is primarily meant for vector data over AMR hierarchies, where the number of AMR levels and vector data has to be reallocated

◆ scatter_add()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::scatter_add ( )

protected

◆ scatter_set()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::scatter_set ( )

protected

◆ setCommunicationList()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::setCommunicationList ( std::shared_ptr< CommunicationList > comm )

overridevirtual

Set the CommunicationList for this Vector.

Setting the CommunicationList for a Vector may involve reallocating ghost storage.

Implements AMP::LinearAlgebra::VectorData.

◆ setGhostValuesByGlobalID() [1/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

template<class TYPE >

void AMP::LinearAlgebra::VectorData::setGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

Set ghost values using global identifier.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

\( \mathit{this}_{\mathit{indices}_i} = \mathit{vals}_i \)

◆ setGhostValuesByGlobalID() [2/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::setGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

overridevirtual

Set ghost values using global identifier.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

\( \mathit{this}_{\mathit{indices}_i} = \mathit{vals}_i \)

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ setGhostValuesByGlobalID() [3/3]

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

virtual void AMP::LinearAlgebra::VectorData::setGhostValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

virtual

Set ghost values using global identifier.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

\( \mathit{this}_{\mathit{indices}_i} = \mathit{vals}_i \)

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, and AMP::LinearAlgebra::ManagedVectorData.

◆ setNoGhosts()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::setNoGhosts ( )

overridevirtual

Ensure this vector has no ghosts.

Calls clearBuffer for the communication list and removes any storage for ghosts

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ setUpdateStatus()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::setUpdateStatus ( UpdateState state )

overridevirtual

Sets the current update state of the Vector.

This sets the update status of the vector. This function should only be called by advanced users

Parameters

[in] state State of the vector to set

Implements AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::ManagedVectorData.

◆ setUpdateStatusPtr()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::setUpdateStatusPtr ( std::shared_ptr< UpdateState > rhs )

overridevirtual

Tie the current update state to another.

This sets the pointer to the update state of the current vector only (not vectors it contains). It should NOT be used by users.

Parameters

rhs	Pointer to share update state with

Implements AMP::LinearAlgebra::VectorData.

◆ setValuesByGlobalID()

template<class TYPE >

void AMP::LinearAlgebra::VectorData::setValuesByGlobalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

inherited

Set owned or shared values using global identifier.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

Since the shared buffer and owned buffer are separate, this function must sort the data by buffer before setting values.

◆ setValuesByLocalID() [1/2]

template<class TYPE >

void AMP::LinearAlgebra::VectorData::setValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		const TYPE *	vals
	)

inherited

Set values in the vector by their local offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector

This will set the owned values for this core. All indices are from 0. \( \mathit{this}_{\mathit{indices}_i} = \mathit{vals}_i \)

◆ setValuesByLocalID() [2/2]

virtual void AMP::LinearAlgebra::VectorData::setValuesByLocalID	(	size_t	num,
		const size_t *	indices,
		const void *	vals,
		const typeID &	id
	)

pure virtualinherited

Set values in the vector by their local offset.

Parameters

[in]	num	number of values to set
[in]	indices	the indices of the values to set
[in]	vals	the values to place in the vector
[in]	id	typeID of raw data

This will set the owned values for this core. All indices are from 0. \( \mathit{this}_{\mathit{indices}_i} = \mathit{vals}_i \)

◆ shared_from_this() [1/2]

std::shared_ptr< VectorData > AMP::enable_shared_from_this< VectorData >::shared_from_this ( )

inlineinherited

Definition at line 28 of file enable_shared_from_this.h.

◆ shared_from_this() [2/2]

std::shared_ptr< const VectorData > AMP::enable_shared_from_this< VectorData >::shared_from_this ( ) const

inlineinherited

Definition at line 46 of file enable_shared_from_this.h.

◆ sizeOfDataBlock()

virtual size_t AMP::LinearAlgebra::VectorData::sizeOfDataBlock ( size_t i = 0 ) const

pure virtualinherited

Number of elements in a data block.

Parameters

[in] i particular data block

Returns: The size of a particular block

◆ sizeofDataBlockType()

virtual size_t AMP::LinearAlgebra::VectorData::sizeofDataBlockType ( size_t i ) const

pure virtualinherited

Return the result of sizeof(TYPE) for the given data block.

Parameters

i	The block to return

◆ swapData()

virtual void AMP::LinearAlgebra::VectorData::swapData ( VectorData & rhs )

pure virtualinherited

Swap the data with another VectorData object.

Parameters

rhs	The VectorData to swap with

◆ VectorDataName()

virtual std::string AMP::LinearAlgebra::VectorData::VectorDataName ( ) const

pure virtualinherited

Get the type name.

◆ writeRestart()

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

void AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::writeRestart ( int64_t fid ) const

overridevirtual

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters

fid	File identifier to write

Reimplemented from AMP::LinearAlgebra::VectorData.

Reimplemented in AMP::LinearAlgebra::VectorDataDevice< TYPE, Allocator >, AMP::LinearAlgebra::VectorDataDefault< TYPE, Allocator >, and AMP::LinearAlgebra::VectorDataDefault< double, AMP::HostAllocator< void > >.

Member Data Documentation

◆ d_AddBuffer

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

TYPE* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_AddBuffer = nullptr

protected

Definition at line 96 of file GhostDataHelper.h.

◆ d_AddBuffer_h

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::vector<TYPE> AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_AddBuffer_h

protected

Definition at line 93 of file GhostDataHelper.h.

◆ d_alloc

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

ScalarAllocator_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_alloc

protected

Definition at line 89 of file GhostDataHelper.h.

◆ d_CommList

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::shared_ptr<CommunicationList> AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_CommList = nullptr

protected

Definition at line 83 of file GhostDataHelper.h.

◆ d_Ghosts

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

TYPE* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_Ghosts = nullptr

protected

Definition at line 95 of file GhostDataHelper.h.

◆ d_Ghosts_h

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::vector<TYPE> AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_Ghosts_h

protected

Definition at line 91 of file GhostDataHelper.h.

◆ d_ghostSize

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_ghostSize = 0

protected

size/length of ghost and add buffers

Definition at line 87 of file GhostDataHelper.h.

Referenced by AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::hasGhosts().

◆ d_globalSize

size_t AMP::LinearAlgebra::VectorData::d_globalSize = 0

protectedinherited

Number of local values.

Definition at line 675 of file VectorData.h.

Referenced by AMP::LinearAlgebra::VectorData::getGlobalSize().

◆ d_int_alloc

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

intAllocator_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_int_alloc

protected

Definition at line 107 of file GhostDataHelper.h.

◆ d_listeners

std::vector<DataChangeListener *> AMP::LinearAlgebra::DataChangeFirer::d_listeners

privateinherited

Definition at line 89 of file DataChangeFirer.h.

◆ d_localRemote

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_localRemote = nullptr

protected

list of local ids that are remote

Definition at line 110 of file GhostDataHelper.h.

◆ d_localSize

size_t AMP::LinearAlgebra::VectorData::d_localSize = 0

protectedinherited

Definition at line 674 of file VectorData.h.

Referenced by AMP::LinearAlgebra::GhostDataHelper< T, AMP::HostAllocator< void > >::getGhostValuesByGlobalID(), AMP::LinearAlgebra::EpetraVectorData::sizeOfDataBlock(), and AMP::LinearAlgebra::TpetraVectorData< ST, LO, GO, NT >::sizeOfDataBlock().

◆ d_localStart

size_t AMP::LinearAlgebra::VectorData::d_localStart = 0

protectedinherited

Number of global values.

Definition at line 676 of file VectorData.h.

Referenced by AMP::LinearAlgebra::VectorData::getLocalStartID().

◆ d_numRemote

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_numRemote = 0

protected

number of local ids that are remote

Definition at line 104 of file GhostDataHelper.h.

◆ d_ReceiveDOFList

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

size_t* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_ReceiveDOFList = nullptr

protected

Definition at line 101 of file GhostDataHelper.h.

◆ d_recvDisplacements

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

int* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_recvDisplacements = nullptr

protected

Definition at line 116 of file GhostDataHelper.h.

◆ d_recvSizes

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

int* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_recvSizes = nullptr

protected

Definition at line 114 of file GhostDataHelper.h.

◆ d_scatter_tag

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

int AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_scatter_tag

protected

Definition at line 119 of file GhostDataHelper.h.

◆ d_sendDisplacements

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

int* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_sendDisplacements = nullptr

protected

Definition at line 115 of file GhostDataHelper.h.

◆ d_SendRecv

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

TYPE* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_SendRecv = nullptr

protected

Buffers for sending/receiving data.

Definition at line 98 of file GhostDataHelper.h.

◆ d_SendRecv_h

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::vector<TYPE> AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_SendRecv_h

protected

Definition at line 92 of file GhostDataHelper.h.

◆ d_sendSizes

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

int* AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_sendSizes = nullptr

protected

Definition at line 113 of file GhostDataHelper.h.

◆ d_size_t_alloc

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

sizetAllocator_t AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_size_t_alloc

protected

Definition at line 106 of file GhostDataHelper.h.

◆ d_UpdateState

template<class TYPE = double, class Allocator = AMP::HostAllocator<void>>

std::shared_ptr<UpdateState> AMP::LinearAlgebra::GhostDataHelper< TYPE, Allocator >::d_UpdateState = nullptr

protected

Definition at line 84 of file GhostDataHelper.h.

◆ weak_ptr_

std::weak_ptr<VectorData > AMP::enable_shared_from_this< VectorData >::weak_ptr_

mutableprotectedinherited

Definition at line 69 of file enable_shared_from_this.h.

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

src/vectors/data/GhostDataHelper.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ intAllocator_t

◆ ScalarAllocator_t

◆ sizetAllocator_t

Constructor & Destructor Documentation

◆ GhostDataHelper() [1/3]

◆ GhostDataHelper() [2/3]

◆ ~GhostDataHelper()

◆ GhostDataHelper() [3/3]

Member Function Documentation

◆ addGhostValuesByGlobalID() [1/3]

◆ addGhostValuesByGlobalID() [2/3]

◆ addGhostValuesByGlobalID() [3/3]

◆ addValuesByGlobalID()

◆ addValuesByLocalID() [1/2]

◆ addValuesByLocalID() [2/2]

◆ allGhostIndices()

◆ allocateBuffers()

◆ assemble()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cloneData()

◆ constBegin()

◆ constEnd()

◆ containsGlobalElement()

◆ copyGhostValues()

◆ dataChanged()

◆ deallocateBuffers()

◆ deregisterListener()

◆ dumpGhostedData()

◆ dumpOwnedData()

◆ end() [1/2]

◆ end() [2/2]

◆ fillGhosts()

◆ fireDataChange()

◆ getAllGhostValues() [1/2]

◆ getAllGhostValues() [2/2]

◆ getComm()

◆ getCommunicationList()

◆ getComponent() [1/2]

◆ getComponent() [2/2]

◆ getDataID()

◆ getGhostAddValuesByGlobalID() [1/3]

◆ getGhostAddValuesByGlobalID() [2/3]

◆ getGhostAddValuesByGlobalID() [3/3]

◆ getGhostSize()

◆ getGhostValuesByGlobalID() [1/3]

◆ getGhostValuesByGlobalID() [2/3]

◆ getGhostValuesByGlobalID() [3/3]

◆ getGhostValuesByGlobalIDUnsorted()

◆ getGlobalSize()

◆ getGlobalUpdateStatus()

◆ getID()

◆ getLocalSize()

◆ getLocalSizes()

◆ getLocalStartID()

◆ getLocalUpdateStatus()

◆ getMemoryLocation()

◆ getNumberOfComponents()

◆ getRawData() [1/2]

◆ getRawData() [2/2]

◆ getRawDataBlock() [1/2]

◆ getRawDataBlock() [2/2]

◆ getRawDataBlockAsVoid() [1/2]

◆ getRawDataBlockAsVoid() [2/2]

◆ getType()

◆ getUpdateStatusPtr()

◆ getValuesByGlobalID()

◆ getValuesByLocalID() [1/2]

◆ getValuesByLocalID() [2/2]

◆ hasContiguousData()

◆ hasGhosts()

◆ isAnAliasOf()

◆ isBlockType()