Base class for solution control classes. More...

#include <solutionControl.H>

Inheritance diagram for solutionControl:

[legend]

Collaboration diagram for solutionControl:

[legend]

Classes
struct	fieldData
	Simple convenient storage of field residuals. More...

Public Member Functions
	TypeName ("solutionControl")
	Run-time type information.
	solutionControl (fvMesh &mesh, const word &algorithmName)
	Construct from mesh.
virtual	~solutionControl ()=default
	Destructor.
virtual const dictionary	dict () const
	Return the solution dictionary.
label	corr () const
	Current corrector loop index.
label	corrNonOrtho () const
	Current non-orthogonal corrector index.
label	nNonOrthCorr () const
	Maximum number of non-orthogonal correctors.
bool	finalNonOrthogonalIter () const
	Helper function to identify final non-orthogonal iteration.
bool	momentumPredictor () const
	Flag to indicate to solve for momentum.
bool	transonic () const
	Flag to indicate to solve using transonic algorithm.
bool	consistent () const
	Flag to indicate to relax pressure using the.
bool	frozenFlow () const
	Flag to indicate that the flow system of equations should not.
virtual bool	loop ()=0
	Main control loop.
bool	correctNonOrthogonal ()
	Non-orthogonal corrector loop.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
template<class StringType>
Foam::word	groupName (StringType base, const word &group)
template<class Type>
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.

Static Public Member Functions
static Pair< scalar >	maxResidual (const fvMesh &fvmesh, const entry &dataDictEntry)
	Extract maximum residual for the solver performance entry, provided the corresponding volume field is available on the mesh.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Protected Member Functions
virtual bool	read (const bool absTolOnly)
	Read controls from fvSolution dictionary.
virtual bool	read ()
	Read controls from fvSolution dictionary.
virtual label	applyToField (const word &fieldName, const bool useRegEx=true) const
	Return index of field in residualControl_ if present.
virtual bool	criteriaSatisfied ()=0
	Return true if all convergence checks are satisfied.
virtual void	storePrevIterFields () const
	Store previous iteration fields.
template<class Type>
void	storePrevIter () const
	Store previous iteration field for vol<Type>Fields.
Pair< scalar >	maxResidual (const entry &solverPerfDictEntry) const
	Extract the maximum residual for the specified field.
virtual void	setFirstIterFlag (const bool check=true, const bool force=false)
	Set the firstIteration flag on the mesh data dictionary.
virtual bool	writeData (Ostream &) const
	Dummy write for regIOobject.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.

Static Protected Member Functions
template<class Type>
static bool	maxTypeResidual (const fvMesh &fvmesh, const entry &solverPerfDictEntry, Pair< scalar > &residuals)
	Initial and final residual of the specified field-name, provided that the corresponding volume field is available on the fvMesh.
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information.
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information.

Protected Attributes
fvMesh &	mesh_
	Reference to the mesh database.
List< fieldData >	residualControl_
	List of residual data per field.
const word	algorithmName_
	The dictionary name, e.g. SIMPLE, PIMPLE.
label	nNonOrthCorr_
	Maximum number of non-orthogonal correctors.
bool	momentumPredictor_
	Flag to indicate to solve for momentum.
bool	transonic_
	Flag to indicate to solve using transonic algorithm.
bool	consistent_
	Flag to indicate to relax pressure using the.
bool	frozenFlow_
	Flag to indicate that the flow system of equations should not.
label	corr_
	Current corrector loop index.
label	corrNonOrtho_
	Current non-orthogonal corrector loop index.

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

Base class for solution control classes.

Definition at line 43 of file solutionControl.H.

Constructor & Destructor Documentation

◆ solutionControl()

solutionControl	(	fvMesh &	mesh,
		const word &	algorithmName )

Construct from mesh.

Definition at line 265 of file solutionControl.C.

References algorithmName_, consistent_, corr_, corrNonOrtho_, frozenFlow_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, mesh, mesh_, momentumPredictor_, nNonOrthCorr_, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regIOobject::regIOobject(), residualControl_, IOobject::time(), timeName, and transonic_.

Here is the call graph for this function:

◆ ~solutionControl()

virtual ~solutionControl ( )

virtualdefault

Destructor.

Member Function Documentation

◆ maxResidual() [1/2]

Foam::Pair< Foam::scalar > maxResidual	(	const fvMesh &	fvmesh,
		const entry &	dataDictEntry )

static

Extract maximum residual for the solver performance entry, provided the corresponding volume field is available on the mesh.

Returns: initial residual as first member, the final residual as the second (or last) member

Definition at line 235 of file solutionControl.C.

References Foam::Info, entry::keyword(), maxTypeResidual(), fvMesh::name(), and Foam::nl.

Referenced by pimpleControl::criteriaSatisfied(), simpleControl::criteriaSatisfied(), and maxResidual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [1/2]

bool read ( const bool absTolOnly )

protectedvirtual

Read controls from fvSolution dictionary.

Definition at line 34 of file solutionControl.C.

