MFEM  v4.2.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
mfem::PetscParVector Class Reference

Wrapper for PETSc's vector class. More...

#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. More...
 
 PetscParVector (MPI_Comm comm, PetscInt glob_size, PetscScalar *_data, PetscInt *col)
 Creates vector with given global size, partitioning of the columns, and data. More...
 
 PetscParVector (const PetscParVector &y)
 Creates vector compatible with y. More...
 
 PetscParVector (MPI_Comm comm, const Vector &_x, bool copy=false)
 Creates a PetscParVector from a Vector. More...
 
 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. More...
 
 PetscParVector (const PetscParMatrix &A, bool transpose=false, bool allocate=true)
 Creates vector compatible with (i.e. in the domain of) A or A^T. More...
 
 PetscParVector (Vec y, bool ref=false)
 Creates PetscParVector out of PETSc Vec object. More...
 
 PetscParVector (ParFiniteElementSpace *pfes)
 Create a true dof parallel vector on a given ParFiniteElementSpace. More...
 
virtual ~PetscParVector ()
 Calls PETSc's destroy function. More...
 
MPI_Comm GetComm () const
 Get the associated MPI communicator. More...
 
PetscInt GlobalSize () const
 Returns the global number of rows. More...
 
 operator Vec () const
 Typecasting to PETSc's Vec type. More...
 
 operator PetscObject () const
 Typecasting to PETSc object. More...
 
VectorGlobalVector () const
 Returns the global vector in each processor. More...
 
PetscParVectoroperator= (PetscScalar d)
 Set constant values. More...
 
PetscParVectorSetValues (const Array< PetscInt > &, const Array< PetscScalar > &)
 Set values in a vector. More...
 
PetscParVectorAddValues (const Array< PetscInt > &, const Array< PetscScalar > &)
 Add values in a vector. More...
 
PetscParVectoroperator= (const PetscParVector &y)
 Define operators for PETSc vectors. More...
 
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(). More...
 
void ResetArray ()
 Reset the PETSc Vec object to use its default data. Call this method after the use of PlaceArray(). More...
 
void Randomize (PetscInt seed=0)
 Set random values. More...
 
void Print (const char *fname=NULL, bool binary=false) const
 Prints the vector (to stdout if fname is NULL) More...
 
- Public Member Functions inherited from mfem::Vector
 Vector ()
 Default constructor for Vector. Sets size = 0 and data = NULL. More...
 
 Vector (const Vector &)
 Copy constructor. Allocates a new data array and copies the data. More...
 
 Vector (int s)
 Creates vector of size s. More...
 
 Vector (double *_data, int _size)
 Creates a vector referencing an array of doubles, owned by someone else. More...
 
 Vector (int size_, MemoryType mt)
 Create a Vector of size size_ using MemoryType mt. More...
 
void UseDevice (bool use_dev) const
 Enable execution of Vector operations using the mfem::Device. More...
 
bool UseDevice () const
 Return the device flag of the Memory object used by the Vector. More...
 
void Load (std::istream **in, int np, int *dim)
 Reads a vector from multiple files. More...
 
void Load (std::istream &in, int Size)
 Load a vector from an input stream. More...
 
void Load (std::istream &in)
 Load a vector from an input stream, reading the size from the stream. More...
 
void SetSize (int s)
 Resize the vector to size s. More...
 
void SetSize (int s, MemoryType mt)
 Resize the vector to size s using MemoryType mt. More...
 
void SetSize (int s, Vector &v)
 Resize the vector to size s using the MemoryType of v. More...
 
void SetData (double *d)
 
void SetDataAndSize (double *d, int s)
 Set the Vector data and size. More...
 
void NewDataAndSize (double *d, int s)
 Set the Vector data and size, deleting the old data, if owned. More...
 
void NewMemoryAndSize (const Memory< double > &mem, int s, bool own_mem)
 Reset the Vector to use the given external Memory mem and size s. More...
 
void MakeRef (Vector &base, int offset, int size)
 Reset the Vector to be a reference to a sub-vector of base. More...
 
void MakeRef (Vector &base, int offset)
 Reset the Vector to be a reference to a sub-vector of base without changing its current size. More...
 
void MakeDataOwner () const
 Set the Vector data (host pointer) ownership flag. More...
 
