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

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

#include <VectorDataNull.h>

Inheritance diagram for AMP::LinearAlgebra::VectorDataNull:
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.
 
void addValuesByLocalID (size_t N, const size_t *, const void *, const typeID &) override
 Add values to vector entities by their local offset.
 
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 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.
 
std::shared_ptr< VectorDatacloneData (const std::string &="") 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 &) 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 &, size_t) 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 *, 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.
 
virtual std::shared_ptr< VectorDatagetComponent (size_t i=0)
 Number of elements in the ith component.
 
virtual std::shared_ptr< const VectorDatagetComponent (size_t i=0) const
 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.
 
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.
 
void getRawData (void *, const typeID &) 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) const override
 Return a pointer to a particular block of memory in the vector.
 
void * getRawDataBlockAsVoid (size_t) override
 Return a pointer to a particular block of memory in the vector.
 
typeID getType (size_t) 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
 
void getValuesByLocalID (size_t N, const size_t *, void *, const typeID &) const override
 Get local values in the vector by their global 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 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.
 
virtual void makeConsistent (ScatterType t)=0
 Update shared values on entire communicator.
 
void makeConsistent (ScatterType) override
 Update shared values on entire communicator.
 
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 *, const typeID &) override
 Copy data into this vector.
 
virtual void registerChildObjects (AMP::IO::RestartManager *manager) const
 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 >) 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.
 
virtual void setNoGhosts ()
 Ensure this vector has no ghosts.
 
void setUpdateStatus (UpdateState) override
 Sets the current update state of the Vector.
 
void setUpdateStatusPtr (std::shared_ptr< UpdateState >) 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.
 
void setValuesByLocalID (size_t N, const size_t *, const void *, const typeID &) override
 Set values in the vector by their local offset.
 
template<class TYPE >
void setValuesByLocalID (size_t num, const size_t *indices, const TYPE *vals)
 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=0) const override
 Number of elements in a data block.
 
size_t sizeofDataBlockType (size_t) const override
 Return the result of sizeof(TYPE) for the given data block.
 
void swapData (VectorData &) override
 Swap the data with another VectorData object.
 
std::string VectorDataName () const override
 Get the type name.
 
 VectorDataNull ()=delete
 
 VectorDataNull (const typeID &type)
 
virtual void writeRestart (int64_t fid) const
 Write restart data to file.
 

Protected Attributes

size_t d_globalSize = 0
 Number of local values.
 
size_t d_localSize = 0
 
size_t d_localStart = 0
 Number of global values.
 
std::weak_ptr< VectorDataweak_ptr_
 

Private Attributes

std::vector< DataChangeListener * > d_listeners
 
typeID d_type
 

Detailed Description

A class used to hold vector data.

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

Definition at line 16 of file VectorDataNull.h.

Constructor & Destructor Documentation

◆ VectorDataNull() [1/2]

AMP::LinearAlgebra::VectorDataNull::VectorDataNull ( )
delete

◆ VectorDataNull() [2/2]

AMP::LinearAlgebra::VectorDataNull::VectorDataNull ( const typeID type)
inline

Definition at line 20 of file VectorDataNull.h.

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::VectorDataNull::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]

void AMP::LinearAlgebra::VectorDataNull::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.

◆ addValuesByLocalID() [2/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 \)

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

std::shared_ptr< VectorData > AMP::LinearAlgebra::VectorDataNull::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::VectorDataNull::containsGlobalElement ( size_t  ) const
inlineoverridevirtual

Implements AMP::LinearAlgebra::VectorData.

Definition at line 42 of file VectorDataNull.h.

◆ copyGhostValues()

void AMP::LinearAlgebra::VectorDataNull::copyGhostValues ( const VectorData rhs)
inlineoverridevirtual

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.

Definition at line 45 of file VectorDataNull.h.

◆ dataChanged()

void AMP::LinearAlgebra::VectorDataNull::dataChanged ( )
inlineoverridevirtual

Notify listeners that data has changed in this vector.

Implements AMP::LinearAlgebra::VectorData.

Definition at line 43 of file VectorDataNull.h.

◆ 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::VectorDataNull::dumpGhostedData ( std::ostream &  out,
size_t  offset 
) const
inlineoverridevirtual

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.

Definition at line 44 of file VectorDataNull.h.

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

void AMP::LinearAlgebra::VectorDataNull::fillGhosts ( const Scalar x)
inlineoverridevirtual

Zero all ghost data (does not modify consistent status)

Implements AMP::LinearAlgebra::VectorData.

Definition at line 27 of file VectorDataNull.h.

◆ 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]valsthe values to place in the vector

This will get any value owned by this core.

◆ getAllGhostValues() [2/2]

size_t AMP::LinearAlgebra::VectorDataNull::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::VectorDataNull::getComm ( ) const
overridevirtual

Get the communicator.

Implements AMP::LinearAlgebra::VectorData.

◆ getCommunicationList()

std::shared_ptr< CommunicationList > AMP::LinearAlgebra::VectorDataNull::getCommunicationList ( ) const
inlineoverridevirtual

Get the CommunicationList for this Vector.

Implements AMP::LinearAlgebra::VectorData.

Definition at line 46 of file VectorDataNull.h.

◆ 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]iparticular 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]iparticular data block
Returns
The number of elements in the ith component

Reimplemented in AMP::LinearAlgebra::MultiVectorData.

◆ getDataID()

uint64_t AMP::LinearAlgebra::VectorDataNull::getDataID ( ) const
inlineoverridevirtual

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.

