simpleMatrix Class Reference

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

Collaboration diagram for simpleMatrix:

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 > &)

Private Attributes
Field< Type >	source_

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

Detailed Description

A simple square matrix solver with scalar coefficients.

Source files

• simpleMatrix.H
• simpleMatrix.C

Definition at line 47 of file simpleMatrix.H.

Constructor & Destructor Documentation

simpleMatrix() [1/5]

simpleMatrix

(

const

label

)

Construct given size.

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

simpleMatrix() [2/5]

simpleMatrix	(	const	label,
		const	scalar,
		const Type &
	)

Construct given size and initial values for coefficients and source.

simpleMatrix() [3/5]

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

Construct from components.

simpleMatrix() [4/5]

simpleMatrix

(

Istream &

)

Construct from Istream.

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 97 of file simpleMatrix.H.

References simpleMatrix::source_.

Referenced by quadricFitting::calculateQuadricCoeffs(), and main().

Here is the caller graph for this function:

source() [2/2]

const Field<Type>& source ( ) const

inline

Return const-access to the source.

Definition at line 103 of file simpleMatrix.H.

References simpleMatrix::source_.

solve()

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().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

LUsolve()

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 quadricFitting::calculateQuadricCoeffs(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator=

(

const simpleMatrix< Type > &

m

)

Definition at line 100 of file simpleMatrix.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, n, Matrix< SquareMatrix< scalar >, scalar >::operator=(), and simpleMatrix::source_.

Here is the call graph for this function:

Friends And Related Function Documentation

operator

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

friend

Field Documentation

source_

Field<Type> source_

private

Definition at line 68 of file simpleMatrix.H.

Referenced by simpleMatrix::operator=(), and simpleMatrix::source().

---

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

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