void Destroy ()
 Destroy a vector. More...
 
int Size () const
 Returns the size of the vector. More...
 
int Capacity () const
 Return the size of the currently allocated data array. More...
 
double * GetData () const
 Return a pointer to the beginning of the Vector data. More...
 
 operator double * ()
 Conversion to double *. More...
 
 operator const double * () const
 Conversion to const double *. More...
 
Memory< double > & GetMemory ()
 Return a reference to the Memory object used by the Vector. More...
 
const Memory< double > & GetMemory () const
 Return a reference to the Memory object used by the Vector, const version. More...
 
void SyncMemory (const Vector &v)
 Update the memory location of the vector to match v. More...
 
void SyncAliasMemory (const Vector &v)
 Update the alias memory location of the vector to match v. More...
 
bool OwnsData () const
 Read the Vector data (host pointer) ownership flag. More...
 
void StealData (double **p)
 Changes the ownership of the data; after the call the Vector is empty. More...
 
double * StealData ()
 Changes the ownership of the data; after the call the Vector is empty. More...
 
double & Elem (int i)
 Access Vector entries. Index i = 0 .. size-1. More...
 
const double & Elem (int i) const
 Read only access to Vector entries. Index i = 0 .. size-1. More...
 
double & operator() (int i)
 Access Vector entries using () for 0-based indexing. More...
 
const double & operator() (int i) const
 Read only access to Vector entries using () for 0-based indexing. More...
 
double operator* (const double *) const
 Dot product with a double * array. More...
 
double operator* (const Vector &v) const
 Return the inner-product. More...
 
Vectoroperator= (const double *v)
 Copy Size() entries from v. More...
 
Vectoroperator= (const Vector &v)
 Copy assignment. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator/= (double c)
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
Vectoroperator+= (double c)
 
Vectoroperator+= (const Vector &v)
 
VectorAdd (const double a, const Vector &Va)
 (*this) += a * Va More...
 
VectorSet (const double a, const Vector &x)
 (*this) = a * x More...
 
void SetVector (const Vector &v, int offset)
 
void Neg ()
 (*this) = -(*this) More...
 
void Swap (Vector &other)
 Swap the contents of two Vectors. More...
 
void median (const Vector &lo, const Vector &hi)
 v = median(v,lo,hi) entrywise. Implementation assumes lo <= hi. More...
 
void GetSubVector (const Array< int > &dofs, Vector &elemvect) const
 Extract entries listed in dofs to the output Vector elemvect. More...
 
void GetSubVector (const Array< int > &dofs, double *elem_data) const
 Extract entries listed in dofs to the output array elem_data. More...
 
void SetSubVector (const Array< int > &dofs, const double value)
 Set the entries listed in dofs to the given value. More...
 
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. More...
 
void SetSubVector (const Array< int > &dofs, double *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. More...
 
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. More...
 
void AddElementVector (const Array< int > &dofs, double *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. More...
 
void AddElementVector (const Array< int > &dofs, const double 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. More...
 
void SetSubVectorComplement (const Array< int > &dofs, const double val)
 Set all vector entries NOT in the dofs Array to the given val. More...
 
void Print (std::ostream &out=mfem::out, int width=8) const
 Prints vector to stream out. More...
 
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. More...
 
void Randomize (int seed=0)
 Set random values in the vector. More...
 
double Norml2 () const
 Returns the l2 norm of the vector. More...
 
double Normlinf () const
 Returns the l_infinity norm of the vector. More...
 
double Norml1 () const
 Returns the l_1 norm of the vector. More...
 
double Normlp (double p) const
 Returns the l_p norm of the vector. More...
 
double Max () const
 Returns the maximal element of the vector. More...
 
double Min () const
 Returns the minimal element of the vector. More...
 
double Sum () const
 Return the sum of the vector entries. More...
 
double DistanceSquaredTo (const double *p) const
 Compute the square of the Euclidean distance to another vector. More...
 
double DistanceTo (const double *p) const
 Compute the Euclidean distance to another vector. More...
 
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. More...
 
virtual ~Vector ()
 Destroys vector. More...
 
const double * Read (bool on_dev=true) const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), on_dev). More...
 
const double * HostRead () const
 Shortcut for mfem::Read(vec.GetMemory(), vec.Size(), false). More...
 
double * Write (bool on_dev=true)
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), on_dev). More...
 
