solution Class Reference

Selector class for relaxation factors, solver type and solution. More...

Inheritance diagram for solution:

[legend]

Collaboration diagram for solution:

[legend]

List of all members.

Public Member Functions
	solution (const objectRegistry &obr, const fileName &dictName)
	Construct for given objectRegistry and dictionary.
const dictionary &	solutionDict () const
	Return the selected sub-dictionary of solvers if the "select".
bool	relax (const word &name) const
	Return true if the relaxation factor is given for the field.
scalar	relaxationFactor (const word &name) const
	Return the relaxation factor for the given field.
const dictionary &	solverDict (const word &name) const
	Return the solver controls dictionary for the given field.
const dictionary &	solver (const word &name) const
	Return the solver controls dictionary for the given field.
bool	read ()
	Read the solution dictionary.
Static Public Member Functions
static label	upgradeSolverDict (dictionary &dict, const bool verbose=true)
	Update from older solver controls syntax.
Static Public Attributes
static int	debug
	Debug switch.

---

Detailed Description

Selector class for relaxation factors, solver type and solution.

Source files

• solution.H
• solution.C

Definition at line 44 of file solution.H.

---

Constructor & Destructor Documentation

localScope solution	(	const objectRegistry &	obr,
		const fileName &	dictName
	)

Construct for given objectRegistry and dictionary.

Definition at line 40 of file solution.C.

---

Member Function Documentation

Foam::label upgradeSolverDict	(	dictionary &	dict,
		const bool	verbose = true
	)			[static]

Update from older solver controls syntax.

Usually verbose, since we want to know about the changes Returns the number of settings changed

Definition at line 68 of file solution.C.

const Foam::dictionary & solutionDict

(

)

const

Return the selected sub-dictionary of solvers if the "select".

keyword is given, otherwise return the complete dictionary

Definition at line 173 of file solution.C.

bool relax

(

const word &

name

)

const

Return true if the relaxation factor is given for the field.

Definition at line 186 of file solution.C.

Foam::scalar relaxationFactor

(

const word &

name

)

const

Return the relaxation factor for the given field.

Definition at line 199 of file solution.C.

const Foam::dictionary & solverDict

(

const word &

name

)

const

Return the solver controls dictionary for the given field.

Definition at line 229 of file solution.C.

const Foam::dictionary & solver

(

const word &

name

)

const

Return the solver controls dictionary for the given field.

Definition at line 241 of file solution.C.

References Foam::endl(), and InfoIn.

Here is the call graph for this function:

bool read

(

)

[virtual]

Read the solution dictionary.

Reimplemented from regIOobject.

Definition at line 145 of file solution.C.

---

Member Data Documentation

int debug [static]

Debug switch.

Definition at line 76 of file solution.H.

---

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

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