Loading [MathJax]/extensions/tex2jax.js
OGS
MathLib::PETScVector Class Reference

Detailed Description

Wrapper class for PETSc vector.

It can be used to create a global vector for either parallel or serial computing.

Caution: Using it to create a local vector is not allowed, as the created vector will be partitioned and distributed across all ranks in an MPI environment.

Definition at line 40 of file PETScVector.h.

#include <PETScVector.h>

Public Types

using IndexType = PetscInt
 
using PETSc_Vec = Vec
 

Public Member Functions

 PETScVector ()
 
 PETScVector (const PetscInt vec_size, const bool is_global_size=true)
 Constructor.
 
 PETScVector (const PetscInt vec_size, const std::vector< PetscInt > &ghost_ids, const bool is_global_size=true)
 Constructor.
 
 PETScVector (const PETScVector &existing_vec, const bool deep_copy=true)
 Copy constructor.
 
 PETScVector (PETScVector &&other)
 
 ~PETScVector ()
 
void finalizeAssembly ()
 Perform MPI collection of assembled entries in buffer.
 
PetscInt size () const
 Get the global size of the vector.
 
PetscInt getLocalSize () const
 Get the number of entries in the same rank.
 
PetscInt getGhostSize () const
 Get the number of ghost entries in the same rank.
 
PetscInt getRangeBegin () const
 Get the start index of the local vector.
 
PetscInt getRangeEnd () const
 Get the end index of the local vector.
 
void set (const PetscInt i, const PetscScalar value)
 
void add (const PetscInt i, const PetscScalar value)
 
template<class T_SUBVEC >
void add (const std::vector< PetscInt > &e_idxs, const T_SUBVEC &sub_vec)
 
template<class T_SUBVEC >
void set (const std::vector< PetscInt > &e_idxs, const T_SUBVEC &sub_vec)
 
void setZero ()
 
PETScVectoroperator= (PETScVector &&)=delete
 
void setLocalAccessibleVector () const
 
std::vector< PetscScalar > get (std::vector< IndexType > const &indices) const
 
PetscScalar operator[] (PetscInt idx) const
 
void getGlobalVector (std::vector< PetscScalar > &u) const
 
PetscScalar get (const PetscInt idx) const
 
PETSc_VecgetRawVector ()
 Exposes the underlying PETSc vector.
 
PETSc_Vec const & getRawVector () const
 
void copyValues (std::vector< PetscScalar > &u) const
 
void copyValues (std::span< PetscScalar > u) const
 
void viewer (const std::string &file_name, const PetscViewerFormat vw_format=PETSC_VIEWER_ASCII_MATLAB) const
 
void shallowCopy (const PETScVector &v)
 

Private Member Functions

void destroy ()
 
PetscScalar * getLocalVector () const
 
PetscInt getLocalIndex (const PetscInt global_index) const
 Get local index by a global index.
 
void restoreArray (PetscScalar *array) const
 
void config ()
 A function called by constructors to configure members.
 

Private Attributes

PETSc_Vec v_ = nullptr
 
PETSc_Vec v_loc_ = nullptr
 
PetscInt start_rank_
 Starting index in a rank.
 
PetscInt end_rank_
 Ending index in a rank.
 
PetscInt size_
 Size of the vector.
 
PetscInt size_loc_
 Size of local entries.
 
PetscInt size_ghosts_ = 0
 Size of local ghost entries.
 
bool created_with_ghost_id_ = false
 Flag to indicate whether the vector is created with ghost entry indices.
 
std::vector< PetscScalar > entry_array_
 Array containing the entries of the vector. If the vector is created without given ghost IDs, the array contains all entries of the global vector, v_. Otherwise it only contains the entries of the global vector owned by the current rank.
 
std::map< PetscInt, PetscInt > global_ids2local_ids_ghost_
 Map global indices of ghost entries to local indices.
 

Friends

void finalizeVectorAssembly (PETScVector &vec)
 Function to finalize the vector assembly.
 

Member Typedef Documentation

◆ IndexType

Definition at line 43 of file PETScVector.h.

◆ PETSc_Vec

Definition at line 46 of file PETScVector.h.

Constructor & Destructor Documentation

