ColumnMajorMatrixTempl< T > Class Template Reference

This class defines a Tensor that can change its shape. More...

#include <ColumnMajorMatrix.h>

Public Member Functions
	ColumnMajorMatrixTempl (const unsigned int rows=Moose::dim, const unsigned int cols=Moose::dim)
	Constructor that sets an initial number of entries and shape.
	ColumnMajorMatrixTempl (const ColumnMajorMatrixTempl< T > &rhs)
	Copy Constructor defined in terms of operator=()
	ColumnMajorMatrixTempl (const TypeTensor< T > &tensor)
	Constructor that fills in the ColumnMajorMatrixTempl with values from a libMesh TypeTensor.
	ColumnMajorMatrixTempl (const DenseMatrix< T > &rhs)
	ColumnMajorMatrixTempl (const DenseVector< T > &rhs)
	ColumnMajorMatrixTempl (const TypeVector< T > &col1, const TypeVector< T > &col2, const TypeVector< T > &col3)
	Constructor that takes in 3 vectors and uses them to create columns.
unsigned int	numEntries () const
	The total number of entries in the Tensor.
void	reshape (const unsigned int rows, const unsigned int cols)
	Change the shape of the tensor.
T &	operator() (const unsigned int i, const unsigned int j=0)
	Get the i,j entry j defaults to zero so you can use it as a column vector.
T	operator() (const unsigned int i, const unsigned int j=0) const
	Get the i,j entry.
void	print ()
	Print the tensor.
void	print_scientific (std::ostream &os)
	Prints to file.
void	fill (TypeTensor< T > &tensor)
	Fills the passed in tensor with the values from this tensor.
void	fill (DenseMatrix< T > &rhs)
	Fills the passed in dense matrix with the values from this tensor.
void	fill (DenseVector< T > &rhs)
	Fills the passed in dense vector with the values from this tensor.
ColumnMajorMatrixTempl< T >	transpose () const
	Returns a matrix that is the transpose of the matrix this was called on.
ColumnMajorMatrixTempl< T >	deviatoric ()
	Returns a matrix that is the deviatoric of the matrix this was called on.
ColumnMajorMatrixTempl< T >	abs ()
	Returns a matrix that is the absolute value of the matrix this was called on.
void	setDiag (T value)
	Set the value of each of the diagonals to the passed in value.
void	addDiag (T value)
	Add to each of the diagonals the passsed in value.
T	tr () const
	The trace of the CMM.
void	zero ()
	Zero the matrix.
void	identity ()
	Turn the matrix into an identity matrix.
T	doubleContraction (const ColumnMajorMatrixTempl< T > &rhs) const
	Double contraction of two matrices ie A : B = Sum(A_ab * B_ba)
T	norm ()
	The Euclidean norm of the matrix.
unsigned int	n () const
	Returns the number of rows.
unsigned int	m () const
	Returns the number of columns.
void	eigen (ColumnMajorMatrixTempl< T > &eval, ColumnMajorMatrixTempl< T > &evec) const
	Returns eigen system solve for a symmetric real matrix.
void	eigenNonsym (ColumnMajorMatrixTempl< T > &eval_real, ColumnMajorMatrixTempl< T > &eval_img, ColumnMajorMatrixTempl< T > &evec_right, ColumnMajorMatrixTempl< T > &eve_left) const
	Returns eigen system solve for a non-symmetric real matrix.
void	exp (ColumnMajorMatrixTempl< T > &z) const
	Returns matrix that is the exponential of the matrix this was called on.
void	inverse (ColumnMajorMatrixTempl< T > &invA) const
	Returns inverse of a general matrix.
T *	rawData ()
	Returns a reference to the raw data pointer.
const T *	rawData () const
ColumnMajorMatrixTempl< T >	kronecker (const ColumnMajorMatrixTempl< T > &rhs) const
	Kronecker Product.
ColumnMajorMatrixTempl< T > &	operator= (const TypeTensor< T > &rhs)
	Sets the values in this tensor to the values on the RHS.
ColumnMajorMatrixTempl< T > &	operator= (const DenseMatrix< T > &rhs)
	Sets the values in this dense matrix to the values on the RHS.
ColumnMajorMatrixTempl< T > &	operator= (const DenseVector< T > &rhs)
	Sets the values in this dense vector to the values on the RHS.
template<typename T2 >
ColumnMajorMatrixTempl< T > &	operator= (const ColumnMajorMatrixTempl< T2 > &rhs)
	Sets the values in this tensor to the values on the RHS Will also reshape this tensor if necessary.
ColumnMajorMatrixTempl< T > &	operator= (const ColumnMajorMatrixTempl< T > &rhs)=default
	defaulted operator=
ColumnMajorMatrixTempl< T >	operator* (T scalar) const
	Scalar multiplication of the ColumnMajorMatrixTempl.
ColumnMajorMatrixTempl< T >	operator* (const TypeVector< T > &rhs) const
	Matrix Vector Multiplication of the libMesh TypeVector Type.
ColumnMajorMatrixTempl< T >	operator* (const ColumnMajorMatrixTempl< T > &rhs) const
	Matrix Matrix Multiplication.
