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

Inheritance diagram for simpleMatrix< Type >:

Public Member Functions
	simpleMatrix (const label)
	Construct given size. More...

	simpleMatrix (const label, const scalar, const Type &)
	Construct given size and initial values for coefficients and source. More...

	simpleMatrix (const scalarSquareMatrix &, const Field< Type > &)
	Construct from components. More...

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

	simpleMatrix (const simpleMatrix< Type > &)
	Construct as copy. More...

Field< Type > &	source ()
	Return access to the source. More...

const Field< Type > &	source () const
	Return const-access to the source. More...

Field< Type >	solve () const
	Solve the matrix using Gaussian elimination with pivoting. More...

Field< Type >	LUsolve () const
	Solve the matrix using LU decomposition with pivoting. More...

void	operator= (const simpleMatrix< Type > &)

Friends
Ostream &	operator (Ostream &, const simpleMatrix< Type > &)

Detailed Description

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

A simple square matrix solver with scalar coefficients.

Source files

Definition at line 49 of file simpleMatrix.H.

Constructor & Destructor Documentation

◆ simpleMatrix() [1/5]

simpleMatrix ( const label mSize )

Construct given size.

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

Definition at line 34 of file simpleMatrix.C.

◆ simpleMatrix() [2/5]

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

Construct given size and initial values for coefficients and source.

Definition at line 43 of file simpleMatrix.C.

◆ simpleMatrix() [3/5]

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

Construct from components.

Definition at line 56 of file simpleMatrix.C.

◆ simpleMatrix() [4/5]

simpleMatrix ( Istream & is )

Construct from Istream.

Definition at line 67 of file simpleMatrix.C.

◆ simpleMatrix() [5/5]

simpleMatrix ( const simpleMatrix< Type > & )

Construct as copy.

Member Function Documentation

◆ source() [1/2]

Field<Type>& source ( )

inline

Return access to the source.

Definition at line 99 of file simpleMatrix.H.

◆ source() [2/2]

const Field<Type>& source ( ) const

inline

Return const-access to the source.

Definition at line 105 of file simpleMatrix.H.

◆ solve()

Foam::Field< Type > solve ( ) const

Solve the matrix using Gaussian elimination with pivoting.

and return the solution

Definition at line 77 of file simpleMatrix.C.

◆ LUsolve()

Foam::Field< Type > LUsolve ( ) const

Solve the matrix using LU decomposition with pivoting.

and return the solution

Definition at line 89 of file simpleMatrix.C.

◆ operator=()

void operator= ( const simpleMatrix< Type > & m )

Definition at line 103 of file simpleMatrix.C.

Friends And Related Function Documentation

◆ operator

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

Public Member Functions

Friends