Wrapper to switch on parProfiling around a linear solver. More...

Inheritance diagram for parProfilingSolver:

Collaboration diagram for parProfilingSolver:

Public Member Functions
	TypeName ("parProfilingSolver")
	Runtime type information. More...

	parProfilingSolver (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 components and solver controls. More...

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

virtual solverPerformance	solve (scalarField &psi, const scalarField &source, const direction cmpt=0) const
	Solve the matrix with forwarding to the base solver. More...

Public Member Functions inherited from lduMatrix::solver
virtual const word &	type () 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)
	Construct solver for given field name, matrix etc. More...

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

const word &	fieldName () const noexcept

const lduMatrix &	matrix () const noexcept

const FieldField< Field, scalar > &	interfaceBouCoeffs () const noexcept

const FieldField< Field, scalar > &	interfaceIntCoeffs () const noexcept

const lduInterfaceFieldPtrsList &	interfaces () const noexcept

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

virtual solverPerformance	scalarSolve (solveScalarField &psi, const solveScalarField &source, const direction cmpt=0) const
	Solve with given field and rhs (in solveScalar precision). More...

solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &tmpField, const lduMatrix::normTypes normType) const
	Return the matrix norm using the specified norm method. More...

solveScalarField::cmptType	normFactor (const solveScalarField &psi, const solveScalarField &source, const solveScalarField &Apsi, solveScalarField &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::solver
static autoPtr< solver >	New (const word &solverName, 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 of given type. More...

static autoPtr< solver >	New (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 given dictionary. More...

Protected Member Functions inherited from lduMatrix::solver
virtual void	readControls ()
	Read the control parameters from controlDict_. More...

Protected Attributes inherited from lduMatrix::solver
word	fieldName_

const lduMatrix &	matrix_

const FieldField< Field, scalar > &	interfaceBouCoeffs_

const FieldField< Field, scalar > &	interfaceIntCoeffs_

lduInterfaceFieldPtrsList	interfaces_

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 normalisation type. More...

scalar	tolerance_
	Final convergence tolerance. More...

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

profilingTrigger	profiling_
	Profiling instrumentation. More...

Detailed Description

Wrapper to switch on parProfiling around a linear solver.

Used in combination with parProfiling functionObject.

Usage

Example of linear solver specification in fvSolution:

solvers
{
    p
    {
        solver          parProfiling;
        // Actual solver to use
        baseSolver      PCG;
        preconditioner  DIC;
        ..
    }
}

Source files

Definition at line 64 of file parProfilingSolver.H.

Constructor & Destructor Documentation

◆ parProfilingSolver()

parProfilingSolver	(	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 components and solver controls.

Definition at line 59 of file parProfilingSolver.C.

References dictionary::get(), initialised_(), and Foam::New().

Here is the call graph for this function:

◆ ~parProfilingSolver()

virtual ~parProfilingSolver ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "parProfilingSolver" )

Runtime type information.

◆ solve()

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

virtual

Solve the matrix with forwarding to the base solver.

Implements lduMatrix::solver.

Definition at line 106 of file parProfilingSolver.C.

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

src/functionObjects/utilities/parProfiling/parProfilingSolver.H
src/functionObjects/utilities/parProfiling/parProfilingSolver.C

Public Member Functions