This class provides a simple parallel, distributed vector datatype which is specific to libmesh. More...

#include <distributed_vector.h>

Inheritance diagram for libMesh::DistributedVector< T >:

Public Member Functions
	DistributedVector (const Parallel::Communicator &comm, const ParallelType=AUTOMATIC)
	Dummy-Constructor. More...

	DistributedVector (const Parallel::Communicator &comm, const numeric_index_type n, const ParallelType ptype=AUTOMATIC)
	Constructor. More...

	DistributedVector (const Parallel::Communicator &comm, const numeric_index_type n, const numeric_index_type n_local, const ParallelType ptype=AUTOMATIC)
	Constructor. More...

	DistributedVector (const Parallel::Communicator &comm, const numeric_index_type N, const numeric_index_type n_local, const std::vector< numeric_index_type > &ghost, const ParallelType ptype=AUTOMATIC)
	Constructor. More...

DistributedVector &	operator= (const DistributedVector &)
	Copy assignment operator. More...

	DistributedVector (DistributedVector &&)=default
	The 5 special functions can be defaulted for this class, as it does not manage any memory itself. More...

	DistributedVector (const DistributedVector &)=default

DistributedVector &	operator= (DistributedVector &&)=default

virtual	~DistributedVector ()=default

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 ptype=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 ptype=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 the 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

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

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 NumericVector< T > &	operator*= (const NumericVector< T > &v) override
	Computes the component-wise multiplication of this vector's entries by another's, \( u_i \leftarrow u_i v_i \, \forall i\). More...

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

virtual void	reciprocal () override
	Computes the component-wise 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 the vector entry specified by `i`. 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 NumericVector< T > &, const SparseMatrix< T > &) override
	Computes \( \vec{u} \leftarrow \vec{u} + A \vec{v} \), i.e. More...

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

virtual void	scale (const T factor) override
	Scale each element of the vector by the given `factor`. 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

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	pointwise_divide (const NumericVector< T > &vec1, const NumericVector< T > &vec2) override
	Computes \( u_i \leftarrow \frac{v_{1,i}}{v_{2,i}} \) (summation not implied) i.e. More...

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

virtual std::size_t	max_allowed_id () const override

virtual bool	initialized () const

ParallelType	type () const

ParallelType &	type ()

void	set_type (ParallelType t)
	Allow the user to change the ParallelType of the NumericVector under some circumstances. More...

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

Real	l2_norm_diff (const NumericVector< T > &other_vec) const

Real	l1_norm_diff (const NumericVector< T > &other_vec) const

virtual T	el (const numeric_index_type i) const

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

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...

virtual void	add_vector (const T *v, const std::vector< numeric_index_type > &dof_indices)
	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...

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...

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...

virtual void	insert (const 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 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...

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

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

virtual void	read_matlab (const std::string &filename)
	Read the contents of the vector from the Matlab-script format used by PETSc. More...

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

virtual std::unique_ptr< NumericVector< T > >	get_subvector (const std::vector< numeric_index_type > &)
	Creates a view into this vector using the indices in `rows`. More...

virtual void	restore_subvector (std::unique_ptr< NumericVector< T >>, const std::vector< numeric_index_type > &)
	Restores a view into this vector using the indices in `rows`. More...

bool	readable () const

bool	compatible (const NumericVector< T > &v) 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, SolverPackage solver_package=libMesh::default_solver_package(), ParallelType parallel_type=AUTOMATIC)
	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_stream=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) noexcept
	Increments the construction counter. More...

void	increment_destructor_count (const std::string &name) noexcept
	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...

std::mutex	_numeric_vector_mutex
	Mutex for performing thread-safe operations. 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 = true
	Flag to control whether reference count information is printed when print_info is called. More...

Private Types
enum	UnclosedState { DO_NOTHING = 0, ADD_VALUES, SET_VALUES, INVALID_UNCLOSEDSTATE }
	Whether we are adding or setting remote values or neither - this determines behavior at the next close();. More...

Private Attributes
std::vector< T >	_values
	Actual vector datatype to hold vector entries. More...

std::vector< std::pair< numeric_index_type, T > >	_remote_values
	Entries to add or set on remote processors during the next close() More...

UnclosedState	_unclosed_state
	The current state of this vector, if it is unclosed. More...

numeric_index_type	_global_size
	The global vector size. More...

numeric_index_type	_local_size
	The local vector size. More...

numeric_index_type	_first_local_index
	The first component stored locally. More...

numeric_index_type	_last_local_index
	The last component (+1) stored locally. More...

Detailed Description

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

This class provides a simple parallel, distributed vector datatype which is specific to libmesh.

Offers some collective communication capabilities.

Note: The class will sill function without MPI, but only on one processor. All overridden virtual functions are documented in numeric_vector.h.

Author: Benjamin S. Kirk

Date: 2003

Definition at line 54 of file distributed_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 119 of file reference_counter.h.

Member Enumeration Documentation

◆ UnclosedState

template<typename T>

enum libMesh::DistributedVector::UnclosedState

private

Whether we are adding or setting remote values or neither - this determines behavior at the next close();.

Enumerator
DO_NOTHING
ADD_VALUES
SET_VALUES
INVALID_UNCLOSEDSTATE

Definition at line 253 of file distributed_vector.h.

                      { DO_NOTHING = 0,
                        ADD_VALUES,
                        SET_VALUES,
                        INVALID_UNCLOSEDSTATE };

Constructor & Destructor Documentation

◆ DistributedVector() [1/6]

template<typename T >

libMesh::DistributedVector< T >::DistributedVector	(	const Parallel::Communicator &	comm,
		const ParallelType	ptype = `AUTOMATIC`
	)

inlineexplicit

Dummy-Constructor.

Dimension=0

Definition at line 289 of file distributed_vector.h.

References libMesh::NumericVector< T >::_type.

                                                                    :
   NumericVector<T>(comm_in, ptype),
   _unclosed_state   (DO_NOTHING),
   _global_size      (0),
   _local_size       (0),
   _first_local_index(0),
   _last_local_index (0)
 {
   this->_type = ptype;
 }

◆ DistributedVector() [2/6]

template<typename T >

libMesh::DistributedVector< T >::DistributedVector	(	const Parallel::Communicator &	comm,
		const numeric_index_type	n,
		const ParallelType	ptype = `AUTOMATIC`
	)

inlineexplicit

Constructor.

Set dimension to n and initialize all elements with zero.

Definition at line 305 of file distributed_vector.h.

References libMesh::DistributedVector< T >::init().

   : NumericVector<T>(comm_in, ptype)
 {
   this->init(n, n, false, ptype);
 }

◆ DistributedVector() [3/6]

template<typename T >

libMesh::DistributedVector< T >::DistributedVector	(	const Parallel::Communicator &	comm,
		const numeric_index_type	n,
		const numeric_index_type	n_local,
		const ParallelType	ptype = `AUTOMATIC`
	)

inline

Constructor.

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

Definition at line 317 of file distributed_vector.h.

References libMesh::DistributedVector< T >::init().

   : NumericVector<T>(comm_in, ptype)
 {
   this->init(n, n_local, false, ptype);
 }

◆ DistributedVector() [4/6]

template<typename T >

libMesh::DistributedVector< T >::DistributedVector	(	const Parallel::Communicator &	comm,
		const numeric_index_type	N,
		const numeric_index_type	n_local,
		const std::vector< numeric_index_type > &	ghost,
		const ParallelType	ptype = `AUTOMATIC`
	)

inline

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 330 of file distributed_vector.h.

References libMesh::DistributedVector< T >::init().

   : NumericVector<T>(comm_in, ptype)
 {
   this->init(n, n_local, ghost, false, ptype);
 }

◆ DistributedVector() [5/6]

template<typename T>

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

default

The 5 special functions can be defaulted for this class, as it does not manage any memory itself.

◆ DistributedVector() [6/6]

template<typename T>

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

default

◆ ~DistributedVector()

template<typename T>

virtual libMesh::DistributedVector< T >::~DistributedVector ( )

virtualdefault

Member Function Documentation

◆ abs()

template<typename T >

void libMesh::DistributedVector< T >::abs ( )

overridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 281 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   for (auto & val : _values)
     val = std::abs(val);
 }

◆ add() [1/4]

template<typename T >

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

inlineoverridevirtual

Adds value to the vector entry specified by i.

Note that library implementations of this method are thread safe, e.g. we will lock _numeric_vector_mutex before writing to the vector

Implements libMesh::NumericVector< T >.

