This class provides a nice interface to PETSc's Vec object. More...

#include <petsc_vector.h>

Inheritance diagram for libMesh::PetscVector< T >:

Public Member Functions
	PetscVector (const Parallel::Communicator &comm_in, const ParallelType type=AUTOMATIC)
	Dummy-Constructor. More...

	PetscVector (const Parallel::Communicator &comm_in, const numeric_index_type n, const ParallelType type=AUTOMATIC)
	Constructor. More...

	PetscVector (const Parallel::Communicator &comm_in, const numeric_index_type n, const numeric_index_type n_local, const ParallelType type=AUTOMATIC)
	Constructor. More...

	PetscVector (const Parallel::Communicator &comm_in, const numeric_index_type N, const numeric_index_type n_local, const std::vector< numeric_index_type > &ghost, const ParallelType type=AUTOMATIC)
	Constructor. More...

	PetscVector (Vec v, const Parallel::Communicator &comm_in)
	Constructor. More...

PetscVector< T > &	operator= (const PetscVector< T > &v)
	Copy assignment operator. More...

	PetscVector (PetscVector &&)=delete
	This class manages a C-style struct (Vec) manually, so we don't want to allow any automatic copy/move functions to be generated, and we can't default the destructor. More...

	PetscVector (const PetscVector &)=delete

PetscVector &	operator= (PetscVector &&)=delete

virtual	~PetscVector ()

virtual void	close () override
	Calls the NumericVector's internal assembly routines, ensuring that the values are consistent across processors. More...

virtual void	clear () override
	Restores the `NumericVector<T>` to a pristine state. More...

virtual void	zero () override
	Set all entries to zero. More...

virtual std::unique_ptr< NumericVector< T > >	zero_clone () const override

virtual std::unique_ptr< NumericVector< T > >	clone () const override

virtual void	init (const numeric_index_type N, const numeric_index_type n_local, const bool fast=false, const ParallelType type=AUTOMATIC) override
	Change the dimension of the vector to `n`. More...

virtual void	init (const numeric_index_type N, const bool fast=false, const ParallelType type=AUTOMATIC) override
	Call `init()` with n_local = N. More...

virtual void	init (const numeric_index_type N, const numeric_index_type n_local, const std::vector< numeric_index_type > &ghost, const bool fast=false, const ParallelType=AUTOMATIC) override
	Create a vector that holds tha local indices plus those specified in the `ghost` argument. More...

virtual void	init (const NumericVector< T > &other, const bool fast=false) override
	Creates a vector that has the same dimension and storage type as `other`, including ghost dofs. More...

virtual NumericVector< T > &	operator= (const T s) override
	Sets all entries of the vector to the value `s`. More...

virtual NumericVector< T > &	operator= (const NumericVector< T > &v) override
	This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual. More...

virtual NumericVector< T > &	operator= (const std::vector< T > &v) override
	Sets (*this)(i) = v(i) for each entry of the vector. More...

virtual Real	min () const override

virtual Real	max () const override

virtual T	sum () const override

virtual Real	l1_norm () const override

virtual Real	l2_norm () const override

virtual Real	linfty_norm () const override

virtual numeric_index_type	size () const override

virtual numeric_index_type	local_size () const override

virtual numeric_index_type	first_local_index () const override

virtual numeric_index_type	last_local_index () const override

numeric_index_type	map_global_to_local_index (const numeric_index_type i) const

virtual T	operator() (const numeric_index_type i) const override

virtual void	get (const std::vector< numeric_index_type > &index, T *values) const override
	Access multiple components at once. More...

PetscScalar *	get_array ()
	Get read/write access to the raw PETSc Vector data array. More...

const PetscScalar *	get_array_read () const
	Get read only access to the raw PETSc Vector data array. More...

void	restore_array ()
	Restore the data array. More...

virtual NumericVector< T > &	operator+= (const NumericVector< T > &v) override
	Adds `v` to *this, $\vec{u} \leftarrow \vec{u} + \vec{v}$ . More...

virtual NumericVector< T > &	operator-= (const NumericVector< T > &v) override
	Subtracts `v` from *this, $\vec{u} \leftarrow \vec{u} - \vec{v}$ . More...

virtual void	reciprocal () override
	Computes the pointwise reciprocal, $u_i \leftarrow \frac{1}{u_i} \, \forall i$ . More...

virtual void	conjugate () override
	Negates the imaginary component of each entry in the vector. More...

virtual void	set (const numeric_index_type i, const T value) override
	Sets v(i) = `value`. More...

virtual void	add (const numeric_index_type i, const T value) override
	Adds `value` to each entry of the vector. More...

virtual void	add (const T s) override
	Adds `s` to each entry of the vector, $u_i \leftarrow u_i + s$ . More...

virtual void	add (const NumericVector< T > &v) override
	Adds `v` to `this`, $\vec{u} \leftarrow \vec{u} + \vec{v}$ . More...

virtual void	add (const T a, const NumericVector< T > &v) override
	Vector addition with a scalar multiple, $\vec{u} \leftarrow \vec{u} + a\vec{v}$ . More...

virtual void	add_vector (const T *v, const std::vector< numeric_index_type > &dof_indices) override
	Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where `v` is a pointer and each `dof_indices`[i] specifies where to add value `v`[i]. More...

virtual void	add_vector (const NumericVector< T > &v, const SparseMatrix< T > &A) override
	Computes $\vec{u} \leftarrow \vec{u} + A \vec{v}$ , i.e. More...

virtual void	add_vector_transpose (const NumericVector< T > &v, const SparseMatrix< T > &A) override
	Computes $\vec{u} \leftarrow \vec{u} + A^T \vec{v}$ , i.e. More...

void	add_vector_conjugate_transpose (const NumericVector< T > &v, const SparseMatrix< T > &A)
	$U \leftarrow U + A^H v$ . More...

virtual void	insert (const T *v, const std::vector< numeric_index_type > &dof_indices) override
	Inserts the entries of `v` in *this at the locations specified by `v`. More...

virtual void	scale (const T factor) override
	Scale each element of the vector by the given `factor`. More...

virtual NumericVector< T > &	operator/= (const NumericVector< T > &v) override
	Computes the pointwise division of this vector's entries by another's, $u_i \leftarrow \frac{u_i}{v_i} \, \forall i$ . More...

virtual void	abs () override
	Sets $u_i \leftarrow \|u_i\|$ for each entry in the vector. More...

virtual T	dot (const NumericVector< T > &v) const override

T	indefinite_dot (const NumericVector< T > &v) const

virtual void	localize (std::vector< T > &v_local) const override
	Creates a copy of the global vector in the local vector `v_local`. More...

virtual void	localize (NumericVector< T > &v_local) const override
	Same, but fills a `NumericVector<T>` instead of a `std::vector`. More...

virtual void	localize (NumericVector< T > &v_local, const std::vector< numeric_index_type > &send_list) const override
	Creates a local vector `v_local` containing only information relevant to this processor, as defined by the `send_list`. More...

virtual void	localize (std::vector< T > &v_local, const std::vector< numeric_index_type > &indices) const override
	Fill in the local std::vector "v_local" with the global indices given in "indices". More...

virtual void	localize (const numeric_index_type first_local_idx, const numeric_index_type last_local_idx, const std::vector< numeric_index_type > &send_list) override
	Updates a local vector with selected values from neighboring processors, as defined by `send_list`. More...

virtual void	localize_to_one (std::vector< T > &v_local, const processor_id_type proc_id=0) const override
	Creates a local copy of the global vector in `v_local` only on processor `proc_id`. More...

virtual void	pointwise_mult (const NumericVector< T > &vec1, const NumericVector< T > &vec2) override
	Computes $u_i \leftarrow u_i v_i$ (summation not implied) i.e. More...

virtual void	print_matlab (const std::string &name="") const override
	Print the contents of the vector in Matlab's sparse matrix format. More...

virtual void	create_subvector (NumericVector< T > &subvector, const std::vector< numeric_index_type > &rows) const override
	Fills in `subvector` from this vector using the indices in `rows`. More...

virtual void	swap (NumericVector< T > &v) override
	Swaps the contents of this with `v`. More...

Vec	vec ()

virtual bool	initialized () const

ParallelType	type () const

ParallelType &	type ()

virtual bool	closed () const

virtual Real	subset_l1_norm (const std::set< numeric_index_type > &indices) const

virtual Real	subset_l2_norm (const std::set< numeric_index_type > &indices) const

virtual Real	subset_linfty_norm (const std::set< numeric_index_type > &indices) const

virtual T	el (const numeric_index_type i) const

void	get (const std::vector< numeric_index_type > &index, std::vector< T > &values) const
	Access multiple components at once. More...

NumericVector< T > &	operator*= (const T a)
	Scales the vector by `a`, $\vec{u} \leftarrow a\vec{u}$ . More...

NumericVector< T > &	operator/= (const T a)
	Scales the vector by `1/a`, $\vec{u} \leftarrow \frac{1}{a}\vec{u}$ . More...

