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")

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

virtual	~pimpleControl ()=default

label	nCorrPIMPLE () const

label	nCorrPISO () const

label	corrPISO () const

bool	SIMPLErho () const

virtual bool	loop ()

bool	correct ()

bool	storeInitialResiduals () const

bool	firstIter () const

bool	finalIter () const

bool	finalInnerIter () const

bool	solveFlow () const

bool	turbCorr ()

bool	ddtCorr () const

Public Member Functions inherited from solutionControl
	TypeName ("solutionControl")

	solutionControl (fvMesh &mesh, const word &algorithmName)

virtual	~solutionControl ()=default

virtual const dictionary	dict () const

label	corr () const

label	corrNonOrtho () const

label	nNonOrthCorr () const

bool	finalNonOrthogonalIter () const

bool	momentumPredictor () const

bool	transonic () const

bool	consistent () const

bool	frozenFlow () const

bool	correctNonOrthogonal ()

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

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

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

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

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	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)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

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

Protected Member Functions
virtual bool	read ()

virtual bool	criteriaSatisfied ()

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

Protected Member Functions inherited from solutionControl
virtual bool	read (const bool absTolOnly)

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

virtual void	storePrevIterFields () const

template<class Type >
void	storePrevIter () const

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

virtual bool	writeData (Ostream &) const

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Protected Attributes
bool	solveFlow_

label	nCorrPIMPLE_

label	nCorrPISO_

label	corrPISO_

bool	SIMPLErho_

bool	turbOnFinalIterOnly_

bool	finalOnLastPimpleIterOnly_

bool	ddtCorr_

bool	converged_

Protected Attributes inherited from solutionControl
fvMesh &	mesh_

List< fieldData >	residualControl_

const word	algorithmName_

label	nNonOrthCorr_

bool	momentumPredictor_

bool	transonic_

bool	consistent_

bool	frozenFlow_

label	corr_

label	corrNonOrtho_

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

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 > &ptr)

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

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

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

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

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

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

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

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

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

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 51 of file pimpleControl.H.

Constructor & Destructor Documentation

◆ pimpleControl()

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

Definition at line 137 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

Member Function Documentation

◆ read()

bool read ( )

protectedvirtual

Reimplemented from solutionControl.

Definition at line 34 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

Implements solutionControl.

Definition at line 54 of file pimpleControl.C.

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

Here is the call graph for this function:

◆ setFirstIterFlag()

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

protectedvirtual

Reimplemented from solutionControl.

Definition at line 122 of file pimpleControl.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "pimpleControl" )

◆ nCorrPIMPLE()

Foam::label nCorrPIMPLE ( ) const

inline

Definition at line 24 of file pimpleControlI.H.

References pimpleControl::nCorrPIMPLE_.

◆ nCorrPISO()

Foam::label nCorrPISO ( ) const

inline

Definition at line 30 of file pimpleControlI.H.

◆ corrPISO()

Foam::label corrPISO ( ) const

inline

Definition at line 36 of file pimpleControlI.H.

◆ SIMPLErho()

bool SIMPLErho ( ) const

inline

Definition at line 42 of file pimpleControlI.H.

◆ loop()

bool loop ( )

virtual

Implements solutionControl.

Definition at line 193 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

Definition at line 48 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

Definition at line 72 of file pimpleControlI.H.

◆ firstIter()

bool firstIter ( ) const

inline

Definition at line 79 of file pimpleControlI.H.

◆ finalIter()

bool finalIter ( ) const

inline

Definition at line 85 of file pimpleControlI.H.

◆ finalInnerIter()

bool finalInnerIter ( ) const

inline

Definition at line 91 of file pimpleControlI.H.

◆ solveFlow()

bool solveFlow ( ) const

inline

Definition at line 108 of file pimpleControlI.H.

◆ turbCorr()

bool turbCorr ( )

inline

Definition at line 114 of file pimpleControlI.H.

◆ ddtCorr()

bool ddtCorr ( ) const

inline

Definition at line 139 of file pimpleControlI.H.

Member Data Documentation

◆ solveFlow_

bool solveFlow_

protected

Definition at line 71 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ nCorrPIMPLE_

label nCorrPIMPLE_

protected

Definition at line 74 of file pimpleControl.H.

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

◆ nCorrPISO_

label nCorrPISO_

protected

Definition at line 77 of file pimpleControl.H.

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

◆ corrPISO_

label corrPISO_

protected

Definition at line 80 of file pimpleControl.H.

Referenced by pisoControl::finalInnerIter().

◆ SIMPLErho_

bool SIMPLErho_

protected

Definition at line 84 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ turbOnFinalIterOnly_

bool turbOnFinalIterOnly_

protected

Definition at line 87 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ finalOnLastPimpleIterOnly_

bool finalOnLastPimpleIterOnly_

protected

Definition at line 91 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ ddtCorr_

bool ddtCorr_

protected

Definition at line 94 of file pimpleControl.H.

Referenced by pimpleControl::read().

◆ converged_

bool converged_

protected

Definition at line 97 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_