References solutionControl::fieldData::absTol, DynamicList< T, SizeMin >::append(), applyToField(), consistent_, dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, frozenFlow_, dictionary::get(), Foam::Info, solutionControl::fieldData::initialResidual, momentumPredictor_, solutionControl::fieldData::name, Foam::nl, nNonOrthCorr_, solutionControl::fieldData::relTol, residualControl_, solutionDict(), and transonic_.

Here is the call graph for this function:

◆ read() [2/2]

bool read ( )

protectedvirtual

Read controls from fvSolution dictionary.

Reimplemented from regIOobject.

Reimplemented in pimpleControl, pisoControl, SIMPLEControl, simpleControl, SIMPLEControlOpt, and SIMPLEControlSingleRun.

Definition at line 129 of file solutionControl.C.

References Foam::read().

Referenced by pimpleControl::read(), and simpleControl::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyToField()

Foam::label applyToField	(	const word &	fieldName,
		const bool	useRegEx = true ) const

protectedvirtual

Return index of field in residualControl_ if present.

Definition at line 135 of file solutionControl.C.

References forAll, IOobject::name(), and residualControl_.

Referenced by pimpleControl::criteriaSatisfied(), simpleControl::criteriaSatisfied(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ criteriaSatisfied()

virtual bool criteriaSatisfied ( )

protectedpure virtual

Return true if all convergence checks are satisfied.

Implemented in pimpleControl, simpleControl, and SIMPLEControlOpt.

References Foam::check().

Here is the call graph for this function:

◆ storePrevIterFields()

void storePrevIterFields ( ) const

protectedvirtual

Store previous iteration fields.

Definition at line 153 of file solutionControl.C.

References storePrevIter().

Referenced by pimpleControl::loop(), simpleControl::loop(), SIMPLEControlOpt::loop(), and SIMPLEControlSingleRun::loop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storePrevIter()

template<class Type>

void storePrevIter ( ) const

protected

Store previous iteration field for vol<Type>Fields.

Definition at line 29 of file solutionControlTemplates.C.

References algorithmName_, string::contains(), DebugInfo, Foam::endl(), fld(), and mesh_.

Here is the call graph for this function:

◆ maxTypeResidual()

template<class Type>

bool maxTypeResidual	(	const fvMesh &	fvmesh,
		const entry &	solverPerfDictEntry,
		Pair< scalar > &	residuals )

staticprotected

Initial and final residual of the specified field-name, provided that the corresponding volume field is available on the fvMesh.

Populate residuals with initial residual as first member and the final residual as second (last) member.

Definition at line 210 of file solutionControl.C.

References Foam::cmptMax(), Pair< T >::first(), objectRegistry::foundObject(), entry::keyword(), FixedList< T, N >::last(), and entry::stream().

Referenced by maxResidual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxResidual() [2/2]

Foam::Pair< Foam::scalar > maxResidual ( const entry & solverPerfDictEntry ) const

protected

Extract the maximum residual for the specified field.

Returns: initial residual as first member, the final residual as second (last) member

Definition at line 164 of file solutionControl.C.

References maxResidual(), and mesh_.

Here is the call graph for this function:

◆ setFirstIterFlag()

void setFirstIterFlag	(	const bool	check = true,
		const bool	force = false )

protectedvirtual

Set the firstIteration flag on the mesh data dictionary.

Reimplemented in pimpleControl.

Definition at line 173 of file solutionControl.C.

References Foam::check(), corr_, corrNonOrtho_, DebugInfo, Foam::endl(), and mesh_.

Referenced by correctNonOrthogonal(), simpleControl::loop(), SIMPLEControlSingleRun::loop(), and pimpleControl::setFirstIterFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & ) const

protectedvirtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 199 of file solutionControl.C.

References NotImplemented.

◆ TypeName()

TypeName ( "solutionControl" )

Run-time type information.

References mesh.

◆ dict()

const Foam::dictionary dict ( ) const

virtual

Return the solution dictionary.

Reimplemented in SIMPLEControl.

Definition at line 293 of file solutionControl.C.

References algorithmName_, and mesh_.

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

Here is the caller graph for this function:

◆ corr()

Foam::label corr ( ) const

inline

Current corrector loop index.

Definition at line 23 of file solutionControlI.H.

References corr_.

◆ corrNonOrtho()

Foam::label corrNonOrtho ( ) const

inline

Current non-orthogonal corrector index.

Definition at line 29 of file solutionControlI.H.

References corrNonOrtho_.

◆ nNonOrthCorr()

Foam::label nNonOrthCorr ( ) const

inline

Maximum number of non-orthogonal correctors.

Definition at line 35 of file solutionControlI.H.

References nNonOrthCorr_.

◆ finalNonOrthogonalIter()

bool finalNonOrthogonalIter ( ) const

inline

Helper function to identify final non-orthogonal iteration.

Definition at line 41 of file solutionControlI.H.

References corrNonOrtho_, and nNonOrthCorr_.

◆ momentumPredictor()

bool momentumPredictor ( ) const

inline

Flag to indicate to solve for momentum.

Definition at line 47 of file solutionControlI.H.

References momentumPredictor_.

◆ transonic()

bool transonic ( ) const