ColumnMajorMatrixTempl< T >	operator+ (const ColumnMajorMatrixTempl< T > &rhs) const
	Matrix Matrix Addition.
ColumnMajorMatrixTempl< T >	operator- (const ColumnMajorMatrixTempl< T > &rhs) const
	Matrix Matrix Subtraction.
ColumnMajorMatrixTempl< T > &	operator+= (const ColumnMajorMatrixTempl< T > &rhs)
	Matrix Matrix Addition plus assignment.
ColumnMajorMatrixTempl< T > &	operator+= (const TypeTensor< T > &rhs)
	Matrix Tensor Addition Plus Assignment.
ColumnMajorMatrixTempl< T > &	operator-= (const ColumnMajorMatrixTempl< T > &rhs)
	Matrix Matrix Subtraction plus assignment.
ColumnMajorMatrixTempl< T >	operator+ (T scalar) const
	Scalar addition.
ColumnMajorMatrixTempl< T > &	operator*= (T scalar)
	Scalar Multiplication plus assignment.
ColumnMajorMatrixTempl< T > &	operator/= (T scalar)
	Scalar Division plus assignment.
ColumnMajorMatrixTempl< T > &	operator+= (T scalar)
	Scalar Addition plus assignment.
void	checkSquareness () const
	Check if matrix is square.
void	checkShapeEquality (const ColumnMajorMatrixTempl< T > &rhs) const
	Check if matrices are of same shape.
bool	operator== (const ColumnMajorMatrixTempl< T > &rhs) const
	Equality operators.
bool	operator!= (const ColumnMajorMatrixTempl< T > &rhs) const
void	eigen (ColumnMajorMatrixTempl< ADReal > &, ColumnMajorMatrixTempl< ADReal > &) const
void	eigenNonsym (ColumnMajorMatrixTempl< ADReal > &, ColumnMajorMatrixTempl< ADReal > &, ColumnMajorMatrixTempl< ADReal > &, ColumnMajorMatrixTempl< ADReal > &) const
void	inverse (ColumnMajorMatrixTempl< ADReal > &) const

Protected Attributes
unsigned int	_n_rows
unsigned int	_n_cols
unsigned int	_n_entries
std::vector< T >	_values

Friends
template<typename T2 >
void	dataStore (std::ostream &, ColumnMajorMatrixTempl< T2 > &, void *)
template<typename T2 >
void	dataLoad (std::istream &, ColumnMajorMatrixTempl< T2 > &, void *)

Detailed Description

template<typename T>
class ColumnMajorMatrixTempl< T >

This class defines a Tensor that can change its shape.

This means a 3x3x3x3 Tensor can be represented as a 9x9 or an 81x1. Further, the values of this tensor are COLUMN major ordered!

Definition at line 31 of file ColumnMajorMatrix.h.

Constructor & Destructor Documentation

