libMesh
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
libMesh::DenseMatrixBase< T > Class Template Referenceabstract

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

#include <dense_matrix_base.h>

Inheritance diagram for libMesh::DenseMatrixBase< T >:
[legend]

Public Member Functions

 DenseMatrixBase (DenseMatrixBase &&)=default
 The 5 special functions can be defaulted for this class, as it does not manage any memory itself. More...
 
 DenseMatrixBase (const DenseMatrixBase &)=default
 
DenseMatrixBaseoperator= (const DenseMatrixBase &)=default
 
DenseMatrixBaseoperator= (DenseMatrixBase &&)=default
 
virtual ~DenseMatrixBase ()=default
 
virtual void zero ()=0
 Set every element in the matrix to 0. More...
 
virtual T el (const unsigned int i, const unsigned int j) const =0
 
virtual T & el (const unsigned int i, const unsigned int j)=0
 
virtual void left_multiply (const DenseMatrixBase< T > &M2)=0
 Performs the operation: (*this) <- M2 * (*this) More...
 
virtual void right_multiply (const DenseMatrixBase< T > &M3)=0
 Performs the operation: (*this) <- (*this) * M3. More...
 
unsigned int m () const
 
unsigned int n () const
 
void print (std::ostream &os=libMesh::out) const
 Pretty-print the matrix, by default to libMesh::out. More...
 
void print_scientific (std::ostream &os, unsigned precision=8) const
 Prints the matrix entries with more decimal places in scientific notation. More...
 
template<typename T2 , typename T3 >
boostcopy::enable_if_c< ScalarTraits< T2 >::value, void >::type add (const T2 factor, const DenseMatrixBase< T3 > &mat)
 Adds factor to every element in the matrix. More...
 

Protected Member Functions

 DenseMatrixBase (const unsigned int new_m=0, const unsigned int new_n=0)
 Constructor. More...
 
void condense (const unsigned int i, const unsigned int j, const T val, DenseVectorBase< T > &rhs)
 Condense-out the (i,j) entry of the matrix, forcing it to take on the value val. More...
 

Static Protected Member Functions

static void multiply (DenseMatrixBase< T > &M1, const DenseMatrixBase< T > &M2, const DenseMatrixBase< T > &M3)
 Helper function - Performs the computation M1 = M2 * M3 where: M1 = (m x n) M2 = (m x p) M3 = (p x n) More...
 

Protected Attributes

unsigned int _m
 The row dimension. More...
 
unsigned int _n
 The column dimension. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const DenseMatrixBase< T > &m)
 Formatted print as above but allows you to do DenseMatrix K; libMesh::out << K << std::endl;. More...
 

Detailed Description

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

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

Specialized dense matrices, for example DenseSubMatrices, can be derived from this class.

Author
John W. Peterson
Date
2003

Definition at line 44 of file dense_matrix_base.h.

Constructor & Destructor Documentation

◆ DenseMatrixBase() [1/3]

template<typename T>
libMesh::DenseMatrixBase< T >::DenseMatrixBase ( const unsigned int  new_m = 0,
const unsigned int  new_n = 0 
)
protected

Constructor.

Creates a dense matrix of dimension m by n. Protected so that there is no way the user can create one.

Definition at line 52 of file dense_matrix_base.h.

53  : _m(new_m), _n(new_n) {}
unsigned int _n
The column dimension.
unsigned int _m
The row dimension.

◆ DenseMatrixBase() [2/3]

template<typename T>
libMesh::DenseMatrixBase< T >::DenseMatrixBase ( DenseMatrixBase< T > &&  )
default

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

◆ DenseMatrixBase() [3/3]

template<typename T>
libMesh::DenseMatrixBase< T >::DenseMatrixBase ( const DenseMatrixBase< T > &  )
default

◆ ~DenseMatrixBase()

template<typename T>
virtual libMesh::DenseMatrixBase< T >::~DenseMatrixBase ( )
virtualdefault

Member Function Documentation

◆ add()

template<typename T >
template<typename T2 , typename T3 >
boostcopy::enable_if_c< ScalarTraits< T2 >::value, void >::type libMesh::DenseMatrixBase< T >::add ( const T2  factor,
const DenseMatrixBase< T3 > &  mat 
)

Adds factor to every element in the matrix.

This should only work if T += T2 * T3 is valid C++ and if T2 is scalar. Return type is void

Definition at line 188 of file dense_matrix_base.h.

References libMesh::DenseMatrixBase< T >::el(), libMesh::DenseMatrixBase< T >::m(), and libMesh::DenseMatrixBase< T >::n().

190 {
191  libmesh_assert_equal_to (this->m(), mat.m());
192  libmesh_assert_equal_to (this->n(), mat.n());
193 
194  for (unsigned int j=0; j<this->n(); j++)
195  for (unsigned int i=0; i<this->m(); i++)
196  this->el(i,j) += factor*mat.el(i,j);
197 }
unsigned int m() const
virtual T el(const unsigned int i, const unsigned int j) const =0
unsigned int n() const

