Inheritance diagram for DiagonalSolver< Type, DType, LUType >:

Collaboration diagram for DiagonalSolver< Type, DType, LUType >:

Public Member Functions
	DiagonalSolver (const DiagonalSolver &)=delete
	No copy construct. More...

void	operator= (const DiagonalSolver &)=delete
	No copy assignment. More...

	TypeName ("diagonal")
	Runtime type information. More...

	DiagonalSolver (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
	Construct from matrix. More...

void	read (const dictionary &solverDict)
	Read and reset the solver parameters from the given dictionary. More...

virtual SolverPerformance< Type >	solve (Field< Type > &psi) const
	Solve the matrix with this solver. More...

Public Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, solver, symMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict),(fieldName, matrix, solverDict))

	declareRunTimeSelectionTable (autoPtr, solver, asymMatrix,(const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict),(fieldName, matrix, solverDict))

	solver (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
	Construct for given field name, matrix and controls. More...

virtual	~solver ()=default
	Destructor. More...

const word &	fieldName () const noexcept

const LduMatrix< Type, DType, LUType > &	matrix () const noexcept

Type	normFactor (const Field< Type > &psi, const Field< Type > &Apsi, Field< Type > &tmpField, const lduMatrix::normTypes normType) const
	Return the matrix norm using the specified norm method. More...

Type	normFactor (const Field< Type > &psi, const Field< Type > &Apsi, Field< Type > &tmpField) const
	Return the matrix norm used to normalise the residual for the stopping criterion. More...

Additional Inherited Members
Static Public Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
static autoPtr< solver >	New (const word &fieldName, const LduMatrix< Type, DType, LUType > &matrix, const dictionary &solverDict)
	Return a new solver. More...

Protected Member Functions inherited from LduMatrix< Type, DType, LUType >::solver
virtual void	readControls ()
	Read the control parameters from controlDict_. More...

template<class T >
void	readControl (const dictionary &dict, T &val, const word &key)
	Deprecated(2021-09) Read control parameter from dictionary. More...

Protected Attributes inherited from LduMatrix< Type, DType, LUType >::solver
word	fieldName_

const LduMatrix< Type, DType, LUType > &	matrix_

dictionary	controlDict_
	Dictionary of solution controls. More...

int	log_
	Verbosity level for solver output statements. More...

label	minIter_
	Minimum number of iterations in the solver. More...

label	maxIter_
	Maximum number of iterations in the solver. More...

lduMatrix::normTypes	normType_
	The matrix normalisation type. More...

Type	tolerance_
	Final convergence tolerance. More...

Type	relTol_
	Convergence tolerance relative to the initial. More...

Detailed Description

template<class Type, class DType, class LUType>
class Foam::DiagonalSolver< Type, DType, LUType >

Foam::DiagonalSolver.

Source files

Definition at line 47 of file DiagonalSolver.H.

Constructor & Destructor Documentation

◆ DiagonalSolver() [1/2]

DiagonalSolver ( const DiagonalSolver< Type, DType, LUType > & )

delete

No copy construct.

◆ DiagonalSolver() [2/2]

DiagonalSolver	(	const word &	fieldName,
		const LduMatrix< Type, DType, LUType > &	matrix,
		const dictionary &	solverDict
	)

Construct from matrix.

Definition at line 27 of file DiagonalSolver.C.

Member Function Documentation

◆ operator=()

void operator= ( const DiagonalSolver< Type, DType, LUType > & )

delete

No copy assignment.

◆ TypeName()

TypeName ( "diagonal" )

Runtime type information.

◆ read()

void read ( const dictionary & solverDict )

virtual

Read and reset the solver parameters from the given dictionary.

Reimplemented from LduMatrix< Type, DType, LUType >::solver.

Definition at line 46 of file DiagonalSolver.C.

◆ solve()

Foam::SolverPerformance< Type > solve ( Field< Type > & psi ) const

virtual

Solve the matrix with this solver.

Implements LduMatrix< Type, DType, LUType >::solver.

Definition at line 55 of file DiagonalSolver.C.

References psi, and Foam::Zero.

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

src/OpenFOAM/matrices/LduMatrix/Solvers/DiagonalSolver/DiagonalSolver.H
src/OpenFOAM/matrices/LduMatrix/Solvers/DiagonalSolver/DiagonalSolver.C

Public Member Functions

Additional Inherited Members