Pimple multi-region control class. As Foam::pimpleControl, but for a multi- region simulation comprising pimple and solid regions. More region types could be added. More...

Inheritance diagram for pimpleMultiRegionControl:

[legend]

Collaboration diagram for pimpleMultiRegionControl:

[legend]

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

	pimpleMultiRegionControl (PtrList< fvMesh > &pimpleMeshes, PtrList< fvMesh > &solidMeshes, const word &algorithmName="PIMPLE")
	Construct from meshes and the algorithm name. More...

virtual	~pimpleMultiRegionControl ()
	Destructor. More...

virtual bool	read ()
	Read controls. More...

pimpleNoLoopControl &	pimple (const label i)
	Access the i-th pimple control. More...

solidNoLoopControl &	solid (const label i)
	Access the i-th solid control. More...

bool	pimpleTurbCorr (const label i) const
	Flag to indicate whether to solve the turbulence. More...

virtual bool	hasResidualControls () const
	Return true if residual controls are present. More...

virtual bool	hasCorrResidualControls () const
	Return true if corrector residual controls are present. More...

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

virtual bool	corrCriteriaSatisfied () const
	Return true if all correction convergence checks are satisfied. More...

virtual void	resetCorrSolveIndex ()
	Reset the solve index in the correction residual control data. More...

virtual void	updateCorrSolveIndex ()
	Update the solve index in the correction residual control data. More...

bool	loop ()
	Pimple loop. More...

bool	run (Time &time)
	Time run loop. More...

bool	loop (Time &time)
	Time loop loop. More...

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

	multiRegionSolutionControl (const Time &time, const word &algorithmName)
	Construct from a time and the name of the algorithm. More...

virtual	~multiRegionSolutionControl ()
	Destructor. More...

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

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

	solutionControl (const objectRegistry &registry, const Time &time, const word &algorithmName)
	Construct from the time, the name of the algorithm and a registry. More...

virtual	~solutionControl ()
	Destructor. More...

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

const word &	algorithmName () const
	Return the name of the algorithm. More...

const char *	algorithmSpace () const
	Return some whitespace the same length as the algorithm name. More...

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

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

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

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

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

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

bool	registered () const
	Is this object registered with the registry? More...

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

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	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 up to date (obviously) More...

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

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

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

void	close ()
	Close Istream. More...

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

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

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

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

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

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

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

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. 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)
	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)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

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

virtual	~IOobject ()
	Destructor. More...

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

const objectRegistry &	db () const
	Return the local objectRegistry. 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 name of the class name read from header. More...

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

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

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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

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

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

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

bool	headerOk ()
	Read header of local object without type-checking. More...

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

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

