MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
mfem::PetscParVector Class Reference

#include <petsc.hpp>

Inheritance diagram for mfem::PetscParVector:
[legend]
Collaboration diagram for mfem::PetscParVector:
[legend]

Public Member Functions

 PetscParVector (MPI_Comm comm, PetscInt glob_size, PetscInt *col=NULL)
 Creates vector with given global size and partitioning of the columns.
 
 PetscParVector (MPI_Comm comm, PetscInt glob_size, PetscScalar *data_, PetscInt *col)
 Creates vector with given global size, partitioning of the columns, and data.
 
 PetscParVector (const PetscParVector &y)
 Creates vector compatible with y.
 
 PetscParVector (MPI_Comm comm, const Vector &x_, bool copy=false)
 Creates a PetscParVector from a Vector.
 
 PetscParVector (MPI_Comm comm, const Operator &op, bool transpose=false, bool allocate=true)
 Creates vector compatible with the Operator (i.e. in the domain of) op or its adjoint.
 
 PetscParVector (const PetscParMatrix &A, bool transpose=false, bool allocate=true)
 Creates vector compatible with (i.e. in the domain of) A or A^T.
 
 PetscParVector (petsc::Vec y, bool ref=false)
 Creates PetscParVector out of PETSc Vec object.
 
 PetscParVector (ParFiniteElementSpace *pfes)
 Create a true dof parallel vector on a given ParFiniteElementSpace.
 
virtual ~PetscParVector ()
 Calls PETSc's destroy function.
 
MPI_Comm GetComm () const
 Get the associated MPI communicator.
 
PetscInt GlobalSize () const
 Returns the global number of rows.
 
 operator petsc::Vec () const
 Typecasting to PETSc's Vec type.
 
 operator PetscObject () const
 Typecasting to PETSc object.
 
VectorGlobalVector () const
 Returns the global vector in each processor.
 
PetscParVectoroperator= (PetscScalar d)
 Set constant values.
 
void SetBlockSize (PetscInt bs)
 Set block size of a vector.
 
PetscParVectorSetValues (const Array< PetscInt > &, const Array< PetscScalar > &)
 Set values in a vector.
 
PetscParVectorAddValues (const Array< PetscInt > &, const Array< PetscScalar > &)
 Add values in a vector.
 
PetscParVectoroperator= (const PetscParVector &y)
 Define operators for PETSc vectors.
 
PetscParVectoroperator+= (const PetscParVector &y)
 
PetscParVectoroperator-= (const PetscParVector &y)
 
PetscParVectoroperator*= (PetscScalar d)
 
PetscParVectoroperator+= (PetscScalar d)
 
void PlaceArray (PetscScalar *temp_data)
 Temporarily replace the data of the PETSc Vec object. To return to the original data array, call ResetArray().
 
void ResetArray ()
 Reset the PETSc Vec object to use its default data. Call this method after the use of PlaceArray().
 
void PlaceMemory (Memory< real_t > &, bool=false)
 This requests write access from where the memory is valid and temporarily replaces the corresponding array used by the PETSc Vec The bool parameter indicates read/write request.
 
void PlaceMemory (const Memory< real_t > &)
 This requests read access from where the memory is valid and temporarily replaces the corresponding array used by the PETSc Vec.
 
void ResetMemory ()
 Completes the operation started with PlaceMemory.
 
void UpdateVecFromFlags ()
 Update PETSc's Vec after having accessed its data via GetMemory()
 
void Randomize (PetscInt seed=0)
 Set random values.
 
void Print (const char *fname=NULL, bool binary=false) const
 Prints the vector (to stdout if fname is NULL)
 
const real_tRead (bool=true) const override
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
 
const real_tHostRead () const override
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
 
real_tWrite (bool=true) override
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
 
real_tHostWrite () override
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
 
real_tReadWrite (bool=true) override
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
 
real_tHostReadWrite () override
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).
 
bool UseDevice () const override
 Return the device flag of the Memory object used by the Vector.
 
void UseDevice (bool) const override
 Enable execution of Vector operations using the mfem::Device.
 