ColumnMajorMatrixTempl() [1/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl ( const unsigned int  rows = Moose::dim, const unsigned int  cols = Moose::dim  )

explicit

Constructor that sets an initial number of entries and shape.

Defaults to creating the same size tensor as TensorValue

Definition at line 20 of file ColumnMajorMatrix.C.

  : _n_rows(rows), _n_cols(cols), _n_entries(rows * cols), _values(rows * cols, 0.0)
{
  _values.resize(rows * cols);
}

ColumnMajorMatrixTempl() [2/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl

(

const ColumnMajorMatrixTempl< T > &

rhs

)

Copy Constructor defined in terms of operator=()

Definition at line 27 of file ColumnMajorMatrix.C.

  : _n_rows(LIBMESH_DIM), _n_cols(LIBMESH_DIM), _n_entries(_n_cols * _n_cols)
{
  *this = rhs;
}

ColumnMajorMatrixTempl() [3/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl ( const TypeTensor< T > &  tensor )

explicit

Constructor that fills in the ColumnMajorMatrixTempl with values from a libMesh TypeTensor.

Definition at line 34 of file ColumnMajorMatrix.C.

  : _n_rows(LIBMESH_DIM),
    _n_cols(LIBMESH_DIM),
    _n_entries(LIBMESH_DIM * LIBMESH_DIM),
    _values(LIBMESH_DIM * LIBMESH_DIM)
{
  for (const auto j : make_range(Moose::dim))
    for (const auto i : make_range(Moose::dim))
      (*this)(i, j) = rhs(i, j);
}

ColumnMajorMatrixTempl() [4/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl ( const DenseMatrix< T > &  rhs )

explicit

Definition at line 46 of file ColumnMajorMatrix.C.

  : _n_rows(LIBMESH_DIM), _n_cols(LIBMESH_DIM), _n_entries(_n_cols * _n_cols)
{
  *this = rhs;
}

ColumnMajorMatrixTempl() [5/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl ( const DenseVector< T > &  rhs )

explicit

Definition at line 53 of file ColumnMajorMatrix.C.

  : _n_rows(LIBMESH_DIM), _n_cols(LIBMESH_DIM), _n_entries(_n_cols * _n_cols)
{
  *this = rhs;
}

ColumnMajorMatrixTempl() [6/6]

template<typename T >

ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl	(	const TypeVector< T > &	col1,
		const TypeVector< T > &	col2,
		const TypeVector< T > &	col3
	)

Constructor that takes in 3 vectors and uses them to create columns.

Definition at line 60 of file ColumnMajorMatrix.C.

  : _n_rows(LIBMESH_DIM),
    _n_cols(LIBMESH_DIM),
    _n_entries(LIBMESH_DIM * LIBMESH_DIM),
    _values(LIBMESH_DIM * LIBMESH_DIM)
{
  unsigned int entry = 0;
  for (const auto i : make_range(Moose::dim))
    _values[entry++] = col1(i);
 
  for (const auto i : make_range(Moose::dim))
    _values[entry++] = col2(i);
 
  for (const auto i : make_range(Moose::dim))
    _values[entry++] = col3(i);
}

Member Function Documentation

abs()

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::abs ( )

inline

Returns a matrix that is the absolute value of the matrix this was called on.

Definition at line 311 of file ColumnMajorMatrix.C.

{
  using std::abs;
  ColumnMajorMatrixTempl<T> & s = (*this);
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols);
 
  for (unsigned int j = 0; j < _n_cols; j++)
    for (unsigned int i = 0; i < _n_rows; i++)
      ret_matrix(i, j) = abs(s(i, j));
 
  return ret_matrix;
}

addDiag()

template<typename T >

void ColumnMajorMatrixTempl< T >::addDiag ( T  value )

inline

Add to each of the diagonals the passsed in value.

Definition at line 496 of file ColumnMajorMatrix.h.

{
  this->checkSquareness();
 
  for (unsigned int i = 0; i < _n_rows; i++)
    (*this)(i, i) += value;
}

checkShapeEquality()

template<typename T >

void ColumnMajorMatrixTempl< T >::checkShapeEquality

(

const ColumnMajorMatrixTempl< T > &

rhs

)

const

Check if matrices are of same shape.

Definition at line 295 of file ColumnMajorMatrix.C.

{
  if (_n_rows != rhs._n_rows || _n_cols != rhs._n_cols)
    mooseError("ColumnMajorMatrix error: Unable to perform the operation on matrices of different "
               "shapes.");
}

checkSquareness()

template<typename T >

void ColumnMajorMatrixTempl< T >::checkSquareness

(

)

const

Check if matrix is square.

Definition at line 287 of file ColumnMajorMatrix.C.

{
  if (_n_rows != _n_cols)
    mooseError("ColumnMajorMatrix error: Unable to perform the operation on a non-square matrix.");
}

Referenced by ColumnMajorMatrixTempl< T >::kronecker().

deviatoric()

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::deviatoric ( )

inline

Returns a matrix that is the deviatoric of the matrix this was called on.

Definition at line 469 of file ColumnMajorMatrix.h.

{
  ColumnMajorMatrixTempl<T> & s = (*this);
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols), I(_n_rows, _n_cols);
 
  I.identity();
 
  for (unsigned int i = 0; i < _n_rows; i++)
    for (unsigned int j = 0; j < _n_cols; j++)
      ret_matrix(i, j) = s(i, j) - I(i, j) * (s.tr() / 3.0);
 
  return ret_matrix;
}

doubleContraction()

template<typename T >

T ColumnMajorMatrixTempl< T >::doubleContraction ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Double contraction of two matrices ie A : B = Sum(A_ab * B_ba)

Definition at line 540 of file ColumnMajorMatrix.h.

{
  this->checkShapeEquality(rhs);
 
  T value = 0;
 
  for (unsigned int j = 0; j < _n_cols; j++)
    for (unsigned int i = 0; i < _n_rows; i++)
      value += (*this)(i, j) * rhs(i, j);
 
  return value;
}

eigen() [1/2]

void ColumnMajorMatrixTempl< ADReal >::eigen	(	ColumnMajorMatrixTempl< ADReal > &	,
		ColumnMajorMatrixTempl< ADReal > &
	)		const

Definition at line 166 of file ColumnMajorMatrix.C.

{
  mooseError("Eigen solves with AD types is not supported.");
}

eigen() [2/2]

template<typename T >

void ColumnMajorMatrixTempl< T >::eigen	(	ColumnMajorMatrixTempl< T > &	eval,
		ColumnMajorMatrixTempl< T > &	evec
	)		const

Returns eigen system solve for a symmetric real matrix.

Definition at line 135 of file ColumnMajorMatrix.C.

{
  this->checkSquareness();
 
  char jobz = 'V';
  char uplo = 'U';
  PetscBLASInt n = _n_rows;
  PetscBLASInt return_value = 0;
 
  eval._n_rows = _n_rows;
  eval._n_cols = 1;
  eval._n_entries = _n_rows;
  eval._values.resize(_n_rows);
 
  evec = *this;
 
  T * eval_data = eval.rawData();
  T * evec_data = evec.rawData();
 
  PetscBLASInt buffer_size = n * 64;
  std::vector<T> buffer(buffer_size);
 
  LAPACKsyev_(&jobz, &uplo, &n, evec_data, &n, eval_data, &buffer[0], &buffer_size, &return_value);
 
  if (return_value)
    mooseError("error in lapack eigen solve");
}

eigenNonsym() [1/2]

void ColumnMajorMatrixTempl< ADReal >::eigenNonsym	(	ColumnMajorMatrixTempl< ADReal > &	,
		ColumnMajorMatrixTempl< ADReal > &	,
		ColumnMajorMatrixTempl< ADReal > &	,
		ColumnMajorMatrixTempl< ADReal > &
	)		const

Definition at line 228 of file ColumnMajorMatrix.C.

{
  mooseError("Eigen solves with AD types is not supported.");
}

eigenNonsym() [2/2]

template<typename T >

void ColumnMajorMatrixTempl< T >::eigenNonsym	(	ColumnMajorMatrixTempl< T > &	eval_real,
		ColumnMajorMatrixTempl< T > &	eval_img,
		ColumnMajorMatrixTempl< T > &	evec_right,
		ColumnMajorMatrixTempl< T > &	eve_left
	)		const

Returns eigen system solve for a non-symmetric real matrix.

Definition at line 174 of file ColumnMajorMatrix.C.

{
  this->checkSquareness();
 
  ColumnMajorMatrixTempl<T> a(*this);
 
  char jobvl = 'V';
  char jobvr = 'V';
  PetscBLASInt n = _n_rows;
  PetscBLASInt return_value = 0;
 
  eval_real._n_rows = _n_rows;
  eval_real._n_cols = 1;
  eval_real._n_entries = _n_rows;
  eval_real._values.resize(_n_rows);
 
  eval_img._n_rows = _n_rows;
  eval_img._n_cols = 1;
  eval_img._n_entries = _n_rows;
  eval_img._values.resize(_n_rows);
 
  T * a_data = a.rawData();
  T * eval_r = eval_real.rawData();
  T * eval_i = eval_img.rawData();
  T * evec_ri = evec_right.rawData();
  T * evec_le = evec_left.rawData();
 
  PetscBLASInt buffer_size = n * 64;
  std::vector<T> buffer(buffer_size);
 
  LAPACKgeev_(&jobvl,
              &jobvr,
              &n,
              a_data,
              &n,
              eval_r,
              eval_i,
              evec_le,
              &n,
              evec_ri,
              &n,
              &buffer[0],
              &buffer_size,
              &return_value);
 
  if (return_value)
    mooseError("error in lapack eigen solve");
}

Referenced by ColumnMajorMatrixTempl< T >::exp().

exp()

template<typename T >

void ColumnMajorMatrixTempl< T >::exp

(

ColumnMajorMatrixTempl< T > &

z

)

const

Returns matrix that is the exponential of the matrix this was called on.

Definition at line 238 of file ColumnMajorMatrix.C.

{
  using std::exp;
  this->checkSquareness();
 
  ColumnMajorMatrixTempl<T> a(*this);
  ColumnMajorMatrixTempl<T> evals_real(_n_rows, 1), evals_img(_n_rows, 1),
      evals_real2(_n_rows, _n_cols);
  ColumnMajorMatrixTempl<T> evec_right(_n_rows, _n_cols), evec_left(_n_rows, _n_cols);
  ColumnMajorMatrixTempl<T> evec_right_inverse(_n_rows, _n_cols);
 
  a.eigenNonsym(evals_real, evals_img, evec_right, evec_left);
 
  for (unsigned int i = 0; i < _n_rows; i++)
    evals_real2(i, i) = exp(evals_real(i, 0));
 
  evec_right.inverse(evec_right_inverse);
 
  z = evec_right * evals_real2 * evec_right_inverse;
}

fill() [1/3]

template<typename T >

void ColumnMajorMatrixTempl< T >::fill ( DenseMatrix< T > &  rhs )

inline

Fills the passed in dense matrix with the values from this tensor.

Definition at line 430 of file ColumnMajorMatrix.h.

{
  if (rhs.n() * rhs.m() != _n_entries)
    mooseError(
        "Cannot fill dense matrix! The ColumnMajorMatrix doesn't have the same number of entries!");
 
  for (unsigned int j = 0, index = 0; j < rhs.m(); ++j)
    for (unsigned int i = 0; i < rhs.n(); ++i, ++index)
      rhs(i, j) = _values[index];
}

fill() [2/3]

template<typename T >

void ColumnMajorMatrixTempl< T >::fill ( DenseVector< T > &  rhs )

inline

Fills the passed in dense vector with the values from this tensor.

Definition at line 443 of file ColumnMajorMatrix.h.

{
  if (_n_rows != rhs.size() || _n_cols != 1)
    mooseError("ColumnMajorMatrix and DenseVector must be the same shape for a fill!");
 
  for (unsigned int i = 0; i < _n_rows; ++i)
    rhs(i) = (*this)(i);
}

fill() [3/3]

template<typename T >

void ColumnMajorMatrixTempl< T >::fill ( TypeTensor< T > &  tensor )

inline

Fills the passed in tensor with the values from this tensor.

Definition at line 417 of file ColumnMajorMatrix.h.

{
  if (Moose::dim * Moose::dim != _n_entries)
    mooseError(
        "Cannot fill tensor! The ColumnMajorMatrix doesn't have the same number of entries!");
 
  for (const auto j : libMesh::make_range(Moose::dim))
    for (const auto i : libMesh::make_range(Moose::dim))
      tensor(i, j) = _values[j * Moose::dim + i];
}

identity()

template<typename T >

void ColumnMajorMatrixTempl< T >::identity ( )

inline

Turn the matrix into an identity matrix.

Definition at line 528 of file ColumnMajorMatrix.h.

{
  this->checkSquareness();
 
  zero();
 
  for (unsigned int i = 0; i < _n_rows; i++)
    (*this)(i, i) = 1;
}

Referenced by ColumnMajorMatrixTempl< T >::deviatoric().

inverse() [1/2]

void ColumnMajorMatrixTempl< ADReal >::inverse

(

ColumnMajorMatrixTempl< ADReal > &

)

const

Definition at line 304 of file ColumnMajorMatrix.C.

{
  mooseError("Inverse solves with AD types is not supported for the ColumnMajorMatrix class.");
}

inverse() [2/2]

template<typename T >

void ColumnMajorMatrixTempl< T >::inverse

(

ColumnMajorMatrixTempl< T > &

invA

)

const

Returns inverse of a general matrix.

Definition at line 261 of file ColumnMajorMatrix.C.

{
  this->checkSquareness();
  this->checkShapeEquality(invA);
 
  PetscBLASInt n = _n_rows;
  PetscBLASInt return_value = 0;
 
  invA = *this;
 
  std::vector<PetscBLASInt> ipiv(n);
  T * invA_data = invA.rawData();
 
  PetscBLASInt buffer_size = n * 64;
  std::vector<T> buffer(buffer_size);
 
  LAPACKgetrf_(&n, &n, invA_data, &n, &ipiv[0], &return_value);
 
  LAPACKgetri_(&n, invA_data, &n, &ipiv[0], &buffer[0], &buffer_size, &return_value);
 
  if (return_value)
    mooseException("Error in LAPACK matrix-inverse calculation");
}

Referenced by ColumnMajorMatrixTempl< T >::exp().

kronecker()

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::kronecker

(

const ColumnMajorMatrixTempl< T > &

rhs

)

const

Kronecker Product.

Definition at line 81 of file ColumnMajorMatrix.C.

{
  rhs.checkSquareness();
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows * rhs._n_rows, _n_cols * rhs._n_cols);
 
  for (unsigned int i = 0; i < _n_rows; i++)
    for (unsigned int j = 0; j < _n_cols; j++)
      for (unsigned int k = 0; k < rhs._n_rows; k++)
        for (unsigned int l = 0; l < rhs._n_cols; l++)
          ret_matrix(((i * _n_rows) + k), ((j * _n_cols) + l)) = (*this)(i, j) * rhs(k, l);
 
  return ret_matrix;
}

m()

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::m ( ) const

inline

Returns the number of columns.

Definition at line 562 of file ColumnMajorMatrix.h.

{
  return _n_cols;
}

Referenced by RankTwoTensorTempl< T >::operator=(), ColumnMajorMatrixTempl< T >::operator=(), and MetaPhysicL::RawType< ColumnMajorMatrixTempl< T > >::value().

n()

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::n ( ) const

inline

Returns the number of rows.

Definition at line 555 of file ColumnMajorMatrix.h.

{
  return _n_rows;
}

Referenced by RankTwoTensorTempl< T >::operator=(), ColumnMajorMatrixTempl< T >::operator=(), and MetaPhysicL::RawType< ColumnMajorMatrixTempl< T > >::value().

norm()

template<typename T >

T ColumnMajorMatrixTempl< T >::norm ( )

inline

The Euclidean norm of the matrix.

Definition at line 327 of file ColumnMajorMatrix.C.

{
  using std::sqrt;
  return sqrt(doubleContraction(*this));
}

numEntries()

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::numEntries ( ) const

inline

The total number of entries in the Tensor.

i.e. cols * rows

Definition at line 340 of file ColumnMajorMatrix.h.

{
  return _n_entries;
}

operator!=()

template<typename T >

bool ColumnMajorMatrixTempl< T >::operator!= ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Definition at line 800 of file ColumnMajorMatrix.h.

{
  return !(*this == rhs);
}

operator()() [1/2]

template<typename T >

T & ColumnMajorMatrixTempl< T >::operator() ( const unsigned int  i, const unsigned int  j = 0  )

inline

Get the i,j entry j defaults to zero so you can use it as a column vector.

Definition at line 365 of file ColumnMajorMatrix.h.

{
  if ((i * j) >= _n_entries)
    mooseError("Reference outside of ColumnMajorMatrix bounds!");
 
  // Row major indexing!
  return _values[(j * _n_rows) + i];
}

operator()() [2/2]

template<typename T >

T ColumnMajorMatrixTempl< T >::operator() ( const unsigned int  i, const unsigned int  j = 0  ) const

inline

Get the i,j entry.

j defaults to zero so you can use it as a column vector. This is the version used for a const ColumnMajorMatrixTempl.

Definition at line 376 of file ColumnMajorMatrix.h.

{
  if ((i * j) >= _n_entries)
    mooseError("Reference outside of ColumnMajorMatrix bounds!");
 
  // Row major indexing!
  return _values[(j * _n_rows) + i];
}

operator*() [1/3]

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator* ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Matrix Matrix Multiplication.

Definition at line 667 of file ColumnMajorMatrix.h.

{
  if (_n_cols != rhs._n_rows)
    mooseError(
        "Cannot perform matrix multiply! The shapes of the two operands are not compatible!");
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, rhs._n_cols);
 
  for (unsigned int i = 0; i < ret_matrix._n_rows; ++i)
    for (unsigned int j = 0; j < ret_matrix._n_cols; ++j)
      for (unsigned int k = 0; k < _n_cols; ++k)
        ret_matrix(i, j) += (*this)(i, k) * rhs(k, j);
 
  return ret_matrix;
}

operator*() [2/3]

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator* ( const TypeVector< T > &  rhs ) const

inline

Matrix Vector Multiplication of the libMesh TypeVector Type.

Definition at line 633 of file ColumnMajorMatrix.h.

{
  if (_n_cols != Moose::dim)
    mooseError("Cannot perform matvec operation! The column dimension of "
               "the ColumnMajorMatrix does not match the TypeVector!");
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, 1);
 
  for (unsigned int i = 0; i < _n_rows; ++i)
    for (unsigned int j = 0; j < _n_cols; ++j)
      ret_matrix._values[i] += (*this)(i, j) * rhs(j);
 
  return ret_matrix;
}

