libMesh::DenseSubVector< T > Class Template Reference

#include <dense_subvector.h>

Inheritance diagram for libMesh::DenseSubVector< T >:

Public Member Functions
	DenseSubVector (DenseVector< T > &new_parent, const unsigned int ioff=0, const unsigned int n=0)
	DenseSubVector (DenseSubVector &&)=default
	DenseSubVector (const DenseSubVector &)=default
DenseSubVector &	operator= (const DenseSubVector &)=default
DenseSubVector &	operator= (DenseSubVector &&)=default
virtual	~DenseSubVector ()=default
DenseVector< T > &	parent ()
virtual void	zero () override
const T &	operator() (const unsigned int i) const
T &	operator() (const unsigned int i)
virtual T	el (const unsigned int i) const override
virtual T &	el (const unsigned int i) override
virtual unsigned int	size () const override
virtual bool	empty () const override
unsigned int	i_off () const
void	reposition (const unsigned int ioff, const unsigned int n)
Real	min () const
Real	max () const
Real	l1_norm () const
Real	l2_norm () const
Real	linfty_norm () const
void	print (std::ostream &os) const
void	print_scientific (std::ostream &os, unsigned precision=8) const

Private Attributes
DenseVector< T > &	_parent_vector
unsigned int	_n
unsigned int	_i_off

Detailed Description

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

Defines a dense subvector for use in finite element computations. Useful for storing element load vectors before summation into a global vector, particularly when you have systems of equations. All overridden virtual functions are documented in dense_vector_base.h.

Author

Benjamin S. Kirk

Date

2003

Definition at line 42 of file dense_subvector.h.

Constructor & Destructor Documentation

DenseSubVector() [1/3]

template<typename T >

libMesh::DenseSubVector< T >::DenseSubVector ( DenseVector< T > &  new_parent, const unsigned int  ioff = 0, const unsigned int  n = 0  )

inline

Constructor. Creates a dense subvector of the vector parent. The subvector has dimensions , and the entry of the subvector is located at the location in the parent vector.

Definition at line 161 of file dense_subvector.h.

References libMesh::DenseSubVector< T >::reposition().

                                                        :
  _parent_vector(new_parent)
{
  reposition (ioff, n);
}

DenseSubVector() [2/3]

template<typename T>

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

default

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

DenseSubVector() [3/3]

template<typename T>

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

default

~DenseSubVector()

template<typename T>

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

virtualdefault

Member Function Documentation

el() [1/2]

template<typename T>

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

inlineoverridevirtual

Returns

The (i) element of the vector.

Implements libMesh::DenseVectorBase< T >.

Definition at line 83 of file dense_subvector.h.

  { return (*this)(i); }

el() [2/2]

template<typename T>

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

inlineoverridevirtual

Returns

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

Implements libMesh::DenseVectorBase< T >.

Definition at line 86 of file dense_subvector.h.

  { return (*this)(i); }

empty()

template<typename T>

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

inlineoverridevirtual

Returns

true iff size() is 0.

Reimplemented from libMesh::DenseVectorBase< T >.

Definition at line 92 of file dense_subvector.h.

References libMesh::DenseSubVector< T >::_n.

Referenced by libMesh::NumericVector< Number >::insert().

  { return (_n == 0); }

i_off()

template<typename T>

unsigned int libMesh::DenseSubVector< T >::i_off ( ) const

inline

Returns

The row offset into the parent vector.

Definition at line 98 of file dense_subvector.h.

References libMesh::DenseSubVector< T >::_i_off.

{ return _i_off; }

l1_norm()

template<typename T >

Real libMesh::DenseSubVector< T >::l1_norm ( ) const

inline

Returns

The -norm of the vector, i.e. the sum of the absolute values of the entries.

Definition at line 252 of file dense_subvector.h.

References std::abs(), and libMesh::Real.

{
  Real my_norm = 0.;
  for (unsigned int i=0; i!=this->size(); i++)
    {
      my_norm += std::abs(_parent_vector (i + this->i_off()));
    }
  return my_norm;
}

l2_norm()

template<typename T >

Real libMesh::DenseSubVector< T >::l2_norm ( ) const

inline

Returns

The -norm of the vector, i.e. the square root of the sum of the squares of the entries.

Definition at line 266 of file dense_subvector.h.

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

{
  Real my_norm = 0.;
  for (unsigned int i=0; i!=this->size(); i++)
    {
      my_norm += TensorTools::norm_sq(_parent_vector (i + this->i_off()));
    }
  return sqrt(my_norm);
}

linfty_norm()

template<typename T >

Real libMesh::DenseSubVector< T >::linfty_norm ( ) const

inline

Returns

The -norm of the vector, i.e. the maximum absolute value of the entries.

Definition at line 280 of file dense_subvector.h.

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

{
  if (!this->size())
    return 0.;
  Real my_norm = TensorTools::norm_sq(_parent_vector (this->i_off()));

  for (unsigned int i=1; i!=this->size(); i++)
    {
      Real current = TensorTools::norm_sq(_parent_vector (i + this->i_off()));
      my_norm = (my_norm > current? my_norm : current);
    }
  return sqrt(my_norm);
}