◆ PETScVector() [1/5]

MathLib::PETScVector::PETScVector ( )
inline

Definition at line 49 of file PETScVector.h.

49{}

◆ PETScVector() [2/5]

MathLib::PETScVector::PETScVector ( const PetscInt vec_size,
const bool is_global_size = true )

Constructor.

Parameters
vec_sizeThe size of the vector, either global or local
is_global_sizeThe flag of the type of vec_size, i.e. whether it is a global size or local size. The default is true. If is_global_size is true, the vector is created by the global size, the local size of the vector is determined by PETSc, and vice versa is the same.

Definition at line 32 of file PETScVector.cpp.

33{
34 if (is_global_size)
35 {
36 VecCreate(PETSC_COMM_WORLD, &v_);
37 VecSetSizes(v_, PETSC_DECIDE, vec_size);
38 }
39 else
40 {
41 // Fix size partitioning
42 // the size can be associated to specific memory allocation of a matrix
43 VecCreateMPI(PETSC_COMM_WORLD, vec_size, PETSC_DECIDE, &v_);
44 }
45
46 config();
47}
void config()
A function called by constructors to configure members.

References config(), and v_.

◆ PETScVector() [3/5]

MathLib::PETScVector::PETScVector ( const PetscInt vec_size,
const std::vector< PetscInt > & ghost_ids,
const bool is_global_size = true )

Constructor.

Parameters
vec_sizeThe size of the vector, either global or local
ghost_idsThe global indices of ghost entries
is_global_sizeThe flag of the type of vec_size, i.e. whether it is a global size or local size. The default is true.

Definition at line 49 of file PETScVector.cpp.

52 : size_ghosts_{static_cast<PetscInt>(ghost_ids.size())},
54{
55 PetscInt nghosts = static_cast<PetscInt>(ghost_ids.size());
56 if (is_global_size)
57 {
58 VecCreateGhost(PETSC_COMM_WORLD, PETSC_DECIDE, vec_size, nghosts,
59 ghost_ids.data(), &v_);
60 }
61 else
62 {
63 VecCreate(PETSC_COMM_WORLD, &v_);
64 VecSetType(v_, VECMPI);
65 VecSetSizes(v_, vec_size, PETSC_DECIDE);
66 VecMPISetGhost(v_, nghosts, ghost_ids.data());
67 }
68
69 config();
70
71 for (PetscInt i = 0; i < nghosts; i++)
72 {
73 global_ids2local_ids_ghost_.emplace(ghost_ids[i], size_loc_ + i);
74 }
75}
PetscInt size_loc_
Size of local entries.
bool created_with_ghost_id_
Flag to indicate whether the vector is created with ghost entry indices.
PetscInt size_ghosts_
Size of local ghost entries.
std::map< PetscInt, PetscInt > global_ids2local_ids_ghost_
Map global indices of ghost entries to local indices.

References config(), global_ids2local_ids_ghost_, size_loc_, and v_.

◆ PETScVector() [4/5]

MathLib::PETScVector::PETScVector ( const PETScVector & existing_vec,
const bool deep_copy = true )
explicit

Copy constructor.

Parameters
existing_vecThe vector to be copied
deep_copyThe flag for a deep copy, which means to copy the values as well, the default is true

Definition at line 77 of file PETScVector.cpp.

78{
79 shallowCopy(existing_vec);
80
81 // Copy values
82 if (deep_copy)
83 {
84 VecCopy(existing_vec.v_, v_);
85 }
86}
void shallowCopy(const PETScVector &v)

References shallowCopy(), and v_.

◆ PETScVector() [5/5]

MathLib::PETScVector::PETScVector ( PETScVector && other)

Definition at line 88 of file PETScVector.cpp.

89 : v_{std::move(other.v_)},
90 v_loc_{std::move(other.v_loc_)},
91 start_rank_{other.start_rank_},
92 end_rank_{other.end_rank_},
93 size_{other.size_},
94 size_loc_{other.size_loc_},
95 size_ghosts_{other.size_ghosts_},
96 created_with_ghost_id_{other.created_with_ghost_id_},
97 global_ids2local_ids_ghost_{other.global_ids2local_ids_ghost_}
98{
99}
PetscInt start_rank_
Starting index in a rank.
PetscInt size_
Size of the vector.
PetscInt end_rank_
Ending index in a rank.