operator*() [3/3]

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator* ( T  scalar ) const

inline

Scalar multiplication of the ColumnMajorMatrixTempl.

Definition at line 621 of file ColumnMajorMatrix.h.

{
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    ret_matrix._values[i] = _values[i] * scalar;
 
  return ret_matrix;
}

operator*=()

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator*= ( T  scalar )

inline

Scalar Multiplication plus assignment.

Definition at line 764 of file ColumnMajorMatrix.h.

{
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] *= scalar;
  return *this;
}

operator+() [1/2]

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator+ ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Matrix Matrix Addition.

Definition at line 685 of file ColumnMajorMatrix.h.

{
  this->checkShapeEquality(rhs);
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    ret_matrix._values[i] = _values[i] + rhs._values[i];
 
  return ret_matrix;
}

operator+() [2/2]

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator+ ( T  scalar ) const

inline

Scalar addition.

Definition at line 752 of file ColumnMajorMatrix.h.

{
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    ret_matrix._values[i] = _values[i] + scalar;
 
  return ret_matrix;
}

operator+=() [1/3]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator+= ( const ColumnMajorMatrixTempl< T > &  rhs )

inline

Matrix Matrix Addition plus assignment.

Note that this is faster than regular addition because the result doesn't have to get copied out