bool	writeHeader (Ostream &, 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 &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

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

	pimpleLoop (const solutionControl &control)
	Construct from a solution control. More...

virtual	~pimpleLoop ()
	Destructor. More...

label	nCorrPimple () const
	Maximum number of pimple correctors. More...

bool	anyPimpleIter () const
	Flag to indicate any pimple iteration. More...

bool	firstPimpleIter () const
	Flag to indicate the first pimple iteration. More...

bool	finalPimpleIter () const
	Flag to indicate the last pimple iteration. More...

bool	loop (correctorConvergenceControl &convergence)
	Pimple loop. More...

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

	convergenceControl (const solutionControl &control)
	Construct from a solution control. More...

	convergenceControl (const convergenceControl &)=delete
	Disallow default bitwise copy construction. More...

virtual	~convergenceControl ()
	Destructor. More...

bool	converged ()
	Flag to indicate whether convergence has been reached. More...

bool	endIfConverged (Time &time)
	End the run if convergence has been reached. More...

void	operator= (const convergenceControl &)=delete
	Disallow default bitwise assignment. More...

template<class ResidualData >
Foam::label	residualControlIndex (const word &fieldName, const List< ResidualData > &residualControl, const bool useRegEx)

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

	correctorConvergenceControl (const solutionControl &control, const word &loopName)
	Construct from a solution control and the loop name. More...

virtual	~correctorConvergenceControl ()
	Destructor. More...

Static Protected Member Functions
static const Time &	time (const PtrList< fvMesh > &pimpleMeshes, const PtrList< fvMesh > &solidMeshes)
	Get the time from the region meshes. More...

Static Protected Member Functions inherited from correctorConvergenceControl
static void	getNSolves (const fvMesh &mesh, const word &fieldName, label &n)
	Get the number of solves that have happened for this variable in. More...

template<class Type >
static void	getNTypeSolves (const fvMesh &mesh, const word &fieldName, label &n)
	Get the number of solves that have happened for this variable in. More...

Protected Attributes
PtrList< pimpleNoLoopControl >	pimpleControls_
	The per-region pimple controls. More...

PtrList< solidNoLoopControl >	solidControls_
	The per-region solid controls. More...

Protected Attributes inherited from solutionControl
const Time &	time_
	Reference to the time. More...

const word	algorithmName_
	Name of the algorithm. More...

const string	algorithmSpaceStr_
	Whitespace the same length as the algorithm name. More...

Protected Attributes inherited from pimpleLoop
const solutionControl &	control_
	Reference to the solution control. More...

label	nCorrPimple_
	Maximum number of pimple correctors. More...

label	corrPimple_
	Current pimple corrector. More...

bool	converged_
	Flag to indicate convergence of the pimple loop. More...

Protected Attributes inherited from convergenceControl
const solutionControl &	control_
	Reference to the solution control. More...

Protected Attributes inherited from correctorConvergenceControl
const solutionControl &	control_
	Reference to the solution control. More...

const word	loopName_
	Name of the corrector loop. More...

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

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

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

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

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

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 Name >
static word	groupName (Name name, const word &group)

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 Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from convergenceControl
static DynamicList< word >	getFieldNames (const fvMesh &mesh)
	Get the list of names of the fields. More...

static void	getInitialResiduals (const fvMesh &mesh, const word &fieldName, const label solvei, scalar &r0, scalar &r)
	Get the initial residuals for the first and the i-th solves in this. More...

template<class ResidualData >
static label	residualControlIndex (const word &fieldName, const List< ResidualData > &residualControl, const bool useRegEx=true)
	Return the index of the named field in residual control data, or -1. More...

template<class Type >
static void	getFieldTypeNames (const fvMesh &mesh, DynamicList< word > &fieldNames)
	Append the of names of the fields of this Type to the given list. More...

template<class Type >
static void	getInitialTypeResiduals (const fvMesh &mesh, const word &fieldName, const label solvei, scalar &r0, scalar &r)
	Get the initial residuals for the first and the i-th solves in this. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

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

Protected Member Functions inherited from solutionControl
virtual bool	writeData (Ostream &) const
	Dummy write for regIOobject. More...

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

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

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Detailed Description

Pimple multi-region control class. As Foam::pimpleControl, but for a multi- region simulation comprising pimple and solid regions. More region types could be added.

Source files

Definition at line 56 of file pimpleMultiRegionControl.H.

Constructor & Destructor Documentation

◆ pimpleMultiRegionControl()

pimpleMultiRegionControl	(	PtrList< fvMesh > &	pimpleMeshes,
		PtrList< fvMesh > &	solidMeshes,
		const word &	algorithmName = `"PIMPLE"`
	)

Construct from meshes and the algorithm name.

Definition at line 64 of file pimpleMultiRegionControl.C.

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

Referenced by pimpleMultiRegionControl::time().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~pimpleMultiRegionControl()

~pimpleMultiRegionControl ( )

virtual

Destructor.

Definition at line 148 of file pimpleMultiRegionControl.C.

Member Function Documentation

◆ time()

const Foam::Time & time	(	const PtrList< fvMesh > &	pimpleMeshes,
		const PtrList< fvMesh > &	solidMeshes
	)

staticprotected

Get the time from the region meshes.

Definition at line 40 of file pimpleMultiRegionControl.C.

References UPtrList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and pimpleMultiRegionControl::pimpleMultiRegionControl().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "pimpleMultiRegionControl" )

Run-time type information.

◆ read()

bool read ( )

virtual

Read controls.

Reimplemented from pimpleLoop.

Definition at line 154 of file pimpleMultiRegionControl.C.

References forAll, and pimpleLoop::read().

Here is the call graph for this function:

◆ pimple()

Foam::pimpleNoLoopControl & pimple ( const label i )

inline

Access the i-th pimple control.