◆ ~PETScVector()

MathLib::PETScVector::~PETScVector ( )
inline

Definition at line 85 of file PETScVector.h.

85{ destroy(); }

References destroy().

Member Function Documentation

◆ add() [1/2]

void MathLib::PETScVector::add ( const PetscInt i,
const PetscScalar value )
inline

Add a value to an entry.

Parameters
iNumber of the entry
valueValue.

Definition at line 115 of file PETScVector.h.

116 {
117 VecSetValue(v_, i, value, ADD_VALUES);
118 }

References v_.

◆ add() [2/2]

template<class T_SUBVEC >
void MathLib::PETScVector::add ( const std::vector< PetscInt > & e_idxs,
const T_SUBVEC & sub_vec )
inline

Add values to several entries.

Parameters
e_idxsIndices of entries to be added Note: std::size_t cannot be the type of e_idxs template argument.
sub_vecEntries to be added.

Definition at line 128 of file PETScVector.h.

129 {
130 VecSetValues(v_, e_idxs.size(), &e_idxs[0], &sub_vec[0], ADD_VALUES);
131 }

References v_.

◆ config()

void MathLib::PETScVector::config ( )
private

A function called by constructors to configure members.

Definition at line 101 of file PETScVector.cpp.

102{
103 VecSetFromOptions(v_);
104 VecGetOwnershipRange(v_, &start_rank_, &end_rank_);
105
106 VecGetLocalSize(v_, &size_loc_);
107 VecGetSize(v_, &size_);
108
109 VecSetOption(v_, VEC_IGNORE_NEGATIVE_INDICES, PETSC_TRUE);
110}

References end_rank_, size_, size_loc_, start_rank_, and v_.

Referenced by PETScVector(), PETScVector(), and shallowCopy().

◆ copyValues() [1/2]

void MathLib::PETScVector::copyValues ( std::span< PetscScalar > u) const

Copy local entries including ghost ones to a span.

Parameters
ua span for the values of local entries. If the sizes of the vector and the span mismatch, an exception will be thrown.

Definition at line 177 of file PETScVector.cpp.

178{
179 if (u.size() != static_cast<std::size_t>(getLocalSize() + getGhostSize()))
180 {
181 OGS_FATAL(
182 "PETScVector::copyValues() size mismatch. Trying to copy a vector "
183 "of size {:d} to a span of size {:d}.",
184 getLocalSize() + getGhostSize(), u.size());
185 }
186
187 PetscScalar* loc_x = getLocalVector();
188 std::copy_n(loc_x, getLocalSize() + getGhostSize(), u.begin());
189 restoreArray(loc_x);
190}
#define OGS_FATAL(...)
Definition Error.h:26
void restoreArray(PetscScalar *array) const
PetscInt getLocalSize() const
Get the number of entries in the same rank.
Definition PETScVector.h:92
PetscScalar * getLocalVector() const
PetscInt getGhostSize() const
Get the number of ghost entries in the same rank.
Definition PETScVector.h:94
static const double u

References getGhostSize(), getLocalSize(), getLocalVector(), OGS_FATAL, restoreArray(), and MathLib::u.

◆ copyValues() [2/2]

void MathLib::PETScVector::copyValues ( std::vector< PetscScalar > & u) const

Copy local entries including ghost ones to a vector.

Parameters
ua vector for the values of local entries. It will be resized to hold the current vector data.

Definition at line 168 of file PETScVector.cpp.

169{
170 u.resize(getLocalSize() + getGhostSize());
171
172 PetscScalar* loc_x = getLocalVector();
173 std::copy_n(loc_x, getLocalSize() + getGhostSize(), u.begin());
174 restoreArray(loc_x);
175}

References getGhostSize(), getLocalSize(), getLocalVector(), restoreArray(), and MathLib::u.

Referenced by setLocalAccessibleVector().

◆ destroy()

void MathLib::PETScVector::destroy ( )
inlineprivate

Definition at line 237 of file PETScVector.h.