Definition at line 625 of file distributed_vector.h.

References libMesh::initialized(), libMesh::libmesh_assert(), and value.

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
   libmesh_assert_less (i, size());
 
   std::scoped_lock lock(this->_numeric_vector_mutex);
 
   if (i >= first_local_index() && i < last_local_index())
     {
       _values[i - _first_local_index] += value;
     }
   else
     {
       _remote_values.emplace_back(i, value);
       _unclosed_state = ADD_VALUES;
     }
 
   this->_is_closed = false;
 }

◆ add() [2/4]

template<typename T >

void libMesh::DistributedVector< T >::add ( const T s )

overridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 228 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   for (auto & val : _values)
     val += v;
 }

◆ add() [3/4]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 241 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   add (1., v);
 }

◆ add() [4/4]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 253 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_values, libMesh::index_range(), libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   // Make sure the NumericVector passed in is really a DistributedVector
   const DistributedVector<T> * v = cast_ptr<const DistributedVector<T> *>(&v_in);
   libmesh_error_msg_if(!v, "Cannot add different types of NumericVectors.");
 
   for (auto i : index_range(_values))
     _values[i] += a * v->_values[i];
 }

◆ add_vector() [1/6]

template<typename T>

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

inlineoverridevirtual

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 >.

Definition at line 195 of file distributed_vector.h.

197 { libmesh_not_implemented(); }

◆ add_vector() [2/6]

template<typename T>

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

virtualinherited

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. Note that library implementations of this method are thread safe

Reimplemented in libMesh::PetscVector< T >, and libMesh::EpetraVector< T >.

Definition at line 648 of file numeric_vector.C.

Referenced by libMesh::RBConstruction::add_scaled_matrix_and_vector(), assemble(), LinearElasticity::assemble(), assemble_1D(), AssembleOptimization::assemble_A_and_F(), assemble_biharmonic(), assemble_divgrad(), assemble_elasticity(), assemble_ellipticdg(), assemble_func(), assemble_graddiv(), assemble_laplace(), assemble_matrix_and_rhs(), assemble_poisson(), assemble_shell(), assemble_stokes(), assemble_wave(), libMesh::LinearImplicitSystem::assembly(), assembly_with_dg_fem_context(), compute_residual(), periodic_bc_test_poisson(), libMesh::HDGProblem::residual(), LaplaceYoung::residual(), LargeDeformationElasticity::residual(), Biharmonic::JR::residual_and_jacobian(), LinearElasticityWithContact::residual_and_jacobian(), libMesh::NewmarkSystem::update_rhs(), and libMesh::SparseMatrix< ValOut >::vector_mult_add().

 {
   libmesh_assert(v);
 
   for (auto i : index_range(dof_indices))
     this->add (dof_indices[i], v[i]);
 }

◆ 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
	)

inlineinherited

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].

This method is guaranteed to be thread safe as long as library implementations of NumericVector are used

Definition at line 959 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>

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

inherited

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).

This method is guaranteed to be thread-safe as long as library implementations of NumericVector are used

Definition at line 660 of file numeric_vector.C.

 {
   libmesh_assert(v.readable());
 
   const std::size_t n = dof_indices.size();
   libmesh_assert_equal_to(v.size(), n);
   for (numeric_index_type i=0; i != n; i++)
     this->add (dof_indices[i], 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
	)

inlineinherited

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).

This method is guaranteed to be thread safe as long as library implementations of NumericVector are used

Definition at line 971 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.

Definition at line 674 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(v));
 
   a.vector_mult_add(*this,v);
 }

◆ add_vector_transpose()

template<typename T>

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

inlineoverridevirtual

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 >.

Definition at line 199 of file distributed_vector.h.

201 { libmesh_not_implemented(); }

◆ build()

template<typename T >

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

staticinherited

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

Definition at line 61 of file numeric_vector.C.

 {
   // Build the appropriate vector
   switch (solver_package)
     {
 
 #ifdef LIBMESH_HAVE_LASPACK
     case LASPACK_SOLVERS:
       return std::make_unique<LaspackVector<T>>(comm, parallel_type);
 #endif
 
 #ifdef LIBMESH_HAVE_PETSC
     case PETSC_SOLVERS:
       return std::make_unique<PetscVector<T>>(comm, parallel_type);
 #endif
 
 #ifdef LIBMESH_TRILINOS_HAVE_EPETRA
     case TRILINOS_SOLVERS:
       return std::make_unique<EpetraVector<T>>(comm, parallel_type);
 #endif
 
 #ifdef LIBMESH_HAVE_EIGEN
     case EIGEN_SOLVERS:
       return std::make_unique<EigenSparseVector<T>>(comm, parallel_type);
 #endif
 
     default:
       return std::make_unique<DistributedVector<T>>(comm, parallel_type);
     }
 }

◆ clear()

template<typename T >

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

inlineoverridevirtual

Restores the NumericVector<T> to a pristine state.

Reimplemented from libMesh::NumericVector< T >.

Definition at line 466 of file distributed_vector.h.

References libMesh::libMeshPrivateData::_is_initialized.

 {
   _values.clear();
   _remote_values.clear();
 
   _unclosed_state = DO_NOTHING;
 
   _global_size =
     _local_size =
     _first_local_index =
     _last_local_index = 0;
 
   this->_is_closed = this->_is_initialized = false;
 }

◆ clone()

template<typename T >

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

inlineoverridevirtual

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 517 of file distributed_vector.h.

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

◆ close()

template<typename T >

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

inlineoverridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 399 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
 
   parallel_object_only();
 
   bool have_remote_values = !_remote_values.empty();
   this->comm().max(have_remote_values);
 
   if (have_remote_values)
     {
       bool someone_is_setting = (_unclosed_state == SET_VALUES);
       this->comm().max(someone_is_setting);
 
 #ifndef NDEBUG
       // If *I* have remote values, I must know what to do with them.
       if (!_remote_values.empty())
         libmesh_assert(_unclosed_state == SET_VALUES ||
                        _unclosed_state == ADD_VALUES);
 
       // If *anyone* had remote values, we must be doing something,
       // and all ranks must agree on what we're doing.
       bool someone_is_adding = (_unclosed_state == ADD_VALUES);
       this->comm().max(someone_is_adding);
 
       libmesh_assert_not_equal_to(someone_is_setting, someone_is_adding);
 #endif
 
       // We want to traverse in id order later, but we can't compare
       // values with default < in the case where Number==complex.
       std::sort(_remote_values.begin(), _remote_values.end(),
                 [](auto a, auto b)
                 { return a.first < b.first; });
 
       std::vector<numeric_index_type> last_local_indices;
       this->comm().allgather(_last_local_index, last_local_indices);
 
       std::map<processor_id_type, std::vector<std::pair<numeric_index_type,T>>>
         updates_to_send;
 
       processor_id_type p = 0;
       for (auto [i, v] : _remote_values)
         {
           while (i >= last_local_indices[p])
             {
               libmesh_assert_less(p, this->n_processors());
               ++p;
             }
           updates_to_send[p].emplace_back(i, v);
         }
       _remote_values.clear();
 
       auto action_functor =
         [this, someone_is_setting]
         (processor_id_type,
          const std::vector<std::pair<numeric_index_type,T>> & incoming_values)
         {
           for (auto [i, v] : incoming_values)
             {
               libmesh_assert_greater_equal(i, _first_local_index);
               libmesh_assert_less(i, _last_local_index);
               if (someone_is_setting)
                 _values[i-_first_local_index] = v;
               else
                 _values[i-_first_local_index] += v;
             }
         };
 
       Parallel::push_parallel_vector_data
         (this->comm(), updates_to_send, action_functor);
 
       _unclosed_state = DO_NOTHING;
     }
 
   this->_is_closed = true;
 }

◆ closed()

template<typename T>

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

inlinevirtualinherited

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

Definition at line 182 of file numeric_vector.h.

Referenced by libMesh::System::add_vector(), libMesh::PetscVector< libMesh::Number >::localize(), libMesh::DofMap::max_constraint_error(), libMesh::EigenSparseVector< T >::operator=(), libMesh::LaspackVector< T >::operator=(), and libMesh::PetscVector< libMesh::Number >::operator=().

