Class ParallelVector

Inheritance Relationships

Derived Type

Class Documentation

class ParallelVector

An abstract implementation of a parallel vector.

Subclassed by opensn::ParallelSTLVector

Public Functions

ParallelVector(uint64_t local_size, uint64_t global_size, const mpi::Communicator &communicator)

Initialize a parallel vector with the given local and global sizes with the given communicator whose entries are set to zero.

ParallelVector(const ParallelVector &other)

Copy constructor.

ParallelVector(ParallelVector &&other) noexcept

Move constructor.

virtual std::unique_ptr<ParallelVector> MakeCopy() const = 0

Creates a copy of the vector datastructures AND values. This routine requires no communication.

virtual std::unique_ptr<ParallelVector> MakeClone() const = 0

Creates a copy of the vector datastructures but NOT the values. The values are defaulted to zero. This routine requires no communication.

virtual double *GetData() = 0

Returns a direct pointer to the memory array used internally by the vector to store its owned elements

virtual const double *GetData() const = 0

Returns a direct const pointer to the memory array used internally by the vector to store its owned elements

inline uint64_t GetLocalSize() const

Return the size of the locally owned portion of the parallel vector.

inline uint64_t GetGlobalSize() const

Return the global size of the parallel vector.

virtual double operator[](int64_t local_id) const = 0

Read only accessor to the entry at the given local index of the local vector.

Note

This accessor allows access to all locally stored elements, including any data beyond local_size_ that may exist in derived classes.

virtual double &operator[](int64_t local_id) = 0

Read/write accessor to the entry at the given local index of the local vector.

Note

This accessor allows access to all locally stored elements, including any data beyond local_size_ that may exist in derived classes.

virtual std::vector<double> MakeLocalVector() = 0

Return a vector containing the locally owned data.

virtual void Set(double value) = 0

Set the entries of the locally owned portion of the parallel vector to the given value.

virtual void Set(const std::vector<double> &local_vector) = 0

Set the entries of the locally owned portion of the parallel vector to the given STL vector.

virtual void BlockSet(const std::vector<double> &y, int64_t local_offset, int64_t num_values) = 0

Copies a contiguous block of data from the source STL vector to the current vector starting at local_offset. The input STL vector must have exactly num_values entries.

virtual void CopyLocalValues(const ParallelVector &y) = 0

Sets the local values of one vector equal to another. The sizes must be compatible.

virtual void CopyLocalValues(Vec y) = 0

Sets the local values of the vector equal to that of the PETSc vector. The sizes must be compatible.

virtual void BlockCopyLocalValues(const ParallelVector &y, int64_t y_offset, int64_t local_offset, int64_t num_values) = 0

Copies a contiguous block of local data (num_values entries) from the source vector (starting at y_offset) to the current vector starting at local_offset.

virtual void BlockCopyLocalValues(Vec y, int64_t y_offset, int64_t local_offset, int64_t num_values) = 0

Copies a contiguous block of local data (num_values entries) from the source vector (starting at y_offset) to the current vector starting at local_offset. PETSc flavor.

virtual void SetValue(int64_t global_id, double value, VecOpType op_type) = 0

Define a set or add operation for the given global id-value pair

This routine adds the global id-value pair to the set operation cache, which upon execution of Assemble, communicates the operations to the appropriate process.

virtual void SetValues(const std::vector<int64_t> &global_ids, const std::vector<double> &values, VecOpType op_type) = 0

Group multiple operations into a single call.

This routine goes through the given global id-value pairs and calls SetValue for each.

virtual void operator+=(const ParallelVector &y) = 0

In place adding of vectors. The sizes must be compatible.

virtual void PlusAY(const ParallelVector &y, double a) = 0

Adds a vector multiplied by scalar a, x=x+a*y. Optimized for a=1.0 and -1.0.

virtual void AXPlusY(double a, const ParallelVector &y) = 0

Performs x = a*x + y with the current vector being x.

virtual void Scale(double a) = 0

Scales a vector by a scalar.

virtual void Shift(double a) = 0

Adds a constant scalar value to all the entries of the vector.

virtual double ComputeNorm(NormType norm_type) const = 0

Returns the specified norm of the vector.

virtual void Assemble() = 0

Communicate all operations stored within the operation cache to the corresponding processes that own the respective global indices, and apply the operations.

This routine clears the respective operation cache once completed.

virtual std::string PrintStr() const = 0

Print the local vectors to stings.

inline virtual void CommunicateGhostEntries()

Communicate the current ghost entries, if applicable, to all other processes to update the locally stored ghost data.

virtual ~ParallelVector() = default

Protected Attributes

const uint64_t local_size_
const uint64_t global_size_
const int location_id_
const int process_count_
const mpi::Communicator &comm_