◆ condense()

template<typename T>
void libMesh::DenseMatrixBase< T >::condense ( const unsigned int  i,
const unsigned int  j,
const T  val,
DenseVectorBase< T > &  rhs 
)
protected

Condense-out the (i,j) entry of the matrix, forcing it to take on the value val.

This is useful in numerical simulations for applying boundary conditions. Preserves the symmetry of the matrix.

Referenced by libMesh::DenseMatrix< Real >::condense().

◆ el() [1/2]

template<typename T>
virtual T libMesh::DenseMatrixBase< T >::el ( const unsigned int  i,
const unsigned int  j 
) const
pure virtual
Returns
The (i,j) element of the matrix. Since internal data representations may differ, you must redefine this function.

Implemented in libMesh::DenseSubMatrix< T >, libMesh::DenseMatrix< T >, libMesh::DenseMatrix< Number >, and libMesh::DenseMatrix< Real >.

Referenced by libMesh::DenseMatrixBase< T >::add().

◆ el() [2/2]

template<typename T>
virtual T& libMesh::DenseMatrixBase< T >::el ( const unsigned int  i,
const unsigned int  j 
)
pure virtual
Returns
The (i,j) element of the matrix as a writable reference. Since internal data representations may differ, you must redefine this function.

Implemented in libMesh::DenseSubMatrix< T >, libMesh::DenseMatrix< T >, libMesh::DenseMatrix< Number >, and libMesh::DenseMatrix< Real >.

◆ left_multiply()

template<typename T>
virtual void libMesh::DenseMatrixBase< T >::left_multiply ( const DenseMatrixBase< T > &  M2)
pure virtual

Performs the operation: (*this) <- M2 * (*this)

Implemented in libMesh::DenseSubMatrix< T >, and libMesh::DenseMatrix< T >.

◆ m()

template<typename T>
unsigned int libMesh::DenseMatrixBase< T >::m ( ) const

◆ multiply()

template<typename T>
static void libMesh::DenseMatrixBase< T >::multiply ( DenseMatrixBase< T > &  M1,
const DenseMatrixBase< T > &  M2,
const DenseMatrixBase< T > &  M3 
)
staticprotected

Helper function - Performs the computation M1 = M2 * M3 where: M1 = (m x n) M2 = (m x p) M3 = (p x n)

◆ n()

template<typename T>
unsigned int libMesh::DenseMatrixBase< T >::n ( ) const

◆ operator=() [1/2]

template<typename T>
DenseMatrixBase& libMesh::DenseMatrixBase< T >::operator= ( const DenseMatrixBase< T > &  )
default

◆ operator=() [2/2]

template<typename T>
DenseMatrixBase& libMesh::DenseMatrixBase< T >::operator= ( DenseMatrixBase< T > &&  )
default

◆ print()

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

Pretty-print the matrix, by default to libMesh::out.

◆ print_scientific()

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

Prints the matrix entries with more decimal places in scientific notation.

◆ right_multiply()

template<typename T>
virtual void libMesh::DenseMatrixBase< T >::right_multiply ( const DenseMatrixBase< T > &  M3)
pure virtual

Performs the operation: (*this) <- (*this) * M3.

Implemented in libMesh::DenseMatrix< T >, and libMesh::DenseSubMatrix< T >.

◆ zero()

template<typename T>
virtual void libMesh::DenseMatrixBase< T >::zero ( )
pure virtual

Set every element in the matrix to 0.

You must redefine what you mean by zeroing the matrix since it depends on how your values are stored.

Implemented in libMesh::DenseSubMatrix< T >, libMesh::DenseMatrix< T >, libMesh::DenseMatrix< Number >, and libMesh::DenseMatrix< Real >.

Friends And Related Function Documentation

◆ operator<<

template<typename T>
std::ostream& operator<< ( std::ostream &  os,
const DenseMatrixBase< T > &  m 
)
friend

Formatted print as above but allows you to do DenseMatrix K; libMesh::out << K << std::endl;.

Definition at line 119 of file dense_matrix_base.h.

120  {
121  m.print(os);
122  return os;
123  }
unsigned int m() const

Member Data Documentation

◆ _m

template<typename T>
unsigned int libMesh::DenseMatrixBase< T >::_m
protected

The row dimension.

Definition at line 169 of file dense_matrix_base.h.

Referenced by libMesh::DenseMatrixBase< T >::m().

◆ _n

template<typename T>
unsigned int libMesh::DenseMatrixBase< T >::_n
protected

The column dimension.

Definition at line 174 of file dense_matrix_base.h.

Referenced by libMesh::DenseMatrixBase< T >::n().


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