simpleMatrix< Type > Class Template Reference

A simple square matrix solver with scalar coefficients. More...

#include <OpenFOAM/simpleMatrix.H>

---

Detailed Description

template<class Type>
class Foam::simpleMatrix< Type >

A simple square matrix solver with scalar coefficients.

Source files

• src/OpenFOAM/matrices/simpleMatrix/simpleMatrix.H
• src/OpenFOAM/matrices/simpleMatrix/simpleMatrix.C

Definition at line 63 of file simpleMatrix.H.

Inheritance diagram for simpleMatrix< Type >:

Collaboration diagram for simpleMatrix< Type >:

List of all members.

Public Member Functions
	simpleMatrix (const label)
	Construct given size.
	simpleMatrix (const label, const scalar, const Type &)
	Construct given size and initial values for the.
	simpleMatrix (const scalarSquareMatrix &, const Field< Type > &)
	Construct from components.
	simpleMatrix (Istream &)
	Construct from Istream.
	simpleMatrix (const simpleMatrix< Type > &)
	Construct as copy.
Field< Type > &	source ()
	Return access to the source.
const Field< Type > &	source () const
	Return const-access to the source.
Field< Type >	solve () const
	Solve the matrix using Gaussian elimination with pivoting.
Field< Type >	LUsolve () const
	Solve the matrix using LU decomposition with pivoting.
void	operator= (const simpleMatrix< Type > &)
Friends
Ostream &	operator (Ostream &, const simpleMatrix< Type > &)

---

Constructor & Destructor Documentation

simpleMatrix

(

const label

mSize  )

Construct given size.

Note: this does not initialise the coefficients or the source.

Definition at line 31 of file simpleMatrix.C.

simpleMatrix	(	const label	mSize,
		const scalar	coeffVal,
		const Type &	sourceVal
	)

Construct given size and initial values for the.

coefficients and source

Definition at line 40 of file simpleMatrix.C.

simpleMatrix	(	const scalarSquareMatrix &	matrix,
		const Field< Type > &	source
	)

Construct from components.

Definition at line 53 of file simpleMatrix.C.

simpleMatrix

(

Istream &

is  )

Construct from Istream.

Definition at line 64 of file simpleMatrix.C.

simpleMatrix

(

const simpleMatrix< Type > &

)

Construct as copy.

---

Member Function Documentation

Field<Type>& source

(

)

[inline]

Return access to the source.

Definition at line 99 of file simpleMatrix.H.

Referenced by EulerImplicit< CompType, ThermoType >::solve().

const Field<Type>& source

(

)

const [inline]

Return const-access to the source.

Definition at line 105 of file simpleMatrix.H.

Foam::Field< Type > solve

(

)

const

Solve the matrix using Gaussian elimination with pivoting.

and return the solution

Definition at line 74 of file simpleMatrix.C.

References Foam::solve().

Foam::Field< Type > LUsolve

(

)

const

Solve the matrix using LU decomposition with pivoting.

and return the solution

Definition at line 86 of file simpleMatrix.C.

References Foam::LUsolve().

Referenced by EulerImplicit< CompType, ThermoType >::solve().

void operator=

(

const simpleMatrix< Type > &

m  )

Definition at line 100 of file simpleMatrix.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, Matrix< SquareMatrix< Type >, Type >::n(), and Matrix< SquareMatrix< scalar >, scalar >::operator=().

---

Friends And Related Function Documentation

Ostream& operator	(	Ostream &	,
		const simpleMatrix< Type > &
	)		[friend]

---

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

• src/OpenFOAM/matrices/simpleMatrix/simpleMatrix.H
• src/OpenFOAM/matrices/simpleMatrix/simpleMatrix.C