Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
AMP::LinearAlgebra::MultiVectorData Class Reference

A class used to hold vector data. More...

#include <MultiVectorData.h>

Inheritance diagram for AMP::LinearAlgebra::MultiVectorData:
Inheritance graph
[legend]

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, const size_t *, const void *, const typeID &) override
 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.
 
void addValuesByLocalID (size_t, const size_t *, const void *, const typeID &) override
 Add values to vector entities by their local offset.
 
void assemble () override
 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.
 
std::shared_ptr< VectorDatacloneData (const std::string &name="") const override
 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=0) const override
 Write data owned by other processors to an std::ostream.
 
void dumpOwnedData (std::ostream &out, size_t GIDoffset=0, size_t LIDoffset=0) const override
 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.
 
size_t getAllGhostValues (void *, const typeID &) const override
 Get all ghost values in the vector.
 
const AMP_MPIgetComm () const override
 Get the communicator.
 
std::shared_ptr< CommunicationListgetCommunicationList () const override
 Get the CommunicationList for this Vector.
 
std::shared_ptr< const VectorDatagetComponent (size_t i=0) const override
 Number of elements in the ith component.
 
std::shared_ptr< VectorDatagetComponent (size_t i=0) override
 Number of elements in the ith component.
 
uint64_t getDataID () const override
 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, const size_t *, void *, const typeID &) const override
 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, const size_t *, void *, const typeID &) const override
 Get ghost values in the vector by their global offset.
 
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.
 
std::vector< size_t > getLocalSizes () const override
 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.
 
AMP::Utilities::MemoryType getMemoryLocation () const override
 returns the memory location for data
 
size_t getNumberOfComponents () const override
 Return integer number of data components.
 
template<class TYPE >
void getRawData (TYPE *buf) const
 Copy data out of this vector.
 
void getRawData (void *buf, const typeID &id) const override
 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.
 
const void * getRawDataBlockAsVoid (size_t i) const override
 Return a pointer to a particular block of memory in the vector.
 
void * getRawDataBlockAsVoid (size_t i) override
 Return a pointer to a particular block of memory in the vector.
 
typeID getType (size_t block) const override
 Return the typeid of the given block.
 
std::shared_ptr< UpdateStategetUpdateStatusPtr () 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.
 
void getValuesByLocalID (size_t, const size_t *, void *, const typeID &) const override
 Get local values in the vector by their global offset.
 
VectorDatagetVectorData (size_t i)
 
const VectorDatagetVectorData (size_t i) const
 
size_t getVectorDataSize () const
 
bool hasContiguousData () const override
 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.
 
void makeConsistent () override
 Update shared values on entire communicator.
 
void makeConsistent (ScatterType t) override
 Update shared values on entire communicator.
 
 MultiVectorData (const AMP::AMP_MPI &comm)
 
 MultiVectorData (int64_t fid, AMP::IO::RestartManager *manager)
 Write restart data to file.
 
 MultiVectorData (VectorData *data, const AMP::Discretization::DOFManager *manager=nullptr)
 
size_t numberOfDataBlocks () const override
 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.
 
void putRawData (const void *buf, const typeID &id) override
 Copy data into this vector.
 
void receiveDataChanged () override
 The method called when a data change event occurs.
 
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 resetMultiVectorData (const AMP::Discretization::DOFManager *manager, const std::vector< VectorData * > &data)
 
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, const size_t *, const void *, const typeID &) override
 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.
 
void setValuesByLocalID (size_t, const size_t *, const void *, const typeID &) override
 Set values in the vector by their local offset.
 
std::shared_ptr< VectorDatashared_from_this ()
 
std::shared_ptr< const VectorDatashared_from_this () const
 
size_t sizeOfDataBlock (size_t i=0) const override
 Number of elements in a data block.
 
size_t sizeofDataBlockType (size_t i) const override
 Return the result of sizeof(TYPE) for the given data block.
 
void swapData (VectorData &rhs) override
 Swap the data with another VectorData object.
 
std::string VectorDataName () const override
 Get the type name.
 
void writeRestart (int64_t fid) const override
 Write restart data to file.
 
virtual ~MultiVectorData ()
 Virtual destructor.
 

Protected Member Functions

