Public Member Functions | List of all members
diagonalSolver Class Reference

Foam::diagonalSolver. More...

Inheritance diagram for diagonalSolver:
Inheritance graph
[legend]
Collaboration diagram for diagonalSolver:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("diagonal")
 Runtime type information. More...
 
 diagonalSolver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Construct from matrix and solver controls. More...
 
void read (const dictionary &)
 Read and reset the solver parameters from the given stream. More...
 
solverPerformance solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
 Solve the matrix with this solver. More...
 
- Public Member Functions inherited from lduMatrix::solver
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, solver, symMatrix,( const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls ),( fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls ))
 
 declareRunTimeSelectionTable (autoPtr, solver, asymMatrix,( const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls ),( fieldName, matrix, interfaceBouCoeffs, interfaceIntCoeffs, interfaces, solverControls ))
 
 solver (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 
virtual ~solver ()
 Destructor. More...
 
const wordfieldName () const
 
const lduMatrixmatrix () const
 
const FieldField< Field, scalar > & interfaceBouCoeffs () const
 
const FieldField< Field, scalar > & interfaceIntCoeffs () const
 
const lduInterfaceFieldPtrsListinterfaces () const
 
scalar normFactor (const scalarField &psi, const scalarField &source, const scalarField &Apsi, scalarField &tmpField) const
 Return the matrix norm used to normalise the residual for the. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lduMatrix::solver
static autoPtr< solverNew (const word &fieldName, const lduMatrix &matrix, const FieldField< Field, scalar > &interfaceBouCoeffs, const FieldField< Field, scalar > &interfaceIntCoeffs, const lduInterfaceFieldPtrsList &interfaces, const dictionary &solverControls)
 Return a new solver. More...
 
- Protected Member Functions inherited from lduMatrix::solver
virtual void readControls ()
 Read the control parameters from the controlDict_. More...
 
- Protected Attributes inherited from lduMatrix::solver
word fieldName_
 
const lduMatrixmatrix_
 
const FieldField< Field, scalar > & interfaceBouCoeffs_
 
const FieldField< Field, scalar > & interfaceIntCoeffs_
 
lduInterfaceFieldPtrsList interfaces_
 
dictionary controlDict_
 Dictionary of controls. More...
 
label maxIter_
 Maximum number of iterations in the solver. More...
 
label minIter_
 Minimum number of iterations in the solver. More...
 
scalar tolerance_
 Final convergence tolerance. More...
 
scalar relTol_
 Convergence tolerance relative to the initial. More...
 

Detailed Description

Foam::diagonalSolver.

Source files

Definition at line 48 of file diagonalSolver.H.

Constructor & Destructor Documentation

diagonalSolver ( const word fieldName,
const lduMatrix matrix,
const FieldField< Field, scalar > &  interfaceBouCoeffs,
const FieldField< Field, scalar > &  interfaceIntCoeffs,
const lduInterfaceFieldPtrsList interfaces,
const dictionary solverControls 
)

Construct from matrix and solver controls.

Definition at line 39 of file diagonalSolver.C.

References diagonalSolver::solve().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "diagonal"  )

Runtime type information.

void read ( const dictionary )
inlinevirtual

Read and reset the solver parameters from the given stream.

Reimplemented from lduMatrix::solver.

Definition at line 84 of file diagonalSolver.H.

References psi, and diagonalSolver::solve().

Here is the call graph for this function:

Foam::solverPerformance solve ( scalarField psi,
const scalarField source,
const direction  cmpt = 0 
) const
virtual

Solve the matrix with this solver.

Implements lduMatrix::solver.

Definition at line 63 of file diagonalSolver.C.

Referenced by diagonalSolver::diagonalSolver(), and diagonalSolver::read().

Here is the caller graph for this function:


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