- Public Member Functions inherited from mfem::Vector
 Vector ()
 
 Vector (const Vector &)
 Copy constructor. Allocates a new data array and copies the data.
 
 Vector (Vector &&v)
 Move constructor. "Steals" data from its argument.
 
 Vector (int s)
 Creates vector of size s.
 
 Vector (real_t *data_, int size_)
 Creates a vector referencing an array of doubles, owned by someone else.
 
 Vector (Vector &base, int base_offset, int size_)
 Create a Vector referencing a sub-vector of the Vector base starting at the given offset, base_offset, and size size_.
 
 Vector (int size_, MemoryType mt)
 Create a Vector of size size_ using MemoryType mt.
 
 Vector (int size_, MemoryType h_mt, MemoryType d_mt)
 Create a Vector of size size_ using host MemoryType h_mt and device MemoryType d_mt.
 
template<int N, typename T = real_t>
 Vector (const T(&values)[N])
 Create a vector using a braced initializer list.
 
virtual void UseDevice (bool use_dev) const
 Enable execution of Vector operations using the mfem::Device.
 
virtual bool UseDevice () const
 Return the device flag of the Memory object used by the Vector.
 
void Load (std::istream **in, int np, int *dim)
 Reads a vector from multiple files.
 
void Load (std::istream &in, int Size)
 Load a vector from an input stream.
 
void Load (std::istream &in)
 Load a vector from an input stream, reading the size from the stream.
 
void SetSize (int s)
 Resize the vector to size s.
 
void SetSize (int s, MemoryType mt)
 Resize the vector to size s using MemoryType mt.
 
void SetSize (int s, const Vector &v)
 Resize the vector to size s using the MemoryType of v.
 
void SetData (real_t *d)
 
void SetDataAndSize (real_t *d, int s)
 Set the Vector data and size.
 
void NewDataAndSize (real_t *d, int s)
 Set the Vector data and size, deleting the old data, if owned.
 
void NewMemoryAndSize (const Memory< real_t > &mem, int s, bool own_mem)
 Reset the Vector to use the given external Memory mem and size s.
 
void MakeRef (Vector &base, int offset, int size)
 Reset the Vector to be a reference to a sub-vector of base.
 
void MakeRef (Vector &base, int offset)
 Reset the Vector to be a reference to a sub-vector of base without changing its current size.
 
void MakeDataOwner () const
 Set the Vector data (host pointer) ownership flag.
 
void Destroy ()
 Destroy a vector.
 
void DeleteDevice (bool copy_to_host=true)
 Delete the device pointer, if owned. If copy_to_host is true and the data is valid only on device, move it to host before deleting. Invalidates the device memory.
 
int Size () const
 Returns the size of the vector.
 
int Capacity () const
 Return the size of the currently allocated data array.
 
real_tGetData () const
 Return a pointer to the beginning of the Vector data.
 
MFEM_DEPRECATED operator real_t * ()
 Conversion to double *. Deprecated.
 
MFEM_DEPRECATED operator const real_t * () const
 Conversion to const double *. Deprecated.
 
real_tbegin ()
 STL-like begin.
 
real_tend ()
 STL-like end.
 
const real_tbegin () const
 STL-like begin (const version).
 
const real_tend () const
 STL-like end (const version).
 
Memory< real_t > & GetMemory ()
 Return a reference to the Memory object used by the Vector.
 
const Memory< real_t > & GetMemory () const
 Return a reference to the Memory object used by the Vector, const version.
 
void SyncMemory (const Vector &v) const
 Update the memory location of the vector to match v.
 
void SyncAliasMemory (const Vector &v) const
 Update the alias memory location of the vector to match v.
 
bool OwnsData () const
 Read the Vector data (host pointer) ownership flag.
 
void StealData (real_t **p)
 Changes the ownership of the data; after the call the Vector is empty.
 
real_tStealData ()
 Changes the ownership of the data; after the call the Vector is empty.
 
real_tElem (int i)
 Access Vector entries. Index i = 0 .. size-1.
 
const real_tElem (int i) const
 Read only access to Vector entries. Index i = 0 .. size-1.
 
real_toperator() (int i)
 Access Vector entries using () for 0-based indexing.
 
const real_toperator() (int i) const
 Read only access to Vector entries using () for 0-based indexing.
 
real_toperator[] (int i)
 Access Vector entries using [] for 0-based indexing.
 