void	add_vector (const std::vector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where `v` is a std::vector and each `dof_indices`[i] specifies where to add value `v`[i]. More...

virtual void	add_vector (const NumericVector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where `v` is a NumericVector and each `dof_indices`[i] specifies where to add value `v(i)`. More...

void	add_vector (const DenseVector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where `v` is a DenseVector and each `dof_indices`[i] specifies where to add value `v(i)`. More...

void	add_vector (const NumericVector< T > &v, const ShellMatrix< T > &A)
	Computes $\vec{u} \leftarrow \vec{u} + A \vec{v}$ , i.e. More...

void	insert (const std::vector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Inserts the entries of `v` in *this at the locations specified by `v`. More...

virtual void	insert (const NumericVector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Inserts the entries of `v` in *this at the locations specified by `v`. More...

void	insert (const DenseVector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Inserts the entries of `v` in *this at the locations specified by `v`. More...

void	insert (const DenseSubVector< T > &v, const std::vector< numeric_index_type > &dof_indices)
	Inserts the entries of `v` in *this at the locations specified by `v`. More...

virtual int	compare (const NumericVector< T > &other_vector, const Real threshold=TOLERANCE) const

virtual int	local_relative_compare (const NumericVector< T > &other_vector, const Real threshold=TOLERANCE) const

virtual int	global_relative_compare (const NumericVector< T > &other_vector, const Real threshold=TOLERANCE) const

virtual void	print (std::ostream &os=libMesh::out) const
	Prints the local contents of the vector, by default to libMesh::out. More...

template<>
void	print (std::ostream &os) const

virtual void	print_global (std::ostream &os=libMesh::out) const
	Prints the global contents of the vector, by default to libMesh::out. More...

template<>
void	print_global (std::ostream &os) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static std::unique_ptr< NumericVector< T > >	build (const Parallel::Communicator &comm, const SolverPackage solver_package=libMesh::default_solver_package())
	Builds a `NumericVector` on the processors in communicator `comm` using the linear solver package specified by `solver_package`. More...

static std::string	get_info ()
	Gets a string containing the reference information. More...

static void	print_info (std::ostream &out=libMesh::out)
	Prints the reference information, by default to `libMesh::out`. More...

static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects. More...

static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info() More...

static void	disable_print_counter_info ()

Protected Types
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information. More...

Protected Member Functions
void	increment_constructor_count (const std::string &name)
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name)
	Increments the destruction counter. More...

Protected Attributes
bool	_is_closed
	Flag which tracks whether the vector's values are consistent on all processors after insertion or addition of values has occurred on some or all processors. More...

bool	_is_initialized
	`true` once init() has been called. More...

ParallelType	_type
	Type of vector. More...

const Parallel::Communicator &	_communicator

Static Protected Attributes
static Counts	_counts
	Actually holds the data. More...

static Threads::atomic< unsigned int >	_n_objects
	The number of objects. More...

static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting. More...

static bool	_enable_print_counter
	Flag to control whether reference count information is printed when print_info is called. More...

Private Types
typedef std::unordered_map< numeric_index_type, numeric_index_type >	GlobalToLocalMap
	Type for map that maps global to local ghost cells. More...

Private Member Functions
void	_get_array (bool read_only) const
	Queries the array (and the local form if the vector is ghosted) from PETSc. More...

void	_restore_array () const
	Restores the array (and the local form if the vector is ghosted) to PETSc. More...

Private Attributes
Vec	_vec
	Actual PETSc vector datatype to hold vector entries. More...

std::atomic< bool >	_array_is_present
	If `true`, the actual PETSc array of the values of the vector is currently accessible. More...

bool	_array_is_present

numeric_index_type	_first
	First local index. More...

numeric_index_type	_last
	Last local index. More...

numeric_index_type	_local_size
	Size of the local values from _get_array() More...

Vec	_local_form
	PETSc vector datatype to hold the local form of a ghosted vector. More...

const PetscScalar *	_read_only_values
	Pointer to the actual PETSc array of the values of the vector. More...

PetscScalar *	_values
	Pointer to the actual PETSc array of the values of the vector. More...

std::mutex	_petsc_vector_mutex
	Mutex for _get_array and _restore_array. More...

Threads::spin_mutex	_petsc_vector_mutex

GlobalToLocalMap	_global_to_local_map
	Map that maps global to local ghost cells (will be empty if not in ghost cell mode). More...

bool	_destroy_vec_on_exit
	This boolean value should only be set to false for the constructor which takes a PETSc Vec object. More...

bool	_values_manually_retrieved
	Whether or not the data array has been manually retrieved using get_array() or get_array_read() More...

bool	_values_read_only
	Whether or not the data array is for read only access. More...

Detailed Description

template<typename T>
class libMesh::PetscVector< T >

This class provides a nice interface to PETSc's Vec object.

All overridden virtual functions are documented in numeric_vector.h.

Author: Benjamin S. Kirk

Date: 2002 NumericVector interface to PETSc Vec.

Definition at line 64 of file petsc_vector.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

◆ GlobalToLocalMap

template<typename T>

typedef std::unordered_map<numeric_index_type,numeric_index_type> libMesh::PetscVector< T >::GlobalToLocalMap

private

Type for map that maps global to local ghost cells.

Definition at line 421 of file petsc_vector.h.

Constructor & Destructor Documentation

◆ PetscVector() [1/7]

template<typename T >

libMesh::PetscVector< T >::PetscVector	(	const Parallel::Communicator &	comm_in,
		const ParallelType	type = `AUTOMATIC`
	)

explicit

Dummy-Constructor.

Dimension=0

Definition at line 454 of file petsc_vector.h.

                                                                                            :
   NumericVector<T>(comm_in, ptype),
   _array_is_present(false),
   _first(0),
   _last(0),
   _local_form(nullptr),
   _values(nullptr),
   _global_to_local_map(),
   _destroy_vec_on_exit(true),
   _values_manually_retrieved(false),
   _values_read_only(false)
 {
   this->_type = ptype;
 }

◆ PetscVector() [2/7]

template<typename T >

libMesh::PetscVector< T >::PetscVector	(	const Parallel::Communicator &	comm_in,
		const numeric_index_type	n,
		const ParallelType	type = `AUTOMATIC`
	)

explicit

Constructor.

Set dimension to n and initialize all elements with zero.

Definition at line 473 of file petsc_vector.h.

                                                        :
   NumericVector<T>(comm_in, ptype),
   _array_is_present(false),
   _local_form(nullptr),
   _values(nullptr),
   _global_to_local_map(),
   _destroy_vec_on_exit(true),
   _values_manually_retrieved(false),
   _values_read_only(false)
 {
   this->init(n, n, false, ptype);
 }

◆ PetscVector() [3/7]

template<typename T >

libMesh::PetscVector< T >::PetscVector	(	const Parallel::Communicator &	comm_in,
		const numeric_index_type	n,
		const numeric_index_type	n_local,
		const ParallelType	type = `AUTOMATIC`
	)

Constructor.

Set local dimension to n_local, the global dimension to n, and initialize all elements with zero.

Definition at line 492 of file petsc_vector.h.

                                                        :
   NumericVector<T>(comm_in, ptype),
   _array_is_present(false),
   _local_form(nullptr),
   _values(nullptr),
   _global_to_local_map(),
   _destroy_vec_on_exit(true),
   _values_manually_retrieved(false),
   _values_read_only(false)
 {
   this->init(n, n_local, false, ptype);
 }

◆ PetscVector() [4/7]

template<typename T >

libMesh::PetscVector< T >::PetscVector	(	const Parallel::Communicator &	comm_in,
		const numeric_index_type	N,
		const numeric_index_type	n_local,
		const std::vector< numeric_index_type > &	ghost,
		const ParallelType	type = `AUTOMATIC`
	)

Constructor.

Set local dimension to n_local, the global dimension to n, but additionally reserve memory for the indices specified by the ghost argument.

Definition at line 512 of file petsc_vector.h.

                                                        :
   NumericVector<T>(comm_in, ptype),
   _array_is_present(false),
   _local_form(nullptr),
   _values(nullptr),
   _global_to_local_map(),
   _destroy_vec_on_exit(true),
   _values_manually_retrieved(false),
   _values_read_only(false)
 {
   this->init(n, n_local, ghost, false, ptype);
 }

◆ PetscVector() [5/7]

template<typename T >

libMesh::PetscVector< T >::PetscVector	(	Vec	v,
		const Parallel::Communicator &	comm_in
	)

Constructor.

Creates a PetscVector assuming you already have a valid PETSc Vec object. In this case, v is NOT destroyed by the PetscVector constructor when this object goes out of scope. This allows ownership of v to remain with the original creator, and to simply provide additional functionality with the PetscVector.

Definition at line 535 of file petsc_vector.h.

                                                                    :
   NumericVector<T>(comm_in, AUTOMATIC),
   _array_is_present(false),
   _local_form(nullptr),
   _values(nullptr),
   _global_to_local_map(),
   _destroy_vec_on_exit(false),
   _values_manually_retrieved(false),
   _values_read_only(false)
 {
   this->_vec = v;
   this->_is_closed = true;
   this->_is_initialized = true;
 
   /* We need to ask PETSc about the (local to global) ghost value
      mapping and create the inverse mapping out of it.  */
   PetscErrorCode ierr=0;
   PetscInt petsc_local_size=0;
   ierr = VecGetLocalSize(_vec, &petsc_local_size);
   LIBMESH_CHKERR(ierr);
 
   // Get the vector type from PETSc.
   // As of PETSc 3.0.0, the VecType #define lost its const-ness, so we
   // need to have it in the code
 #if PETSC_VERSION_LESS_THAN(3,0,0) || !PETSC_VERSION_LESS_THAN(3,4,0)
   // Pre-3.0 and petsc-dev (as of October 2012) use non-const versions
   VecType ptype;
 #else
   const VecType ptype;
 #endif
   ierr = VecGetType(_vec, &ptype);
   LIBMESH_CHKERR(ierr);
 
   if ((std::strcmp(ptype,VECSHARED) == 0) || (std::strcmp(ptype,VECMPI) == 0))
     {
 #if PETSC_RELEASE_LESS_THAN(3,1,1)
       ISLocalToGlobalMapping mapping = _vec->mapping;
 #else
       ISLocalToGlobalMapping mapping;
       ierr = VecGetLocalToGlobalMapping(_vec, &mapping);
       LIBMESH_CHKERR(ierr);
 #endif
 
       // If is a sparsely stored vector, set up our new mapping
       if (mapping)
         {
           const numeric_index_type my_local_size = static_cast<numeric_index_type>(petsc_local_size);
           const numeric_index_type ghost_begin = static_cast<numeric_index_type>(petsc_local_size);
 #if PETSC_RELEASE_LESS_THAN(3,4,0)
           const numeric_index_type ghost_end = static_cast<numeric_index_type>(mapping->n);
 #else
           PetscInt n;
           ierr = ISLocalToGlobalMappingGetSize(mapping, &n);
           LIBMESH_CHKERR(ierr);
           const numeric_index_type ghost_end = static_cast<numeric_index_type>(n);
 #endif
 #if PETSC_RELEASE_LESS_THAN(3,1,1)
           const PetscInt * indices = mapping->indices;
 #else
           const PetscInt * indices;
           ierr = ISLocalToGlobalMappingGetIndices(mapping,&indices);
           LIBMESH_CHKERR(ierr);
 #endif
           for (numeric_index_type i=ghost_begin; i<ghost_end; i++)
             _global_to_local_map[indices[i]] = i-my_local_size;
           this->_type = GHOSTED;
 #if !PETSC_RELEASE_LESS_THAN(3,1,1)
           ierr = ISLocalToGlobalMappingRestoreIndices(mapping, &indices);
           LIBMESH_CHKERR(ierr);
 #endif
         }
       else
         this->_type = PARALLEL;
     }
   else
     this->_type = SERIAL;
 }

◆ PetscVector() [6/7]

template<typename T>

libMesh::PetscVector< T >::PetscVector ( PetscVector< T > && )

delete

This class manages a C-style struct (Vec) manually, so we don't want to allow any automatic copy/move functions to be generated, and we can't default the destructor.

◆ PetscVector() [7/7]

template<typename T>

libMesh::PetscVector< T >::PetscVector ( const PetscVector< T > & )

delete

◆ ~PetscVector()

template<typename T >

libMesh::PetscVector< T >::~PetscVector ( )

virtual

Definition at line 619 of file petsc_vector.h.

 {
   this->clear ();
 }

Member Function Documentation

◆ _get_array()

template<typename T>

void libMesh::PetscVector< T >::_get_array ( bool read_only ) const

private

Queries the array (and the local form if the vector is ghosted) from PETSc.

Parameters

read_only Whether or not a read only copy of the raw data

◆ _restore_array()

template<typename T>

void libMesh::PetscVector< T >::_restore_array ( ) const

private

Restores the array (and the local form if the vector is ghosted) to PETSc.

Referenced by libMesh::PetscVector< libMesh::Real >::init().

◆ abs()

template<typename T>

virtual void libMesh::PetscVector< T >::abs ( )

overridevirtual

Sets $u_i \leftarrow |u_i|$ for each entry in the vector.

Implements libMesh::NumericVector< T >.

◆ add() [1/4]

template<typename T>

virtual void libMesh::PetscVector< T >::add	(	const numeric_index_type	i,
		const T	value
	)

overridevirtual

Adds value to each entry of the vector.

Implements libMesh::NumericVector< T >.

◆ add() [2/4]

template<typename T>

virtual void libMesh::PetscVector< T >::add ( const T s )

overridevirtual

Adds s to each entry of the vector, $u_i \leftarrow u_i + s$ .

Implements libMesh::NumericVector< T >.

◆ add() [3/4]

template<typename T>

virtual void libMesh::PetscVector< T >::add ( const NumericVector< T > & v )

overridevirtual

Adds v to this, $\vec{u} \leftarrow \vec{u} + \vec{v}$ .

Equivalent to calling operator+=().

Implements libMesh::NumericVector< T >.

◆ add() [4/4]

template<typename T>

virtual void libMesh::PetscVector< T >::add	(	const T	a,
		const NumericVector< T > &	v
	)

overridevirtual

Vector addition with a scalar multiple, $\vec{u} \leftarrow \vec{u} + a\vec{v}$ .

Equivalent to calling operator+=().

Implements libMesh::NumericVector< T >.

◆ add_vector() [1/6]

template<typename T>

virtual void libMesh::PetscVector< T >::add_vector	(	const T *	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

overridevirtual

Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where v is a pointer and each dof_indices[i] specifies where to add value v[i].

This should be overridden in subclasses for efficiency.

Reimplemented from libMesh::NumericVector< T >.

◆ add_vector() [2/6]

template<typename T>

virtual void libMesh::PetscVector< T >::add_vector	(	const NumericVector< T > &	v,
		const SparseMatrix< T > &	A
	)

overridevirtual

Computes $\vec{u} \leftarrow \vec{u} + A \vec{v}$ , i.e.

adds the product of a SparseMatrix A and a NumericVector v to this.

Implements libMesh::NumericVector< T >.

◆ add_vector() [3/6]

template<typename T>

void libMesh::NumericVector< T >::add_vector	(	const std::vector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inherited

Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where v is a std::vector and each dof_indices[i] specifies where to add value v[i].

Definition at line 835 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->add_vector(v.data(), dof_indices);
 }

◆ add_vector() [4/6]

template<typename T>

virtual void libMesh::NumericVector< T >::add_vector	(	const NumericVector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

virtualinherited

Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where v is a NumericVector and each dof_indices[i] specifies where to add value v(i).

◆ add_vector() [5/6]

template<typename T>

void libMesh::NumericVector< T >::add_vector	(	const DenseVector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inherited

Computes $\vec{u} \leftarrow \vec{u} + \vec{v}$ , where v is a DenseVector and each dof_indices[i] specifies where to add value v(i).

Definition at line 847 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->add_vector(&v(0), dof_indices);
 }

◆ add_vector() [6/6]

template<typename T>

void libMesh::NumericVector< T >::add_vector	(	const NumericVector< T > &	v,
		const ShellMatrix< T > &	A
	)

inherited

Computes $\vec{u} \leftarrow \vec{u} + A \vec{v}$ , i.e.

adds the product of a ShellMatrix A and a NumericVector v to this.

◆ add_vector_conjugate_transpose()

template<typename T>

void libMesh::PetscVector< T >::add_vector_conjugate_transpose	(	const NumericVector< T > &	v,
		const SparseMatrix< T > &	A
	)

$U \leftarrow U + A^H v$ .

Adds the product of the conjugate-transpose of SparseMatrix A and a NumericVector v to this.

◆ add_vector_transpose()

template<typename T>

virtual void libMesh::PetscVector< T >::add_vector_transpose	(	const NumericVector< T > &	v,
		const SparseMatrix< T > &	A
	)

overridevirtual

Computes $\vec{u} \leftarrow \vec{u} + A^T \vec{v}$ , i.e.

adds the product of the transpose of a SparseMatrix A and a NumericVector v to this.

Implements libMesh::NumericVector< T >.

◆ build()

template<typename T>

static std::unique_ptr<NumericVector<T> > libMesh::NumericVector< T >::build	(	const Parallel::Communicator &	comm,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a NumericVector on the processors in communicator comm using the linear solver package specified by solver_package.

◆ clear()

template<typename T >

void libMesh::PetscVector< T >::clear ( )

overridevirtual

Restores the NumericVector<T> to a pristine state.

Reimplemented from libMesh::NumericVector< T >.

Definition at line 838 of file petsc_vector.h.

 {
   parallel_object_only();
 
   if (this->initialized())
     this->_restore_array();
 
   if ((this->initialized()) && (this->_destroy_vec_on_exit))
     {
       PetscErrorCode ierr=0;
 
       ierr = LibMeshVecDestroy(&_vec);
       LIBMESH_CHKERR(ierr);
     }
 
   this->_is_closed = this->_is_initialized = false;
 
   _global_to_local_map.clear();
 }

◆ clone()

template<typename T >

std::unique_ptr< NumericVector< T > > libMesh::PetscVector< T >::clone ( ) const

overridevirtual

Returns: A copy of this vector wrapped in a smart pointer.

Note: This must be overridden in the derived classes.

Implements libMesh::NumericVector< T >.

Definition at line 910 of file petsc_vector.h.

 {
   NumericVector<T> * cloned_vector = new PetscVector<T>(this->comm(), this->type());
   cloned_vector->init(*this, true);
   *cloned_vector = *this;
   return std::unique_ptr<NumericVector<T>>(cloned_vector);
 }

◆ close()

template<typename T >

void libMesh::PetscVector< T >::close ( )

overridevirtual

Calls the NumericVector's internal assembly routines, ensuring that the values are consistent across processors.

Implements libMesh::NumericVector< T >.

Definition at line 810 of file petsc_vector.h.

 {
   parallel_object_only();
 
   this->_restore_array();
 
   PetscErrorCode ierr=0;
 
   ierr = VecAssemblyBegin(_vec);
   LIBMESH_CHKERR(ierr);
   ierr = VecAssemblyEnd(_vec);
   LIBMESH_CHKERR(ierr);
 
   if (this->type() == GHOSTED)
     {
       ierr = VecGhostUpdateBegin(_vec,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecGhostUpdateEnd(_vec,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
     }
 
   this->_is_closed = true;
 }

◆ closed()

template<typename T>

virtual bool libMesh::NumericVector< T >::closed ( ) const

virtualinherited

Returns: true if the vector is closed and ready for computation, false otherwise.

Definition at line 165 of file numeric_vector.h.

165 { return _is_closed; }

libMesh::NumericVector::_is_closed

bool _is_closed

Flag which tracks whether the vector's values are consistent on all processors after insertion or add...

Definition: numeric_vector.h:712

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::Parallel::sync_element_data_by_parent_id(), libMesh::Parallel::sync_node_data_by_element_id(), and libMesh::Parallel::sync_node_data_by_element_id_once().

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ compare()

template<typename T>

virtual int libMesh::NumericVector< T >::compare	(	const NumericVector< T > &	other_vector,
		const Real	threshold = `TOLERANCE`
	)		const

virtualinherited

Returns: -1 when this is equivalent to other_vector (up to the given threshold), or the first index where abs(a[i]-b[i]) exceeds the threshold.

◆ conjugate()

template<typename T>

virtual void libMesh::PetscVector< T >::conjugate ( )

overridevirtual

Negates the imaginary component of each entry in the vector.

Implements libMesh::NumericVector< T >.

◆ create_subvector()

template<typename T>

virtual void libMesh::PetscVector< T >::create_subvector	(	NumericVector< T > &	,
		const std::vector< numeric_index_type > &
	)		const

overridevirtual

Fills in subvector from this vector using the indices in rows.

Similar to the create_submatrix() routine for the SparseMatrix class, it is currently only implemented for PetscVectors.

Reimplemented from libMesh::NumericVector< T >.

◆ disable_print_counter_info()

static void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

◆ dot()

template<typename T>

virtual T libMesh::PetscVector< T >::dot ( const NumericVector< T > & v ) const

overridevirtual

Returns: $\vec{u} \cdot \vec{v}$ , the dot product of (*this) with the vector v.

Uses the complex-conjugate of v in the complex-valued case.

Implements libMesh::NumericVector< T >.

◆ el()

template<typename T>

virtual T libMesh::NumericVector< T >::el ( const numeric_index_type i ) const

virtualinherited

Returns: (*this)(i).

Definition at line 346 of file numeric_vector.h.

346 { return (*this)(i); }

◆ enable_print_counter_info()

static void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

Methods to enable/disable the reference counter output from print_info()

◆ first_local_index()

template<typename T >

numeric_index_type libMesh::PetscVector< T >::first_local_index ( ) const

overridevirtual

Returns: The index of the first vector element actually stored on this processor.

Note: The minimum for this index is 0.

Implements libMesh::NumericVector< T >.

Definition at line 959 of file petsc_vector.h.

 {
   libmesh_assert (this->initialized());
 
   numeric_index_type first = 0;
 
   if (_array_is_present) // Can we use cached values?
     first = _first;
   else
     {
       PetscErrorCode ierr=0;
       PetscInt petsc_first=0, petsc_last=0;
       ierr = VecGetOwnershipRange (_vec, &petsc_first, &petsc_last);
       LIBMESH_CHKERR(ierr);
       first = static_cast<numeric_index_type>(petsc_first);
     }
 
   return first;
 }

◆ get() [1/2]

template<typename T>

void libMesh::PetscVector< T >::get	(	const std::vector< numeric_index_type > &	index,
		T *	values
	)		const

overridevirtual

Access multiple components at once.

values will not be reallocated; it should already have enough space. The default implementation calls operator() for each index, but some implementations may supply faster methods here.

Reimplemented from libMesh::NumericVector< T >.

Definition at line 1087 of file petsc_vector.h.

 {
   this->_get_array(true);
 
   const std::size_t num = index.size();
 
   for (std::size_t i=0; i<num; i++)
     {
       const numeric_index_type local_index = this->map_global_to_local_index(index[i]);
 #ifndef NDEBUG
       if (this->type() == GHOSTED)
         {
           libmesh_assert_less (local_index, _local_size);
         }
 #endif
       values[i] = static_cast<T>(_read_only_values[local_index]);
     }
 }

◆ get() [2/2]

template<typename T>

void libMesh::NumericVector< T >::get	(	const std::vector< numeric_index_type > &	index,
		std::vector< T > &	values
	)		const

inherited

Access multiple components at once.

values will be resized, if necessary, and filled. The default implementation calls operator() for each index, but some implementations may supply faster methods here.

Definition at line 820 of file numeric_vector.h.

 {
   const std::size_t num = index.size();
   values.resize(num);
   if (!num)
     return;
 
   this->get(index, values.data());
 }

◆ get_array()

template<typename T >

PetscScalar * libMesh::PetscVector< T >::get_array ( )

Get read/write access to the raw PETSc Vector data array.

Note: This is an advanced interface. In general you should avoid using it unless you know what you are doing!

Definition at line 1110 of file petsc_vector.h.

 {
   _values_manually_retrieved = true;
   _get_array(false);
 
   return _values;
 }

◆ get_array_read()

template<typename T >

const PetscScalar * libMesh::PetscVector< T >::get_array_read ( ) const

Get read only access to the raw PETSc Vector data array.

Note: This is an advanced interface. In general you should avoid using it unless you know what you are doing!

Definition at line 1121 of file petsc_vector.h.

 {
   _values_manually_retrieved = true;
   _get_array(true);
 
   return _read_only_values;
 }

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

◆ global_relative_compare()

template<typename T>

virtual int libMesh::NumericVector< T >::global_relative_compare	(	const NumericVector< T > &	other_vector,
		const Real	threshold = `TOLERANCE`
	)		const

virtualinherited

Returns: -1 when this is equivalent to other_vector (up to the given global relative threshold), or the first index where abs(a[i]-b[i])/max_j(a[j],b[j]) exceeds the threshold.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

protectedinherited

Increments the construction counter.

Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.first++;
 }

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

protectedinherited

Increments the destruction counter.

Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

 {
   Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
   std::pair<unsigned int, unsigned int> & p = _counts[name];
 
   p.second++;
 }

◆ indefinite_dot()

template<typename T>

T libMesh::PetscVector< T >::indefinite_dot ( const NumericVector< T > & v ) const

Returns: The dot product of (*this) with the vector v.

Note: Does not use the complex-conjugate of v in the complex-valued case.

◆ init() [1/4]

template<typename T >

void libMesh::PetscVector< T >::init	(	const numeric_index_type	n,
		const numeric_index_type	n_local,
		const bool	fast = `false`,
		const ParallelType	ptype = `AUTOMATIC`
	)

overridevirtual

Change the dimension of the vector to n.

The reserved memory for this vector remains unchanged if possible. If n==0, all memory is freed. Therefore, if you want to resize the vector and release the memory not needed, you have to first call init(0) and then init(n). This behaviour is analogous to that of the STL containers.

On fast==false, the vector is filled by zeros.

Implements libMesh::NumericVector< T >.

Definition at line 628 of file petsc_vector.h.

 {
   parallel_object_only();
 
   PetscErrorCode ierr=0;
   PetscInt petsc_n=static_cast<PetscInt>(n);
   PetscInt petsc_n_local=static_cast<PetscInt>(n_local);
 
 
   // Clear initialized vectors
   if (this->initialized())
     this->clear();
 
   if (ptype == AUTOMATIC)
     {
       if (n == n_local)
         this->_type = SERIAL;
       else
         this->_type = PARALLEL;
     }
   else
     this->_type = ptype;
 
   libmesh_assert ((this->_type==SERIAL && n==n_local) ||
                   this->_type==PARALLEL);
 
   // create a sequential vector if on only 1 processor
   if (this->_type == SERIAL)
     {
       ierr = VecCreateSeq (PETSC_COMM_SELF, petsc_n, &_vec);
       CHKERRABORT(PETSC_COMM_SELF,ierr);
 
       ierr = VecSetFromOptions (_vec);
       CHKERRABORT(PETSC_COMM_SELF,ierr);
     }
   // otherwise create an MPI-enabled vector
   else if (this->_type == PARALLEL)
     {
 #ifdef LIBMESH_HAVE_MPI
       libmesh_assert_less_equal (n_local, n);
       ierr = VecCreateMPI (this->comm().get(), petsc_n_local, petsc_n,
                            &_vec);
       LIBMESH_CHKERR(ierr);
 #else
       libmesh_assert_equal_to (n_local, n);
       ierr = VecCreateSeq (PETSC_COMM_SELF, petsc_n, &_vec);
       CHKERRABORT(PETSC_COMM_SELF,ierr);
 #endif
 
       ierr = VecSetFromOptions (_vec);
       LIBMESH_CHKERR(ierr);
     }
   else
     libmesh_error_msg("Unsupported type " << this->_type);
 
   this->_is_initialized = true;
   this->_is_closed = true;
 
 
   if (fast == false)
     this->zero ();
 }

◆ init() [2/4]

template<typename T >

void libMesh::PetscVector< T >::init	(	const numeric_index_type	n,
		const bool	fast = `false`,
		const ParallelType	ptype = `AUTOMATIC`
	)

overridevirtual

Call init() with n_local = N.

Implements libMesh::NumericVector< T >.

Definition at line 698 of file petsc_vector.h.

 {
   this->init(n,n,fast,ptype);
 }

◆ init() [3/4]

template<typename T>

virtual void libMesh::PetscVector< T >::init	(	const numeric_index_type	n,
		const numeric_index_type	n_local,
		const std::vector< numeric_index_type > &	ghost,
		const bool	fast = `false`,
		const ParallelType	ptype = `AUTOMATIC`
	)

overridevirtual

Create a vector that holds tha local indices plus those specified in the ghost argument.

Implements libMesh::NumericVector< T >.

◆ init() [4/4]

template<typename T>

void libMesh::PetscVector< T >::init	(	const NumericVector< T > &	other,
		const bool	fast = `false`
	)

overridevirtual

Creates a vector that has the same dimension and storage type as other, including ghost dofs.

Implements libMesh::NumericVector< T >.

Definition at line 771 of file petsc_vector.h.

 {
   parallel_object_only();
 
   // Clear initialized vectors
   if (this->initialized())
     this->clear();
 
   const PetscVector<T> & v = cast_ref<const PetscVector<T> &>(other);
 
   // Other vector should restore array.
   if (v.initialized())
     {
       v._restore_array();
     }
 
   this->_global_to_local_map = v._global_to_local_map;
 
   // Even if we're initializing sizes based on an uninitialized or
   // unclosed vector, *this* vector is being initialized now and is
   // initially closed.
   this->_is_closed      = true; // v._is_closed;
   this->_is_initialized = true; // v._is_initialized;
 
   this->_type = v._type;
 
   // We want to have a valid Vec, even if it's initially of size zero
   PetscErrorCode ierr = VecDuplicate (v._vec, &this->_vec);
   LIBMESH_CHKERR(ierr);
 
   if (fast == false)
     this->zero ();
 }

◆ initialized()

template<typename T>

virtual bool libMesh::NumericVector< T >::initialized ( ) const

virtualinherited

Returns: true if the vector has been initialized, false otherwise.

Definition at line 149 of file numeric_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::init().

149 { return _is_initialized; }

libMesh::NumericVector::_is_initialized

bool _is_initialized

true once init() has been called.

Definition: numeric_vector.h:717

◆ insert() [1/5]

template<typename T>

virtual void libMesh::PetscVector< T >::insert	(	const T *	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

overridevirtual

Inserts the entries of v in *this at the locations specified by v.

Reimplemented from libMesh::NumericVector< T >.

◆ insert() [2/5]

template<typename T>

void libMesh::NumericVector< T >::insert	(	const std::vector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inherited

Inserts the entries of v in *this at the locations specified by v.

Definition at line 859 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->insert(v.data(), dof_indices);
 }

◆ insert() [3/5]

template<typename T>

virtual void libMesh::NumericVector< T >::insert	(	const NumericVector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

virtualinherited

Inserts the entries of v in *this at the locations specified by v.

◆ insert() [4/5]

template<typename T>

void libMesh::NumericVector< T >::insert	(	const DenseVector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inherited

Inserts the entries of v in *this at the locations specified by v.

Definition at line 871 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->insert(&v(0), dof_indices);
 }

◆ insert() [5/5]

template<typename T>

void libMesh::NumericVector< T >::insert	(	const DenseSubVector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inherited

Inserts the entries of v in *this at the locations specified by v.

Definition at line 883 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->insert(&v(0), dof_indices);
 }

◆ l1_norm()

template<typename T>

virtual Real libMesh::PetscVector< T >::l1_norm ( ) const

overridevirtual

Returns: The $\ell_1$ -norm of the vector, i.e. the sum of the absolute values of the entries.

Implements libMesh::NumericVector< T >.

◆ l2_norm()

template<typename T>

virtual Real libMesh::PetscVector< T >::l2_norm ( ) const

overridevirtual

Returns: The $\ell_2$ -norm of the vector, i.e. the square root of the sum of the squares of the entries.

Implements libMesh::NumericVector< T >.

◆ last_local_index()

template<typename T >

numeric_index_type libMesh::PetscVector< T >::last_local_index ( ) const

overridevirtual

Returns: The index+1 of the last vector element actually stored on this processor.

Note: The maximum for this index is size().

Implements libMesh::NumericVector< T >.

Definition at line 983 of file petsc_vector.h.

 {
   libmesh_assert (this->initialized());
 
   numeric_index_type last = 0;
 
   if (_array_is_present) // Can we use cached values?
     last = _last;
   else
     {
       PetscErrorCode ierr=0;
       PetscInt petsc_first=0, petsc_last=0;
       ierr = VecGetOwnershipRange (_vec, &petsc_first, &petsc_last);
       LIBMESH_CHKERR(ierr);
       last = static_cast<numeric_index_type>(petsc_last);
     }
 
   return last;
 }

◆ linfty_norm()

template<typename T>

virtual Real libMesh::PetscVector< T >::linfty_norm ( ) const

overridevirtual

Returns: The $\ell_{\infty}$ -norm of the vector, i.e. the maximum absolute value of the entries of the vector.

Implements libMesh::NumericVector< T >.

◆ local_relative_compare()

template<typename T>

virtual int libMesh::NumericVector< T >::local_relative_compare	(	const NumericVector< T > &	other_vector,
		const Real	threshold = `TOLERANCE`
	)		const

virtualinherited

Returns: -1 when this is equivalent to other_vector, (up to the given local relative threshold), or the first index where abs(a[i]-b[i])/max(a[i],b[i]) exceeds the threshold.

◆ local_size()

template<typename T >

numeric_index_type libMesh::PetscVector< T >::local_size ( ) const

overridevirtual

Returns: The local size of the vector, i.e. index_stop - index_start.

Implements libMesh::NumericVector< T >.

Definition at line 942 of file petsc_vector.h.

 {
   libmesh_assert (this->initialized());
 
   PetscErrorCode ierr=0;
   PetscInt petsc_size=0;
 
   ierr = VecGetLocalSize(_vec, &petsc_size);
   LIBMESH_CHKERR(ierr);
 
   return static_cast<numeric_index_type>(petsc_size);
 }

◆ localize() [1/5]

template<typename T>

virtual void libMesh::PetscVector< T >::localize ( std::vector< T > & v_local ) const

overridevirtual

Creates a copy of the global vector in the local vector v_local.

Implements libMesh::NumericVector< T >.

◆ localize() [2/5]

template<typename T>

virtual void libMesh::PetscVector< T >::localize ( NumericVector< T > & v_local ) const

overridevirtual

Same, but fills a NumericVector<T> instead of a std::vector.

Implements libMesh::NumericVector< T >.

◆ localize() [3/5]

template<typename T>

virtual void libMesh::PetscVector< T >::localize	(	NumericVector< T > &	v_local,
		const std::vector< numeric_index_type > &	send_list
	)		const

overridevirtual

Creates a local vector v_local containing only information relevant to this processor, as defined by the send_list.

Implements libMesh::NumericVector< T >.

◆ localize() [4/5]

template<typename T>

virtual void libMesh::PetscVector< T >::localize	(	std::vector< T > &	v_local,
		const std::vector< numeric_index_type > &	indices
	)		const

overridevirtual

Fill in the local std::vector "v_local" with the global indices given in "indices".

Note: The indices can be different on every processor, and the same index can be localized to more than one processor. The resulting v_local can be shorter than the original, and the entries will be in the order specified by indices.

Example:

*   On 4 procs *this = {a, b, c, d, e, f, g, h, i} is a parallel vector.
*   On each proc, the indices arrays are set up as:
*   proc0, indices = {1,2,4,5}
*   proc1, indices = {2,5,6,8}
*   proc2, indices = {2,3,6,7}
*   proc3, indices = {0,1,2,3}
*
*   After calling this version of localize, the v_local vectors are:
*   proc0, v_local = {b,c,e,f}
*   proc1, v_local = {c,f,g,i}
*   proc2, v_local = {c,d,g,h}
*   proc3, v_local = {a,b,c,d}
*

This function is useful in parallel I/O routines, when you have a parallel vector of solution values which you want to write a subset of.

Implements libMesh::NumericVector< T >.

◆ localize() [5/5]

template<typename T>

virtual void libMesh::PetscVector< T >::localize	(	const numeric_index_type	first_local_idx,
		const numeric_index_type	last_local_idx,
		const std::vector< numeric_index_type > &	send_list
	)

overridevirtual

Updates a local vector with selected values from neighboring processors, as defined by send_list.

Implements libMesh::NumericVector< T >.

◆ localize_to_one()

template<typename T>

virtual void libMesh::PetscVector< T >::localize_to_one	(	std::vector< T > &	v_local,
		const processor_id_type	proc_id = `0`
	)		const

overridevirtual

Creates a local copy of the global vector in v_local only on processor proc_id.

By default the data is sent to processor 0. This method is useful for outputting data from one processor.

Implements libMesh::NumericVector< T >.

◆ map_global_to_local_index()

template<typename T >

numeric_index_type libMesh::PetscVector< T >::map_global_to_local_index ( const numeric_index_type i ) const

Returns: The local index corresponding to global index i.

If the index is not a ghost cell, this is done by subtraction the number of the first local index. If it is a ghost cell, it has to be looked up in the map.

Definition at line 1007 of file petsc_vector.h.

 {
   libmesh_assert (this->initialized());
 
   numeric_index_type first=0;
   numeric_index_type last=0;
 
   if (_array_is_present) // Can we use cached values?
     {
       first = _first;
       last = _last;
     }
   else
     {
       PetscErrorCode ierr=0;
       PetscInt petsc_first=0, petsc_last=0;
       ierr = VecGetOwnershipRange (_vec, &petsc_first, &petsc_last);
       LIBMESH_CHKERR(ierr);
       first = static_cast<numeric_index_type>(petsc_first);
       last = static_cast<numeric_index_type>(petsc_last);
     }
 
 
   if ((i>=first) && (i<last))
     {
       return i-first;
     }
 
   GlobalToLocalMap::const_iterator it = _global_to_local_map.find(i);
 #ifndef NDEBUG
   const GlobalToLocalMap::const_iterator end = _global_to_local_map.end();
   if (it == end)
     {
       std::ostringstream error_message;
       error_message << "No index " << i << " in ghosted vector.\n"
                     << "Vector contains [" << first << ',' << last << ")\n";
       GlobalToLocalMap::const_iterator b = _global_to_local_map.begin();
       if (b == end)
         {
           error_message << "And empty ghost array.\n";
         }
       else
         {
           error_message << "And ghost array {" << b->first;
           for (++b; b != end; ++b)
             error_message << ',' << b->first;
           error_message << "}\n";
         }
 
       libmesh_error_msg(error_message.str());
     }
   libmesh_assert (it != _global_to_local_map.end());
 #endif
   return it->second+last-first;
 }

◆ max()

template<typename T >

Real libMesh::PetscVector< T >::max ( ) const

overridevirtual

Returns: The maximum entry in the vector, or the maximum real part in the case of complex numbers.

Implements libMesh::NumericVector< T >.

Definition at line 1162 of file petsc_vector.h.

 {
   parallel_object_only();
 
   this->_restore_array();
 
   PetscErrorCode ierr=0;
   PetscInt index=0;
   PetscReal returnval=0.;
 
   ierr = VecMax (_vec, &index, &returnval);
   LIBMESH_CHKERR(ierr);
 
   // this return value is correct: VecMax returns a PetscReal
   return static_cast<Real>(returnval);
 }

◆ min()

template<typename T >

Real libMesh::PetscVector< T >::min ( ) const

overridevirtual

Returns: The minimum entry in the vector, or the minimum real part in the case of complex numbers.

Implements libMesh::NumericVector< T >.

Definition at line 1141 of file petsc_vector.h.

 {
   parallel_object_only();
 
   this->_restore_array();
 
   PetscErrorCode ierr=0;
   PetscInt index=0;
   PetscReal returnval=0.;
 
   ierr = VecMin (_vec, &index, &returnval);
   LIBMESH_CHKERR(ierr);
 
   // this return value is correct: VecMin returns a PetscReal
   return static_cast<Real>(returnval);
 }

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inherited

Returns: The number of processors in the group.

Definition at line 95 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

96 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ operator()()

template<typename T >

T libMesh::PetscVector< T >::operator() ( const numeric_index_type i ) const

overridevirtual

Returns: A copy of the ith entry of the vector.

Implements libMesh::NumericVector< T >.

Definition at line 1067 of file petsc_vector.h.

 {
   this->_get_array(true);
 
   const numeric_index_type local_index = this->map_global_to_local_index(i);
 
 #ifndef NDEBUG
   if (this->type() == GHOSTED)
     {
       libmesh_assert_less (local_index, _local_size);
     }
 #endif
 
   return static_cast<T>(_read_only_values[local_index]);
 }

◆ operator*=()

template<typename T>

NumericVector<T>& libMesh::NumericVector< T >::operator*= ( const T a )

inherited

Scales the vector by a, $\vec{u} \leftarrow a\vec{u}$ .

Equivalent to u.scale(a)

Returns: A reference to *this.

Definition at line 391 of file numeric_vector.h.

391 { this->scale(a); return *this; }

libMesh::NumericVector::scale

virtual void scale(const T factor)=0

Scale each element of the vector by the given factor.

◆ operator+=()

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator+= ( const NumericVector< T > & v )

overridevirtual

Adds v to *this, $\vec{u} \leftarrow \vec{u} + \vec{v}$ .

Equivalent to u.add(1, v).

Returns: A reference to *this.

Implements libMesh::NumericVector< T >.

◆ operator-=()

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator-= ( const NumericVector< T > & v )

overridevirtual

Subtracts v from *this, $\vec{u} \leftarrow \vec{u} - \vec{v}$ .

Equivalent to u.add(-1, v).

Returns: A reference to *this.

Implements libMesh::NumericVector< T >.

◆ operator/=() [1/2]

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator/= ( const NumericVector< T > & )

overridevirtual

Computes the pointwise division of this vector's entries by another's, $u_i \leftarrow \frac{u_i}{v_i} \, \forall i$ .

Returns: A reference to *this.

Implements libMesh::NumericVector< T >.

◆ operator/=() [2/2]

template<typename T>

NumericVector<T>& libMesh::NumericVector< T >::operator/= ( const T a )

inherited

Scales the vector by 1/a, $\vec{u} \leftarrow \frac{1}{a}\vec{u}$ .

Equivalent to u.scale(1./a)

Returns: A reference to *this.

Definition at line 400 of file numeric_vector.h.

400 { this->scale(1./a); return *this; }

libMesh::NumericVector::scale

virtual void scale(const T factor)=0

Scale each element of the vector by the given factor.

◆ operator=() [1/5]

template<typename T>

PetscVector<T>& libMesh::PetscVector< T >::operator= ( const PetscVector< T > & v )

Copy assignment operator.

Calls VecCopy after performing various checks.

Returns: A reference to *this as the derived type.

◆ operator=() [2/5]

template<typename T>

PetscVector& libMesh::PetscVector< T >::operator= ( PetscVector< T > && )

delete

◆ operator=() [3/5]

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator= ( const T s )

overridevirtual

Sets all entries of the vector to the value s.

Returns: A reference to *this.

Implements libMesh::NumericVector< T >.

◆ operator=() [4/5]

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator= ( const NumericVector< T > & v )

overridevirtual

This looks like a copy assignment operator, but note that, unlike normal copy assignment operators, it is pure virtual.

This function should be overridden in derived classes so that they can be copied correctly via references to the base class. This design usually isn't a good idea in general, but in this context it works because we usually don't have a mix of different kinds of NumericVectors active in the library at a single time.

Returns: A reference to *this as the base type.

Implements libMesh::NumericVector< T >.

◆ operator=() [5/5]

template<typename T>

virtual NumericVector<T>& libMesh::PetscVector< T >::operator= ( const std::vector< T > & v )

overridevirtual

Sets (*this)(i) = v(i) for each entry of the vector.

Returns: A reference to *this as the base type.

Implements libMesh::NumericVector< T >.

◆ pointwise_mult()

template<typename T>

virtual void libMesh::PetscVector< T >::pointwise_mult	(	const NumericVector< T > &	vec1,
		const NumericVector< T > &	vec2
	)

overridevirtual

Computes $u_i \leftarrow u_i v_i$ (summation not implied) i.e.

the pointwise (component-wise) product of vec1 and vec2, and stores the result in *this.

Implements libMesh::NumericVector< T >.

◆ print() [1/2]

template<typename T >

void libMesh::NumericVector< T >::print ( std::ostream & os = libMesh::out ) const

virtualinherited

Prints the local contents of the vector, by default to libMesh::out.

Definition at line 916 of file numeric_vector.h.

 {
   libmesh_assert (this->initialized());
   os << "Size\tglobal =  " << this->size()
      << "\t\tlocal =  " << this->local_size() << std::endl;
 
   os << "#\tValue" << std::endl;
   for (numeric_index_type i=this->first_local_index(); i<this->last_local_index(); i++)
     os << i << "\t" << (*this)(i) << std::endl;
 }

◆ print() [2/2]

template<>

void libMesh::NumericVector< Complex >::print ( std::ostream & os ) const

inherited

Definition at line 898 of file numeric_vector.h.

 {
   libmesh_assert (this->initialized());
   os << "Size\tglobal =  " << this->size()
      << "\t\tlocal =  " << this->local_size() << std::endl;
 
   // std::complex<>::operator<<() is defined, but use this form
   os << "#\tReal part\t\tImaginary part" << std::endl;
   for (numeric_index_type i=this->first_local_index(); i<this->last_local_index(); i++)
     os << i << "\t"
        << (*this)(i).real() << "\t\t"
        << (*this)(i).imag() << std::endl;
 }

◆ print_global() [1/2]

template<typename T >

void libMesh::NumericVector< T >::print_global ( std::ostream & os = libMesh::out ) const

virtualinherited

Prints the global contents of the vector, by default to libMesh::out.

Definition at line 953 of file numeric_vector.h.

 {
   libmesh_assert (this->initialized());
 
   std::vector<T> v(this->size());
   this->localize(v);
 
   // Right now we only want one copy of the output
   if (this->processor_id())
     return;
 
   os << "Size\tglobal =  " << this->size() << std::endl;
   os << "#\tValue" << std::endl;
   for (numeric_index_type i=0; i!=v.size(); i++)
     os << i << "\t" << v[i] << std::endl;
 }

◆ print_global() [2/2]

template<>

void libMesh::NumericVector< Complex >::print_global ( std::ostream & os ) const

inherited

Definition at line 931 of file numeric_vector.h.

 {
   libmesh_assert (this->initialized());
 
   std::vector<Complex> v(this->size());
   this->localize(v);
 
   // Right now we only want one copy of the output
   if (this->processor_id())
     return;
 
   os << "Size\tglobal =  " << this->size() << std::endl;
   os << "#\tReal part\t\tImaginary part" << std::endl;
   for (numeric_index_type i=0; i!=v.size(); i++)
     os << i << "\t"
        << v[i].real() << "\t\t"
        << v[i].imag() << std::endl;
 }

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

◆ print_matlab()

template<typename T>

virtual void libMesh::PetscVector< T >::print_matlab ( const std::string & = "" ) const

overridevirtual

Print the contents of the vector in Matlab's sparse matrix format.

Optionally prints the vector to the file named name. If name is not specified it is dumped to the screen.

Reimplemented from libMesh::NumericVector< T >.

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inherited

Returns: The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

Referenced by libMesh::DofMap::end_dof(), libMesh::DofMap::end_old_dof(), libMesh::DofMap::first_dof(), libMesh::DofMap::first_old_dof(), libMesh::DofMap::last_dof(), libMesh::MeshBase::n_active_local_elem(), libMesh::DofMap::n_local_dofs(), libMesh::MeshBase::n_local_elem(), libMesh::MeshBase::n_local_nodes(), and libMesh::MeshTools::weight().

102 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ reciprocal()

template<typename T>

virtual void libMesh::PetscVector< T >::reciprocal ( )

overridevirtual

Computes the pointwise reciprocal, $u_i \leftarrow \frac{1}{u_i} \, \forall i$ .

Implements libMesh::NumericVector< T >.

◆ restore_array()

template<typename T >

void libMesh::PetscVector< T >::restore_array ( )

Restore the data array.

Note: This MUST be called after get_array() or get_array_read() and before using any other interface functions on PetscVector.

Definition at line 1131 of file petsc_vector.h.

 {
   // \note \p _values_manually_retrieved needs to be set to \p false
   // \e before calling \p _restore_array()!
   _values_manually_retrieved = false;
   _restore_array();
 }

◆ scale()

template<typename T>

virtual void libMesh::PetscVector< T >::scale ( const T factor )

overridevirtual

Scale each element of the vector by the given factor.

Implements libMesh::NumericVector< T >.

◆ set()

template<typename T>

virtual void libMesh::PetscVector< T >::set	(	const numeric_index_type	i,
		const T	value
	)

overridevirtual

Sets v(i) = value.

Implements libMesh::NumericVector< T >.

◆ size()

template<typename T >

numeric_index_type libMesh::PetscVector< T >::size ( ) const

overridevirtual

Returns: The size of the vector.

Implements libMesh::NumericVector< T >.

Definition at line 922 of file petsc_vector.h.

 {
   libmesh_assert (this->initialized());
 
   PetscErrorCode ierr=0;
   PetscInt petsc_size=0;
 
   if (!this->initialized())
     return 0;
 
   ierr = VecGetSize(_vec, &petsc_size);
   LIBMESH_CHKERR(ierr);
 
   return static_cast<numeric_index_type>(petsc_size);
 }

◆ subset_l1_norm()

template<typename T>

virtual Real libMesh::NumericVector< T >::subset_l1_norm ( const std::set< numeric_index_type > & indices ) const

virtualinherited

Returns: The $\ell_1$ -norm of the vector, i.e. the sum of the absolute values for the specified entries in the vector.

Note: The indices must necessarily live on this processor.

◆ subset_l2_norm()

template<typename T>

virtual Real libMesh::NumericVector< T >::subset_l2_norm ( const std::set< numeric_index_type > & indices ) const

virtualinherited

Returns: The $\ell_2$ -norm of the vector, i.e. the square root of the sum of the squares of the elements for the specified entries in the vector.

Note: The indices must necessarily live on this processor.

◆ subset_linfty_norm()

template<typename T>

virtual Real libMesh::NumericVector< T >::subset_linfty_norm ( const std::set< numeric_index_type > & indices ) const

virtualinherited

Returns: The maximum absolute value of the specified entries of this vector, which is the $\ell_{\infty}$ -norm of a vector.

Note: The indices must necessarily live on this processor.

◆ sum()

template<typename T>

virtual T libMesh::PetscVector< T >::sum ( ) const

overridevirtual

Returns: The sum of all values in the vector.

Implements libMesh::NumericVector< T >.

◆ swap()

template<typename T>

void libMesh::PetscVector< T >::swap ( NumericVector< T > & v )

overridevirtual

Swaps the contents of this with v.

There should be enough indirection in subclasses to make this an O(1) header-swap operation.

Reimplemented from libMesh::NumericVector< T >.

Definition at line 1183 of file petsc_vector.h.

 {
   parallel_object_only();
 
   NumericVector<T>::swap(other);
 
   PetscVector<T> & v = cast_ref<PetscVector<T> &>(other);
 
   std::swap(_vec, v._vec);
   std::swap(_destroy_vec_on_exit, v._destroy_vec_on_exit);
   std::swap(_global_to_local_map, v._global_to_local_map);
 
 #ifdef LIBMESH_HAVE_CXX11_THREAD
   // Only truly atomic for v... but swap() doesn't really need to be thread safe!
   _array_is_present = v._array_is_present.exchange(_array_is_present);
 #else
   std::swap(_array_is_present, v._array_is_present);
 #endif
 
   std::swap(_local_form, v._local_form);
   std::swap(_values, v._values);
 }

◆ type() [1/2]

template<typename T>

ParallelType libMesh::NumericVector< T >::type ( ) const

inherited

Returns: The type (SERIAL, PARALLEL, GHOSTED) of the vector.

Definition at line 154 of file numeric_vector.h.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::DistributedVector< T >::init(), libMesh::EigenSparseVector< T >::init(), libMesh::LaspackVector< T >::init(), and libMesh::EpetraVector< T >::init().

154 { return _type; }

libMesh::NumericVector::_type

ParallelType _type

Type of vector.

Definition: numeric_vector.h:722

◆ type() [2/2]

template<typename T>

ParallelType& libMesh::NumericVector< T >::type ( )

inherited

Returns: The type (SERIAL, PARALLEL, GHOSTED) of the vector.

Definition at line 159 of file numeric_vector.h.

159 { return _type; }

libMesh::NumericVector::_type

ParallelType _type

Type of vector.

Definition: numeric_vector.h:722

◆ vec()

template<typename T>

Vec libMesh::PetscVector< T >::vec ( )

Returns: The raw PETSc Vec pointer.

Note: This is generally not required in user-level code.; Don't do anything crazy like calling LibMeshVecDestroy() on it, or very bad things will likely happen!

Definition at line 325 of file petsc_vector.h.

325 { libmesh_assert (_vec); return _vec; }

libMesh::PetscVector::_vec

Vec _vec

Actual PETSc vector datatype to hold vector entries.

Definition: petsc_vector.h:333

◆ zero()

template<typename T >

void libMesh::PetscVector< T >::zero ( )

overridevirtual

Set all entries to zero.

Equivalent to v = 0, but more obvious and faster.

Implements libMesh::NumericVector< T >.

Definition at line 862 of file petsc_vector.h.

 {
   parallel_object_only();
 
   libmesh_assert(this->closed());
 
   this->_restore_array();
 
   PetscErrorCode ierr=0;
 
   PetscScalar z=0.;
 
   if (this->type() != GHOSTED)
     {
       ierr = VecSet (_vec, z);
       LIBMESH_CHKERR(ierr);
     }
   else
     {
       /* Vectors that include ghost values require a special
          handling.  */
       Vec loc_vec;
       ierr = VecGhostGetLocalForm (_vec,&loc_vec);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecSet (loc_vec, z);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecGhostRestoreLocalForm (_vec,&loc_vec);
       LIBMESH_CHKERR(ierr);
     }
 }

◆ zero_clone()

template<typename T >

std::unique_ptr< NumericVector< T > > libMesh::PetscVector< T >::zero_clone ( ) const

overridevirtual

Returns: A smart pointer to a copy of this vector with the same type, size, and partitioning, but with all zero entries.

Note: This must be overridden in the derived classes.

Implements libMesh::NumericVector< T >.

Definition at line 899 of file petsc_vector.h.

 {
   NumericVector<T> * cloned_vector = new PetscVector<T>(this->comm(), this->type());
   cloned_vector->init(*this);
   return std::unique_ptr<NumericVector<T>>(cloned_vector);
 }

Member Data Documentation

◆ _array_is_present [1/2]

template<typename T>

std::atomic<bool> libMesh::PetscVector< T >::_array_is_present

mutableprivate

If true, the actual PETSc array of the values of the vector is currently accessible.

That means that the members _local_form and _values are valid.

Definition at line 342 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::swap().

◆ _array_is_present [2/2]

template<typename T>

bool libMesh::PetscVector< T >::_array_is_present

mutableprivate

Definition at line 344 of file petsc_vector.h.

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 107 of file parallel_object.h.

Referenced by libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _destroy_vec_on_exit

template<typename T>

bool libMesh::PetscVector< T >::_destroy_vec_on_exit

private

This boolean value should only be set to false for the constructor which takes a PETSc Vec object.

Definition at line 433 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::swap().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

◆ _first

template<typename T>

numeric_index_type libMesh::PetscVector< T >::_first

mutableprivate

First local index.

Only valid when _array_is_present

Definition at line 352 of file petsc_vector.h.

◆ _global_to_local_map

template<typename T>

GlobalToLocalMap libMesh::PetscVector< T >::_global_to_local_map

private

Map that maps global to local ghost cells (will be empty if not in ghost cell mode).

Definition at line 427 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::init(), and libMesh::PetscVector< libMesh::Real >::swap().

◆ _is_closed

template<typename T>

bool libMesh::NumericVector< T >::_is_closed

protectedinherited

Flag which tracks whether the vector's values are consistent on all processors after insertion or addition of values has occurred on some or all processors.

Definition at line 712 of file numeric_vector.h.

Referenced by libMesh::NumericVector< Number >::closed(), and libMesh::EpetraVector< T >::EpetraVector().

◆ _is_initialized

template<typename T>

bool libMesh::NumericVector< T >::_is_initialized

protectedinherited

true once init() has been called.

Definition at line 717 of file numeric_vector.h.

Referenced by libMesh::EpetraVector< T >::EpetraVector(), and libMesh::NumericVector< Number >::initialized().

◆ _last

template<typename T>

numeric_index_type libMesh::PetscVector< T >::_last

mutableprivate

Last local index.

Only valid when _array_is_present

Definition at line 359 of file petsc_vector.h.

◆ _local_form

template<typename T>

Vec libMesh::PetscVector< T >::_local_form

mutableprivate

PETSc vector datatype to hold the local form of a ghosted vector.

The contents of this field are only valid if the vector is ghosted and _array_is_present is true.

Definition at line 371 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::swap().

◆ _local_size

template<typename T>

numeric_index_type libMesh::PetscVector< T >::_local_size

mutableprivate

Size of the local values from _get_array()

Definition at line 364 of file petsc_vector.h.

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic<unsigned int> libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects.

Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _petsc_vector_mutex [1/2]

template<typename T>

std::mutex libMesh::PetscVector< T >::_petsc_vector_mutex

mutableprivate

Mutex for _get_array and _restore_array.

This is part of the object to keep down thread contention when reading frmo multiple PetscVectors simultaneously

Definition at line 399 of file petsc_vector.h.

◆ _petsc_vector_mutex [2/2]

template<typename T>

Threads::spin_mutex libMesh::PetscVector< T >::_petsc_vector_mutex

mutableprivate

Definition at line 401 of file petsc_vector.h.

◆ _read_only_values

template<typename T>

const PetscScalar* libMesh::PetscVector< T >::_read_only_values

mutableprivate

Pointer to the actual PETSc array of the values of the vector.

This pointer is only valid if _array_is_present is true. We're using PETSc's VecGetArrayRead() function, which requires a constant PetscScalar *, but _get_array and _restore_array are const member functions, so _values also needs to be mutable (otherwise it is a "const PetscScalar * const" in that context).

Definition at line 381 of file petsc_vector.h.

◆ _type

template<typename T>

ParallelType libMesh::NumericVector< T >::_type

protectedinherited

Type of vector.

Definition at line 722 of file numeric_vector.h.

Referenced by libMesh::DistributedVector< T >::DistributedVector(), libMesh::EigenSparseVector< T >::EigenSparseVector(), libMesh::EpetraVector< T >::EpetraVector(), libMesh::PetscVector< libMesh::Real >::init(), libMesh::LaspackVector< T >::LaspackVector(), and libMesh::NumericVector< Number >::type().

◆ _values

template<typename T>

PetscScalar* libMesh::PetscVector< T >::_values

mutableprivate

Pointer to the actual PETSc array of the values of the vector.

This pointer is only valid if _array_is_present is true. We're using PETSc's VecGetArrayRead() function, which requires a constant PetscScalar *, but _get_array and _restore_array are const member functions, so _values also needs to be mutable (otherwise it is a "const PetscScalar * const" in that context).

Definition at line 391 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::swap().

◆ _values_manually_retrieved

template<typename T>

bool libMesh::PetscVector< T >::_values_manually_retrieved

mutableprivate

Whether or not the data array has been manually retrieved using get_array() or get_array_read()

Definition at line 439 of file petsc_vector.h.

◆ _values_read_only

template<typename T>

bool libMesh::PetscVector< T >::_values_read_only

mutableprivate

Whether or not the data array is for read only access.

Definition at line 444 of file petsc_vector.h.

◆ _vec

template<typename T>

Vec libMesh::PetscVector< T >::_vec

private

Actual PETSc vector datatype to hold vector entries.

Definition at line 333 of file petsc_vector.h.

Referenced by libMesh::PetscVector< libMesh::Real >::init(), libMesh::PetscVector< libMesh::Real >::swap(), and libMesh::PetscVector< libMesh::Real >::vec().

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

include/numerics/petsc_vector.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename T> class libMesh::PetscVector< T >

Member Typedef Documentation

◆ Counts

◆ GlobalToLocalMap

Constructor & Destructor Documentation

◆ PetscVector() [1/7]

◆ PetscVector() [2/7]

◆ PetscVector() [3/7]

◆ PetscVector() [4/7]

◆ PetscVector() [5/7]

◆ PetscVector() [6/7]

◆ PetscVector() [7/7]

◆ ~PetscVector()

Member Function Documentation

◆ _get_array()

◆ _restore_array()

◆ abs()

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ add_vector() [1/6]

◆ add_vector() [2/6]

◆ add_vector() [3/6]

◆ add_vector() [4/6]

◆ add_vector() [5/6]

◆ add_vector() [6/6]

◆ add_vector_conjugate_transpose()

◆ add_vector_transpose()

◆ build()

◆ clear()

◆ clone()

◆ close()

◆ closed()

◆ comm()

◆ compare()

◆ conjugate()

◆ create_subvector()

◆ disable_print_counter_info()

◆ dot()

◆ el()

◆ enable_print_counter_info()

◆ first_local_index()

◆ get() [1/2]

◆ get() [2/2]

◆ get_array()

◆ get_array_read()

◆ get_info()

◆ global_relative_compare()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ indefinite_dot()

◆ init() [1/4]

◆ init() [2/4]

◆ init() [3/4]

◆ init() [4/4]

◆ initialized()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ l1_norm()

◆ l2_norm()

◆ last_local_index()

◆ linfty_norm()

◆ local_relative_compare()

◆ local_size()

◆ localize() [1/5]

◆ localize() [2/5]

template<typename T>
class libMesh::PetscVector< T >