PIMPLE control class to supply convergence information/checks for the PIMPLE loop. More...

Inheritance diagram for pimpleControl:

Collaboration diagram for pimpleControl:

Public Member Functions
	TypeName ("pimpleControl")
	Run-time type information. More...

	pimpleControl (fvMesh &mesh, const word &dictName="PIMPLE", const bool verbose=true)
	Construct from mesh and the name of control sub-dictionary. More...

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

label	nCorrPIMPLE () const
	Maximum number of PIMPLE correctors. More...

label	nCorrPISO () const
	Maximum number of PISO correctors. More...

label	corrPISO () const
	Current PISO corrector index. More...

bool	SIMPLErho () const
	Flag to indicate whether to update density in SIMPLE. More...

virtual bool	loop ()
	PIMPLE loop. More...

bool	correct ()
	Pressure corrector loop control. More...

bool	storeInitialResiduals () const
	Return true to store the initial residuals. More...

bool	firstIter () const
	Return true for first PIMPLE (outer) iteration. More...

bool	finalIter () const
	Return true for final PIMPLE (outer) iteration. More...

bool	finalInnerIter () const
	Return true for final inner iteration. More...

bool	solveFlow () const
	Return true to solve for flow. More...

bool	turbCorr ()
	Return true to solve for turbulence. More...

bool	ddtCorr () const
	Return true to apply ddtCorr. More...

Public Member Functions inherited from solutionControl
	TypeName ("solutionControl")
	Run-time type information. More...

	solutionControl (fvMesh &mesh, const word &algorithmName)
	Construct from mesh. More...

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

virtual const dictionary	dict () const
	Return the solution dictionary. More...

label	corr () const
	Current corrector loop index. More...

label	corrNonOrtho () const
	Current non-orthogonal corrector index. More...

label	nNonOrthCorr () const
	Maximum number of non-orthogonal correctors. More...

bool	finalNonOrthogonalIter () const
	Helper function to identify final non-orthogonal iteration. More...

bool	momentumPredictor () const
	Flag to indicate to solve for momentum. More...

bool	transonic () const
	Flag to indicate to solve using transonic algorithm. More...

bool	consistent () const
	Flag to indicate to relax pressure using the. More...

bool	frozenFlow () const
	Flag to indicate that the flow system of equations should not. More...

bool	correctNonOrthogonal ()
	Non-orthogonal corrector loop. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set as up-to-date. More...

virtual void	rename (const word &newName)
	Rename. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=true) const
	Write using setting from DB. More...

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

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

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const Time &	time () const
	Return time. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return non-constant access to the class name read from header. More...

const string &	note () const
	Return the optional note. More...

string &	note ()
	Return non-constant access to the optional note. More...

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete path + object name. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &is)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header. More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

Protected Member Functions
virtual bool	read ()
	Read controls from fvSolution dictionary. More...

virtual bool	criteriaSatisfied ()
	Return true if all convergence checks are satisfied. More...

virtual void	setFirstIterFlag (const bool check=true, const bool force=false)
	Set the firstIteration flag on the mesh data dictionary. More...

Protected Member Functions inherited from solutionControl
virtual bool	read (const bool absTolOnly)
	Read controls from fvSolution dictionary. More...

virtual label	applyToField (const word &fieldName, const bool useRegEx=true) const
	Return index of field in residualControl_ if present. More...

virtual void	storePrevIterFields () const
	Store previous iteration fields. More...

template<class Type >
void	storePrevIter () const
	Store previous iteration field for vol<Type>Fields. More...

Pair< scalar >	maxResidual (const entry &solverPerfDictEntry) const
	Extract the maximum residual for the specified field. More...

virtual bool	writeData (Ostream &) const
	Dummy write for regIOobject. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
bool	solveFlow_
	Flag to indicate whether to solve for the flow. More...

label	nCorrPIMPLE_
	Maximum number of PIMPLE correctors. More...

label	nCorrPISO_
	Maximum number of PISO correctors. More...

label	corrPISO_
	Current PISO corrector. More...

