libMesh::DenseVectorBase< T > Class Template Reference

Defines an abstract dense vector base class for use in Finite Element-type computations. More...

#include <dense_vector_base.h>

Inheritance diagram for libMesh::DenseVectorBase< T >:

Public Member Functions
	DenseVectorBase ()=default
	Constructor.
	DenseVectorBase (DenseVectorBase &&)=default
	The 5 special functions can be defaulted for this class, as it does not manage any memory itself.
	DenseVectorBase (const DenseVectorBase &)=default
DenseVectorBase &	operator= (const DenseVectorBase &)=default
DenseVectorBase &	operator= (DenseVectorBase &&)=default
virtual	~DenseVectorBase ()=default
virtual void	zero ()=0
	Set every element in the vector to 0.
virtual T	el (const unsigned int i) const =0
virtual T &	el (const unsigned int i)=0
virtual unsigned int	size () const =0
virtual bool	empty () const
void	print (std::ostream &os) const
	Pretty-print the vector to stdout.
void	print_scientific (std::ostream &os, unsigned precision=8) const
	Prints the entries of the vector with additional decimal places in scientific notation.

Friends
std::ostream &	operator<< (std::ostream &os, const DenseVectorBase< T > &v)
	Same as above, but allows you to print using the usual stream syntax.

Detailed Description

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

Defines an abstract dense vector base class for use in Finite Element-type computations.

Specialized dense vectors, for example DenseSubVectors, can be derived from this class.

Author

John W. Peterson

Date

2003

Definition at line 42 of file dense_vector_base.h.

Constructor & Destructor Documentation

DenseVectorBase() [1/3]

template<typename T >

libMesh::DenseVectorBase< T >::DenseVectorBase ( )

default

Constructor.

DenseVectorBase() [2/3]

template<typename T >

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

default

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

DenseVectorBase() [3/3]

template<typename T >

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

default

~DenseVectorBase()

template<typename T >

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

virtualdefault

Member Function Documentation

el() [1/2]

template<typename T >

virtual T libMesh::DenseVectorBase< T >::el ( const unsigned int  i ) const

pure virtual

Returns

The (i) element of the vector.

Implemented in libMesh::DenseSubVector< T >, libMesh::DenseVector< T >, and libMesh::DenseVector< Number >.

Referenced by libMesh::DenseMatrixBase< T >::condense(), and libMesh::DofMap::extract_local_vector().

el() [2/2]

template<typename T >

virtual T & libMesh::DenseVectorBase< T >::el ( const unsigned int  i )

pure virtual

Returns

The (i) element of the vector as a writable reference.

Implemented in libMesh::DenseSubVector< T >, libMesh::DenseVector< T >, and libMesh::DenseVector< Number >.

empty()

template<typename T >

virtual bool libMesh::DenseVectorBase< T >::empty ( ) const

inlinevirtual

Returns

true iff size() is 0.

Reimplemented in libMesh::DenseSubVector< T >, libMesh::DenseVector< T >, and libMesh::DenseVector< Number >.

Definition at line 85 of file dense_vector_base.h.

{ return (this->size() == 0); }

References libMesh::DenseVectorBase< T >::size().

operator=() [1/2]

template<typename T >

DenseVectorBase & libMesh::DenseVectorBase< T >::operator= ( const DenseVectorBase< T > &  )

default

operator=() [2/2]

template<typename T >

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

default

print()

template<typename T >

void libMesh::DenseVectorBase< T >::print

(

std::ostream &

os

)

const

Pretty-print the vector to stdout.

Definition at line 110 of file dense_vector_base.h.

{
  for (auto i : make_range(this->size()))
    os << std::setw(8)
       << this->el(i)
       << std::endl;
}

References libMesh::make_range().

print_scientific()

template<typename T >

void libMesh::DenseVectorBase< T >::print_scientific	(	std::ostream &	os,
		unsigned	precision = 8
	)		const

Prints the entries of the vector with additional decimal places in scientific notation.

Definition at line 31 of file dense_vector_base.C.

{
  // save the initial format flags
  std::ios_base::fmtflags os_flags = os.flags();
 
  // Print the vector entries.
  for (auto i : make_range(this->size()))
    os << std::setw(10)
       << std::scientific
       << std::setprecision(precision)
       << this->el(i)
       << std::endl;
 
  // reset the original format flags
  os.flags(os_flags);
}

References libMesh::make_range().

size()

template<typename T >

virtual unsigned int libMesh::DenseVectorBase< T >::size ( ) const

pure virtual

Returns

The size of the vector.

Implemented in libMesh::DenseSubVector< T >, libMesh::DenseVector< T >, and libMesh::DenseVector< Number >.

Referenced by libMesh::DenseMatrixBase< T >::condense(), libMesh::DenseVectorBase< T >::empty(), and libMesh::DofMap::extract_local_vector().

zero()

template<typename T >

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

pure virtual

Set every element in the vector to 0.

Needs to be pure virtual since the storage method may be different in derived classes.

Implemented in libMesh::DenseSubVector< T >, libMesh::DenseVector< T >, and libMesh::DenseVector< Number >.

Referenced by libMesh::DofMap::extract_local_vector().

Friends And Related Symbol Documentation

operator<<

template<typename T >

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

friend

Same as above, but allows you to print using the usual stream syntax.

Definition at line 96 of file dense_vector_base.h.

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

---

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

• include/base/dof_map.h
• include/numerics/dense_vector_base.h
• src/numerics/dense_vector_base.C