const real_toperator[] (int i) const
 Read only access to Vector entries using [] for 0-based indexing.
 
real_t operator* (const real_t *) const
 Dot product with a double * array.
 
real_t operator* (const Vector &v) const
 Return the inner-product.
 
Vectoroperator= (const real_t *v)
 Copy Size() entries from v.
 
Vectoroperator= (const Vector &v)
 Copy assignment.
 
Vectoroperator= (Vector &&v)
 Move assignment.
 
Vectoroperator= (real_t value)
 Redefine '=' for vector = constant.
 
Vectoroperator*= (real_t c)
 
Vectoroperator*= (const Vector &v)
 Component-wise scaling: (*this)(i) *= v(i)
 
Vectoroperator/= (real_t c)
 
Vectoroperator/= (const Vector &v)
 Component-wise division: (*this)(i) /= v(i)
 
Vectoroperator-= (real_t c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (real_t c)
 
Vectoroperator+= (const Vector &v)
 
VectorAdd (const real_t a, const Vector &Va)
 (*this) += a * Va
 
VectorSet (const real_t a, const Vector &x)
 (*this) = a * x
 
void SetVector (const Vector &v, int offset)
 
void AddSubVector (const Vector &v, int offset)
 
void Neg ()
 (*this) = -(*this)
 
void Reciprocal ()
 (*this)(i) = 1.0 / (*this)(i)
 
void Swap (Vector &other)
 Swap the contents of two Vectors.
 
void cross3D (const Vector &vin, Vector &vout) const
 
void median (const Vector &lo, const Vector &hi)
 v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi.
 
void GetSubVector (const Array< int > &dofs, Vector &elemvect) const
 Extract entries listed in dofs to the output Vector elemvect.
 
void GetSubVector (const Array< int > &dofs, real_t *elem_data) const
 Extract entries listed in dofs to the output array elem_data.
 
void SetSubVector (const Array< int > &dofs, const real_t value)
 Set the entries listed in dofs to the given value.
 
void SetSubVector (const Array< int > &dofs, const Vector &elemvect)
 Set the entries listed in dofs to the values given in the elemvect Vector. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elemvect.
 
void SetSubVector (const Array< int > &dofs, real_t *elem_data)
 Set the entries listed in dofs to the values given the , elem_data array. Negative dof values cause the -dof-1 position in this Vector to receive the -val from elem_data.
 
void AddElementVector (const Array< int > &dofs, const Vector &elemvect)
 Add elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elemvect.
 
void AddElementVector (const Array< int > &dofs, real_t *elem_data)
 Add elements of the elem_data array to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -val from elem_data.
 
void AddElementVector (const Array< int > &dofs, const real_t a, const Vector &elemvect)
 Add times the elements of the elemvect Vector to the entries listed in dofs. Negative dof values cause the -dof-1 position in this Vector to add the -a*val from elemvect.
 
void SetSubVectorComplement (const Array< int > &dofs, const real_t val)
 Set all vector entries NOT in the dofs Array to the given val.
 
void Print (std::ostream &out=mfem::out, int width=8) const
 Prints vector to stream out.
 
void Print (adios2stream &out, const std::string &variable_name) const
 
void Print_HYPRE (std::ostream &out) const
 Prints vector to stream out in HYPRE_Vector format.
 
void PrintHash (std::ostream &out) const
 Print the Vector size and hash of its data.
 
void Randomize (int seed=0)
 Set random values in the vector.
 
real_t Norml2 () const
 Returns the l2 norm of the vector.
 
real_t Normlinf () const
 Returns the l_infinity norm of the vector.
 
real_t Norml1 () const
 Returns the l_1 norm of the vector.
 
real_t Normlp (real_t p) const
 Returns the l_p norm of the vector.
 
real_t Max () const
 Returns the maximal element of the vector.
 
real_t Min () const
 Returns the minimal element of the vector.
 
real_t Sum () const
 Return the sum of the vector entries.
 
real_t DistanceSquaredTo (const real_t *p) const
 Compute the square of the Euclidean distance to another vector.
 
real_t DistanceSquaredTo (const Vector &p) const
 Compute the square of the Euclidean distance to another vector.
 
real_t DistanceTo (const real_t *p) const
 Compute the Euclidean distance to another vector.
 
real_t DistanceTo (const Vector &p) const
 Compute the Euclidean distance to another vector.
 
int CheckFinite () const
 Count the number of entries in the Vector for which isfinite is false, i.e. the entry is a NaN or +/-Inf.
 
virtual ~Vector ()
 Destroys vector.
 
virtual const real_tRead (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).
 
virtual const real_tHostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).
 