template<class TYPE >
size_t getAllGhostValues (TYPE *) const
 
void partitionGlobalValues (const int num, const size_t *indices, const void *vals, const size_t bytes, std::vector< std::vector< size_t > > &out_indices, std::vector< std::vector< std::byte > > &out_vals, std::vector< std::vector< int > > *remap=nullptr) const
 
void partitionLocalValues (const int num, const size_t *indices, const void *vals, const size_t bytes, std::vector< std::vector< size_t > > &out_indices, std::vector< std::vector< std::byte > > &out_vals, std::vector< std::vector< int > > *remap=nullptr) const
 

Protected Attributes

AMP::AMP_MPI d_comm
 
std::vector< VectorData * > d_data
 
AMP::Discretization::multiDOFHelper d_dofMap
 
size_t d_globalSize = 0
 Number of local values.
 
size_t d_localSize = 0
 
size_t d_localStart = 0
 Number of global values.
 
std::shared_ptr< UpdateStated_UpdateState
 
std::weak_ptr< VectorDataweak_ptr_
 

Private Member Functions

void deregisterFromFirer (DataChangeFirer *firer)
 Deregister this DataChangeListener with a DataChangeFirer.
 
void registerWithFirer (DataChangeFirer *firer)
 Register this DataChangeListener with a DataChangeFirer.
 

Private Attributes

std::vector< DataChangeFirer * > d_firers
 
std::vector< DataChangeListener * > d_listeners
 

Detailed Description

A class used to hold vector data.

MultiVectorData is a default implementation of VectorData that stores the local values as a single block of data on the CPU.

Definition at line 29 of file MultiVectorData.h.

Constructor & Destructor Documentation

◆ ~MultiVectorData()

virtual AMP::LinearAlgebra::MultiVectorData::~MultiVectorData ( )
inlinevirtual

Virtual destructor.

Definition at line 34 of file MultiVectorData.h.

◆ MultiVectorData() [1/3]

AMP::LinearAlgebra::MultiVectorData::MultiVectorData ( const AMP::AMP_MPI comm)
inlineexplicit

Definition at line 137 of file MultiVectorData.h.

◆ MultiVectorData() [2/3]

AMP::LinearAlgebra::MultiVectorData::MultiVectorData ( VectorData data,
const AMP::Discretization::DOFManager manager = nullptr 
)
explicit

◆ MultiVectorData() [3/3]

AMP::LinearAlgebra::MultiVectorData::MultiVectorData ( int64_t  fid,
AMP::IO::RestartManager manager 
)

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters
fidFile identifier to read
managerRestart manager

Member Function Documentation

◆ addGhostValuesByGlobalID() [1/2]

template<class TYPE >
void AMP::LinearAlgebra::VectorData::addGhostValuesByGlobalID ( size_t  num,
const size_t *  indices,
const TYPE *  vals 
)
inherited

Add shared values using global identifier.

Parameters
[in]numnumber of values to add
[in]indicesthe indices of the values to add
[in]valsthe values to place in the vector

◆ addGhostValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::MultiVectorData::addGhostValuesByGlobalID ( size_t  num,
const size_t *  indices,
const void *  vals,
const typeID id 
)
overridevirtual

Add shared values using global identifier.

Parameters
[in]numnumber of values to add
[in]indicesthe indices of the values to add
[in]valsthe values to place in the vector
[in]idtypeID of raw data

Implements AMP::LinearAlgebra::VectorData.

◆ 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]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe 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]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe 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]

void AMP::LinearAlgebra::MultiVectorData::addValuesByLocalID ( size_t  num,
const size_t *  indices,
const void *  vals,
const typeID id 
)
overridevirtual

Add values to vector entities by their local offset.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector
[in]idtypeID 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 \)

Implements AMP::LinearAlgebra::VectorData.

◆ assemble()

void AMP::LinearAlgebra::MultiVectorData::assemble ( )
overridevirtual

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

This method is empty except for instantiations of NativePetscVectorData

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ 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()

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

Clone the data.

Implements AMP::LinearAlgebra::VectorData.

◆ 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()

bool AMP::LinearAlgebra::MultiVectorData::containsGlobalElement ( size_t  ) const
overridevirtual