Definition at line 713 of file ColumnMajorMatrix.h.

{
  this->checkShapeEquality(rhs);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] += rhs._values[i];
 
  return *this;
}

operator+=() [2/3]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator+= ( const TypeTensor< T > &  rhs )

inline

Matrix Tensor Addition Plus Assignment.

Definition at line 725 of file ColumnMajorMatrix.h.

{
  if ((_n_rows != Moose::dim) || (_n_cols != Moose::dim))
    mooseError("Cannot perform matrix addition and assignment! The shapes of the two operands are "
               "not compatible!");
 
  for (const auto j : libMesh::make_range(Moose::dim))
    for (const auto i : libMesh::make_range(Moose::dim))
      (*this)(i, j) += rhs(i, j);
 
  return *this;
}

operator+=() [3/3]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator+= ( T  scalar )

inline

Scalar Addition plus assignment.

Definition at line 782 of file ColumnMajorMatrix.h.

{
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] += scalar;
  return *this;
}

operator-()

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::operator- ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Matrix Matrix Subtraction.

Definition at line 699 of file ColumnMajorMatrix.h.

{
  this->checkShapeEquality(rhs);
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_rows, _n_cols);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    ret_matrix._values[i] = _values[i] - rhs._values[i];
 
  return ret_matrix;
}