238 {
239 if (v_ != nullptr)
240 {
241 VecDestroy(&v_);
242 }
243 v_ = nullptr;
244 }

References v_.

Referenced by ~PETScVector(), and shallowCopy().

◆ finalizeAssembly()

void MathLib::PETScVector::finalizeAssembly ( )

Perform MPI collection of assembled entries in buffer.

Definition at line 112 of file PETScVector.cpp.

113{
114 VecAssemblyBegin(v_);
115 VecAssemblyEnd(v_);
116}

References v_.

Referenced by MathLib::applyKnownSolution(), and MathLib::LinAlg::finalizeAssembly().

◆ get() [1/2]

PetscScalar MathLib::PETScVector::get ( const PetscInt idx) const

Definition at line 192 of file PETScVector.cpp.

193{
195 {
196 return entry_array_[getLocalIndex(idx)];
197 }
198
199 return entry_array_[idx];
200}
std::vector< PetscScalar > entry_array_
Array containing the entries of the vector. If the vector is created without given ghost IDs,...
PetscInt getLocalIndex(const PetscInt global_index) const
Get local index by a global index.

References created_with_ghost_id_, entry_array_, and getLocalIndex().

◆ get() [2/2]

std::vector< PetscScalar > MathLib::PETScVector::get ( std::vector< IndexType > const & indices) const

Get several entries. setLocalAccessibleVector() must be called beforehand.

Definition at line 202 of file PETScVector.cpp.

204{
205 std::vector<PetscScalar> local_x(indices.size());
206 std::transform(indices.begin(), indices.end(), local_x.begin(),
207 [this](IndexType index) { return get(index); });
208 return local_x;
209}

Referenced by operator[]().

◆ getGhostSize()

PetscInt MathLib::PETScVector::getGhostSize ( ) const
inline

Get the number of ghost entries in the same rank.

Definition at line 94 of file PETScVector.h.

94{ return size_ghosts_; }

References size_ghosts_.

Referenced by copyValues(), and copyValues().

◆ getGlobalVector()

void MathLib::PETScVector::getGlobalVector ( std::vector< PetscScalar > & u) const

Get global vector

Parameters
uArray to store the global vector. Memory allocation is needed in advance

Definition at line 118 of file PETScVector.cpp.

119{
120#ifdef TEST_MEM_PETSC
121 PetscLogDouble mem1, mem2;
122 PetscMemoryGetCurrentUsage(&mem1);
123#endif
124
125 assert(static_cast<PetscInt>(u.size()) == size_);
126
127 PetscInt state;
128 VecLockGet(v_, &state);
129 if (state != 0)
130 {
131 OGS_FATAL("PETSc vector is already locked for {:s} access.",
132 state > 0 ? "read" : "write");
133 }
134 PetscScalar* xp = nullptr;
135 VecGetArray(v_, &xp);
136
137 BaseLib::MPI::Mpi mpi{PETSC_COMM_WORLD};
138 BaseLib::MPI::allgatherv(std::span(xp, size_loc_), u, mpi);
139
140 // This following line may be needed late on
141 // for a communication load balance:
142 // MPI_Barrier(PETSC_COMM_WORLD);
143
144 VecRestoreArray(v_, &xp);
145
146// TEST
147#ifdef TEST_MEM_PETSC
148 PetscMemoryGetCurrentUsage(&mem2);
149 PetscPrintf(
150 PETSC_COMM_WORLD,
151 "### Memory usage by Updating. Before :%f After:%f Increase:%d\n", mem1,
152 mem2, (int)(mem2 - mem1));
153#endif
154}
static std::vector< int > allgatherv(std::span< T > const send_buffer, std::vector< std::remove_const_t< T > > &receive_buffer, Mpi const &mpi)
Definition MPI.h:164

References BaseLib::MPI::allgatherv(), OGS_FATAL, size_, size_loc_, MathLib::u, and v_.

Referenced by setLocalAccessibleVector().

◆ getLocalIndex()

PetscInt MathLib::PETScVector::getLocalIndex ( const PetscInt global_index) const
private

Get local index by a global index.

Definition at line 229 of file PETScVector.cpp.