182 { 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:831

◆ comm()

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

inlineinherited

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

Definition at line 97 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

98 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ compare()

template<typename T>

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.

Definition at line 153 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(other_vector));
 
   int first_different_i = std::numeric_limits<int>::max();
   numeric_index_type i = first_local_index();
 
   while (first_different_i==std::numeric_limits<int>::max()
          && i<last_local_index())
   {
     if (std::abs((*this)(i) - other_vector(i)) > threshold)
       first_different_i = i;
     else
       i++;
   }
 
   // Find the correct first differing index in parallel
   this->comm().min(first_different_i);
 
   if (first_different_i == std::numeric_limits<int>::max())
     return -1;
 
   return first_different_i;
 }

◆ compatible()

template<typename T>

bool libMesh::NumericVector< T >::compatible ( const NumericVector< T > & v ) const

inherited

Returns: whether or not this vector and the vector v are able to be read for global operations with one-another

Definition at line 692 of file numeric_vector.C.

 {
   return this->readable() && v.readable() &&
          this->size() == v.size() &&
          this->local_size() == v.local_size() &&
          this->first_local_index() == v.first_local_index() &&
          this->last_local_index() == v.last_local_index();
 }

◆ conjugate()

template<typename T >

void libMesh::DistributedVector< T >::conjugate ( )

overridevirtual

Negates the imaginary component of each entry in the vector.

Implements libMesh::NumericVector< T >.

Definition at line 216 of file distributed_vector.C.

References libMesh::libmesh_conj().

 {
   // Replace values by complex conjugate
   for (auto & val : _values)
     val = libmesh_conj(val);
 }

◆ create_subvector()

template<typename T>

virtual void libMesh::NumericVector< T >::create_subvector	(	NumericVector< T > &	,
		const std::vector< numeric_index_type > &	,
		bool	= `true`
	)		const

inlinevirtualinherited

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. The boolean parameter communicates whether the supplied vector of rows corresponds to all the rows that should be used in the subvector's index set, e.g. whether the rows correspond to the global collective. If the rows supplied are only the local indices, then the boolean parameter should be set to false

Reimplemented in libMesh::PetscVector< T >.

Definition at line 762 of file numeric_vector.h.

Referenced by libMesh::StaticCondensation::forward_elimination().

   {
     libmesh_not_implemented();
   }

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = false;
   return;
 }

◆ dot()

template<typename T >

T libMesh::DistributedVector< 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 >.

Definition at line 295 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_values, libMesh::DistributedVector< T >::first_local_index(), libMesh::index_range(), and libMesh::DistributedVector< T >::last_local_index().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   // Make sure the NumericVector passed in is really a DistributedVector
   const DistributedVector<T> * v = cast_ptr<const DistributedVector<T> *>(&V);
 
   // Make sure that the two vectors are distributed in the same way.
   libmesh_assert_equal_to ( this->first_local_index(), v->first_local_index() );
   libmesh_assert_equal_to ( this->last_local_index(), v->last_local_index()  );
 
   // The result of dotting together the local parts of the vector.
   T local_dot = 0;
 
   for (auto i : index_range(_values))
     local_dot += this->_values[i] * v->_values[i];
 
   // The local dot products are now summed via MPI
   this->comm().sum(local_dot);
 
   return local_dot;
 }

◆ el()

template<typename T>

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

inlinevirtualinherited

Returns: (*this)(i).

Definition at line 375 of file numeric_vector.h.

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

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Definition at line 94 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ first_local_index()

template<typename T >

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

inlineoverridevirtual

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 556 of file distributed_vector.h.

References libMesh::initialized(), and libMesh::libmesh_assert().

Referenced by libMesh::DistributedVector< T >::dot().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   return _first_local_index;
 }

◆ get() [1/2]

template<typename T>

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

inlinevirtualinherited

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 in libMesh::PetscVector< T >.

Definition at line 930 of file numeric_vector.h.

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::EquationSystems::build_parallel_solution_vector(), compute_residual(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::HDGProblem::jacobian(), libMesh::FEMContext::pre_fe_reinit(), libMesh::System::project_vector(), libMesh::System::request_vector(), libMesh::HDGProblem::residual(), libMesh::System::restrict_vectors(), libMesh::StaticCondensation::set_local_vectors(), libMesh::System::solve_for_unconstrained_dofs(), and libMesh::System::vector_name().

 {
   const std::size_t num = index.size();
   for (std::size_t i=0; i<num; i++)
     {
       values[i] = (*this)(index[i]);
     }
 }

◆ get() [2/2]

template<typename T>

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

inlineinherited

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 944 of file numeric_vector.h.

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

◆ get_info()

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

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

Referenced by libMesh::ReferenceCounter::print_info().

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
   std::ostringstream oss;
 
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
 
   for (const auto & [name, cd] : _counts)
     oss << "| " << name << " reference count information:\n"
         << "|  Creations:    " << cd.first    << '\n'
         << "|  Destructions: " << cd.second << '\n';
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_subvector()

template<typename T>

virtual std::unique_ptr<NumericVector<T> > libMesh::NumericVector< T >::get_subvector ( const std::vector< numeric_index_type > & )

inlinevirtualinherited

Creates a view into 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 in libMesh::PetscVector< T >, and libMesh::PetscVector< libMesh::Number >.

Definition at line 776 of file numeric_vector.h.

Referenced by libMesh::StaticCondensation::apply(), libMesh::CondensedEigenSystem::copy_sub_to_super(), and libMesh::CondensedEigenSystem::copy_super_to_sub().

   {
     libmesh_not_implemented();
   }

◆ global_relative_compare()

template<typename T>

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.

Definition at line 211 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(other_vector));
 
   int first_different_i = std::numeric_limits<int>::max();
   numeric_index_type i = first_local_index();
 
   const Real my_norm = this->linfty_norm();
   const Real other_norm = other_vector.linfty_norm();
   const Real abs_threshold = std::max(my_norm, other_norm) * threshold;
 
   do
     {
       if (std::abs((*this)(i) - other_vector(i) ) > abs_threshold)
         first_different_i = i;
       else
         i++;
     }
   while (first_different_i==std::numeric_limits<int>::max()
          && i<last_local_index());
 
   // Find the correct first differing index in parallel
   this->comm().min(first_different_i);
 
   if (first_different_i == std::numeric_limits<int>::max())
     return -1;
 
   return first_different_i;
 }

◆ increment_constructor_count()

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

inlineprotectednoexceptinherited

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.first++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_constructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ increment_destructor_count()

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

inlineprotectednoexceptinherited

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

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

 {
   libmesh_try
   {
     Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
     std::pair<unsigned int, unsigned int> & p = _counts[name];
     p.second++;
   }
   libmesh_catch (...)
   {
     auto stream = libMesh::err.get();
     stream->exceptions(stream->goodbit); // stream must not throw
     libMesh::err << "Encountered unrecoverable error while calling "
                  << "ReferenceCounter::increment_destructor_count() "
                  << "for a(n) " << name << " object." << std::endl;
     std::terminate();
   }
 }

◆ init() [1/4]

template<typename T >

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

inlineoverridevirtual

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 344 of file distributed_vector.h.

References libMesh::libMeshPrivateData::_is_initialized, libMesh::AUTOMATIC, libMesh::GHOSTED, libMesh::initialized(), libMesh::libmesh_assert(), libMesh::make_range(), libMesh::PARALLEL, libMesh::SERIAL, and libMesh::zero.

Referenced by libMesh::DistributedVector< T >::DistributedVector(), and libMesh::DistributedVector< T >::localize().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert_less_equal (n_local, n);
 
   if (ptype == AUTOMATIC)
     {
       if (n == n_local)
         this->_type = SERIAL;
       else
         this->_type = PARALLEL;
     }
   else if (ptype == GHOSTED &&
            n == n_local) // We can support GHOSTED with no ghosts...
     this->_type = SERIAL;
   else
     this->_type = ptype;
 
   libmesh_assert ((this->_type==SERIAL && n==n_local) ||
                   this->_type==PARALLEL);
 
   // Clear the data structures if already initialized
   if (this->initialized())
     this->clear();
 
   // Initialize data structures
   _unclosed_state = DO_NOTHING;
   _values.resize(n_local);
   _remote_values.clear();
   _local_size  = n_local;
   _global_size = n;
 
   _first_local_index = 0;
 
 #ifdef LIBMESH_HAVE_MPI
 
   std::vector<numeric_index_type> local_sizes (this->n_processors(), 0);
 
   local_sizes[this->processor_id()] = n_local;
 
   this->comm().sum(local_sizes);
 
   // _first_local_index is the sum of _local_size
   // for all processor ids less than ours
   for (auto p : make_range(this->processor_id()))
     _first_local_index += local_sizes[p];
 
 
 #  ifdef DEBUG
   // Make sure all the local sizes sum up to the global
   // size, otherwise there is big trouble!
   numeric_index_type dbg_sum=0;
 
   for (auto p : make_range(this->n_processors()))
     dbg_sum += local_sizes[p];
 
   libmesh_assert_equal_to (dbg_sum, n);
 
 #  endif
 
 #else
 
   // No other options without MPI!
   libmesh_error_msg_if(n != n_local, "ERROR:  MPI is required for n != n_local!");
 
 #endif
 
   _last_local_index = _first_local_index + n_local;
 
   // Set the initialized flag
   this->_is_initialized = true;
   this->_is_closed = true;
 
   // Zero the components unless directed otherwise
   if (!fast)
     this->zero();
 }