operator-=()

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator-= ( const ColumnMajorMatrixTempl< T > &  rhs )

inline

Matrix Matrix Subtraction plus assignment.

Note that this is faster than regular subtraction because the result doesn't have to get copied out

Definition at line 740 of file ColumnMajorMatrix.h.

{
  this->checkShapeEquality(rhs);
 
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] -= rhs._values[i];
 
  return *this;
}

operator/=()

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator/= ( T  scalar )

inline

Scalar Division plus assignment.

Definition at line 773 of file ColumnMajorMatrix.h.

{
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] /= scalar;
  return *this;
}

operator=() [1/5]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator= ( const ColumnMajorMatrixTempl< T > &  rhs )

default

defaulted operator=

operator=() [2/5]

template<typename T >

template<typename T2 >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator= ( const ColumnMajorMatrixTempl< T2 > &  rhs )

inline

Sets the values in this tensor to the values on the RHS Will also reshape this tensor if necessary.

Definition at line 608 of file ColumnMajorMatrix.h.

{
  this->reshape(rhs.m(), rhs.n());
 
  for (MooseIndex(rhs.m()) i = 0; i < rhs.m(); ++i)
    for (MooseIndex(rhs.n()) j = 0; j < rhs.n(); ++j)
      (*this)(i, j) = rhs(i, j);
 
  return *this;
}

