MFEM  v3.4
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)
 Creates a PetscParVector from a Vector (data is not copied) 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
 Conversion function to PETSc's Vec type. More...
 
VectorGlobalVector () const
 Returns the global vector in each processor. More...
 
PetscParVectoroperator= (PetscScalar d)
 Set constant values. More...
 
PetscParVectoroperator= (const PetscParVector &y)
 Define '=' for PETSc vectors. More...
 
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)
 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...
 
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 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 MakeDataOwner ()
 
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...
 
bool OwnsData () const
 
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)
 Redefine '=' for vector = vector. More...
 
Vectoroperator= (double value)
 Redefine '=' for vector = constant. More...
 
Vectoroperator*= (double c)
 
Vectoroperator/= (double c)
 
Vectoroperator-= (double c)
 
Vectoroperator-= (const Vector &v)
 
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
 
void GetSubVector (const Array< int > &dofs, double *elem_data) const
 
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)
 
void SetSubVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const Vector &elemvect)
 Add (element) subvector to the vector. More...
 
void AddElementVector (const Array< int > &dofs, double *elem_data)
 
void AddElementVector (const Array< int > &dofs, const double a, const Vector &elemvect)
 
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_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
 
virtual ~Vector ()
 Destroys vector. More...
 
 Vector (N_Vector nv)
 Construct a wrapper Vector from SUNDIALS N_Vector. More...
 
virtual N_Vector ToNVector ()
 Return a new wrapper SUNDIALS N_Vector of type SUNDIALS_NVEC_SERIAL. More...
 
virtual void ToNVector (N_Vector &nv)
 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
int size
 
int allocsize
 
double * data
 

Friends

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

Detailed Description

Wrapper for PETSc's vector class.

Definition at line 33 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 162 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 186 of file petsc.cpp.

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

Creates vector compatible with y.

Definition at line 197 of file petsc.cpp.

mfem::PetscParVector::PetscParVector ( MPI_Comm  comm,
const Vector _x 
)

Creates a PetscParVector from a Vector (data is not copied)

Definition at line 154 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 203 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 226 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 245 of file petsc.cpp.

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

Create a true dof parallel vector on a given ParFiniteElementSpace.

Definition at line 255 of file petsc.cpp.

mfem::PetscParVector::~PetscParVector ( )
virtual

Calls PETSc's destroy function.

Definition at line 180 of file petsc.cpp.

Member Function Documentation

void mfem::PetscParVector::_SetDataAndSize_ ( )
protected

Definition at line 136 of file petsc.cpp.

MPI_Comm mfem::PetscParVector::GetComm ( ) const
inline

Get the associated MPI communicator.

Definition at line 94 of file petsc.hpp.

PetscInt mfem::PetscParVector::GlobalSize ( ) const

Returns the global number of rows.

Definition at line 147 of file petsc.cpp.

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

Returns the global vector in each processor.

Definition at line 273 of file petsc.cpp.

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

Conversion function to PETSc's Vec type.

Definition at line 100 of file petsc.hpp.

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

Set constant values.

Definition at line 298 of file petsc.cpp.

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

Define '=' for PETSc vectors.

Definition at line 304 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 310 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 332 of file petsc.cpp.

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

Set random values.

Definition at line 320 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 315 of file petsc.cpp.

Friends And Related Function Documentation

friend class PetscBDDCSolver
friend

Definition at line 44 of file petsc.hpp.

friend class PetscLinearSolver
friend

Definition at line 41 of file petsc.hpp.

friend class PetscNonlinearSolver
friend

Definition at line 43 of file petsc.hpp.

friend class PetscODESolver
friend

Definition at line 40 of file petsc.hpp.

friend class PetscParMatrix
friend

Definition at line 39 of file petsc.hpp.

friend class PetscPreconditioner
friend

Definition at line 42 of file petsc.hpp.

Member Data Documentation

Vec mfem::PetscParVector::x
protected

The actual PETSc object.

Definition at line 37 of file petsc.hpp.


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