◆ copyGhostValues()

void AMP::LinearAlgebra::MultiVectorData::copyGhostValues ( const VectorData rhs)
overridevirtual

Copy ghosted vlues to a vector.

Parameters
[in]rhsVector 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()

void AMP::LinearAlgebra::MultiVectorData::dataChanged ( )
overridevirtual

Notify listeners that data has changed in this vector.

Implements AMP::LinearAlgebra::VectorData.

◆ deregisterFromFirer()

void AMP::LinearAlgebra::DataChangeListener::deregisterFromFirer ( DataChangeFirer firer)
privateinherited

Deregister this DataChangeListener with a DataChangeFirer.

Parameters
firerthe data change firer this object will no longer listen for

This method will erase firer from the list. This method is only used by the DataChangeFirer

◆ deregisterListener()

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

Deregister a listener with this DataChangeFirer.

Parameters
[in]listenerThe listener to remove from the list

Removes a listener from itself.

◆ dumpGhostedData()

void AMP::LinearAlgebra::MultiVectorData::dumpGhostedData ( std::ostream &  out,
size_t  offset = 0 
) const
overridevirtual

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

Parameters
[in]outThe output stream to write to.
[in]offsetA number to add to the global ID when writing information

Implements AMP::LinearAlgebra::VectorData.

◆ dumpOwnedData()

void AMP::LinearAlgebra::MultiVectorData::dumpOwnedData ( std::ostream &  out,
size_t  GIDoffset = 0,
size_t  LIDoffset = 0 
) const
overridevirtual

Write owned data to an std::ostream.

Parameters
[in]outThe output stream to write to.
[in]GIDoffsetA number to add to the global ID when writing information
[in]LIDoffsetA number to add to the local ID when writing information

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ 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()

void AMP::LinearAlgebra::MultiVectorData::fillGhosts ( const Scalar x)
overridevirtual

Zero all ghost data (does not modify consistent status)

Implements AMP::LinearAlgebra::VectorData.

◆ 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 receiveDataChanged().

◆ getAllGhostValues() [1/2]

template<class TYPE >
size_t AMP::LinearAlgebra::MultiVectorData::getAllGhostValues ( TYPE *  ) const
protected

◆ getAllGhostValues() [2/2]

size_t AMP::LinearAlgebra::MultiVectorData::getAllGhostValues ( void *  vals,
const typeID id 
) const
overridevirtual

Get all ghost values in the vector.

Parameters
[out]valsthe values to place in the vector
[in]idtypeID of raw data

This will get any value owned by this core.

Returns
Returns the number of ghost values

Implements AMP::LinearAlgebra::VectorData.

◆ getComm()

const AMP_MPI & AMP::LinearAlgebra::MultiVectorData::getComm ( ) const
inlineoverridevirtual

Get the communicator.

Implements AMP::LinearAlgebra::VectorData.

Definition at line 129 of file MultiVectorData.h.

References d_comm.

◆ getCommunicationList()

std::shared_ptr< CommunicationList > AMP::LinearAlgebra::MultiVectorData::getCommunicationList ( ) const
overridevirtual

◆ getComponent() [1/2]

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

Number of elements in the ith component.

Parameters
[in]iparticular data block
Returns
The number of elements in the ith component

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ getComponent() [2/2]

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

Number of elements in the ith component.

Parameters
[in]iparticular data block
Returns
The number of elements in the ith component

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ getDataID()

uint64_t AMP::LinearAlgebra::MultiVectorData::getDataID ( ) const
overridevirtual

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.

Implements AMP::LinearAlgebra::VectorData.

◆ getGhostAddValuesByGlobalID() [1/2]

template<class TYPE >
void AMP::LinearAlgebra::VectorData::getGhostAddValuesByGlobalID ( size_t  num,
const size_t *  indices,
TYPE *  vals 
) const
inherited

get ghosted values to add to off-proc elements

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector

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

◆ getGhostAddValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::MultiVectorData::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]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector
[in]idtypeID of raw data

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

Implements AMP::LinearAlgebra::VectorData.

◆ getGhostSize()

size_t AMP::LinearAlgebra::MultiVectorData::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/2]