bool	SIMPLErho_

bool	turbOnFinalIterOnly_
	Flag to indicate whether to only solve turbulence on final iter. More...

bool	finalOnLastPimpleIterOnly_

bool	ddtCorr_
	Flag to indicate that ddtCorr should be applied; default = yes. More...

bool	converged_
	Converged flag. More...

Protected Attributes inherited from solutionControl
fvMesh &	mesh_
	Reference to the mesh database. More...

List< fieldData >	residualControl_
	List of residual data per field. More...

const word	algorithmName_
	The dictionary name, e.g. SIMPLE, PIMPLE. More...

label	nNonOrthCorr_
	Maximum number of non-orthogonal correctors. More...

bool	momentumPredictor_
	Flag to indicate to solve for momentum. More...

bool	transonic_
	Flag to indicate to solve using transonic algorithm. More...

bool	consistent_
	Flag to indicate to relax pressure using the. More...

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

label	corr_
	Current corrector loop index. More...

label	corrNonOrtho_
	Current non-orthogonal corrector loop index. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Member Functions inherited from solutionControl
static Pair< scalar >	maxResidual (const fvMesh &fvmesh, const entry &dataDictEntry)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &aptr)

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)

template<class Type >
static Type &	store (tmp< Type > &tptr)

template<class Type >
static Type &	store (tmp< Type > &&tptr)

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class StringType >
static word	scopedName (StringType scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Protected Member Functions inherited from solutionControl
template<class Type >
static bool	maxTypeResidual (const fvMesh &fvmesh, const entry &solverPerfDictEntry, Pair< scalar > &residuals)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

PIMPLE control class to supply convergence information/checks for the PIMPLE loop.

May also be used to for PISO-based algorithms as PISO controls are a sub-set of PIMPLE controls.

Definition at line 55 of file pimpleControl.H.

Constructor & Destructor Documentation

◆ pimpleControl()

pimpleControl	(	fvMesh &	mesh,
		const word &	dictName = `"PIMPLE"`,
		const bool	verbose = `true`
	)

Construct from mesh and the name of control sub-dictionary.

Definition at line 146 of file pimpleControl.C.

References Foam::endl(), Foam::Info, Foam::nl, Foam::read(), and token::TAB.

Here is the call graph for this function:

◆ ~pimpleControl()

virtual ~pimpleControl ( )

virtualdefault

Destructor.

Member Function Documentation

◆ read()

bool read ( )

protectedvirtual

Read controls from fvSolution dictionary.

Reimplemented from solutionControl.

Definition at line 41 of file pimpleControl.C.

References pimpleControl::ddtCorr_, solutionControl::dict(), pimpleControl::finalOnLastPimpleIterOnly_, pimpleControl::nCorrPIMPLE_, pimpleControl::nCorrPISO_, pimpleDict, solutionControl::read(), pimpleControl::SIMPLErho_, pimpleControl::solveFlow_, and pimpleControl::turbOnFinalIterOnly_.

Here is the call graph for this function:

◆ criteriaSatisfied()

bool criteriaSatisfied ( )

protectedvirtual

Return true if all convergence checks are satisfied.

Implements solutionControl.

Definition at line 61 of file pimpleControl.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAllConstIters(), Foam::Info, entry::keyword(), and Foam::fvc::relative().

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 from solutionControl.

Definition at line 131 of file pimpleControl.C.

References DebugInfo, Foam::endl(), and solutionControl::setFirstIterFlag().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "pimpleControl" )

Run-time type information.

◆ nCorrPIMPLE()

Foam::label nCorrPIMPLE ( ) const

inline

Maximum number of PIMPLE correctors.

Definition at line 31 of file pimpleControlI.H.

References pimpleControl::nCorrPIMPLE_.

◆ nCorrPISO()

Foam::label nCorrPISO ( ) const

inline

Maximum number of PISO correctors.

Definition at line 37 of file pimpleControlI.H.

◆ corrPISO()

Foam::label corrPISO ( ) const

inline

Current PISO corrector index.