230{
231 if (global_index >= 0) // non-ghost entry.
232 {
233#ifndef NDEBUG
234 if (global_index < start_rank_ || global_index >= end_rank_)
235 {
236 OGS_FATAL(
237 "The global index {:d} is out of the range `[`{:d}, {:d}`)` of "
238 "the current rank.",
239 global_index, start_rank_, end_rank_);
240 }
241#endif
242 return global_index - start_rank_;
243 }
244
245 // A special case for a ghost location with global index equal to
246 // the size of the local vector:
247 PetscInt real_global_index = (-global_index == size_) ? 0 : -global_index;
248
249#ifndef NDEBUG
250 if (global_ids2local_ids_ghost_.find(real_global_index) ==
253 {
254 OGS_FATAL("The global index {:d} is not found as a ghost ID",
255 global_index);
256 }
257#endif
258
259 return global_ids2local_ids_ghost_.at(real_global_index);
260}

References end_rank_, global_ids2local_ids_ghost_, OGS_FATAL, size_, and start_rank_.

Referenced by get().

◆ getLocalSize()

PetscInt MathLib::PETScVector::getLocalSize ( ) const
inline

Get the number of entries in the same rank.

Definition at line 92 of file PETScVector.h.

92{ return size_loc_; }

References size_loc_.

Referenced by copyValues(), and copyValues().

◆ getLocalVector()

PetscScalar * MathLib::PETScVector::getLocalVector ( ) const
private

Get local vector, i.e. entries in the same rank

Definition at line 211 of file PETScVector.cpp.

212{
213 PetscScalar* loc_array;
215 {
216 VecGhostUpdateBegin(v_, INSERT_VALUES, SCATTER_FORWARD);
217 VecGhostUpdateEnd(v_, INSERT_VALUES, SCATTER_FORWARD);
218 VecGhostGetLocalForm(v_, &v_loc_);
219 VecGetArray(v_loc_, &loc_array);
220 }
221 else
222 {
223 VecGetArray(v_, &loc_array);
224 }
225
226 return loc_array;
227}

References created_with_ghost_id_, global_ids2local_ids_ghost_, v_, and v_loc_.

Referenced by copyValues(), and copyValues().

◆ getRangeBegin()

PetscInt MathLib::PETScVector::getRangeBegin ( ) const
inline

Get the start index of the local vector.

Definition at line 96 of file PETScVector.h.

96{ return start_rank_; }

References start_rank_.

◆ getRangeEnd()

PetscInt MathLib::PETScVector::getRangeEnd ( ) const
inline

Get the end index of the local vector.

Definition at line 98 of file PETScVector.h.

98{ return end_rank_; }

References end_rank_.

◆ getRawVector() [1/2]

◆ getRawVector() [2/2]

PETSc_Vec const & MathLib::PETScVector::getRawVector ( ) const
inline

Exposes the underlying PETSc vector.

Warning
This method is dangerous insofar as you can do arbitrary things also with a const PETSc vector!

Definition at line 186 of file PETScVector.h.

186{ return v_; }

References v_.

◆ operator=()

PETScVector & MathLib::PETScVector::operator= ( PETScVector && )
delete

Disallow moving.

Todo
This operator should be implemented properly when doing a general cleanup of all matrix and vector classes.

◆ operator[]()

PetscScalar MathLib::PETScVector::operator[] ( PetscInt idx) const
inline

Get the value of an entry by [] operator. setLocalAccessibleVector() must be called beforehand.

Definition at line 163 of file PETScVector.h.

163{ return get(idx); }
std::vector< PetscScalar > get(std::vector< IndexType > const &indices) const

References get().

◆ restoreArray()

void MathLib::PETScVector::restoreArray ( PetscScalar * array) const
inlineprivate

Restore array after finish access local array

Parameters
arrayPointer to the local array fetched by VecGetArray

Definition at line 262 of file PETScVector.cpp.

263{
265 {
266 VecRestoreArray(v_loc_, &array);
267 VecGhostRestoreLocalForm(v_, &v_loc_);
268 }
269 else
270 {
271 VecRestoreArray(v_, &array);
272 }
273}

References created_with_ghost_id_, global_ids2local_ids_ghost_, v_, and v_loc_.

Referenced by copyValues(), and copyValues().

◆ set() [1/2]

void MathLib::PETScVector::set ( const PetscInt i,
const PetscScalar value )
inline

Insert a single entry with value.

Parameters
iEntry index
valueEntry value

Definition at line 105 of file PETScVector.h.

106 {
107 VecSetValue(v_, i, value, INSERT_VALUES);
108 }

References v_.

Referenced by MathLib::applyKnownSolution().

◆ set() [2/2]

template<class T_SUBVEC >
void MathLib::PETScVector::set ( const std::vector< PetscInt > & e_idxs,
const T_SUBVEC & sub_vec )
inline

Add values to several entries

Parameters
e_idxsIndices of entries to be added. Note: std::size_t cannot be the type of e_idxs template argument
sub_vecEntries to be added

Definition at line 141 of file PETScVector.h.

142 {
143 VecSetValues(v_, e_idxs.size(), &e_idxs[0], &sub_vec[0], INSERT_VALUES);
144 }

References v_.

◆ setLocalAccessibleVector()

void MathLib::PETScVector::setLocalAccessibleVector ( ) const

Set local accessible vector in order to get entries. Call this before call operator[] or get(...).

Definition at line 156 of file PETScVector.cpp.

157{
159 {
161 return;
162 }
163
164 entry_array_.resize(size_);
166}
void getGlobalVector(std::vector< PetscScalar > &u) const
void copyValues(std::vector< PetscScalar > &u) const

References copyValues(), created_with_ghost_id_, entry_array_, getGlobalVector(), and size_.

Referenced by MathLib::LinAlg::setLocalAccessibleVector().

◆ setZero()

void MathLib::PETScVector::setZero ( )
inline

Definition at line 147 of file PETScVector.h.

147{ VecSet(v_, 0.0); }

References v_.

◆ shallowCopy()

void MathLib::PETScVector::shallowCopy ( const PETScVector & v)

Definition at line 293 of file PETScVector.cpp.

294{
295 destroy();
296
297 VecDuplicate(v.getRawVector(), &v_);
298
299 start_rank_ = v.start_rank_;
300 end_rank_ = v.end_rank_;
301 size_ = v.size_;
302 size_loc_ = v.size_loc_;
303 size_ghosts_ = v.size_ghosts_;
304 created_with_ghost_id_ = v.created_with_ghost_id_;
305 global_ids2local_ids_ghost_ = v.global_ids2local_ids_ghost_;
306
307 config();
308}
static const double v

References config(), created_with_ghost_id_, destroy(), end_rank_, global_ids2local_ids_ghost_, size_, size_ghosts_, size_loc_, start_rank_, MathLib::v, and v_.

Referenced by PETScVector(), MathLib::LinAlg::copy(), MathLib::LinAlg::matMult(), and MathLib::LinAlg::matMultAdd().

◆ size()

PetscInt MathLib::PETScVector::size ( ) const
inline

Get the global size of the vector.

Definition at line 90 of file PETScVector.h.

90{ return size_; }

References size_.

◆ viewer()

void MathLib::PETScVector::viewer ( const std::string & file_name,
const PetscViewerFormat vw_format = PETSC_VIEWER_ASCII_MATLAB ) const

View the global vector for test purpose. Do not use it for output a big vector.

Parameters
file_nameFile name for output
vw_formatFile format listed as: PETSC_VIEWER_DEFAULT Default format PETSC_VIEWER_ASCII_MATLAB MATLAB format PETSC_VIEWER_ASCII_DENSE Print matrix as dense PETSC_VIEWER_ASCII_IMPL Implementation-specific format (which is in many cases the same as the default) PETSC_VIEWER_ASCII_INFO Basic information about object PETSC_VIEWER_ASCII_INFO_DETAIL More detailed info about object PETSC_VIEWER_ASCII_COMMON Identical output format for all objects of a particular type PETSC_VIEWER_ASCII_INDEX (for vectors) Prints the vector element number next to each vector entry PETSC_VIEWER_ASCII_SYMMODU Print parallel vectors without indicating the processor ranges PETSC_VIEWER_ASCII_VTK Outputs the object to a VTK file PETSC_VIEWER_NATIVE Store the object to the binary file in its native format (for example, dense matrices are stored as dense), DMDA vectors are dumped directly to the file instead of being first put in the natural ordering PETSC_VIEWER_DRAW_BASIC Views the vector with a simple 1d plot PETSC_VIEWER_DRAW_LG Views the vector with a line graph PETSC_VIEWER_DRAW_CONTOUR Views the vector with a contour plot

Definition at line 275 of file PETScVector.cpp.

277{
278 PetscViewer viewer;
279 PetscViewerASCIIOpen(PETSC_COMM_WORLD, file_name.c_str(), &viewer);
280 PetscViewerPushFormat(viewer, vw_format);
281
282 PetscObjectSetName((PetscObject)v_, file_name.c_str());
283 VecView(v_, viewer);
284
285#define nEXIT_TEST
286#ifdef EXIT_TEST
287 VecDestroy(v_);
288 PetscFinalize();
289 exit(0);
290#endif
291}
void viewer(const std::string &file_name, const PetscViewerFormat vw_format=PETSC_VIEWER_ASCII_MATLAB) const

References v_, and viewer().

Referenced by viewer().

Friends And Related Symbol Documentation

◆ finalizeVectorAssembly

void finalizeVectorAssembly ( PETScVector & vec)
friend

Function to finalize the vector assembly.

Definition at line 310 of file PETScVector.cpp.

311{
312 vec.finalizeAssembly();
313}

Member Data Documentation

◆ created_with_ghost_id_

bool MathLib::PETScVector::created_with_ghost_id_ = false
private

Flag to indicate whether the vector is created with ghost entry indices.

Definition at line 264 of file PETScVector.h.

Referenced by get(), getLocalVector(), restoreArray(), setLocalAccessibleVector(), and shallowCopy().

◆ end_rank_

PetscInt MathLib::PETScVector::end_rank_
private

Ending index in a rank.

Definition at line 254 of file PETScVector.h.

Referenced by config(), getLocalIndex(), getRangeEnd(), and shallowCopy().

◆ entry_array_

std::vector<PetscScalar> MathLib::PETScVector::entry_array_
mutableprivate

Array containing the entries of the vector. If the vector is created without given ghost IDs, the array contains all entries of the global vector, v_. Otherwise it only contains the entries of the global vector owned by the current rank.

Definition at line 273 of file PETScVector.h.

Referenced by get(), and setLocalAccessibleVector().

◆ global_ids2local_ids_ghost_

std::map<PetscInt, PetscInt> MathLib::PETScVector::global_ids2local_ids_ghost_
mutableprivate

Map global indices of ghost entries to local indices.

Definition at line 276 of file PETScVector.h.

Referenced by PETScVector(), getLocalIndex(), getLocalVector(), restoreArray(), and shallowCopy().

◆ size_

PetscInt MathLib::PETScVector::size_
private

Size of the vector.

Definition at line 257 of file PETScVector.h.

Referenced by config(), getGlobalVector(), getLocalIndex(), setLocalAccessibleVector(), shallowCopy(), and size().

◆ size_ghosts_

PetscInt MathLib::PETScVector::size_ghosts_ = 0
private

Size of local ghost entries.

Definition at line 261 of file PETScVector.h.

Referenced by getGhostSize(), and shallowCopy().

◆ size_loc_

PetscInt MathLib::PETScVector::size_loc_
private

Size of local entries.

Definition at line 259 of file PETScVector.h.

Referenced by PETScVector(), config(), getGlobalVector(), getLocalSize(), and shallowCopy().

◆ start_rank_

PetscInt MathLib::PETScVector::start_rank_
private

Starting index in a rank.

Definition at line 252 of file PETScVector.h.

Referenced by config(), getLocalIndex(), getRangeBegin(), and shallowCopy().

◆ v_

◆ v_loc_

PETSc_Vec MathLib::PETScVector::v_loc_ = nullptr
mutableprivate

Local vector, which is only for the case that v_ is created with ghost entries.

Definition at line 249 of file PETScVector.h.

Referenced by getLocalVector(), and restoreArray().


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