virtual real_tWrite (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).
 
virtual real_tReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).
 
virtual real_tHostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).
 

Protected Member Functions

void SetDataAndSize_ ()
 
void SetVecType_ ()
 
void SetFlagsFromMask_ () const
 

Protected Attributes

petsc::Vec x
 The actual PETSc object.
 
PetscMemory pdata
 
- Protected Attributes inherited from mfem::Vector
Memory< real_tdata
 
int size
 

Friends

class PetscParMatrix
 
class PetscODESolver
 
class PetscLinearSolver
 
class PetscPreconditioner
 
class PetscNonlinearSolver
 
class PetscBDDCSolver
 

Detailed Description

Definition at line 156 of file petsc.hpp.

Constructor & Destructor Documentation

◆ PetscParVector() [1/8]

mfem::PetscParVector::PetscParVector ( MPI_Comm  comm,
PetscInt  glob_size,
PetscInt col = NULL 
)

Creates vector with given global size and partitioning of the columns.

If col is provided, processor P owns columns [col[P],col[P+1]). Otherwise, PETSc decides the partitioning

Definition at line 578 of file petsc.cpp.

◆ PetscParVector() [2/8]

mfem::PetscParVector::PetscParVector ( MPI_Comm  comm,
PetscInt  glob_size,
PetscScalar data_,
PetscInt col 
)

Creates vector with given global size, partitioning of the columns, and data.

The data must be allocated and destroyed outside. If data_ is NULL, a dummy vector without a valid data array will be created.

Definition at line 603 of file petsc.cpp.

◆ PetscParVector() [3/8]

mfem::PetscParVector::PetscParVector ( const PetscParVector y)

Creates vector compatible with y.

Definition at line 615 of file petsc.cpp.

◆ PetscParVector() [4/8]

mfem::PetscParVector::PetscParVector ( MPI_Comm  comm,
const Vector x_,
bool  copy = false 
)

Creates a PetscParVector from a Vector.

Parameters
[in]commMPI communicator on which the new object lives
[in]x_The mfem Vector (data is not shared)
[in]copyWhether to copy the data in x_ or not

Definition at line 529 of file petsc.cpp.

◆ PetscParVector() [5/8]

mfem::PetscParVector::PetscParVector ( MPI_Comm  comm,
const Operator op,
bool  transpose = false,
bool  allocate = true 
)
explicit

Creates vector compatible with the Operator (i.e. in the domain of) op or its adjoint.

The argument allocate determines if the memory is actually allocated to store the data.

Definition at line 621 of file petsc.cpp.

◆ PetscParVector() [6/8]

mfem::PetscParVector::PetscParVector ( const PetscParMatrix A,
bool  transpose = false,
bool  allocate = true 
)
explicit

Creates vector compatible with (i.e. in the domain of) A or A^T.

The argument allocate determines if the memory is actually allocated to store the data.

Definition at line 642 of file petsc.cpp.

◆ PetscParVector() [7/8]

mfem::PetscParVector::PetscParVector ( petsc::Vec  y,
bool  ref = false 
)
explicit

Creates PetscParVector out of PETSc Vec object.

Parameters
[in]yThe PETSc Vec object.
[in]refIf true, we increase the reference count of y.

Definition at line 667 of file petsc.cpp.

◆ PetscParVector() [8/8]

mfem::PetscParVector::PetscParVector ( ParFiniteElementSpace pfes)
explicit

Create a true dof parallel vector on a given ParFiniteElementSpace.

Definition at line 677 of file petsc.cpp.

◆ ~PetscParVector()

mfem::PetscParVector::~PetscParVector ( )
virtual

Calls PETSc's destroy function.

Definition at line 596 of file petsc.cpp.

Member Function Documentation

◆ AddValues()