Definition at line 43 of file pimpleControlI.H.

◆ SIMPLErho()

bool SIMPLErho ( ) const

inline

Flag to indicate whether to update density in SIMPLE.

rather than PISO mode

Definition at line 49 of file pimpleControlI.H.

◆ loop()

bool loop ( )

virtual

PIMPLE loop.

Implements solutionControl.

Definition at line 202 of file pimpleControl.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, and Foam::read().

Here is the call graph for this function:

◆ correct()

bool correct ( )

inline

Pressure corrector loop control.

Definition at line 55 of file pimpleControlI.H.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ storeInitialResiduals()

bool storeInitialResiduals ( ) const

inline

Return true to store the initial residuals.

Definition at line 79 of file pimpleControlI.H.

◆ firstIter()

bool firstIter ( ) const

inline

Return true for first PIMPLE (outer) iteration.

Definition at line 86 of file pimpleControlI.H.

◆ finalIter()

bool finalIter ( ) const

inline

Return true for final PIMPLE (outer) iteration.

Definition at line 92 of file pimpleControlI.H.

◆ finalInnerIter()

bool finalInnerIter ( ) const

inline

Return true for final inner iteration.

Definition at line 98 of file pimpleControlI.H.

◆ solveFlow()

bool solveFlow ( ) const

inline

Return true to solve for flow.

Definition at line 115 of file pimpleControlI.H.

◆ turbCorr()

bool turbCorr ( )

inline

Return true to solve for turbulence.

Definition at line 121 of file pimpleControlI.H.

◆ ddtCorr()

bool ddtCorr ( ) const

inline

Return true to apply ddtCorr.

Definition at line 146 of file pimpleControlI.H.

Member Data Documentation

◆ solveFlow_

bool solveFlow_

protected

Flag to indicate whether to solve for the flow.

Definition at line 75 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ nCorrPIMPLE_

label nCorrPIMPLE_

protected

Maximum number of PIMPLE correctors.

Definition at line 78 of file pimpleControl.H.

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

◆ nCorrPISO_

label nCorrPISO_

protected

Maximum number of PISO correctors.

Definition at line 81 of file pimpleControl.H.

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

◆ corrPISO_

label corrPISO_

protected

Current PISO corrector.

Definition at line 84 of file pimpleControl.H.

Referenced by pisoControl::finalInnerIter().

◆ SIMPLErho_

bool SIMPLErho_

protected

Flag to indicate whether to update density in SIMPLE rather than PISO mode

Definition at line 88 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ turbOnFinalIterOnly_

bool turbOnFinalIterOnly_

protected

Flag to indicate whether to only solve turbulence on final iter.

Definition at line 91 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ finalOnLastPimpleIterOnly_

bool finalOnLastPimpleIterOnly_

protected

Flag to indicate wheter the final solver is used only on the final pimple iter

Definition at line 95 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ ddtCorr_

bool ddtCorr_

protected

Flag to indicate that ddtCorr should be applied; default = yes.

Definition at line 98 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ converged_

bool converged_

protected

Converged flag.

Definition at line 101 of file pimpleControl.H.

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

src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleControl.H
src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleControl.C
src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleControlI.H

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pimpleControl()

◆ ~pimpleControl()

Member Function Documentation

◆ read()

◆ criteriaSatisfied()

◆ setFirstIterFlag()

◆ TypeName()

◆ nCorrPIMPLE()

◆ nCorrPISO()

◆ corrPISO()

◆ SIMPLErho()

◆ loop()

◆ correct()

◆ storeInitialResiduals()

◆ firstIter()

◆ finalIter()

◆ finalInnerIter()

◆ solveFlow()

◆ turbCorr()

◆ ddtCorr()

Member Data Documentation

◆ solveFlow_

◆ nCorrPIMPLE_

◆ nCorrPISO_

◆ corrPISO_

◆ SIMPLErho_

◆ turbOnFinalIterOnly_

◆ finalOnLastPimpleIterOnly_

◆ ddtCorr_

◆ converged_