Definition at line 29 of file pimpleMultiRegionControlI.H.

References pimpleMultiRegionControl::pimpleControls_.

◆ solid()

Foam::solidNoLoopControl & solid ( const label i )

inline

Access the i-th solid control.

Definition at line 36 of file pimpleMultiRegionControlI.H.

References pimpleMultiRegionControl::solidControls_.

◆ pimpleTurbCorr()

bool pimpleTurbCorr ( const label i ) const

inline

Flag to indicate whether to solve the turbulence.

Definition at line 42 of file pimpleMultiRegionControlI.H.

References pimpleLoop::finalPimpleIter(), and pimpleMultiRegionControl::pimpleControls_.

Here is the call graph for this function:

◆ hasResidualControls()

bool hasResidualControls ( ) const

virtual

Return true if residual controls are present.

Implements convergenceControl.

Definition at line 174 of file pimpleMultiRegionControl.C.

References forAll.

◆ hasCorrResidualControls()

bool hasCorrResidualControls ( ) const

virtual

Return true if corrector residual controls are present.

Implements correctorConvergenceControl.

Definition at line 191 of file pimpleMultiRegionControl.C.

References forAll.

◆ criteriaSatisfied()

bool criteriaSatisfied ( ) const

virtual

Return true if all convergence checks are satisfied.

Implements convergenceControl.

Definition at line 208 of file pimpleMultiRegionControl.C.

References forAll.

◆ corrCriteriaSatisfied()

bool corrCriteriaSatisfied ( ) const

virtual

Return true if all correction convergence checks are satisfied.

Implements correctorConvergenceControl.

Definition at line 225 of file pimpleMultiRegionControl.C.

References forAll.

◆ resetCorrSolveIndex()

void resetCorrSolveIndex ( )

virtual

Reset the solve index in the correction residual control data.

Implements correctorConvergenceControl.

Definition at line 242 of file pimpleMultiRegionControl.C.

References forAll.

◆ updateCorrSolveIndex()

void updateCorrSolveIndex ( )

virtual

Update the solve index in the correction residual control data.

Implements correctorConvergenceControl.

Definition at line 255 of file pimpleMultiRegionControl.C.

References forAll.

◆ loop() [1/2]

bool loop ( )

Pimple loop.

Definition at line 268 of file pimpleMultiRegionControl.C.

References forAll, pimpleLoop::loop(), and Foam::read().

Here is the call graph for this function:

◆ run()

bool run ( Time & time )

Time run loop.

Definition at line 308 of file pimpleMultiRegionControl.C.

References forAll, Foam::read(), and Time::run().

Here is the call graph for this function:

◆ loop() [2/2]

bool loop ( Time & time )

Time loop loop.

Definition at line 328 of file pimpleMultiRegionControl.C.

References forAll, Time::loop(), and Foam::read().

Here is the call graph for this function:

Member Data Documentation

◆ pimpleControls_

PtrList<pimpleNoLoopControl> pimpleControls_

protected

The per-region pimple controls.

Definition at line 68 of file pimpleMultiRegionControl.H.

Referenced by pimpleMultiRegionControl::pimple(), and pimpleMultiRegionControl::pimpleTurbCorr().

◆ solidControls_

PtrList<solidNoLoopControl> solidControls_

protected

The per-region solid controls.

Definition at line 71 of file pimpleMultiRegionControl.H.

Referenced by pimpleMultiRegionControl::solid().

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

src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleMultiRegionControl/pimpleMultiRegionControl.H
src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleMultiRegionControl/pimpleMultiRegionControl.C
src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleMultiRegionControl/pimpleMultiRegionControlI.H

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pimpleMultiRegionControl()

◆ ~pimpleMultiRegionControl()

Member Function Documentation

◆ time()

◆ TypeName()

◆ read()

◆ pimple()

◆ solid()

◆ pimpleTurbCorr()

◆ hasResidualControls()

◆ hasCorrResidualControls()

◆ criteriaSatisfied()

◆ corrCriteriaSatisfied()

◆ resetCorrSolveIndex()

◆ updateCorrSolveIndex()

◆ loop() [1/2]

◆ run()

◆ loop() [2/2]

Member Data Documentation

◆ pimpleControls_

◆ solidControls_