max()

template<typename T >

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

inline

Returns

The maximum element in the vector, or the maximum real part in the case of complex numbers.

Definition at line 235 of file dense_subvector.h.

References libMesh::libmesh_real(), and libMesh::Real.

{
  libmesh_assert (this->size());
  Real my_max = libmesh_real(_parent_vector (this->i_off()));

  for (unsigned int i=1; i!=this->size(); i++)
    {
      Real current = libmesh_real(_parent_vector (i + this->i_off()));
      my_max = (my_max > current? my_max : current);
    }
  return my_max;
}

min()

template<typename T >

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

inline

Returns

The minimum element in the vector, or the minimum real part in the case of complex numbers.

Definition at line 218 of file dense_subvector.h.

References libMesh::libmesh_real(), and libMesh::Real.

{
  libmesh_assert (this->size());
  Real my_min = libmesh_real(_parent_vector (this->i_off()));

  for (unsigned int i=1; i!=this->size(); i++)
    {
      Real current = libmesh_real(_parent_vector (i + this->i_off()));
      my_min = (my_min < current? my_min : current);
    }
  return my_min;
}

operator()() [1/2]

template<typename T >

const T & libMesh::DenseSubVector< T >::operator() ( const unsigned int  i ) const

inline

Returns

The (i,j) element of the subvector as a const reference.

Definition at line 197 of file dense_subvector.h.

{
  libmesh_assert_less (i, this->size());
  libmesh_assert_less (i + this->i_off(), _parent_vector.size());

  return _parent_vector (i + this->i_off());
}

operator()() [2/2]

template<typename T >

T & libMesh::DenseSubVector< T >::operator() ( const unsigned int  i )

inline

Returns

The (i,j) element of the subvector as a writable reference.

Definition at line 208 of file dense_subvector.h.

{
  libmesh_assert_less (i, this->size());
  libmesh_assert_less (i + this->i_off(), _parent_vector.size());

  return _parent_vector (i + this->i_off());
}

operator=() [1/2]

template<typename T>

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

default

operator=() [2/2]

template<typename T>

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

default

parent()

template<typename T>

DenseVector<T>& libMesh::DenseSubVector< T >::parent ( )

inline

Returns

A reference to the parent vector.

Definition at line 68 of file dense_subvector.h.

References libMesh::DenseSubVector< T >::_parent_vector.

Referenced by libMesh::DenseSubMatrix< T >::condense().

{ return _parent_vector; }

print()

template<typename T >

void libMesh::DenseVectorBase< T >::print ( std::ostream &  os ) const

inherited

Pretty-print the vector to stdout.

Definition at line 51 of file dense_vector_base.C.

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

print_scientific()

template<typename T >

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

inherited

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 : IntRange<int>(0, 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);
}

reposition()

template<typename T >

void libMesh::DenseSubVector< T >::reposition ( const unsigned int  ioff, const unsigned int  n  )

inline

Changes the location of the subvector in the parent vector.

Definition at line 173 of file dense_subvector.h.

Referenced by libMesh::DenseSubVector< T >::DenseSubVector().

{
  _i_off = ioff;
  _n = n;

  // Make sure we still fit in the parent vector.
  libmesh_assert_less_equal ((this->i_off() + this->size()), _parent_vector.size());
}

size()

template<typename T>

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

inlineoverridevirtual

Returns

The size of the vector.

Implements libMesh::DenseVectorBase< T >.

Definition at line 89 of file dense_subvector.h.

References libMesh::DenseSubVector< T >::_n.

Referenced by libMesh::NumericVector< Number >::insert().

  { return _n; }

zero()

template<typename T >

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

inlineoverridevirtual

Set every element in the vector to 0. Needs to be pure virtual since the storage method may be different in derived classes.

Implements libMesh::DenseVectorBase< T >.

Definition at line 187 of file dense_subvector.h.

{
  for (unsigned int i=0; i<this->size(); i++)
    _parent_vector (i + this->i_off()) = 0.;
}

Member Data Documentation

_i_off

template<typename T>

unsigned int libMesh::DenseSubVector< T >::_i_off

private

The offset into the parent vector.

Definition at line 152 of file dense_subvector.h.

Referenced by libMesh::DenseSubVector< T >::i_off().

_n

template<typename T>

unsigned int libMesh::DenseSubVector< T >::_n

private

The length of this subvector.

Definition at line 147 of file dense_subvector.h.

Referenced by libMesh::DenseSubVector< T >::empty(), and libMesh::DenseSubVector< T >::size().

_parent_vector

template<typename T>

DenseVector<T>& libMesh::DenseSubVector< T >::_parent_vector

private

The parent vector that contains this subvector.

Definition at line 142 of file dense_subvector.h.

Referenced by libMesh::DenseSubVector< T >::parent().

---

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

• dense_subvector.h