Provides a uniform interface to vector storage schemes for different linear algebra libraries. More...

#include <dof_map.h>

Inheritance diagram for libMesh::NumericVector< T >:

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

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

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

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

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

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

	NumericVector (const NumericVector &)=default

NumericVector &	operator= (NumericVector &&)=default

virtual	~NumericVector ()=default
	While this class doesn't manage any memory, the derived class might and users may be deleting through a pointer to this base class. More...

virtual bool	initialized () const

ParallelType	type () const

ParallelType &	type ()

virtual bool	closed () const

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

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

virtual void	zero ()=0
	Set all entries to zero. More...

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

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

virtual void	init (const numeric_index_type n, const numeric_index_type n_local, const bool fast=false, const ParallelType ptype=AUTOMATIC)=0
	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)=0
	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 ptype=AUTOMATIC)=0
	Create a vector that holds tha local indices plus those specified in the `ghost` argument. More...

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

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

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

virtual Real	min () const =0

virtual Real	max () const =0

virtual T	sum () const =0

virtual Real	l1_norm () const =0

virtual Real	l2_norm () const =0

virtual Real	linfty_norm () const =0

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

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

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

virtual numeric_index_type	size () const =0

virtual numeric_index_type	local_size () const =0

virtual numeric_index_type	first_local_index () const =0

virtual numeric_index_type	last_local_index () const =0

virtual T	operator() (const numeric_index_type i) const =0

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

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

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

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

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

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

virtual NumericVector< T > &	operator/= (const NumericVector< T > &v)=0
	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 ()=0
	Computes the component-wise reciprocal, \( u_i \leftarrow \frac{1}{u_i} \, \forall i\). More...

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

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

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

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

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

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

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

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

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

virtual void	add_vector (const NumericVector< T > &v, const SparseMatrix< T > &A)=0
	Computes \( \vec{u} \leftarrow \vec{u} + A \vec{v} \), i.e. 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	add_vector_transpose (const NumericVector< T > &v, const SparseMatrix< T > &A)=0
	Computes \( \vec{u} \leftarrow \vec{u} + A^T \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...

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

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

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

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

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

virtual T	dot (const NumericVector< T > &v) const =0

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

virtual void	localize (NumericVector< T > &v_local) const =0
	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 =0
	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 =0
	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)=0
	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 =0
	Creates a local copy of the global vector in `v_local` only on processor `proc_id`. 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	pointwise_mult (const NumericVector< T > &vec1, const NumericVector< T > &vec2)=0
	Computes \( u_i \leftarrow u_i v_i \) (summation not implied) i.e. More...

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

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

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

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

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

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

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

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

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

static void	disable_print_counter_info ()

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

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

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

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

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

ParallelType	_type
	Type of vector. More...

const Parallel::Communicator &	_communicator

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

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

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

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

Friends
std::ostream &	operator<< (std::ostream &os, const NumericVector< T > &v)
	Same as above but allows you to use stream syntax. More...

Detailed Description

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

Provides a uniform interface to vector storage schemes for different linear algebra libraries.

Note: This class is the abstract base class for different implementations of numeric vectors. Most of the time you should use a System object to create numeric vectors. If this is not desired, you can instantiate one of the derived classes (PetscVector, EigenSparseVector, etc.) or use the NumericVector::build method. When creating the vector yourself, make sure that you initialize the vector properly (NumericVector::init).

Author: Benjamin S. Kirk

Date: 2003

Definition at line 43 of file vector_fe_ex5.C.

Member Typedef Documentation

◆ Counts

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

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ NumericVector() [1/6]

template<typename T >

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

inlineexplicit

Dummy-Constructor.

Dimension=0

Definition at line 747 of file numeric_vector.h.

                                                            :
   ParallelObject(comm_in),
   _is_closed(false),
   _is_initialized(false),
   _type(ptype)
 {
 }

◆ NumericVector() [2/6]

template<typename T >

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

inlineexplicit

Constructor.

Set dimension to n and initialize all elements with zero.