template<class TYPE >
void AMP::LinearAlgebra::VectorData::getGhostValuesByGlobalID ( size_t  num,
const size_t *  indices,
TYPE *  vals 
) const
inherited

Get ghost values in the vector by their global offset.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[out]valsthe values to place in the vector

This will get any value owned by this core.

◆ getGhostValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::MultiVectorData::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]numnumber of values to set
[in]indicesthe indices of the values to set
[out]valsthe values to place in the vector
[in]idtypeID of raw data

This will get any value owned by this core.

Implements AMP::LinearAlgebra::VectorData.

◆ 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()

std::vector< size_t > AMP::LinearAlgebra::MultiVectorData::getLocalSizes ( ) const
overridevirtual

The local sizes on each rank.

Returns
The local sizes on each rank

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ 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()

UpdateState AMP::LinearAlgebra::MultiVectorData::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.

◆ getMemoryLocation()

AMP::Utilities::MemoryType AMP::LinearAlgebra::MultiVectorData::getMemoryLocation ( ) const
overridevirtual

returns the memory location for data

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ getNumberOfComponents()

size_t AMP::LinearAlgebra::MultiVectorData::getNumberOfComponents ( ) const
overridevirtual

Return integer number of data components.

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ getRawData() [1/2]

template<class TYPE >
void AMP::LinearAlgebra::VectorData::getRawData ( TYPE *  buf) const
inherited

Copy data out of this vector.

Parameters
[out]bufBuffer to copy to

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

◆ getRawData() [2/2]

void AMP::LinearAlgebra::MultiVectorData::getRawData ( void *  buf,
const typeID id 
) const
overridevirtual

Copy data out of this vector.

Parameters
[out]bufBuffer to copy to
[in]idtypeID of raw data

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

Implements AMP::LinearAlgebra::VectorData.

◆ 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_TYPEThe pointer type of the return
Parameters
[in]iWhich 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_TYPEThe pointer type of the return
Parameters
[in]iWhich block
Returns
A const contiguous array of type RETURN_TYPE

◆ getRawDataBlockAsVoid() [1/2]

const void * AMP::LinearAlgebra::MultiVectorData::getRawDataBlockAsVoid ( size_t  i) const
overridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

◆ getRawDataBlockAsVoid() [2/2]

void * AMP::LinearAlgebra::MultiVectorData::getRawDataBlockAsVoid ( size_t  i)
overridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

◆ getType()

typeID AMP::LinearAlgebra::MultiVectorData::getType ( size_t  block) const
overridevirtual

Return the typeid of the given block.

Parameters
blockThe block id to check

Implements AMP::LinearAlgebra::VectorData.

◆ getUpdateStatusPtr()

std::shared_ptr< UpdateState > AMP::LinearAlgebra::MultiVectorData::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]numnumber of values to set
[in]indicesthe indices of the values to set
[out]valsthe 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]numnumber of values to set
[in]indicesthe indices of the values to set
[out]valsthe values to place in the vector

This will get any value used by this core.

◆ getValuesByLocalID() [2/2]

void AMP::LinearAlgebra::MultiVectorData::getValuesByLocalID ( size_t  num,
const size_t *  indices,
void *  vals,
const typeID id 
) const
overridevirtual

Get local values in the vector by their global offset.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[out]valsthe values to place in the vector
[in]idtypeID of raw data

This will get any value used by this core.

Implements AMP::LinearAlgebra::VectorData.

◆ getVectorData() [1/2]

VectorData * AMP::LinearAlgebra::MultiVectorData::getVectorData ( size_t  i)

◆ getVectorData() [2/2]

const VectorData * AMP::LinearAlgebra::MultiVectorData::getVectorData ( size_t  i) const

◆ getVectorDataSize()

size_t AMP::LinearAlgebra::MultiVectorData::getVectorDataSize ( ) const
inline

Definition at line 127 of file MultiVectorData.h.

References d_data.

◆ hasContiguousData()

bool AMP::LinearAlgebra::MultiVectorData::hasContiguousData ( ) const
inlineoverridevirtual

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

Reimplemented from AMP::LinearAlgebra::VectorData.

Definition at line 64 of file MultiVectorData.h.

References numberOfDataBlocks().

◆ hasGhosts()

