SymmetricSquareMatrix< Type > Class Template Reference

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 >:

Collaboration diagram for SymmetricSquareMatrix< Type >:

Public Member Functions
	SymmetricSquareMatrix ()
	Null constructor. More...
	SymmetricSquareMatrix (const label n)
	Construct given number of rows/columns. More...
	SymmetricSquareMatrix (const label m, const label n)
	Construct with given number of rows/columns. More...
	SymmetricSquareMatrix (const label m, const label n, const Type &)
	Construct with given number of rows/columns. More...
	SymmetricSquareMatrix (Istream &)
	Construct from Istream. More...
autoPtr< SymmetricSquareMatrix< Type > >	clone () const
	Clone. More...
Type &	operator() (const label r, const label c)
	Return subscript-checked row of Matrix. More...
const Type &	operator() (const label r, const label c) const
	Return subscript-checked row of constant Matrix. More...
Public Member Functions inherited from Matrix< SymmetricSquareMatrix< Type >, Type >
	Matrix ()
	Null constructor. More...
	Matrix (const label n, const label m)
	Construct given number of rows and columns. More...
	Matrix (const label n, const label m, const Type &)
	Construct with given number of rows and columns. More...
	Matrix (const Matrix< Form, Type > &)
	Copy constructor. More...
	Matrix (Istream &)
	Construct from Istream. More...
autoPtr< Matrix< Form, Type > >	clone () const
	Clone. More...
	~Matrix ()
	Destructor. More...
label	n () const
	Return the number of rows. More...
label	m () const
	Return the number of columns. More...
label	size () const
	Return the number of elements in matrix (n*m) More...
void	checki (const label i) const
	Check index i is within valid range (0 ... n-1). More...
void	checkj (const label j) const
	Check index j is within valid range (0 ... m-1). More...
void	clear ()
	Clear the Matrix, i.e. set sizes to zero. More...
void	transfer (Matrix< Form, Type > &)
	Transfer the contents of the argument Matrix into this Matrix. More...
Form	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...
void	operator= (const Matrix< Form, Type > &)
	Assignment operator. Takes linear time. More...
void	operator= (const Type &)
	Assignment of all entries to the given value. More...

Additional Inherited Members
Static Public Member Functions inherited from Matrix< SymmetricSquareMatrix< Type >, Type >
static const Matrix< Form, Type > &	null ()
	Return a null Matrix. 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

• SymmetricSquareMatrix.H
• SymmetricSquareMatrixI.H
• SymmetricSquareMatrix.C

Definition at line 51 of file SymmetricSquareMatrix.H.

Constructor & Destructor Documentation

SymmetricSquareMatrix() [1/5]

SymmetricSquareMatrix

inline

Null constructor.

Definition at line 29 of file SymmetricSquareMatrixI.H.

SymmetricSquareMatrix() [2/5]

SymmetricSquareMatrix ( const label  n )

inline

Construct given number of rows/columns.

Definition at line 36 of file SymmetricSquareMatrixI.H.

SymmetricSquareMatrix() [3/5]

SymmetricSquareMatrix ( const label  m, const label  n  )

inline

Construct with given number of rows/columns.

Definition at line 44 of file SymmetricSquareMatrixI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and n.

Here is the call graph for this function:

SymmetricSquareMatrix() [4/5]

SymmetricSquareMatrix ( const label  m, const label  n, const Type &  t  )

inline

Construct with given number of rows/columns.

and value for all elements.

Definition at line 62 of file SymmetricSquareMatrixI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and n.

Here is the call graph for this function:

SymmetricSquareMatrix() [5/5]

SymmetricSquareMatrix ( Istream &  is )

inline

Construct from Istream.

Definition at line 80 of file SymmetricSquareMatrixI.H.

Member Function Documentation

clone()

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

inline

Clone.

Definition at line 88 of file SymmetricSquareMatrixI.H.

operator()() [1/2]

Type & operator() ( const label  r, const label  c  )

inline

Return subscript-checked row of Matrix.

Definition at line 99 of file SymmetricSquareMatrixI.H.

References Foam::constant::universal::c.

operator()() [2/2]

const Type & operator() ( const label  r, const label  c  ) const

inline

Return subscript-checked row of constant Matrix.

Definition at line 117 of file SymmetricSquareMatrixI.H.

References Foam::constant::universal::c.

---

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

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