Definition at line 760 of file numeric_vector.h.

                                                            :
   ParallelObject(comm_in),
   _is_closed(false),
   _is_initialized(false),
   _type(ptype)
 {
   libmesh_not_implemented(); // Abstract base class!
   // init(n, n, false, ptype);
 }

◆ NumericVector() [3/6]

template<typename T >

libMesh::NumericVector< T >::NumericVector	(	const Parallel::Communicator &	comm_in,
		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 776 of file numeric_vector.h.

                                                            :
   ParallelObject(comm_in),
   _is_closed(false),
   _is_initialized(false),
   _type(ptype)
 {
   libmesh_not_implemented(); // Abstract base class!
   // init(n, n_local, false, ptype);
 }

◆ NumericVector() [4/6]

template<typename T >

libMesh::NumericVector< T >::NumericVector	(	const Parallel::Communicator &	comm_in,
		const numeric_index_type	N,
		const numeric_index_type	n_local,
		const std::vector< numeric_index_type > &	ghost,
		const ParallelType	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 793 of file numeric_vector.h.

                                                            :
   ParallelObject(comm_in),
   _is_closed(false),
   _is_initialized(false),
   _type(ptype)
 {
   libmesh_not_implemented(); // Abstract base class!
   // init(n, n_local, ghost, false, ptype);
 }

◆ NumericVector() [5/6]

template<typename T>

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

default

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

◆ NumericVector() [6/6]

template<typename T>

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

default

◆ ~NumericVector()

template<typename T>

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

virtualdefault

While this class doesn't manage any memory, the derived class might and users may be deleting through a pointer to this base class.

Member Function Documentation

◆ abs()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, and libMesh::EigenSparseVector< T >.

◆ add() [1/4]

template<typename T>

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

pure virtual

Adds value to each entry of the vector.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by add_M_C_K_helmholtz(), libMesh::NewmarkSolver::advance_timestep(), assemble_wave(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::RBConstruction::compute_Fq_representor_innerprods(), libMesh::RBConstruction::compute_output_dual_innerprods(), libMesh::RBConstruction::compute_residual_dual_norm_slow(), libMesh::ContinuationSystem::continuation_solve(), libMesh::TransientRBConstruction::enrich_RB_space(), fill_dirichlet_bc(), AssembleOptimization::gradient(), libMesh::ContinuationSystem::initialize_tangent(), libMesh::NewtonSolver::line_search(), main(), libMesh::TransientRBConstruction::mass_matrix_scaled_matvec(), LaplaceYoung::postcheck(), libMesh::NewtonSolver::solve(), libMesh::ContinuationSystem::solve_tangent(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_assembly(), libMesh::NewmarkSystem::update_rhs(), libMesh::ContinuationSystem::update_solution(), libMesh::NewmarkSystem::update_u_v_a(), and libMesh::TensorShellMatrix< T >::vector_mult_add().

◆ add() [2/4]

template<typename T>

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

pure virtual

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

Equivalent to calling operator+=().

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ add() [3/4]

template<typename T>

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

pure virtual

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

Equivalent to calling operator+=().

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ add() [4/4]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ add_vector() [1/6]

template<typename T>

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

inline

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

Definition at line 862 of file numeric_vector.h.

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

◆ add_vector() [2/6]

template<typename T>

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

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 385 of file numeric_vector.C.

 {
   a.vector_mult_add(*this,v);
 }

◆ add_vector() [3/6]

template<typename T>

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

pure virtual

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

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

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

virtual

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

Definition at line 373 of file numeric_vector.C.

 {
   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 std::vector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inline

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

Definition at line 850 of file numeric_vector.h.

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

◆ add_vector() [6/6]

template<typename T>

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

virtual

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

This should be overridden in subclasses for efficiency.

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

Definition at line 363 of file numeric_vector.C.

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

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

◆ add_vector_transpose()

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ build()

template<typename T >

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

static

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

Definition at line 49 of file numeric_vector.C.

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

◆ clear()

template<typename T >

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

inlinevirtual

Restores the NumericVector<T> to a pristine state.

Reimplemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Definition at line 811 of file numeric_vector.h.

 {
   _is_closed      = false;
   _is_initialized = false;
 }

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), and libMesh::System::project_vector().

◆ clone()

template<typename T>

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

pure virtual

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

Note: This must be overridden in the derived classes.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::NewmarkSolver::advance_timestep(), HeatSystem::perturb_accumulate_residuals(), libMesh::System::project_vector(), libMesh::TwostepTimeSolver::solve(), and libMesh::ImplicitSystem::weighted_sensitivity_solve().

◆ close()

template<typename T>

virtual void libMesh::NumericVector< T >::close ( )

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by add_M_C_K_helmholtz(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), assemble(), AssembleOptimization::assemble_A_and_F(), assemble_matrix_and_rhs(), libMesh::ImplicitSystem::assemble_residual_derivatives(), assemble_shell(), libMesh::FEMSystem::assembly(), libMesh::LinearImplicitSystem::assembly(), libMesh::System::boundary_project_vector(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ContinuationSystem::continuation_solve(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::RBEIMConstruction::get_explicit_sys_subvector(), libMesh::ContinuationSystem::initialize_tangent(), libMesh::NewtonSolver::line_search(), HeatSystem::perturb_accumulate_residuals(), libMesh::System::project_vector(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), libMesh::System::read_serialized_vector(), libMesh::RBEIMConstruction::set_explicit_sys_subvector(), ParsedFEMFunctionTest::setUp(), libMesh::NewtonSolver::solve(), libMesh::NoxNonlinearSolver< Number >::solve(), libMesh::ContinuationSystem::solve_tangent(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_assembly(), libMesh::ContinuationSystem::update_solution(), libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve(), libMesh::ImplicitSystem::weighted_sensitivity_solve(), and libMesh::RBConstruction::zero_constrained_dofs_on_vector().

◆ closed()

template<typename T>

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

inlinevirtual

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

Definition at line 171 of file numeric_vector.h.

171 { return _is_closed; }

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

◆ comm()

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

inlineinherited

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

Definition at line 94 of file parallel_object.h.

95 { return _communicator; }

References libMesh::ParallelObject::_communicator.

◆ compare()

template<typename T>

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

virtual

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 105 of file numeric_vector.C.

 {
   libmesh_assert (this->initialized());
   libmesh_assert (other_vector.initialized());
   libmesh_assert_equal_to (this->first_local_index(), other_vector.first_local_index());
   libmesh_assert_equal_to (this->last_local_index(), other_vector.last_local_index());
  
   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)
         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;
 }

◆ conjugate()

template<typename T>

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

pure virtual

Negates the imaginary component of each entry in the vector.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ create_subvector()

template<typename T>

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

inlinevirtual

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

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

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

Definition at line 707 of file numeric_vector.h.

   {
     libmesh_not_implemented();
   }

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 106 of file reference_counter.C.

 {
   _enable_print_counter = false;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

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

◆ dot()

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by libMesh::TransientRBConstruction::add_IC_to_RB_space(), libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::RBSCMConstruction::Aq_inner_product(), libMesh::RBSCMConstruction::B_inner_product(), libMesh::ContinuationSystem::continuation_solve(), libMesh::TransientRBConstruction::enrich_RB_space(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), AssembleOptimization::objective(), libMesh::ImplicitSystem::qoi_parameter_hessian(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), libMesh::ContinuationSystem::solve_tangent(), libMesh::TransientRBConstruction::truth_solve(), libMesh::RBConstruction::truth_solve(), libMesh::TransientRBConstruction::update_RB_system_matrices(), libMesh::RBConstruction::update_RB_system_matrices(), and libMesh::ContinuationSystem::update_solution().

◆ el()

template<typename T>

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

inlinevirtual

Returns: (*this)(i).

Definition at line 352 of file numeric_vector.h.

352 { 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 100 of file reference_counter.C.

 {
   _enable_print_counter = true;
   return;
 }

References libMesh::ReferenceCounter::_enable_print_counter.

◆ first_local_index()

template<typename T>

virtual numeric_index_type libMesh::NumericVector< T >::first_local_index ( ) const

pure virtual

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

Note: The minimum for this index is 0.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::NumericVector< Number >::compare(), AssembleOptimization::equality_constraints(), libMesh::DofMap::extract_local_vector(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::RBEIMConstruction::get_explicit_sys_subvector(), libMesh::NumericVector< Number >::global_relative_compare(), libMesh::index_range(), AssembleOptimization::inequality_constraints(), libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters(), libMesh::VectorSetAction< Val >::insert(), libMesh::RBConstructionBase< CondensedEigenSystem >::load_training_set(), libMesh::NumericVector< Number >::local_relative_compare(), libMesh::DofMap::max_constraint_error(), and libMesh::RBEIMConstruction::set_explicit_sys_subvector().

◆ get() [1/2]

template<typename T>

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

inline

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

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

◆ get() [2/2]

template<typename T>

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

inlinevirtual

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

Definition at line 821 of file numeric_vector.h.

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

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), compute_residual(), libMesh::EpetraVector< T >::EpetraVector(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters(), libMesh::RBConstructionBase< CondensedEigenSystem >::load_training_set(), libMesh::FEMContext::pre_fe_reinit(), and libMesh::System::project_vector().

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

 {
 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
  
   std::ostringstream oss;
  
   oss << '\n'
       << " ---------------------------------------------------------------------------- \n"
       << "| Reference count information                                                |\n"
       << " ---------------------------------------------------------------------------- \n";
  
   for (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
  
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
  
   oss << " ---------------------------------------------------------------------------- \n";
  
   return oss.str();
  
 #else
  
   return "";
  
 #endif
 }

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

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

◆ global_relative_compare()

template<typename T>

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

virtual

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 170 of file numeric_vector.C.

 {
   libmesh_assert (this->initialized());
   libmesh_assert (other_vector.initialized());
   libmesh_assert_equal_to (this->first_local_index(), other_vector.first_local_index());
   libmesh_assert_equal_to (this->last_local_index(), other_vector.last_local_index());
  
   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 )

inlineprotectedinherited

Increments the construction counter.

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

Definition at line 181 of file reference_counter.h.

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

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

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

◆ increment_destructor_count()

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

inlineprotectedinherited

Increments the destruction counter.

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

Definition at line 194 of file reference_counter.h.

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

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

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

◆ init() [1/4]

template<typename T>

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

pure virtual

Call init() with n_local = N.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ init() [2/4]

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::TransientRBConstruction::add_IC_to_RB_space(), libMesh::System::add_vector(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::DistributedVector< T >::clone(), libMesh::EigenSparseVector< T >::clone(), libMesh::LaspackVector< T >::clone(), libMesh::EpetraVector< T >::clone(), libMesh::PetscVector< libMesh::Number >::clone(), libMesh::TransientRBConstruction::enrich_RB_space(), AssembleOptimization::equality_constraints(), AssembleOptimization::inequality_constraints(), AssembleOptimization::inequality_constraints_jacobian(), main(), LinearElasticityWithContact::move_mesh(), libMesh::System::project_vector(), libMesh::DistributedVector< T >::zero_clone(), libMesh::EigenSparseVector< T >::zero_clone(), libMesh::LaspackVector< T >::zero_clone(), libMesh::EpetraVector< T >::zero_clone(), and libMesh::PetscVector< libMesh::Number >::zero_clone().

◆ init() [3/4]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ init() [4/4]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ initialized()

template<typename T>

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

inlinevirtual

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

Definition at line 155 of file numeric_vector.h.

155 { return _is_initialized; }

Referenced by libMesh::ImplicitSystem::assemble(), libMesh::NumericVector< Number >::compare(), libMesh::PetscVector< libMesh::Number >::create_subvector(), libMesh::NumericVector< Number >::global_relative_compare(), libMesh::PetscVector< libMesh::Number >::init(), and libMesh::NumericVector< Number >::local_relative_compare().

◆ insert() [1/5]

template<typename T>

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

inline

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

Definition at line 898 of file numeric_vector.h.

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

◆ insert() [2/5]

template<typename T>

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

inline

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

Definition at line 886 of file numeric_vector.h.

 {
   libmesh_assert(v.size() == dof_indices.size());
   if (!v.empty())
     this->insert(&v(0), 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
	)

virtual

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

Definition at line 93 of file numeric_vector.C.

 {
   libmesh_assert_equal_to (V.size(), dof_indices.size());
  
   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 std::vector< T > &	v,
		const std::vector< numeric_index_type > &	dof_indices
	)

inline

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

Definition at line 874 of file numeric_vector.h.

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

◆ insert() [5/5]

template<typename T>

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

virtual

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

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

Definition at line 83 of file numeric_vector.C.

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

Referenced by Biharmonic::JR::bounds().

◆ l1_norm()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::FEMSystem::assembly(), and libMesh::System::calculate_norm().

◆ l2_norm()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::System::calculate_norm(), libMesh::ContinuationSystem::continuation_solve(), libMesh::RBConstruction::enrich_basis_from_rhs_terms(), libMesh::ContinuationSystem::initialize_tangent(), libMesh::NewtonSolver::line_search(), libMesh::NewtonSolver::solve(), libMesh::ContinuationSystem::solve_tangent(), and libMesh::ContinuationSystem::update_solution().

◆ last_local_index()

template<typename T>

virtual numeric_index_type libMesh::NumericVector< T >::last_local_index ( ) const

pure virtual

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

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::NumericVector< Number >::compare(), AssembleOptimization::equality_constraints(), libMesh::DofMap::extract_local_vector(), libMesh::RBEIMConstruction::get_explicit_sys_subvector(), libMesh::NumericVector< Number >::global_relative_compare(), libMesh::index_range(), AssembleOptimization::inequality_constraints(), libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters(), libMesh::VectorSetAction< Val >::insert(), libMesh::NumericVector< Number >::local_relative_compare(), libMesh::DofMap::max_constraint_error(), and libMesh::RBEIMConstruction::set_explicit_sys_subvector().

◆ linfty_norm()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::System::calculate_norm(), and libMesh::NumericVector< Number >::global_relative_compare().

◆ local_relative_compare()

template<typename T>

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

virtual

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 137 of file numeric_vector.C.

 {
   libmesh_assert (this->initialized());
   libmesh_assert (other_vector.initialized());
   libmesh_assert_equal_to (this->first_local_index(), other_vector.first_local_index());
   libmesh_assert_equal_to (this->last_local_index(), other_vector.last_local_index());
  
   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>

virtual numeric_index_type libMesh::NumericVector< T >::local_size ( ) const

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::PetscLinearSolver< Number >::adjoint_solve(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::DistributedVector< T >::init(), libMesh::EigenSparseVector< T >::init(), libMesh::LaspackVector< T >::init(), libMesh::EpetraVector< T >::init(), libMesh::System::project_vector(), and libMesh::PetscLinearSolver< Number >::solve().

◆ localize() [1/5]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, and libMesh::EigenSparseVector< T >.

◆ localize() [2/5]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ localize() [3/5]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ localize() [4/5]

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::System::calculate_norm(), AssembleOptimization::equality_constraints(), libMesh::AdjointRefinementEstimator::estimate_error(), AssembleOptimization::inequality_constraints(), AssembleOptimization::inequality_constraints_jacobian(), main(), LinearElasticityWithContact::move_mesh(), libMesh::System::project_vector(), libMesh::UnsteadySolver::reinit(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::RBConstruction::set_context_solution_vec(), libMesh::RBEIMConstruction::set_explicit_sys_subvector(), libMesh::RBEIMConstruction::update_RB_system_matrices(), libMesh::MeshOutput< MeshBase >::write_nodal_data(), and libMesh::Nemesis_IO_Helper::write_nodal_solution().

◆ localize() [5/5]

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ localize_to_one()

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ max()

template<typename T>

virtual Real libMesh::NumericVector< T >::max ( ) const

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ min()

template<typename T>

virtual Real libMesh::NumericVector< T >::min ( ) const

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 83 of file reference_counter.h.

84 { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 100 of file parallel_object.h.

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

References libMesh::ParallelObject::_communicator.

◆ operator()()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ operator*=() [1/2]

template<typename T>

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

pure virtual

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.

Implemented in libMesh::EigenSparseVector< T >, libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator*=() [2/2]

template<typename T>

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

inline

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

Equivalent to u.scale(a)

Returns: A reference to *this.

Definition at line 397 of file numeric_vector.h.

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

◆ operator+=()

template<typename T>

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

pure virtual

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

Equivalent to u.add(1, v).

Returns: A reference to *this.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator-=()

template<typename T>

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

pure virtual

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

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

Returns: A reference to *this.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator/=() [1/2]

template<typename T>

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

pure virtual

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.

Implemented in libMesh::EigenSparseVector< T >, libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator/=() [2/2]

template<typename T>

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

inline

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

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

◆ operator=() [1/4]

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator=() [2/4]

template<typename T>

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

pure virtual

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

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

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator=() [3/4]

template<typename T>

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

pure virtual

Sets all entries of the vector to the value s.

Returns: A reference to *this.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

◆ operator=() [4/4]

template<typename T>

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

default

◆ pointwise_mult()

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by libMesh::TensorShellMatrix< T >::get_diagonal().

◆ print() [1/2]

template<>

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

inline

Definition at line 913 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() [2/2]

template<typename T >

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

inlinevirtual

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

Definition at line 931 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_global() [1/2]

template<>

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

inline

Definition at line 946 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 : IntRange<numeric_index_type>(0, v.size()))
     os << i << "\t"
        << v[i].real() << "\t\t"
        << v[i].imag() << std::endl;
 }

◆ print_global() [2/2]

template<typename T >

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

inlinevirtual

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

Definition at line 968 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 : IntRange<numeric_index_type>(0, v.size()))
     os << i << "\t" << v[i] << std::endl;
 }

◆ print_info()

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

staticinherited

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

Definition at line 87 of file reference_counter.C.

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

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

◆ print_matlab()

template<typename T>

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

inlinevirtual

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

   {
     libmesh_not_implemented();
   }

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 106 of file parallel_object.h.

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

References libMesh::ParallelObject::_communicator.

◆ reciprocal()

template<typename T>

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

pure virtual

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ scale()

template<typename T>

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

pure virtual

Scale each element of the vector by the given factor.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by libMesh::TransientRBConstruction::add_IC_to_RB_space(), libMesh::ContinuationSystem::continuation_solve(), libMesh::TransientRBConstruction::enrich_RB_space(), libMesh::ContinuationSystem::initialize_tangent(), libMesh::NumericVector< Number >::operator*=(), libMesh::NumericVector< Number >::operator/=(), libMesh::ContinuationSystem::solve_tangent(), libMesh::RBConstruction::update_residual_terms(), libMesh::NewmarkSystem::update_u_v_a(), and libMesh::TensorShellMatrix< T >::vector_mult().

◆ set()

template<typename T>

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

pure virtual

Sets v(i) = value.

Implemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, libMesh::DistributedVector< T >, and libMesh::PetscVector< libMesh::Number >.

Referenced by assemble_shell(), libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), AssembleOptimization::equality_constraints(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_deterministic(), libMesh::RBConstructionBase< CondensedEigenSystem >::generate_training_parameters_random(), libMesh::RBEIMConstruction::get_explicit_sys_subvector(), AssembleOptimization::inequality_constraints(), libMesh::RBConstructionBase< CondensedEigenSystem >::initialize_training_parameters(), libMesh::VectorSetAction< Val >::insert(), libMesh::RBConstructionBase< CondensedEigenSystem >::load_training_set(), AssembleOptimization::lower_and_upper_bounds(), main(), libMesh::System::project_vector(), libMesh::System::read_SCALAR_dofs(), libMesh::RBEIMConstruction::set_explicit_sys_subvector(), ParsedFEMFunctionTest::setUp(), WriteVecAndScalar::testWrite(), libMesh::RBConstruction::zero_constrained_dofs_on_vector(), and libMesh::System::zero_variable().

◆ size()

template<typename T>

virtual numeric_index_type libMesh::NumericVector< T >::size ( ) const

pure virtual

Returns: The size of the vector.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::NumericVector< Number >::add_vector(), libMesh::System::calculate_norm(), AssembleOptimization::equality_constraints(), libMesh::DofMap::extract_local_vector(), AssembleOptimization::inequality_constraints(), AssembleOptimization::inequality_constraints_jacobian(), libMesh::DistributedVector< T >::init(), libMesh::EigenSparseVector< T >::init(), libMesh::LaspackVector< T >::init(), libMesh::EpetraVector< T >::init(), libMesh::NumericVector< Number >::insert(), main(), LinearElasticityWithContact::move_mesh(), libMesh::DistributedVector< T >::operator*=(), libMesh::EigenSparseVector< T >::operator*=(), libMesh::LaspackVector< T >::operator*=(), libMesh::EpetraVector< T >::operator*=(), libMesh::DistributedVector< T >::operator/=(), libMesh::EigenSparseVector< T >::operator/=(), libMesh::LaspackVector< T >::operator/=(), libMesh::EpetraVector< T >::operator/=(), libMesh::System::project_vector(), libMesh::PetscLinearSolver< Number >::solve(), and libMesh::System::write_serialized_vector().

◆ subset_l1_norm()

template<class T >

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

virtual

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 312 of file numeric_vector.C.

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

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

◆ subset_l2_norm()

template<class T >

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

virtual

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 327 of file numeric_vector.C.

 {
   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);
 }

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

◆ subset_linfty_norm()

template<class T >

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

virtual

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 342 of file numeric_vector.C.

 {
   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;
 }

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

◆ sum()

template<typename T>

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

pure virtual

Returns: The sum of all values in the vector.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

◆ swap()

template<typename T>

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

inlinevirtual

Swaps the contents of this with v.

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

Reimplemented in libMesh::PetscVector< T >, libMesh::EpetraVector< T >, libMesh::DistributedVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::PetscVector< libMesh::Number >.

Definition at line 989 of file numeric_vector.h.

 {
   std::swap(_is_closed, v._is_closed);
   std::swap(_is_initialized, v._is_initialized);
   std::swap(_type, v._type);
 }

Referenced by libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::WeightedPatchRecoveryErrorEstimator::estimate_error(), libMesh::PatchRecoveryErrorEstimator::estimate_error(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::ExactErrorEstimator::estimate_error(), main(), and libMesh::EpetraVector< T >::swap().

◆ type() [1/2]

template<typename T>

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

inline

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

Definition at line 165 of file numeric_vector.h.

165 { return _type; }

◆ type() [2/2]

template<typename T>

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

inline

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

Definition at line 160 of file numeric_vector.h.

160 { return _type; }

Referenced by libMesh::EpetraVector< T >::EpetraVector(), libMesh::MeshFunction::find_element(), libMesh::MeshFunction::find_elements(), libMesh::DistributedVector< T >::init(), libMesh::EigenSparseVector< T >::init(), libMesh::LaspackVector< T >::init(), libMesh::EpetraVector< T >::init(), libMesh::PetscVector< libMesh::Number >::localize(), libMesh::PetscVector< libMesh::Number >::operator=(), libMesh::System::project_vector(), and libMesh::System::read_serialized_vector().

◆ zero()

template<typename T>

virtual void libMesh::NumericVector< T >::zero ( )

pure virtual

Set all entries to zero.

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

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by add_M_C_K_helmholtz(), apply_initial(), libMesh::ImplicitSystem::assemble(), AssembleOptimization::assemble_A_and_F(), libMesh::RBConstruction::assemble_all_output_vectors(), libMesh::RBConstruction::assemble_Fq_vector(), libMesh::ExplicitSystem::assemble_qoi_derivative(), libMesh::FEMSystem::assemble_qoi_derivative(), libMesh::FEMSystem::assembly(), libMesh::RBConstruction::compute_Fq_representor_innerprods(), libMesh::RBConstruction::compute_output_dual_innerprods(), libMesh::ContinuationSystem::continuation_solve(), libMesh::TransientRBConstruction::enrich_RB_space(), AssembleOptimization::equality_constraints(), AssembleOptimization::gradient(), AssembleOptimization::inequality_constraints(), libMesh::NewmarkSystem::initial_conditions(), libMesh::TransientRBConstruction::mass_matrix_scaled_matvec(), LaplaceYoung::residual(), LargeDeformationElasticity::residual(), LinearElasticityWithContact::residual_and_jacobian(), libMesh::NewtonSolver::solve(), libMesh::ContinuationSystem::solve_tangent(), libMesh::TransientRBConstruction::truth_assembly(), libMesh::RBConstruction::truth_assembly(), libMesh::RBEIMConstruction::truth_solve(), libMesh::TransientRBConstruction::update_residual_terms(), libMesh::RBConstruction::update_residual_terms(), libMesh::NewmarkSystem::update_rhs(), libMesh::SumShellMatrix< T >::vector_mult(), and libMesh::SparseMatrix< ValOut >::vector_mult().

◆ zero_clone()

template<typename T>

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

pure virtual

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.

Implemented in libMesh::PetscVector< T >, libMesh::PetscVector< libMesh::Number >, libMesh::EpetraVector< T >, libMesh::LaspackVector< T >, libMesh::EigenSparseVector< T >, and libMesh::DistributedVector< T >.

Referenced by libMesh::SumShellMatrix< T >::get_diagonal(), AssembleOptimization::objective(), libMesh::NewtonSolver::solve(), and libMesh::ImplicitSystem::weighted_sensitivity_adjoint_solve().

Friends And Related Function Documentation

◆ operator<<

template<typename T>

std::ostream& operator<<	(	std::ostream &	os,
		const NumericVector< T > &	v
	)

friend

Same as above but allows you to use stream syntax.

Definition at line 685 of file numeric_vector.h.

   {
     v.print_global(os);
     return os;
   }

Member Data Documentation

◆ _communicator

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

protectedinherited

Definition at line 112 of file parallel_object.h.

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

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _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 141 of file reference_counter.h.

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

◆ _is_closed

template<typename T>

bool libMesh::NumericVector< T >::_is_closed

protected

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

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

◆ _is_initialized

template<typename T>

bool libMesh::NumericVector< T >::_is_initialized

protected

true once init() has been called.

Definition at line 732 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(), and libMesh::DistributedVector< T >::operator=().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

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

staticprotectedinherited

The number of objects.

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

Definition at line 130 of file reference_counter.h.

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

◆ _type

template<typename T>

ParallelType libMesh::NumericVector< T >::_type

protected

Type of vector.

Definition at line 737 of file numeric_vector.h.

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

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

examples/vector_fe/vector_fe_ex5/vector_fe_ex5.C
include/numerics/numeric_vector.h
src/numerics/numeric_vector.C

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

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

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ NumericVector() [1/6]

◆ NumericVector() [2/6]

◆ NumericVector() [3/6]

◆ NumericVector() [4/6]

◆ NumericVector() [5/6]

◆ NumericVector() [6/6]

◆ ~NumericVector()

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

◆ conjugate()

◆ create_subvector()

◆ disable_print_counter_info()

◆ dot()

◆ el()

◆ enable_print_counter_info()

◆ first_local_index()

◆ get() [1/2]

◆ get() [2/2]

◆ get_info()

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

◆ l2_norm()

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

◆ localize_to_one()

◆ max()

◆ min()

◆ n_objects()

◆ n_processors()

◆ operator()()

◆ operator*=() [1/2]

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