A templated 2D square symmetric matrix of objects of <T>, where the n x n matrix dimension is known and used for subscript bounds checking, etc. More...

Inheritance diagram for SymmetricSquareMatrix< Type >:

[legend]

Collaboration diagram for SymmetricSquareMatrix< Type >:

[legend]

Public Member Functions
	SymmetricSquareMatrix ()
	Null constructor. More...

	SymmetricSquareMatrix (const label n)
	Construct given number of rows/columns. More...

	SymmetricSquareMatrix (const label n, const zero)
	Construct given number of rows/columns, initialising to zero. More...

	SymmetricSquareMatrix (const label n, const Identity< Type >)
	Construct given number of rows/columns,. More...

	SymmetricSquareMatrix (const label n, const Type &)
	Construct with given number of rows/columns. More...

template<class InputIterator >
	SymmetricSquareMatrix (const label n, InputIterator first, InputIterator last)
	Construct with given number of rows/columns. More...

	SymmetricSquareMatrix (const label n, std::initializer_list< Type >)
	Construct with given number of rows/columns and initialiser list. More...

	SymmetricSquareMatrix (std::initializer_list< Type >)
	Construct from an initialiser list. More...

	SymmetricSquareMatrix (std::initializer_list< std::initializer_list< Type >>)
	Construct from initialiser list list. More...

	SymmetricSquareMatrix (Istream &)
	Construct from Istream. More...

autoPtr< SymmetricSquareMatrix< Type > >	clone () const
	Clone. More...

Public Member Functions inherited from Matrix< SymmetricSquareMatrix< Type >, Type >
	Matrix ()
	Null constructor. More...

	Matrix (const label m, const label n)
	Construct given number of rows and columns. More...

	Matrix (const label m, const label n, const zero)
	Construct with given number of rows and columns. More...

	Matrix (const label m, const label n, const Type &)
	Construct with given number of rows and columns. More...

	Matrix (const label m, const label n, InputIterator first, InputIterator last)
	Construct with given number of rows and columns. More...

	Matrix (const label m, const label n, std::initializer_list< Type >)
	Construct with given number of rows and columns and initialiser list. More...

	Matrix (std::initializer_list< std::initializer_list< Type >>)
	Construct from initialiser list list. More...

	Matrix (const mType &)
	Copy constructor. More...

	Matrix (const Matrix< Form2, Type > &)
	Copy constructor from matrix of a different form. More...

	Matrix (const ConstMatrixBlock< MatrixType > &)
	Construct from a block of another matrix. More...

	Matrix (const MatrixBlock< MatrixType > &)
	Construct from a block of another matrix. More...

	Matrix (const MatrixSpace< MSForm, Type, Mrows, Ncols > &)

	Matrix (Istream &)
	Construct from Istream. More...

autoPtr< mType >	clone () const
	Clone. More...

	~Matrix ()
	Destructor. More...

label	m () const
	Return the number of rows. More...

label	n () const
	Return the number of columns. More...

label	size () const
	Return the number of elements in matrix (m*n) More...

const Type *	v () const
	Return element vector of the constant Matrix. More...

Type *	v ()
	Return element vector of the Matrix. More...

ConstMatrixBlock< mType >	block (const label m, const label n, const label mStart, const label nStart) const

ConstMatrixBlock< mType >	block (const label mStart, const label nStart) const

MatrixBlock< mType >	block (const label m, const label n, const label mStart, const label nStart)

MatrixBlock< mType >	block (const label mStart, const label nStart)

Foam::ConstMatrixBlock< Foam::Matrix< SymmetricSquareMatrix< Type >, Type > >	block (const label mStart, const label nStart) const

Foam::MatrixBlock< Foam::Matrix< SymmetricSquareMatrix< Type >, Type > >	block (const label mStart, const label nStart)

ConstMatrixBlock< mType >	col (const label m, const label rowStart) const

ConstMatrixBlock< mType >	col (const label m, const label mStart, const label nStart) const

MatrixBlock< mType >	col (const label m, const label rowStart)

MatrixBlock< mType >	col (const label m, const label mStart, const label nStart)

void	checki (const label i) const
	Check index i is within valid range (0 ... m-1). More...

void	checkj (const label j) const
	Check index j is within valid range (0 ... n-1). More...

void	clear ()
	Clear the Matrix, i.e. set sizes to zero. More...

void	transfer (mType &)
	Transfer the contents of the argument Matrix into this Matrix. More...

void	setSize (const label m, const label n)
	Resize the matrix preserving the elements. More...

void	shallowResize (const label m, const label n)
	Resize the matrix without reallocating storage (unsafe) More...

SymmetricSquareMatrix< Type >	T () const
	Return the transpose of the matrix. More...

Type *	operator[] (const label)
	Return subscript-checked row of Matrix. More...

const Type *	operator[] (const label) const
	Return subscript-checked row of constant Matrix. More...

const Type &	operator() (const label i, const label j) const
	(i, j) const element access operator More...

