Selector class for relaxation factors, solver type and solution. More...
#include <OpenFOAM/solution.H>
Selector class for relaxation factors, solver type and solution.
Definition at line 49 of file solution.H.
Inheritance diagram for solution: Collaboration diagram for solution: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.
| |
| localScope solution | ( | const objectRegistry & | obr, |
| const fileName & | dictName | ||
| ) |
Construct for given objectRegistry and dictionary.
Definition at line 48 of file solution.C.
References solution::read().
| 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 76 of file solution.C.
References dictionary::add(), Foam::endl(), IOstream::eof(), forAll, forAllIter, Foam::Info, entry::isDict(), dictionary::lookupEntryPtr(), Pstream::master(), Foam::name(), dictionary::set(), ICCG::solverDict(), BICCG::solverDict(), and entry::stream().
| 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 181 of file solution.C.
| bool relax | ( | const word & | name ) | const |
Return true if the relaxation factor is given for the field.
Definition at line 194 of file solution.C.
References Foam::endl(), and Foam::Info.
| Foam::scalar relaxationFactor | ( | const word & | name ) | const |
Return the relaxation factor for the given field.
Definition at line 207 of file solution.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and Foam::readScalar().
Referenced by GeometricField< Type, PatchField, GeoMesh >::relax().
| const Foam::dictionary & solverDict | ( | const word & | name ) | const |
Return the solver controls dictionary for the given field.
Definition at line 237 of file solution.C.
References Foam::endl(), and InfoIn.
Referenced by Foam::MULES::implicitSolve().
| const Foam::dictionary & solver | ( | const word & | name ) | const |
Return the solver controls dictionary for the given field.
Definition at line 249 of file solution.C.
References Foam::endl(), and InfoIn.
| bool read | ( | ) | [virtual]
|
Read the solution dictionary.
Reimplemented from regIOobject.
Definition at line 153 of file solution.C.
References dictionary::found(), regIOobject::read(), dictionary::readIfPresent(), solutionDict(), and dictionary::subDict().
Referenced by solution::solution().
int debug [static]
|
Debug switch.
Definition at line 79 of file solution.H.