inline

Flag to indicate to solve using transonic algorithm.

Definition at line 53 of file solutionControlI.H.

References transonic_.

◆ consistent()

bool consistent ( ) const

inline

Flag to indicate to relax pressure using the.

"consistent" approach of SIMPLEC

Definition at line 59 of file solutionControlI.H.

References consistent_.

◆ frozenFlow()

bool frozenFlow ( ) const

inline

Flag to indicate that the flow system of equations should not.

be evolved

Definition at line 65 of file solutionControlI.H.

References frozenFlow_.

◆ loop()

virtual bool loop ( )

pure virtual

Main control loop.

Implemented in pimpleControl, SIMPLEControl, simpleControl, SIMPLEControlOpt, and SIMPLEControlSingleRun.

◆ correctNonOrthogonal()

bool correctNonOrthogonal ( )

inline

Non-orthogonal corrector loop.

Definition at line 71 of file solutionControlI.H.

References algorithmName_, corrNonOrtho_, Foam::endl(), Foam::Info, nNonOrthCorr_, and setFirstIterFlag().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

◆ residualControl_

List<fieldData> residualControl_

protected

List of residual data per field.

Definition at line 90 of file solutionControl.H.

Referenced by applyToField(), pimpleControl::criteriaSatisfied(), simpleControl::criteriaSatisfied(), pimpleControl::loop(), pimpleControl::pimpleControl(), read(), simpleControl::simpleControl(), and solutionControl().

◆ algorithmName_

const word algorithmName_

protected

The dictionary name, e.g. SIMPLE, PIMPLE.

Definition at line 95 of file solutionControl.H.

Referenced by pimpleControl::correct(), correctNonOrthogonal(), pimpleControl::criteriaSatisfied(), simpleControl::criteriaSatisfied(), dict(), pimpleControl::loop(), simpleControl::loop(), pimpleControl::pimpleControl(), simpleControl::simpleControl(), solutionControl(), and storePrevIter().

◆ nNonOrthCorr_

label nNonOrthCorr_

protected

Maximum number of non-orthogonal correctors.

Definition at line 103 of file solutionControl.H.

Referenced by correctNonOrthogonal(), pimpleControl::finalInnerIter(), finalNonOrthogonalIter(), nNonOrthCorr(), read(), and solutionControl().

◆ momentumPredictor_

bool momentumPredictor_

protected

Flag to indicate to solve for momentum.

Definition at line 108 of file solutionControl.H.

Referenced by momentumPredictor(), read(), and solutionControl().

◆ transonic_

bool transonic_

protected

Flag to indicate to solve using transonic algorithm.

Definition at line 113 of file solutionControl.H.

Referenced by read(), solutionControl(), and transonic().

◆ consistent_

bool consistent_

protected

Flag to indicate to relax pressure using the.

"consistent" approach of SIMPLEC

Definition at line 120 of file solutionControl.H.

Referenced by consistent(), read(), and solutionControl().

◆ frozenFlow_

bool frozenFlow_

protected

Flag to indicate that the flow system of equations should not.

be evolved

Definition at line 127 of file solutionControl.H.

Referenced by frozenFlow(), read(), and solutionControl().

◆ corr_

label corr_

protected

Current corrector loop index.

Definition at line 135 of file solutionControl.H.

Referenced by corr(), pimpleControl::criteriaSatisfied(), pimpleControl::finalIter(), pimpleControl::firstIter(), pimpleControl::loop(), pimpleControl::setFirstIterFlag(), setFirstIterFlag(), solutionControl(), and pimpleControl::storeInitialResiduals().

◆ corrNonOrtho_

label corrNonOrtho_

protected

Current non-orthogonal corrector loop index.

Definition at line 140 of file solutionControl.H.

Referenced by correctNonOrthogonal(), corrNonOrtho(), pimpleControl::finalInnerIter(), finalNonOrthogonalIter(), pimpleControl::setFirstIterFlag(), setFirstIterFlag(), solutionControl(), and pimpleControl::storeInitialResiduals().

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

src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.H
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControl.C
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlI.H
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/solutionControlTemplates.C

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solutionControl()

◆ ~solutionControl()

Member Function Documentation

◆ maxResidual() [1/2]

◆ read() [1/2]

◆ read() [2/2]

◆ applyToField()

◆ criteriaSatisfied()

◆ storePrevIterFields()

◆ storePrevIter()

◆ maxTypeResidual()

◆ maxResidual() [2/2]

◆ setFirstIterFlag()

◆ writeData()

◆ TypeName()

◆ dict()

◆ corr()

◆ corrNonOrtho()

◆ nNonOrthCorr()

◆ finalNonOrthogonalIter()

◆ momentumPredictor()

◆ transonic()

◆ consistent()

◆ frozenFlow()

◆ loop()

◆ correctNonOrthogonal()

Member Data Documentation

◆ mesh_

◆ residualControl_

◆ algorithmName_

◆ nNonOrthCorr_

◆ momentumPredictor_

◆ transonic_

◆ consistent_

◆ frozenFlow_

◆ corr_

◆ corrNonOrtho_