operator=() [3/5]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator=

(

const DenseMatrix< T > &

rhs

)

Sets the values in this dense matrix to the values on the RHS.

Will also reshape this tensor if necessary.

Definition at line 98 of file ColumnMajorMatrix.C.

{
  if (_n_rows != rhs.m() || _n_cols != rhs.n())
    mooseError("ColumnMajorMatrix and DenseMatrix should be of the same shape.");
 
  _n_rows = rhs.m();
  _n_cols = rhs.n();
  _n_entries = rhs.m() * rhs.n();
  _values.resize(rhs.m() * rhs.n());
 
  for (unsigned int j = 0; j < _n_cols; ++j)
    for (unsigned int i = 0; i < _n_rows; ++i)
      (*this)(i, j) = rhs(i, j);
 
  return *this;
}

operator=() [4/5]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator=

(

const DenseVector< T > &

rhs

)

Sets the values in this dense vector to the values on the RHS.

Will also reshape this tensor if necessary.

Definition at line 117 of file ColumnMajorMatrix.C.

{
  if (_n_rows != rhs.size() || _n_cols != 1)
    mooseError("ColumnMajorMatrix and DenseVector should be of the same shape.");
 
  _n_rows = rhs.size();
  _n_cols = 1;
  _n_entries = rhs.size();
  _values.resize(rhs.size());
 
  for (unsigned int i = 0; i < _n_rows; ++i)
    (*this)(i) = rhs(i);
 
  return *this;
}

operator=() [5/5]

template<typename T >

ColumnMajorMatrixTempl< T > & ColumnMajorMatrixTempl< T >::operator= ( const TypeTensor< T > &  rhs )

inline

Sets the values in this tensor to the values on the RHS.

Will also reshape this tensor if necessary.

Definition at line 583 of file ColumnMajorMatrix.h.

{
  // Resize the tensor if necessary
  if ((Moose::dim * Moose::dim) != _n_entries)
  {
    _n_entries = Moose::dim * Moose::dim;
    _values.resize(_n_entries);
  }
 
  // Make sure the shape is correct
  reshape(Moose::dim, Moose::dim);
 
  ColumnMajorMatrixTempl<T> & s = (*this);
 
  // Copy the values
  for (unsigned int j = 0; j < _n_cols; j++)
    for (unsigned int i = 0; i < _n_cols; i++)
      s(i, j) = rhs(i, j);
 
  return *this;
}

operator==()

template<typename T >

bool ColumnMajorMatrixTempl< T >::operator== ( const ColumnMajorMatrixTempl< T > &  rhs ) const

inline

Equality operators.

Definition at line 791 of file ColumnMajorMatrix.h.

{
  if (_n_entries != rhs._n_entries || _n_rows != rhs._n_rows || _n_cols != rhs._n_cols)
    return false;
  return std::equal(_values.begin(), _values.end(), rhs._values.begin());
}

print()

template<typename T >

void ColumnMajorMatrixTempl< T >::print ( )

inline

Print the tensor.

Definition at line 387 of file ColumnMajorMatrix.h.

{
  ColumnMajorMatrixTempl<T> & s = (*this);
 
  for (unsigned int i = 0; i < _n_rows; i++)
  {
    for (unsigned int j = 0; j < _n_cols; j++)
      Moose::out << std::setw(15) << s(i, j) << " ";
 
    Moose::out << std::endl;
  }
}

print_scientific()

template<typename T >

void ColumnMajorMatrixTempl< T >::print_scientific ( std::ostream &  os )

inline

Prints to file.

Definition at line 402 of file ColumnMajorMatrix.h.

{
  ColumnMajorMatrixTempl<T> & s = (*this);
 
  for (unsigned int i = 0; i < _n_rows; i++)
  {
    for (unsigned int j = 0; j < _n_cols; j++)
      os << std::setw(15) << std::scientific << std::setprecision(8) << s(i, j) << " ";
 
    os << std::endl;
  }
}

rawData() [1/2]

template<typename T >

T * ColumnMajorMatrixTempl< T >::rawData ( )

inline

Returns a reference to the raw data pointer.

Definition at line 569 of file ColumnMajorMatrix.h.

{
  return &_values[0];
}

Referenced by ColumnMajorMatrixTempl< T >::eigen(), and ColumnMajorMatrixTempl< T >::inverse().

rawData() [2/2]

template<typename T >

const T * ColumnMajorMatrixTempl< T >::rawData ( ) const

inline