Definition at line 50 of file VectorDataNull.h.

◆ 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::VectorDataNull::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::VectorDataNull::getGhostSize ( ) const
inlineoverridevirtual

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.

Definition at line 49 of file VectorDataNull.h.

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

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

UpdateState AMP::LinearAlgebra::VectorDataNull::getLocalUpdateStatus ( ) const
inlineoverridevirtual

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.

Definition at line 38 of file VectorDataNull.h.

References AMP::LinearAlgebra::UNCHANGED.

◆ getMemoryLocation()

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

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

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

◆ getRawData() [2/2]

void AMP::LinearAlgebra::VectorDataNull::getRawData ( void *  buf,
const typeID id 
) const
inlineoverridevirtual

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.

Definition at line 25 of file VectorDataNull.h.

◆ 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::VectorDataNull::getRawDataBlockAsVoid ( size_t  i) const
inlineoverridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

Definition at line 52 of file VectorDataNull.h.

◆ getRawDataBlockAsVoid() [2/2]

void * AMP::LinearAlgebra::VectorDataNull::getRawDataBlockAsVoid ( size_t  i)
inlineoverridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

Definition at line 51 of file VectorDataNull.h.

◆ getType()

typeID AMP::LinearAlgebra::VectorDataNull::getType ( size_t  block) const
inlineoverridevirtual

Return the typeid of the given block.

Parameters
blockThe block id to check

Implements AMP::LinearAlgebra::VectorData.

Definition at line 37 of file VectorDataNull.h.

References d_type.

◆ getUpdateStatusPtr()

std::shared_ptr< UpdateState > AMP::LinearAlgebra::VectorDataNull::getUpdateStatusPtr ( ) const
inlineoverridevirtual

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.

Definition at line 41 of file VectorDataNull.h.

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

void AMP::LinearAlgebra::VectorDataNull::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.

◆ getValuesByLocalID() [2/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.

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

bool AMP::LinearAlgebra::VectorDataNull::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 VectorDataNull.h.

◆ 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/3]

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.

◆ makeConsistent() [2/3]

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

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.

◆ makeConsistent() [3/3]

void AMP::LinearAlgebra::VectorDataNull::makeConsistent ( ScatterType  t)
inlineoverridevirtual

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.

Definition at line 56 of file VectorDataNull.h.

◆ numberOfDataBlocks()

size_t AMP::LinearAlgebra::VectorDataNull::numberOfDataBlocks ( ) const
inlineoverridevirtual

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.

Definition at line 22 of file VectorDataNull.h.

◆ 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::VectorDataNull::putRawData ( const void *  buf,
const typeID id 
)
inlineoverridevirtual

Copy data into this vector.

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

Implements AMP::LinearAlgebra::VectorData.

Definition at line 24 of file VectorDataNull.h.

◆ registerChildObjects()

virtual void AMP::LinearAlgebra::VectorData::registerChildObjects ( AMP::IO::RestartManager manager) const
virtualinherited

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

◆ 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

◆ setCommunicationList()

void AMP::LinearAlgebra::VectorDataNull::setCommunicationList ( std::shared_ptr< CommunicationList comm)
inlineoverridevirtual

Set the CommunicationList for this Vector.

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

Implements AMP::LinearAlgebra::VectorData.

Definition at line 47 of file VectorDataNull.h.

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

virtual void AMP::LinearAlgebra::VectorData::setNoGhosts ( )
virtualinherited

◆ setUpdateStatus()

void AMP::LinearAlgebra::VectorDataNull::setUpdateStatus ( UpdateState  state)
inlineoverridevirtual

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.

Definition at line 39 of file VectorDataNull.h.

◆ setUpdateStatusPtr()

void AMP::LinearAlgebra::VectorDataNull::setUpdateStatusPtr ( std::shared_ptr< UpdateState rhs)
inlineoverridevirtual

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.

Definition at line 40 of file VectorDataNull.h.

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

void AMP::LinearAlgebra::VectorDataNull::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.

◆ setValuesByLocalID() [2/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 \)

◆ 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::VectorDataNull::sizeOfDataBlock ( size_t  i = 0) const
inlineoverridevirtual

Number of elements in a data block.

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

Implements AMP::LinearAlgebra::VectorData.

Definition at line 23 of file VectorDataNull.h.

◆ sizeofDataBlockType()

size_t AMP::LinearAlgebra::VectorDataNull::sizeofDataBlockType ( size_t  i) const
inlineoverridevirtual

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

Parameters
iThe block to return

Implements AMP::LinearAlgebra::VectorData.

Definition at line 53 of file VectorDataNull.h.

References AMP::typeID::bytes, and d_type.

◆ swapData()

void AMP::LinearAlgebra::VectorDataNull::swapData ( VectorData rhs)
inlineoverridevirtual

Swap the data with another VectorData object.

Parameters
rhsThe VectorData to swap with

Implements AMP::LinearAlgebra::VectorData.

Definition at line 54 of file VectorDataNull.h.

References AMP_ERROR.

◆ VectorDataName()

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

Get the type name.

Implements AMP::LinearAlgebra::VectorData.

Definition at line 21 of file VectorDataNull.h.

◆ writeRestart()

virtual void AMP::LinearAlgebra::VectorData::writeRestart ( int64_t  fid) const
virtualinherited

Member Data Documentation

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

typeID AMP::LinearAlgebra::VectorDataNull::d_type
private

Definition at line 60 of file VectorDataNull.h.

Referenced by getType(), and sizeofDataBlockType().

◆ 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:43.
Comments on this page