PetscParVector & mfem::PetscParVector::AddValues ( const Array< PetscInt > &  idx,
const Array< PetscScalar > &  vals 
)

Add values in a vector.

Note
Any process can add to any location.
This is a collective operation, so all processes need to call it.

Definition at line 745 of file petsc.cpp.

◆ GetComm()

MPI_Comm mfem::PetscParVector::GetComm ( ) const

Get the associated MPI communicator.

Definition at line 694 of file petsc.cpp.

◆ GlobalSize()

PetscInt mfem::PetscParVector::GlobalSize ( ) const

Returns the global number of rows.

Definition at line 517 of file petsc.cpp.

◆ GlobalVector()

Vector * mfem::PetscParVector::GlobalVector ( ) const

Returns the global vector in each processor.

Definition at line 699 of file petsc.cpp.

◆ HostRead()

const mfem::real_t * mfem::PetscParVector::HostRead ( ) const
overridevirtual

Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false).

Reimplemented from mfem::Vector.

Definition at line 435 of file petsc.cpp.

◆ HostReadWrite()

mfem::real_t * mfem::PetscParVector::HostReadWrite ( )
overridevirtual

Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false).

Reimplemented from mfem::Vector.

Definition at line 495 of file petsc.cpp.

◆ HostWrite()

mfem::real_t * mfem::PetscParVector::HostWrite ( )
overridevirtual

Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false).

Reimplemented from mfem::Vector.

Definition at line 465 of file petsc.cpp.

◆ operator petsc::Vec()

mfem::PetscParVector::operator petsc::Vec ( ) const
inline

Typecasting to PETSc's Vec type.

Definition at line 234 of file petsc.hpp.

◆ operator PetscObject()

mfem::PetscParVector::operator PetscObject ( ) const
inline

Typecasting to PETSc object.

Definition at line 237 of file petsc.hpp.

◆ operator*=()

PetscParVector & mfem::PetscParVector::operator*= ( PetscScalar  d)

Definition at line 780 of file petsc.cpp.

◆ operator+=() [1/2]

PetscParVector & mfem::PetscParVector::operator+= ( const PetscParVector y)

Definition at line 766 of file petsc.cpp.

◆ operator+=() [2/2]

PetscParVector & mfem::PetscParVector::operator+= ( PetscScalar  d)

Definition at line 787 of file petsc.cpp.

◆ operator-=()

PetscParVector & mfem::PetscParVector::operator-= ( const PetscParVector y)

Definition at line 773 of file petsc.cpp.

◆ operator=() [1/2]

PetscParVector & mfem::PetscParVector::operator= ( const PetscParVector y)

Define operators for PETSc vectors.

Definition at line 759 of file petsc.cpp.

◆ operator=() [2/2]

PetscParVector & mfem::PetscParVector::operator= ( PetscScalar  d)

Set constant values.

Definition at line 724 of file petsc.cpp.

◆ PlaceArray()

void mfem::PetscParVector::PlaceArray ( PetscScalar temp_data)

Temporarily replace the data of the PETSc Vec object. To return to the original data array, call ResetArray().

Note
This method calls PETSc's VecPlaceArray() function.
The inherited Vector::data pointer is not affected by this call.

Definition at line 794 of file petsc.cpp.

◆ PlaceMemory() [1/2]

void mfem::PetscParVector::PlaceMemory ( const Memory< real_t > &  mem)

This requests read access from where the memory is valid and temporarily replaces the corresponding array used by the PETSc Vec.

Definition at line 848 of file petsc.cpp.

◆ PlaceMemory() [2/2]

void mfem::PetscParVector::PlaceMemory ( Memory< real_t > &  mem,
bool  rw = false 
)

This requests write access from where the memory is valid and temporarily replaces the corresponding array used by the PETSc Vec The bool parameter indicates read/write request.

Definition at line 804 of file petsc.cpp.

◆ Print()

void mfem::PetscParVector::Print ( const char *  fname = NULL,
bool  binary = false 
) const

Prints the vector (to stdout if fname is NULL)

Definition at line 950 of file petsc.cpp.

◆ Randomize()

void mfem::PetscParVector::Randomize ( PetscInt  seed = 0)

Set random values.

Definition at line 935 of file petsc.cpp.

◆ Read()