Type &	operator() (const label i, const label j)
	(i, j) element access operator More...

void	operator= (const mType &)
	Assignment operator. Takes linear time. More...

void	operator= (const ConstMatrixBlock< MatrixType > &)
	Assignment to a block of another matrix. More...

void	operator= (const MatrixBlock< MatrixType > &)
	Assignment to a block of another matrix. More...

void	operator= (const zero)
	Assignment of all elements to zero. More...

void	operator= (const Type &)
	Assignment of all elements to the given value. More...

Static Public Member Functions
static word	typeName ()
	Return the instantiated type name. More...

Static Public Member Functions inherited from Matrix< SymmetricSquareMatrix< Type >, Type >
static const mType &	null ()
	Return a null Matrix. More...

Additional Inherited Members
Public Types inherited from Matrix< SymmetricSquareMatrix< Type >, Type >
typedef Matrix< SymmetricSquareMatrix< Type >, Type >	mType
	Matrix type. More...

typedef Type	cmptType
	Component type. More...

Detailed Description

template<class Type>
class Foam::SymmetricSquareMatrix< Type >

A templated 2D square symmetric matrix of objects of <T>, where the n x n matrix dimension is known and used for subscript bounds checking, etc.

Source files

Definition at line 52 of file SymmetricSquareMatrix.H.

Constructor & Destructor Documentation

◆ SymmetricSquareMatrix() [1/10]

SymmetricSquareMatrix

inline

Null constructor.

Definition at line 29 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [2/10]

SymmetricSquareMatrix ( const label n )

inline

Construct given number of rows/columns.

Definition at line 36 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [3/10]

SymmetricSquareMatrix	(	const label	n,
		const	zero
	)

inline

Construct given number of rows/columns, initialising to zero.

Definition at line 43 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [4/10]

SymmetricSquareMatrix	(	const label	n,
		const Identity< Type >
	)

inline

Construct given number of rows/columns,.

Definition at line 54 of file SymmetricSquareMatrixI.H.

References Matrix< SymmetricSquareMatrix< Type >, Type >::n(), and Matrix< SymmetricSquareMatrix< Type >, Type >::operator()().

Here is the call graph for this function:

◆ SymmetricSquareMatrix() [5/10]

SymmetricSquareMatrix	(	const label	n,
		const Type &	t
	)

inline

Construct with given number of rows/columns.

initialising all elements to the given value

Definition at line 70 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [6/10]

SymmetricSquareMatrix	(	const label	n,
		InputIterator	first,
		InputIterator	last
	)

inline

Construct with given number of rows/columns.

and start and end iterators

Definition at line 82 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [7/10]

SymmetricSquareMatrix	(	const label	n,
		std::initializer_list< Type >	lst
	)

inline

Construct with given number of rows/columns and initialiser list.

Definition at line 94 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [8/10]

SymmetricSquareMatrix ( std::initializer_list< Type > lst )

inline

Construct from an initialiser list.

Definition at line 124 of file SymmetricSquareMatrixI.H.

◆ SymmetricSquareMatrix() [9/10]

SymmetricSquareMatrix ( std::initializer_list< std::initializer_list< Type >> lstLst )

inline

Construct from initialiser list list.

Definition at line 105 of file SymmetricSquareMatrixI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Matrix< SymmetricSquareMatrix< Type >, Type >::m(), Matrix< SymmetricSquareMatrix< Type >, Type >::n(), and Foam::nl.

Here is the call graph for this function:

◆ SymmetricSquareMatrix() [10/10]

SymmetricSquareMatrix ( Istream & is )

inline

Construct from Istream.

Definition at line 134 of file SymmetricSquareMatrixI.H.

Member Function Documentation

◆ clone()

Foam::autoPtr< Foam::SymmetricSquareMatrix< Type > > clone

inline

Clone.

Definition at line 142 of file SymmetricSquareMatrixI.H.

◆ typeName()

static word typeName ( )

inlinestatic

Return the instantiated type name.

Definition at line 113 of file SymmetricSquareMatrix.H.

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

src/OpenFOAM/matrices/SymmetricSquareMatrix/SymmetricSquareMatrix.H
src/OpenFOAM/matrices/SymmetricSquareMatrix/SymmetricSquareMatrixI.H

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::SymmetricSquareMatrix< Type >

Constructor & Destructor Documentation

◆ SymmetricSquareMatrix() [1/10]

◆ SymmetricSquareMatrix() [2/10]

◆ SymmetricSquareMatrix() [3/10]

◆ SymmetricSquareMatrix() [4/10]

◆ SymmetricSquareMatrix() [5/10]

◆ SymmetricSquareMatrix() [6/10]

◆ SymmetricSquareMatrix() [7/10]

◆ SymmetricSquareMatrix() [8/10]

◆ SymmetricSquareMatrix() [9/10]

◆ SymmetricSquareMatrix() [10/10]

Member Function Documentation

◆ clone()

◆ typeName()

template<class Type>
class Foam::SymmetricSquareMatrix< Type >