Definition at line 576 of file ColumnMajorMatrix.h.

{
  return &_values[0];
}

reshape()

template<typename T >

void ColumnMajorMatrixTempl< T >::reshape ( const unsigned int  rows, const unsigned int  cols  )

inline

Change the shape of the tensor.

Note that cols * rows should be equal to numEntries()!

Definition at line 347 of file ColumnMajorMatrix.h.

{
  if (cols * rows == _n_entries)
  {
    _n_rows = rows;
    _n_cols = cols;
  }
  else
  {
    _n_rows = rows;
    _n_cols = cols;
    _n_entries = _n_rows * _n_cols;
    _values.resize(_n_entries);
  }
}

Referenced by PiecewiseBilinear::parse(), and PiecewiseBilinear::PiecewiseBilinear().

setDiag()

template<typename T >

void ColumnMajorMatrixTempl< T >::setDiag ( T  value )

inline

Set the value of each of the diagonals to the passed in value.

Definition at line 486 of file ColumnMajorMatrix.h.

{
  this->checkSquareness();
 
  for (unsigned int i = 0; i < _n_rows; i++)
    (*this)(i, i) = value;
}

tr()

template<typename T >

T ColumnMajorMatrixTempl< T >::tr ( ) const

inline

The trace of the CMM.

Definition at line 506 of file ColumnMajorMatrix.h.

{
  this->checkSquareness();
 
  T trace = 0;
 
  for (unsigned int i = 0; i < _n_rows; i++)
    trace += (*this)(i, i);
 
  return trace;
}

Referenced by ColumnMajorMatrixTempl< T >::deviatoric().

transpose()

template<typename T >

ColumnMajorMatrixTempl< T > ColumnMajorMatrixTempl< T >::transpose ( ) const

inline

Returns a matrix that is the transpose of the matrix this was called on.

Definition at line 454 of file ColumnMajorMatrix.h.

{
  const ColumnMajorMatrixTempl<T> & s = (*this);
 
  ColumnMajorMatrixTempl<T> ret_matrix(_n_cols, _n_rows);
 
  for (unsigned int i = 0; i < _n_rows; i++)
    for (unsigned int j = 0; j < _n_cols; j++)
      ret_matrix(j, i) = s(i, j);
 
  return ret_matrix;
}

zero()

template<typename T >

void ColumnMajorMatrixTempl< T >::zero ( )

inline

Zero the matrix.

Definition at line 520 of file ColumnMajorMatrix.h.

{
  for (unsigned int i = 0; i < _n_entries; i++)
    _values[i] = 0;
}

Friends And Related Symbol Documentation

dataLoad

template<typename T >

template<typename T2 >

void dataLoad ( std::istream &  , ColumnMajorMatrixTempl< T2 > &  , void *    )

friend

dataStore

template<typename T >

template<typename T2 >

void dataStore ( std::ostream &  , ColumnMajorMatrixTempl< T2 > &  , void *    )

friend

Member Data Documentation

_n_cols

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::_n_cols

protected

Definition at line 329 of file ColumnMajorMatrix.h.

Referenced by ColumnMajorMatrixTempl< T >::checkShapeEquality(), ColumnMajorMatrixTempl< T >::eigen(), ColumnMajorMatrixTempl< T >::kronecker(), ColumnMajorMatrixTempl< T >::operator*(), and ColumnMajorMatrixTempl< T >::operator==().

_n_entries

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::_n_entries

protected

Definition at line 329 of file ColumnMajorMatrix.h.

Referenced by ColumnMajorMatrixTempl< T >::eigen(), and ColumnMajorMatrixTempl< T >::operator==().

_n_rows

template<typename T >

unsigned int ColumnMajorMatrixTempl< T >::_n_rows

protected

Definition at line 329 of file ColumnMajorMatrix.h.

Referenced by ColumnMajorMatrixTempl< T >::checkShapeEquality(), ColumnMajorMatrixTempl< T >::eigen(), ColumnMajorMatrixTempl< T >::kronecker(), ColumnMajorMatrixTempl< T >::operator*(), and ColumnMajorMatrixTempl< T >::operator==().

_values

template<typename T >

std::vector<T> ColumnMajorMatrixTempl< T >::_values

protected

Definition at line 330 of file ColumnMajorMatrix.h.

Referenced by ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl(), ColumnMajorMatrixTempl< T >::ColumnMajorMatrixTempl(), dataLoad(), dataStore(), ColumnMajorMatrixTempl< T >::eigen(), ColumnMajorMatrixTempl< T >::operator*(), ColumnMajorMatrixTempl< T >::operator*(), ColumnMajorMatrixTempl< T >::operator+(), ColumnMajorMatrixTempl< T >::operator+(), ColumnMajorMatrixTempl< T >::operator+=(), ColumnMajorMatrixTempl< T >::operator-(), ColumnMajorMatrixTempl< T >::operator-=(), and ColumnMajorMatrixTempl< T >::operator==().

---

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

• include/functions/PiecewiseBilinear.h
• include/utils/ColumnMajorMatrix.h
• src/utils/ColumnMajorMatrix.C