bool AMP::LinearAlgebra::MultiVectorData::hasGhosts ( ) const
overridevirtual

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.

◆ 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]rhsVectorData 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
idThe typeid
blockThe block id to check

◆ makeConsistent() [1/2]

void AMP::LinearAlgebra::MultiVectorData::makeConsistent ( )
overridevirtual

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.

◆ makeConsistent() [2/2]

void AMP::LinearAlgebra::MultiVectorData::makeConsistent ( ScatterType  t)
overridevirtual

Update shared values on entire communicator.

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

◆ numberOfDataBlocks()

size_t AMP::LinearAlgebra::MultiVectorData::numberOfDataBlocks ( ) const
overridevirtual

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

Implements AMP::LinearAlgebra::VectorData.

Referenced by hasContiguousData().

◆ partitionGlobalValues()

void AMP::LinearAlgebra::MultiVectorData::partitionGlobalValues ( const int  num,
const size_t *  indices,
const void *  vals,
const size_t  bytes,
std::vector< std::vector< size_t > > &  out_indices,
std::vector< std::vector< std::byte > > &  out_vals,
std::vector< std::vector< int > > *  remap = nullptr 
) const
protected

A method that will translate an array of global ids relative to the multivector into an array of arrays of global ids relative to the component vectors

Parameters
[in]numThe number of DOFs that need to be mapped
[in]indicesThe indices of the values relative to the multivector
[in]valsValues associated somehow with the indices
[in]bytesSize of a value
[out]out_indicesAn array of arrays of mapped indices relative to constituent vectors
[out]out_valsThe values partitioned according to out_indices
[out]remapIf not null, this is a list of where in the indices array an entry comes from

◆ partitionLocalValues()

void AMP::LinearAlgebra::MultiVectorData::partitionLocalValues ( const int  num,
const size_t *  indices,
const void *  vals,
const size_t  bytes,
std::vector< std::vector< size_t > > &  out_indices,
std::vector< std::vector< std::byte > > &  out_vals,
std::vector< std::vector< int > > *  remap = nullptr 
) const
protected

A method that will translate an array of local ids relative to the multivector into an array of arrays of local ids relative to the component vectors

Parameters
[in]numThe number of DOFs that need to be mapped
[in]indicesThe indices of the values relative to the multivector
[in]valsValues associated somehow with the indices
[in]bytesSize of a value
[out]out_indicesAn array of arrays of mapped indices relative to constituent vectors
[out]out_valsThe values partitioned according to out_indices
[out]remapIf not null, this is a list of where in the indices array an entry comes from

◆ 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]bufBuffer to copy from

◆ putRawData() [2/2]

void AMP::LinearAlgebra::MultiVectorData::putRawData ( const void *  buf,
const typeID id 
)
overridevirtual

Copy data into this vector.

Parameters
[in]bufBuffer to copy from
[in]idtypeID of raw data

Implements AMP::LinearAlgebra::VectorData.

◆ receiveDataChanged()

void AMP::LinearAlgebra::MultiVectorData::receiveDataChanged ( )
inlineoverridevirtual

The method called when a data change event occurs.

The method called when a data change event occurs

Implements AMP::LinearAlgebra::DataChangeListener.

Definition at line 135 of file MultiVectorData.h.

References AMP::LinearAlgebra::DataChangeFirer::fireDataChange().

◆ registerChildObjects()

void AMP::LinearAlgebra::MultiVectorData::registerChildObjects ( AMP::IO::RestartManager manager) const
overridevirtual

Register any child objects.

This function will register child objects with the manager

Parameters
managerRestart manager

Reimplemented from AMP::LinearAlgebra::VectorData.

◆ registerListener() [1/2]

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

Register a listener with this DataChangeFirer.

Parameters
[in]listenerThe 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]listenerThe listener to be alerted to data change events

Adds a listener to itself.

◆ registerWithFirer()

void AMP::LinearAlgebra::DataChangeListener::registerWithFirer ( DataChangeFirer firer)
privateinherited

Register this DataChangeListener with a DataChangeFirer.

Parameters
firerthe data change firer this object will listen for

This method will push firer onto the list. This method is only used by the DataChangeFirer

◆ 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