◆ init() [2/4]

template<typename T >

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

inlineoverridevirtual

Call init() with n_local = N.

Implements libMesh::NumericVector< T >.

Definition at line 455 of file distributed_vector.h.

References libMesh::TriangleWrapper::init().

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

◆ init() [3/4]

template<typename T >

void libMesh::DistributedVector< 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`
	)

inlineoverridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 430 of file distributed_vector.h.

References libMesh::TriangleWrapper::init().

 {
   // TODO: we shouldn't ignore the ghost sparsity pattern
   this->init(n, n_local, fast, ptype);
 }

◆ init() [4/4]

template<class T >

void libMesh::DistributedVector< 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 445 of file distributed_vector.h.

References libMesh::TriangleWrapper::init(), libMesh::NumericVector< T >::local_size(), libMesh::NumericVector< T >::size(), and libMesh::NumericVector< T >::type().

 {
   this->init(other.size(),other.local_size(),fast,other.type());
 }

◆ initialized()

template<typename T>

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

inlinevirtualinherited

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

Definition at line 149 of file numeric_vector.h.

Referenced by libMesh::System::add_vector(), libMesh::ImplicitSystem::assemble(), libMesh::PetscVector< libMesh::Number >::create_subvector(), and libMesh::PetscVector< libMesh::Number >::init().

149 { return _is_initialized; }

libMesh::NumericVector::_is_initialized

bool _is_initialized

true once init() has been called.

Definition: numeric_vector.h:836

◆ insert() [1/5]

template<typename T>

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

virtualinherited

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

Note that library implementations of this method are thread safe

Reimplemented in libMesh::PetscVector< T >, and libMesh::EpetraVector< T >.

Definition at line 128 of file numeric_vector.C.

Referenced by libMesh::StaticCondensation::backwards_substitution(), and Biharmonic::JR::bounds().

 {
   libmesh_assert (v);
 
   for (auto i : index_range(dof_indices))
     this->set (dof_indices[i], v[i]);
 }

◆ insert() [2/5]

template<typename T>

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

inlineinherited

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

This method is guaranteed to be thread-safe as long as library implementations of NumericVector are used

Definition at line 983 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>

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

inherited

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

This method is guaranteed to be thread-safe as long as library implementations of NumericVector are used

Definition at line 140 of file numeric_vector.C.

 {
   libmesh_assert_equal_to (V.size(), dof_indices.size());
   libmesh_assert (V.readable());
 
   for (auto i : index_range(dof_indices))
     this->set (dof_indices[i], V(i));
 }

◆ insert() [4/5]

template<typename T>

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

inlineinherited

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

This method is guaranteed to be thread-safe as long as library implementations of NumericVector are used

Definition at line 995 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
	)

inlineinherited

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

This method is guaranteed to be thread-safe as long as library implementations of NumericVector are used

Definition at line 1007 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 >

Real libMesh::DistributedVector< 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 >.

Definition at line 70 of file distributed_vector.C.

References libMesh::initialized(), libMesh::libmesh_assert(), and libMesh::Real.

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   Real local_l1 = 0.;
 
   for (auto & val : _values)
     local_l1 += std::abs(val);
 
   this->comm().sum(local_l1);
 
   return local_l1;
 }

◆ l1_norm_diff()

template<class T>

Real libMesh::NumericVector< T >::l1_norm_diff ( const NumericVector< T > & other_vec ) const

inherited

Returns: The \( \ell_1 \)-norm of \( \vec{u} - \vec{v} \), where \( \vec{u} \) is this.

Definition at line 632 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(v));
 
   Real norm = 0;
   for (const auto i : make_range(this->first_local_index(), this->last_local_index()))
     norm += libMesh::l1_norm_diff((*this)(i), v(i));
 
   this->comm().sum(norm);
 
   return norm;
 }

◆ l2_norm()

template<typename T >

Real libMesh::DistributedVector< 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 >.

Definition at line 92 of file distributed_vector.C.

References libMesh::initialized(), libMesh::libmesh_assert(), libMesh::TensorTools::norm_sq(), and libMesh::Real.

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   Real local_l2 = 0.;
 
   for (auto & val : _values)
     local_l2 += TensorTools::norm_sq(val);
 
   this->comm().sum(local_l2);
 
   return std::sqrt(local_l2);
 }

◆ l2_norm_diff()

template<class T>

Real libMesh::NumericVector< T >::l2_norm_diff ( const NumericVector< T > & other_vec ) const

inherited

Returns: The \( \ell_2 \)-norm of \( \vec{u} - \vec{v} \), where \( \vec{u} \) is this.

Definition at line 616 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(v));
 
   Real norm = 0;
   for (const auto i : make_range(this->first_local_index(), this->last_local_index()))
     norm += TensorTools::norm_sq((*this)(i) - v(i));
 
   this->comm().sum(norm);
 
   return std::sqrt(norm);
 }

◆ last_local_index()

template<typename T >

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

inlineoverridevirtual

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 569 of file distributed_vector.h.

References libMesh::initialized(), and libMesh::libmesh_assert().

Referenced by libMesh::DistributedVector< T >::dot().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   return _last_local_index;
 }

◆ linfty_norm()

template<typename T >

Real libMesh::DistributedVector< 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 >.

Definition at line 114 of file distributed_vector.C.

References libMesh::initialized(), libMesh::libmesh_assert(), and libMesh::Real.

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   Real local_linfty = 0.;
 
   for (auto & val : _values)
     local_linfty  = std::max(local_linfty,
                              static_cast<Real>(std::abs(val))
                              ); // Note we static_cast so that both
                                 // types are the same, as required
                                 // by std::max
 
   this->comm().max(local_linfty);
 
   return local_linfty;
 }

◆ local_relative_compare()

template<typename T>

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.

Definition at line 181 of file numeric_vector.C.

 {
   libmesh_assert(this->compatible(other_vector));
 
   int first_different_i = std::numeric_limits<int>::max();
   numeric_index_type i = first_local_index();
 
   do
     {
       if (std::abs((*this)(i) - other_vector(i)) > threshold *
           std::max(std::abs((*this)(i)), std::abs(other_vector(i))))
         first_different_i = i;
       else
         i++;
     }
   while (first_different_i==std::numeric_limits<int>::max()
          && i<last_local_index());
 
   // Find the correct first differing index in parallel
   this->comm().min(first_different_i);
 
   if (first_different_i == std::numeric_limits<int>::max())
     return -1;
 
   return first_different_i;
 }

◆ local_size()

template<typename T >

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

inlineoverridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 543 of file distributed_vector.h.

References libMesh::initialized(), and libMesh::libmesh_assert().

Referenced by libMesh::DistributedVector< T >::operator=().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   return _local_size;
 }

◆ localize() [1/5]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 652 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

Referenced by libMesh::DistributedVector< T >::localize().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   v_local = this->_values;
 
   this->comm().allgather (v_local);
 
 #ifndef LIBMESH_HAVE_MPI
   libmesh_assert_equal_to (local_size(), size());
 #endif
 }

◆ localize() [2/5]

template<typename T >

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

overridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 479 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_first_local_index, libMesh::DistributedVector< T >::_global_size, libMesh::NumericVector< T >::_is_closed, libMesh::NumericVector< T >::_is_initialized, libMesh::DistributedVector< T >::_last_local_index, libMesh::DistributedVector< T >::_local_size, libMesh::DistributedVector< T >::_values, libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   DistributedVector<T> * v_local = cast_ptr<DistributedVector<T> *>(&v_local_in);
 
   v_local->_first_local_index = 0;
 
   v_local->_global_size =
     v_local->_local_size =
     v_local->_last_local_index = size();
 
   v_local->_is_initialized =
     v_local->_is_closed = true;
 
   // Call localize on the vector's values.  This will help
   // prevent code duplication
   localize (v_local->_values);
 
 #ifndef LIBMESH_HAVE_MPI
 
   libmesh_assert_equal_to (local_size(), size());
 
 #endif
 }

◆ localize() [3/5]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 511 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   // TODO: We don't yet support the send list; this is inefficient:
   localize (v_local_in);
 }

◆ localize() [4/5]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 525 of file distributed_vector.C.

References distance(), libMesh::index_range(), and libMesh::libmesh_assert().

 {
   // Resize v_local so there is enough room to hold all the local values.
   v_local.resize(indices.size());
 
   // We need to know who has the values we want, so get everyone's _local_size
   std::vector<numeric_index_type> local_sizes;
   this->comm().allgather (_local_size, local_sizes);
 
   // Make a vector of partial sums of local sizes
   std::vector<numeric_index_type> local_size_sums(this->n_processors());
   local_size_sums[0] = local_sizes[0];
   for (auto i : IntRange<numeric_index_type>(1, local_sizes.size()))
     local_size_sums[i] = local_size_sums[i-1] + local_sizes[i];
 
   // We now fill in 'requested_ids' based on the indices.  Also keep
   // track of the local index (in the indices vector) for each of
   // these, since we need that when unpacking.
   std::map<processor_id_type, std::vector<numeric_index_type>>
     requested_ids, local_requested_ids;
 
   // We'll use this typedef a couple of times below.
   typedef typename std::vector<numeric_index_type>::iterator iter_t;
 
   // For each index in indices, determine which processor it is on.
   // This is an O(N*log(p)) algorithm that uses std::upper_bound().
   // Note: upper_bound() returns an iterator to the first entry which is
   // greater than the given value.
   for (auto i : index_range(indices))
     {
       iter_t ub = std::upper_bound(local_size_sums.begin(),
                                    local_size_sums.end(),
                                    indices[i]);
 
       processor_id_type on_proc = cast_int<processor_id_type>
         (std::distance(local_size_sums.begin(), ub));
 
       requested_ids[on_proc].push_back(indices[i]);
       local_requested_ids[on_proc].push_back(i);
     }
 
   auto gather_functor =
     [this]
     (processor_id_type, const std::vector<dof_id_type> & ids,
      std::vector<T> & values)
     {
       // The first send/receive we did was for indices, the second one will be
       // for corresponding floating point values, so create storage for that now...
       const std::size_t ids_size = ids.size();
       values.resize(ids_size);
 
       for (std::size_t i=0; i != ids_size; i++)
         {
           // The index of the requested value
           const numeric_index_type requested_index = ids[i];
 
           // Transform into local numbering, and get requested value.
           values[i] = _values[requested_index - _first_local_index];
         }
     };
 
   auto action_functor =
     [& v_local, & local_requested_ids]
     (processor_id_type pid,
      const std::vector<dof_id_type> &,
      const std::vector<T> & values)
     {
       // Now write the received values to the appropriate place(s) in v_local
       for (auto i : index_range(values))
         {
           libmesh_assert(local_requested_ids.count(pid));
           libmesh_assert_less(i, local_requested_ids[pid].size());
 
           // Get the index in v_local where this value needs to be inserted.
           const numeric_index_type local_requested_index =
             local_requested_ids[pid][i];
 
           // Actually set the value in v_local
           v_local[local_requested_index] = values[i];
         }
     };
 
   const T * ex = nullptr;
   Parallel::pull_parallel_vector_data
     (this->comm(), requested_ids, gather_functor, action_functor, ex);
 }

◆ localize() [5/5]

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 616 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_values, libMesh::DistributedVector< T >::init(), libMesh::DistributedVector< T >::localize(), and libMesh::PARALLEL.

 {
   // Only good for serial vectors
   libmesh_assert_equal_to (this->size(), this->local_size());
   libmesh_assert_greater (last_local_idx, first_local_idx);
   libmesh_assert_less_equal (send_list.size(), this->size());
   libmesh_assert_less (last_local_idx, this->size());
 
   const numeric_index_type my_size       = this->size();
   const numeric_index_type my_local_size = (last_local_idx - first_local_idx + 1);
 
   // Don't bother for serial cases
   if ((first_local_idx == 0) &&
       (my_local_size == my_size))
     return;
 
 
   // Build a parallel vector, initialize it with the local
   // parts of (*this)
   DistributedVector<T> parallel_vec(this->comm());
 
   parallel_vec.init (my_size, my_local_size, true, PARALLEL);
 
   // Copy part of *this into the parallel_vec
   for (numeric_index_type i=first_local_idx; i<=last_local_idx; i++)
     parallel_vec._values[i-first_local_idx] = _values[i];
 
   // localize like normal
   parallel_vec.localize (*this, send_list);
 }

◆ localize_to_one()

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 673 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   v_local = this->_values;
 
   this->comm().gather (pid, v_local);
 
 #ifndef LIBMESH_HAVE_MPI
   libmesh_assert_equal_to (local_size(), size());
 #endif
 }

◆ max()

template<typename T >

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

inlineoverridevirtual

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 674 of file distributed_vector.h.

References libMesh::closed(), libMesh::initialized(), libMesh::libmesh_assert(), libMesh::libmesh_real(), and libMesh::Real.

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert (this->closed());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   Real local_max = -std::numeric_limits<Real>::max();
   for (auto v : _values)
     local_max = std::max(libmesh_real(v), local_max);
 
   this->comm().max(local_max);
 
   return local_max;
 }

◆ max_allowed_id()

template<typename T >

std::size_t libMesh::DistributedVector< T >::max_allowed_id ( ) const

inlineoverridevirtual

Returns: the max number of entries (across all procs) that the NumericVector can have.

Although we define numeric_index_type, and it is typically required that the NumericVector's underlying implementation's indices have size equal to sizeof(numeric_index_type), these two types can still have different signedness, which affects the maximum number of values which can be stored in the NumericVector.

Implements libMesh::NumericVector< T >.

Definition at line 716 of file distributed_vector.h.

 {
   // Uses a std:vector<T>, so our indexing matches that
   return std::numeric_limits<typename std::vector<T>::size_type>::max();
 }

◆ min()

template<typename T >

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

inlineoverridevirtual

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 651 of file distributed_vector.h.

References libMesh::closed(), libMesh::initialized(), libMesh::libmesh_assert(), libMesh::libmesh_real(), and libMesh::Real.

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert (this->closed());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   Real local_min = std::numeric_limits<Real>::max();
   for (auto v : _values)
     local_min = std::min(libmesh_real(v), local_min);
 
   this->comm().min(local_min);
 
   return local_min;
 }

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 85 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

86 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

The number of objects.

Definition: reference_counter.h:132

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 103 of file parallel_object.h.

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

   {
     processor_id_type returnval =
       cast_int<processor_id_type>(_communicator.size());
     libmesh_assert(returnval); // We never have an empty comm
     return returnval;
   }

◆ operator()()

template<typename T >

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

inlineoverridevirtual

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

Implements libMesh::NumericVector< T >.

Definition at line 582 of file distributed_vector.h.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
   libmesh_assert ( ((i >= first_local_index()) &&
                     (i <  last_local_index())) );
 
   return _values[i - _first_local_index];
 }

◆ operator*=() [1/2]

template<typename T >

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

overridevirtual

Computes the component-wise multiplication of this vector's entries by another's, \( u_i \leftarrow u_i v_i \, \forall i\).

Returns: A reference to *this.

Implements libMesh::NumericVector< T >.

Definition at line 170 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_values, libMesh::index_range(), and libMesh::NumericVector< T >::size().

 {
   libmesh_assert_equal_to(size(), v.size());
 
   const DistributedVector<T> & v_vec = cast_ref<const DistributedVector<T> &>(v);
 
   for (auto i : index_range(_values))
     _values[i] *= v_vec._values[i];
 
   return *this;
 }

◆ operator*=() [2/2]

template<typename T>

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

inlineinherited

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

Equivalent to u.scale(a)

Returns: A reference to *this.

Definition at line 420 of file numeric_vector.h.

420 { 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 >

NumericVector< T > & libMesh::DistributedVector< 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 >.

Definition at line 140 of file distributed_vector.C.

References libMesh::closed(), libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->closed());
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   add(1., v);
 
   return *this;
 }

◆ operator-=()

template<typename T >

NumericVector< T > & libMesh::DistributedVector< 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 >.

Definition at line 155 of file distributed_vector.C.

References libMesh::closed(), libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->closed());
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   add(-1., v);
 
   return *this;
 }

◆ operator/=() [1/2]

template<typename T >

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

overridevirtual

Computes the component-wise 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 >.

Definition at line 185 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_values, libMesh::index_range(), and libMesh::NumericVector< T >::size().

 {
   libmesh_assert_equal_to(size(), v.size());
 
   const DistributedVector<T> & v_vec = cast_ref<const DistributedVector<T> &>(v);
 
   for (auto i : index_range(_values))
     _values[i] /= v_vec._values[i];
 
   return *this;
 }

◆ operator/=() [2/2]

template<typename T>

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

inlineinherited

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 438 of file numeric_vector.h.

438 { 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 >

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

Copy assignment operator.

We cannot default this (although it essentially implements the default behavior) because the compiler-generated default attempts to automatically call the base class (NumericVector) copy assignment operator, which we have chosen to make pure virtual for other design reasons.

Definition at line 353 of file distributed_vector.C.

References libMesh::DistributedVector< T >::_first_local_index, libMesh::DistributedVector< T >::_global_size, libMesh::NumericVector< T >::_is_closed, libMesh::libMeshPrivateData::_is_initialized, libMesh::NumericVector< T >::_is_initialized, libMesh::DistributedVector< T >::_last_local_index, libMesh::DistributedVector< T >::_local_size, libMesh::DistributedVector< T >::_values, and libMesh::DistributedVector< T >::local_size().

 {
   this->_is_initialized    = v._is_initialized;
   this->_is_closed         = v._is_closed;
 
   _global_size       = v._global_size;
   _local_size        = v._local_size;
   _first_local_index = v._first_local_index;
   _last_local_index  = v._last_local_index;
 
   if (v.local_size() == this->local_size())
     _values = v._values;
 
   else
     libmesh_error_msg("v.local_size() = " << v.local_size() << " must be equal to this->local_size() = " << this->local_size());
 
   return *this;
 }

◆ operator=() [2/5]

template<typename T>

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

default

◆ operator=() [3/5]

template<typename T >

NumericVector< T > & libMesh::DistributedVector< 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 >.

Definition at line 323 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   for (auto & val : _values)
     val = s;
 
   return *this;
 }

◆ operator=() [4/5]

template<typename T >

NumericVector< T > & libMesh::DistributedVector< 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 >.

Definition at line 339 of file distributed_vector.C.

 {
   // Make sure the NumericVector passed in is really a DistributedVector
   const DistributedVector<T> * v = cast_ptr<const DistributedVector<T> *>(&v_in);
 
   *this = *v;
 
   return *this;
 }

◆ operator=() [5/5]

template<typename T >

NumericVector< T > & libMesh::DistributedVector< 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 >.

Definition at line 376 of file distributed_vector.C.

References libMesh::index_range(), libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   if (v.size() == local_size())
     _values = v;
 
   else if (v.size() == size())
     for (auto i : index_range(*this))
       _values[i-first_local_index()] = v[i];
 
   else
     libmesh_error_msg("Incompatible sizes in DistributedVector::operator=");
 
   return *this;
 }

◆ pointwise_divide()

template<typename T >

void libMesh::DistributedVector< T >::pointwise_divide	(	const NumericVector< T > &	vec1,
		const NumericVector< T > &	vec2
	)

overridevirtual

Computes \( u_i \leftarrow \frac{v_{1,i}}{v_{2,i}} \) (summation not implied) i.e.

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

Implements libMesh::NumericVector< T >.

Definition at line 704 of file distributed_vector.C.

 {
   libmesh_not_implemented();
 }

◆ pointwise_mult()

template<typename T >

void libMesh::DistributedVector< 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 >.

Definition at line 695 of file distributed_vector.C.

 {
   libmesh_not_implemented();
 }

◆ print() [1/2]

template<typename T >

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

inlinevirtualinherited

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

Definition at line 1040 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 (auto i : index_range(*this))
     os << i << "\t" << (*this)(i) << std::endl;
 }

◆ print() [2/2]

template<>

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

inlineinherited

Definition at line 1022 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 (auto i : index_range(*this))
     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

inlinevirtualinherited

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

Definition at line 1077 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 (auto i : make_range(v.size()))
     os << i << "\t" << v[i] << std::endl;
 }

◆ print_global() [2/2]

template<>

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

inlineinherited

Definition at line 1055 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 (auto i : make_range(v.size()))
     os << i << "\t"
        << v[i].real() << "\t\t"
        << v[i].imag() << std::endl;
 }

◆ print_info()

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

staticinherited

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

Definition at line 81 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

 {
   if (_enable_print_counter)
     out_stream << ReferenceCounter::get_info();
 }

◆ print_matlab()

template<typename T >

void libMesh::NumericVector< T >::print_matlab ( const std::string & filename = "" ) const

virtualinherited

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 in libMesh::PetscVector< T >, and libMesh::PetscVector< libMesh::Number >.

Definition at line 245 of file numeric_vector.C.

Referenced by libMesh::RBConstruction::enrich_basis_from_rhs_terms().

 {
   parallel_object_only();
 
   libmesh_assert (this->initialized());
 
   const numeric_index_type first_dof = this->first_local_index(),
                            end_dof   = this->last_local_index();
 
   // We'll print the vector from processor 0 to make sure
   // it's serialized properly
   if (this->processor_id() == 0)
     {
       std::unique_ptr<std::ofstream> file;
 
       if (filename != "")
         file = std::make_unique<std::ofstream>(filename.c_str());
 
       std::ostream & os = (filename == "") ? libMesh::out : *file;
 
       // Print a header similar to PETSC_VIEWER_ASCII_MATLAB
       os << "%Vec Object: () " << this->n_processors() << " MPI processes\n"
          << "%  type: " << (this->n_processors() > 1 ? "mpi" : "seq") << "\n"
          << "Vec = [\n";
 
       for (numeric_index_type i : make_range(end_dof))
         os << (*this)(i) << '\n';
 
       std::vector<T> cbuf;
       for (auto p : IntRange<processor_id_type>(1, this->n_processors()))
         {
           this->comm().receive(p, cbuf);
 
           for (auto c : cbuf)
             os << c << '\n';
         }
 
       os << "];\n" << std::endl;
     }
   else
     {
       std::vector<T> cbuf(end_dof - first_dof);
 
       for (numeric_index_type i : make_range(end_dof - first_dof))
         cbuf[i] = (*this)(first_dof+i);
       this->comm().send(0,cbuf);
     }
 }

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 114 of file parallel_object.h.

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

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

TIMPI::Communicator::rank

processor_id_type rank() const

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:120

◆ read_matlab()

template<typename T >

void libMesh::NumericVector< T >::read_matlab ( const std::string & filename )

virtualinherited

Read the contents of the vector from the Matlab-script format used by PETSc.

If the size of the matrix in filename appears consistent with the existing partitioning of this then the existing parallel decomposition will be retained. If not, then this will be initialized with the size from the file, linearly partitioned onto the number of processors available.

Definition at line 297 of file numeric_vector.C.

 {
   LOG_SCOPE("read_matlab()", "NumericVector");
 
 #ifndef LIBMESH_HAVE_CXX11_REGEX
   libmesh_not_implemented();  // What is your compiler?!?  Email us!
   libmesh_ignore(filename);
 #else
   parallel_object_only();
 
   const bool gzipped_file = (filename.rfind(".gz") == filename.size() - 3);
 
   // If we don't already have this size, we'll need to reinit, and
   // determine which entries each processor is in charge of.
   std::vector<numeric_index_type> first_entries, end_entries;
 
   numeric_index_type first_entry = 0,
                      end_entry = 0,
                      n = 0;
 
   // We'll use an istream here; it might be an ifstream if we're
   // opening a raw ASCII file or a gzstream if we're opening a
   // compressed one.
   std::unique_ptr<std::istream> file;
 
   // First read through the file, saving size and entry data
   std::vector<T> entries;
 
   {
   // We'll read the vector on processor 0 rather than try to juggle
   // parallel I/O.
   if (this->processor_id() == 0)
     {
       // We'll be using regular expressions to make ourselves slightly
       // more robust to formatting.
       const std::regex start_regex // assignment like "Vec_0x84000002_1 = ["
         ("\\s*\\w+\\s*=\\s*\\[");
       const std::regex end_regex // end of assignment
         ("^[^%]*\\]");
 
       if (gzipped_file)
         {
 #ifdef LIBMESH_HAVE_GZSTREAM
           auto inf = std::make_unique<igzstream>();
           libmesh_assert(inf);
           inf->open(filename.c_str(), std::ios::in);
           file = std::move(inf);
 #else
           libmesh_error_msg("ERROR: need gzstream to handle .gz files!!!");
 #endif
         }
       else
         {
           auto inf = std::make_unique<std::ifstream>();
           libmesh_assert(inf);
 
           std::string new_name = Utility::unzip_file(filename);
 
           inf->open(new_name.c_str(), std::ios::in);
           file = std::move(inf);
         }
 
       const std::string whitespace = " \t";
 
       bool have_started = false;
       bool have_ended = false;
 
       for (std::string line; std::getline(*file, line);)
         {
           std::smatch sm;
 
           // First, try to match an entry.  This is the most common
           // case so we won't rely on slow std::regex for it.
           // stringstream is at least an improvement over that.
           std::istringstream l(line);
           T value;
           l >> value;
 
           if (!l.fail())
             {
               libmesh_error_msg_if
                 (!have_started, "Confused by premature entries in vector file " << filename);
 
               entries.push_back(value);
               ++n;
             }
 
           else if (std::regex_search(line, start_regex))
             have_started = true;
 
           else if (std::regex_search(line, end_regex))
             {
               have_ended = true;
               break;
             }
         }
 
       libmesh_error_msg_if
         (!have_started, "Confused by missing assignment-beginning in vector file " << filename);
 
       libmesh_error_msg_if
         (!have_ended, "Confused by missing assignment-ending in vector file " << filename);
     }
 
   this->comm().broadcast(n);
 
   if (this->initialized() &&
       n == this->size())
     {
       first_entry = this->first_local_index(),
       end_entry = this->last_local_index();
     }
   else
     {
       // Determine which rows/columns each processor will be in charge of
       first_entry =     this->processor_id() * n / this->n_processors(),
       end_entry   = (this->processor_id()+1) * n / this->n_processors();
     }
 
   this->comm().gather(0, first_entry, first_entries);
   this->comm().gather(0, end_entry, end_entries);
 
   } // Done reading entry data and broadcasting vector size
 
   // If we're not already initialized compatibly with the file then
   // we'll initialize here
   bool need_init = !this->initialized() ||
                    (this->size() != n) ||
                    (this->local_size() != end_entry - first_entry);
 
   this->comm().max(need_init);
 
   if (need_init)
     this->init(n, end_entry - first_entry);
 
   // Set the vector values last.  The iota call here is inefficient
   // but it's probably better than calling a single virtual function
   // per index.
   if (this->processor_id() == 0)
     for (auto p : make_range(this->n_processors()))
       {
         const numeric_index_type first_entry_p = first_entries[p];
         const numeric_index_type n_local = end_entries[p] - first_entry_p;
         std::vector<numeric_index_type> indices(n_local);
         std::iota(indices.begin(), indices.end(), first_entry_p);
         this->insert(entries.data() + first_entries[p],
                      indices);
       }
 
   this->close();
 #endif
 }

◆ readable()

template<typename T >

bool libMesh::NumericVector< T >::readable ( ) const

inherited

Returns: whether or not this vector is able to be read for global operations

Definition at line 685 of file numeric_vector.C.

Referenced by libMesh::NumericVector< Number >::add_vector(), libMesh::NumericVector< Number >::compatible(), and libMesh::NumericVector< Number >::insert().

 {
   return this->initialized() && this->closed();
 }

◆ reciprocal()

template<typename T >

void libMesh::DistributedVector< T >::reciprocal ( )

overridevirtual

Computes the component-wise reciprocal, \( u_i \leftarrow \frac{1}{u_i} \, \forall i\).

Implements libMesh::NumericVector< T >.

Definition at line 201 of file distributed_vector.C.

 {
   for (auto & val : _values)
     {
       // Don't divide by zero
       libmesh_assert_not_equal_to (val, T(0));
 
       val = 1. / val;
     }
 }

◆ restore_subvector()

template<typename T>

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

inlinevirtualinherited

Restores a view into this vector using the indices in rows.

This is currently only implemented for PetscVectors.

Reimplemented in libMesh::PetscVector< T >.

Definition at line 786 of file numeric_vector.h.

Referenced by libMesh::StaticCondensation::apply(), libMesh::CondensedEigenSystem::copy_sub_to_super(), and libMesh::CondensedEigenSystem::copy_super_to_sub().

   {
     libmesh_not_implemented();
   }

◆ scale()

template<typename T >

void libMesh::DistributedVector< T >::scale ( const T factor )

overridevirtual

Scale each element of the vector by the given factor.

Implements libMesh::NumericVector< T >.

Definition at line 270 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   for (auto & val : _values)
     val *= factor;
 }

◆ set()

template<typename T >

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

inlineoverridevirtual

Sets v(i) = value.

Note that library implementations of this method are thread safe, e.g. we will lock _numeric_vector_mutex before writing to the vector

Implements libMesh::NumericVector< T >.

Definition at line 597 of file distributed_vector.h.

References libMesh::initialized(), libMesh::libmesh_assert(), and value.

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
   libmesh_assert_less (i, size());
   libmesh_assert (_unclosed_state == DO_NOTHING ||
                   _unclosed_state == SET_VALUES);
 
   std::scoped_lock lock(this->_numeric_vector_mutex);
   if (i >= first_local_index() && i < last_local_index())
     {
       _values[i - _first_local_index] = value;
     }
   else
     {
       _remote_values.emplace_back(i, value);
       _unclosed_state = SET_VALUES;
     }
 
   this->_is_closed = false;
 }

◆ set_type()

template<typename T >

void libMesh::NumericVector< T >::set_type ( ParallelType t )

inherited

Allow the user to change the ParallelType of the NumericVector under some circumstances.

If the NumericVector has not been initialized yet, then it is generally safe to change the ParallelType. otherwise, if the NumericVector has already been initialized with a specific type, we cannot change it without doing some extra copying/reinitialization work, and we currently throw an error if this is requested.

Definition at line 97 of file numeric_vector.C.

Referenced by libMesh::System::add_vector().

 {
   // Check for no-op
   if (_type == t)
     return;
 
   // If the NumericVector is not yet initialized, then it is generally
   // safe to change the ParallelType, with minor restrictions.
   if (!this->initialized())
     {
       // If ghosted vectors are not enabled and the user requested a
       // GHOSTED vector, fall back on SERIAL.
 #ifndef LIBMESH_ENABLE_GHOSTED
       if (t == GHOSTED)
         {
           _type = SERIAL;
           return;
         }
 #endif
 
       _type = t;
       return;
     }
 
   // If we made it here, then the NumericVector was already
   // initialized and we don't currently allow the ParallelType to be
   // changed, although this could potentially be added later.
   libmesh_not_implemented();
 }

◆ size()

template<typename T >

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

inlineoverridevirtual

Returns: The size of the vector.

Implements libMesh::NumericVector< T >.

Definition at line 530 of file distributed_vector.h.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   return _global_size;
 }

◆ subset_l1_norm()

template<class T >

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.

Definition at line 559 of file numeric_vector.C.

Referenced by libMesh::System::discrete_var_norm().

 {
   libmesh_assert (this->readable());
 
   const NumericVector<T> & v = *this;
 
   Real norm = 0;
 
   for (const auto & index : indices)
     norm += std::abs(v(index));
 
   this->comm().sum(norm);
 
   return norm;
 }

◆ subset_l2_norm()

template<class T >

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.

Definition at line 576 of file numeric_vector.C.

Referenced by libMesh::System::discrete_var_norm().

 {
   libmesh_assert (this->readable());
 
   const NumericVector<T> & v = *this;
 
   Real norm = 0;
 
   for (const auto & index : indices)
     norm += TensorTools::norm_sq(v(index));
 
   this->comm().sum(norm);
 
   return std::sqrt(norm);
 }

◆ subset_linfty_norm()

template<class T >

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.

Definition at line 593 of file numeric_vector.C.

Referenced by libMesh::System::discrete_var_norm().

 {
   libmesh_assert (this->readable());
 
   const NumericVector<T> & v = *this;
 
   Real norm = 0;
 
   for (const auto & index : indices)
     {
       Real value = std::abs(v(index));
       if (value > norm)
         norm = value;
     }
 
   this->comm().max(norm);
 
   return norm;
 }

◆ sum()

template<typename T >

T libMesh::DistributedVector< T >::sum ( ) const

overridevirtual

Returns: The sum of all values in the vector.

Implements libMesh::NumericVector< T >.

Definition at line 48 of file distributed_vector.C.

References libMesh::initialized(), and libMesh::libmesh_assert().

 {
   // This function must be run on all processors at once
   parallel_object_only();
 
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   T local_sum = 0.;
 
   for (auto & val : _values)
     local_sum += val;
 
   this->comm().sum(local_sum);
 
   return local_sum;
 }

◆ swap()

template<typename T >

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

inlineoverridevirtual

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 696 of file distributed_vector.h.

References libMesh::DistributedVector< T >::_first_local_index, libMesh::DistributedVector< T >::_global_size, libMesh::NumericVector< T >::_is_closed, libMesh::libMeshPrivateData::_is_initialized, libMesh::NumericVector< T >::_is_initialized, libMesh::DistributedVector< T >::_last_local_index, libMesh::DistributedVector< T >::_local_size, libMesh::DistributedVector< T >::_remote_values, libMesh::DistributedVector< T >::_unclosed_state, and libMesh::DistributedVector< T >::_values.

 {
   DistributedVector<T> & v = cast_ref<DistributedVector<T> &>(other);
 
   std::swap(_global_size, v._global_size);
   std::swap(_local_size, v._local_size);
   std::swap(_first_local_index, v._first_local_index);
   std::swap(_last_local_index, v._last_local_index);
 
   std::swap(this->_is_initialized, v._is_initialized);
   std::swap(this->_is_closed, v._is_closed);
   std::swap(this->_unclosed_state, v._unclosed_state);
 
   // This should be O(1) with any reasonable STL implementation
   std::swap(_values, v._values);
   std::swap(_remote_values, v._remote_values);
 }

◆ type() [1/2]

template<typename T>

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

inlineinherited

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

Definition at line 154 of file numeric_vector.h.

Referenced by libMesh::System::add_vector(), libMesh::MeshFunction::check_found_elem(), libMesh::DofMap::constrain_element_residual(), libMesh::PetscVector< libMesh::Number >::create_subvector(), libMesh::EpetraVector< T >::EpetraVector(), libMesh::DofMap::heterogeneously_constrain_element_jacobian_and_residual(), libMesh::DofMap::heterogeneously_constrain_element_residual(), libMesh::DistributedVector< T >::init(), libMesh::LaspackVector< T >::init(), libMesh::EigenSparseVector< T >::init(), libMesh::EpetraVector< T >::init(), libMesh::PetscVector< libMesh::Number >::localize(), libMesh::System::project_vector(), and libMesh::System::read_serialized_vector().

154 { return _type; }

libMesh::NumericVector::_type

ParallelType _type

Type of vector.

Definition: numeric_vector.h:841

◆ type() [2/2]

template<typename T>

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

inlineinherited

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

Deprecated:: because it is dangerous to change the ParallelType of an already-initialized NumericVector. See NumericVector::set_type() for a safer, non-deprecated setter.

Definition at line 164 of file numeric_vector.h.

164 { return _type; }

libMesh::NumericVector::_type

ParallelType _type

Type of vector.

Definition: numeric_vector.h:841

◆ zero()

template<typename T >

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

inlineoverridevirtual

Set all entries to zero.

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

Implements libMesh::NumericVector< T >.

Definition at line 485 of file distributed_vector.h.

References libMesh::closed(), libMesh::initialized(), and libMesh::libmesh_assert().

 {
   libmesh_assert (this->initialized());
   libmesh_assert_equal_to (_values.size(), _local_size);
   libmesh_assert_equal_to ((_last_local_index - _first_local_index), _local_size);
 
   // We should be closed
   libmesh_assert (this->closed());
   libmesh_assert_equal_to (_unclosed_state, DO_NOTHING);
   libmesh_assert (_remote_values.empty());
 
   std::fill (_values.begin(),
              _values.end(),
              0.);
 }

◆ zero_clone()

template<typename T >

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

inlineoverridevirtual

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 505 of file distributed_vector.h.

 {
   std::unique_ptr<NumericVector<T>> cloned_vector =
     std::make_unique<DistributedVector<T>>(this->comm());
   cloned_vector->init(*this);
   return cloned_vector;
 }

Member Data Documentation

◆ _communicator

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

protectedinherited

Definition at line 120 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::StaticCondensation::close(), libMesh::ParallelObject::comm(), libMesh::CondensedEigenSystem::initialize_condensed_matrices(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), libMesh::ParallelObject::processor_id(), libMesh::BoundaryInfo::regenerate_id_sets(), and libMesh::StaticCondensationDofMap::reinit().

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

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

Definition at line 143 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _first_local_index

template<typename T>

numeric_index_type libMesh::DistributedVector< T >::_first_local_index

private

The first component stored locally.

Definition at line 276 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

◆ _global_size

template<typename T>

numeric_index_type libMesh::DistributedVector< T >::_global_size

private

The global vector size.

Definition at line 266 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::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 831 of file numeric_vector.h.

Referenced by libMesh::NumericVector< Number >::closed(), libMesh::PetscVector< libMesh::Number >::create_subvector(), libMesh::EpetraVector< T >::EpetraVector(), libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

◆ _is_initialized

template<typename T>

bool libMesh::NumericVector< T >::_is_initialized

protectedinherited

true once init() has been called.

Definition at line 836 of file numeric_vector.h.

Referenced by libMesh::PetscVector< libMesh::Number >::create_subvector(), libMesh::EpetraVector< T >::EpetraVector(), libMesh::NumericVector< Number >::initialized(), libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

◆ _last_local_index

template<typename T>

numeric_index_type libMesh::DistributedVector< T >::_last_local_index

private

The last component (+1) stored locally.

Definition at line 281 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

◆ _local_size

template<typename T>

numeric_index_type libMesh::DistributedVector< T >::_local_size

private

The local vector size.

Definition at line 271 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 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 132 of file reference_counter.h.

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

◆ _numeric_vector_mutex

template<typename T>

std::mutex libMesh::NumericVector< T >::_numeric_vector_mutex

protectedinherited

Mutex for performing thread-safe operations.

Definition at line 846 of file numeric_vector.h.

◆ _remote_values

template<typename T>

std::vector<std::pair<numeric_index_type, T> > libMesh::DistributedVector< T >::_remote_values

private

Entries to add or set on remote processors during the next close()

Definition at line 247 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::swap().

◆ _type

template<typename T>

ParallelType libMesh::NumericVector< T >::_type

protectedinherited

Type of vector.

Definition at line 841 of file numeric_vector.h.

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

◆ _unclosed_state

template<typename T>

UnclosedState libMesh::DistributedVector< T >::_unclosed_state

private

The current state of this vector, if it is unclosed.

Definition at line 261 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::swap().

◆ _values

template<typename T>

std::vector<T> libMesh::DistributedVector< T >::_values

private

Actual vector datatype to hold vector entries.

Definition at line 241 of file distributed_vector.h.

Referenced by libMesh::DistributedVector< T >::add(), libMesh::DistributedVector< T >::dot(), libMesh::DistributedVector< T >::localize(), libMesh::DistributedVector< T >::operator*=(), libMesh::DistributedVector< T >::operator/=(), libMesh::DistributedVector< T >::operator=(), and libMesh::DistributedVector< T >::swap().

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

include/numerics/distributed_vector.h
src/numerics/distributed_vector.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Counts

Member Enumeration Documentation

◆ UnclosedState

Constructor & Destructor Documentation

◆ DistributedVector() [1/6]

◆ DistributedVector() [2/6]

◆ DistributedVector() [3/6]

◆ DistributedVector() [4/6]

◆ DistributedVector() [5/6]

◆ DistributedVector() [6/6]

◆ ~DistributedVector()

Member Function Documentation

◆ 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_transpose()

◆ build()

◆ clear()

◆ clone()

◆ close()

◆ closed()

◆ comm()

◆ compare()

◆ compatible()

◆ conjugate()

◆ create_subvector()

◆ disable_print_counter_info()

◆ dot()

◆ el()

◆ enable_print_counter_info()

◆ first_local_index()

◆ get() [1/2]

◆ get() [2/2]

◆ get_info()

◆ get_subvector()

◆ global_relative_compare()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ 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()

◆ l1_norm_diff()

◆ l2_norm()

◆ l2_norm_diff()

◆ last_local_index()

◆ linfty_norm()

◆ local_relative_compare()

◆ local_size()

◆ localize() [1/5]

◆ localize() [2/5]

◆ localize() [3/5]

◆ localize() [4/5]

◆ localize() [5/5]

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