const mfem::real_t * mfem::PetscParVector::Read ( bool  on_dev = true) const
overridevirtual

Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented from mfem::Vector.

Definition at line 411 of file petsc.cpp.

◆ ReadWrite()

mfem::real_t * mfem::PetscParVector::ReadWrite ( bool  on_dev = true)
overridevirtual

Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented from mfem::Vector.

Definition at line 470 of file petsc.cpp.

◆ ResetArray()

void mfem::PetscParVector::ResetArray ( )

Reset the PETSc Vec object to use its default data. Call this method after the use of PlaceArray().

Note
This method calls PETSc's VecResetArray() function.

Definition at line 799 of file petsc.cpp.

◆ ResetMemory()

void mfem::PetscParVector::ResetMemory ( )

Completes the operation started with PlaceMemory.

Definition at line 891 of file petsc.cpp.

◆ SetBlockSize()

void mfem::PetscParVector::SetBlockSize ( PetscInt  bs)

Set block size of a vector.

Note
This will error if the local size of the vector is not a multiple of the block size bs.
This is a logically collective operation, so all processes need to call it.

Definition at line 524 of file petsc.cpp.

◆ SetDataAndSize_()

void mfem::PetscParVector::SetDataAndSize_ ( )
protected

Definition at line 267 of file petsc.cpp.

◆ SetFlagsFromMask_()

void mfem::PetscParVector::SetFlagsFromMask_ ( ) const
protected

Definition at line 323 of file petsc.cpp.

◆ SetValues()

PetscParVector & mfem::PetscParVector::SetValues ( const Array< PetscInt > &  idx,
const Array< PetscScalar > &  vals 
)

Set values in a vector.

Note
Any process can insert in any location.
This is a collective operation, so all processes need to call it.

Definition at line 731 of file petsc.cpp.

◆ SetVecType_()

void mfem::PetscParVector::SetVecType_ ( )
protected

Definition at line 387 of file petsc.cpp.

◆ UpdateVecFromFlags()

void mfem::PetscParVector::UpdateVecFromFlags ( )

Update PETSc's Vec after having accessed its data via GetMemory()

Definition at line 357 of file petsc.cpp.

◆ UseDevice() [1/2]

bool mfem::PetscParVector::UseDevice ( ) const
overridevirtual

Return the device flag of the Memory object used by the Vector.

Reimplemented from mfem::Vector.

Definition at line 509 of file petsc.cpp.

◆ UseDevice() [2/2]

void mfem::PetscParVector::UseDevice ( bool  use_dev) const
overridevirtual

Enable execution of Vector operations using the mfem::Device.

The default is to use Backend::CPU (serial execution on each MPI rank), regardless of the mfem::Device configuration.

When appropriate, MFEM functions and class methods will enable the use of the mfem::Device for their Vector parameters.

Some derived classes, e.g. GridFunction, enable the use of the mfem::Device by default.

Reimplemented from mfem::Vector.

Definition at line 500 of file petsc.cpp.

◆ Write()

mfem::real_t * mfem::PetscParVector::Write ( bool  on_dev = true)
overridevirtual

Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev).

Reimplemented from mfem::Vector.

Definition at line 440 of file petsc.cpp.

Friends And Related Function Documentation

◆ PetscBDDCSolver

friend class PetscBDDCSolver
friend

Definition at line 169 of file petsc.hpp.

◆ PetscLinearSolver

friend class PetscLinearSolver
friend

Definition at line 166 of file petsc.hpp.

◆ PetscNonlinearSolver

friend class PetscNonlinearSolver
friend

Definition at line 168 of file petsc.hpp.

◆ PetscODESolver

friend class PetscODESolver
friend

Definition at line 165 of file petsc.hpp.

◆ PetscParMatrix

friend class PetscParMatrix
friend

Definition at line 164 of file petsc.hpp.

◆ PetscPreconditioner

friend class PetscPreconditioner
friend

Definition at line 167 of file petsc.hpp.

Member Data Documentation

◆ pdata

PetscMemory mfem::PetscParVector::pdata
mutableprotected

Definition at line 162 of file petsc.hpp.

◆ x

petsc::Vec mfem::PetscParVector::x
protected

The actual PETSc object.

Definition at line 160 of file petsc.hpp.


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