◆ resetMultiVectorData()

void AMP::LinearAlgebra::MultiVectorData::resetMultiVectorData ( const AMP::Discretization::DOFManager manager,
const std::vector< VectorData * > &  data 
)

◆ setCommunicationList()

void AMP::LinearAlgebra::MultiVectorData::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/2]

template<class TYPE >
void AMP::LinearAlgebra::VectorData::setGhostValuesByGlobalID ( size_t  num,
const size_t *  indices,
const TYPE *  vals 
)
inherited

Set ghost values using global identifier.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector

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

◆ setGhostValuesByGlobalID() [2/2]

void AMP::LinearAlgebra::MultiVectorData::setGhostValuesByGlobalID ( size_t  num,
const size_t *  indices,
const void *  vals,
const typeID id 
)
overridevirtual

Set ghost values using global identifier.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector
[in]idtypeID of raw data

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

Implements AMP::LinearAlgebra::VectorData.

◆ setNoGhosts()

void AMP::LinearAlgebra::MultiVectorData::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()

void AMP::LinearAlgebra::MultiVectorData::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]stateState of the vector to set

Implements AMP::LinearAlgebra::VectorData.

◆ setUpdateStatusPtr()

void AMP::LinearAlgebra::MultiVectorData::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
rhsPointer 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]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe 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]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe 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]

void AMP::LinearAlgebra::MultiVectorData::setValuesByLocalID ( size_t  num,
const size_t *  indices,
const void *  vals,
const typeID id 
)
overridevirtual

Set values in the vector by their local offset.

Parameters
[in]numnumber of values to set
[in]indicesthe indices of the values to set
[in]valsthe values to place in the vector
[in]idtypeID 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 \)

Implements AMP::LinearAlgebra::VectorData.

◆ 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()

size_t AMP::LinearAlgebra::MultiVectorData::sizeOfDataBlock ( size_t  i = 0) const
overridevirtual

Number of elements in a data block.

Parameters
[in]iparticular data block
Returns
The size of a particular block

Implements AMP::LinearAlgebra::VectorData.

◆ sizeofDataBlockType()

size_t AMP::LinearAlgebra::MultiVectorData::sizeofDataBlockType ( size_t  i) const
overridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

◆ swapData()

void AMP::LinearAlgebra::MultiVectorData::swapData ( VectorData rhs)
overridevirtual

Swap the data with another VectorData object.

Parameters
rhsThe VectorData to swap with

Implements AMP::LinearAlgebra::VectorData.

◆ VectorDataName()

std::string AMP::LinearAlgebra::MultiVectorData::VectorDataName ( ) const
inlineoverridevirtual

Get the type name.

Implements AMP::LinearAlgebra::VectorData.

Definition at line 38 of file MultiVectorData.h.

◆ writeRestart()

void AMP::LinearAlgebra::MultiVectorData::writeRestart ( int64_t  fid) const
overridevirtual

Write restart data to file.

This function will write the mesh to an HDF5 file

Parameters
fidFile identifier to write

Reimplemented from AMP::LinearAlgebra::VectorData.

Member Data Documentation

◆ d_comm

AMP::AMP_MPI AMP::LinearAlgebra::MultiVectorData::d_comm
protected

Definition at line 217 of file MultiVectorData.h.

Referenced by getComm().

◆ d_data

std::vector<VectorData *> AMP::LinearAlgebra::MultiVectorData::d_data
protected

Definition at line 218 of file MultiVectorData.h.

Referenced by getVectorDataSize().

◆ d_dofMap

AMP::Discretization::multiDOFHelper AMP::LinearAlgebra::MultiVectorData::d_dofMap
protected

Definition at line 219 of file MultiVectorData.h.

◆ d_firers

std::vector<DataChangeFirer *> AMP::LinearAlgebra::DataChangeListener::d_firers
privateinherited

Definition at line 80 of file DataChangeListener.h.

◆ 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_listeners

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

Definition at line 89 of file DataChangeFirer.h.

◆ d_localSize

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

◆ 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_UpdateState

std::shared_ptr<UpdateState> AMP::LinearAlgebra::MultiVectorData::d_UpdateState
protected

Definition at line 220 of file MultiVectorData.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:



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page