double * HostWrite ()
 Shortcut for mfem::Write(vec.GetMemory(), vec.Size(), false). More...
 
double * ReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), on_dev). More...
 
double * HostReadWrite ()
 Shortcut for mfem::ReadWrite(vec.GetMemory(), vec.Size(), false). More...
 
MFEM_DEPRECATED Vector (N_Vector nv)
 (DEPRECATED) Construct a wrapper Vector from SUNDIALS N_Vector. More...
 
virtual MFEM_DEPRECATED N_Vector ToNVector ()
 (DEPRECATED) Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...
 
virtual MFEM_DEPRECATED void ToNVector (N_Vector &nv, long global_length=0)
 Update an existing wrapper SUNDIALS N_Vector to point to this Vector. More...
 

Protected Member Functions

void _SetDataAndSize_ ()
 

Protected Attributes

Vec x
 The actual PETSc object. More...
 
- Protected Attributes inherited from mfem::Vector
Memory< double > data
 
int size
 

Friends

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

Detailed Description

Wrapper for PETSc's vector class.

Definition at line 75 of file petsc.hpp.

Constructor & Destructor Documentation

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 207 of file petsc.cpp.

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 231 of file petsc.cpp.

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

Creates vector compatible with y.

Definition at line 242 of file petsc.cpp.

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]_xThe mfem Vector (data is not shared)
[in]copyWhether to copy the data in _x or not

Definition at line 190 of file petsc.cpp.

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 248 of file petsc.cpp.

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 271 of file petsc.cpp.

mfem::PetscParVector::PetscParVector ( 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 290 of file petsc.cpp.

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

Create a true dof parallel vector on a given ParFiniteElementSpace.

Definition at line 300 of file petsc.cpp.

mfem::PetscParVector::~PetscParVector ( )
virtual

Calls PETSc's destroy function.

Definition at line 225 of file petsc.cpp.

Member Function Documentation

void mfem::PetscParVector::_SetDataAndSize_ ( )
protected

Definition at line 172 of file petsc.cpp.

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 process needs to call it

Definition at line 367 of file petsc.cpp.

MPI_Comm mfem::PetscParVector::GetComm ( ) const

Get the associated MPI communicator.

Definition at line 318 of file petsc.cpp.

PetscInt mfem::PetscParVector::GlobalSize ( ) const

Returns the global number of rows.

Definition at line 183 of file petsc.cpp.

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

Returns the global vector in each processor.

Definition at line 323 of file petsc.cpp.

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

Typecasting to PETSc object.

Definition at line 148 of file petsc.hpp.

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

Typecasting to PETSc's Vec type.

Definition at line 145 of file petsc.hpp.

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

Definition at line 398 of file petsc.cpp.

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

Definition at line 386 of file petsc.cpp.

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

Definition at line 404 of file petsc.cpp.

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

Definition at line 392 of file petsc.cpp.

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

Set constant values.

Definition at line 348 of file petsc.cpp.

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

Define operators for PETSc vectors.

Definition at line 380 of file petsc.cpp.

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 410 of file petsc.cpp.

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

Prints the vector (to stdout if fname is NULL)

Definition at line 435 of file petsc.cpp.

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

Set random values.

Definition at line 420 of file petsc.cpp.

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 415 of file petsc.cpp.

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 process needs to call it

Definition at line 354 of file petsc.cpp.

Friends And Related Function Documentation

friend class PetscBDDCSolver
friend

Definition at line 86 of file petsc.hpp.

friend class PetscLinearSolver
friend

Definition at line 83 of file petsc.hpp.

friend class PetscNonlinearSolver
friend

Definition at line 85 of file petsc.hpp.

friend class PetscODESolver
friend

Definition at line 82 of file petsc.hpp.

friend class PetscParMatrix
friend

Definition at line 81 of file petsc.hpp.

friend class PetscPreconditioner
friend

Definition at line 84 of file petsc.hpp.

Member Data Documentation

Vec mfem::PetscParVector::x
protected

The actual PETSc object.

Definition at line 79 of file petsc.hpp.


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