Base class for solution control classes. More...

Inheritance diagram for solutionControl:

Collaboration diagram for solutionControl:

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

Public Member Functions
	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...

virtual bool	loop ()=0
	Main control loop. 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 isTimeObject=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	registered () const noexcept

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

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

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

label &	eventNo () noexcept
	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...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. 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 bool	read ()
	Read object. More...

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

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const

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

virtual bool	writeData (Ostream &) const =0
	Pure virtual writeData function. 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 (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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 rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=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 rOpt=NO_READ, writeOption wOpt=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...

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

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

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

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

string &	note () noexcept
	Modifiable access to the optional note. More...

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

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

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

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

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

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

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

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

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

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

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. 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
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

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	objectRelPath () const
	The object path relative to the root. 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...

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)
	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 with current type() More...

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

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

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

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

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

Static Public Member Functions
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)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

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

static word	scopedName (const std::string &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, const bool noSyntaxHint=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...

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

virtual bool	read ()
	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 bool	criteriaSatisfied ()=0
	Return true if all convergence checks are satisfied. 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 void	setFirstIterFlag (const bool check=true, const bool force=false)
	Set the firstIteration flag on the mesh data dictionary. More...

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

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

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

Static Protected Member Functions
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)

Protected Attributes
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	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

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

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

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

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 float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

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

Detailed Description

Base class for solution control classes.

Definition at line 49 of file solutionControl.H.

Constructor & Destructor Documentation

◆ solutionControl()

solutionControl	(	fvMesh &	mesh,
		const word &	algorithmName
	)

Construct from mesh.

Definition at line 272 of file solutionControl.C.

◆ ~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 242 of file solutionControl.C.

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

Here is the call graph for this function:

◆ read() [1/2]

bool read ( const bool absTolOnly )

protectedvirtual

Read controls from fvSolution dictionary.

Definition at line 41 of file solutionControl.C.

References solutionControl::fieldData::absTol, solutionControl::applyToField(), solutionControl::consistent_, solutionControl::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, solutionControl::frozenFlow_, dictionary::get(), dictionary::getOrDefault(), Foam::Info, solutionControl::fieldData::initialResidual, solutionControl::momentumPredictor_, solutionControl::fieldData::name, Foam::nl, solutionControl::nNonOrthCorr_, solutionControl::fieldData::relTol, solutionControl::residualControl_, solutionDict(), dictionary::subOrEmptyDict(), and solutionControl::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, simpleControl, SIMPLEControlOpt, SIMPLEControl, and SIMPLEControlSingleRun.

Definition at line 136 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 142 of file solutionControl.C.

References forAll, string::match(), and Foam::name().

Referenced by solutionControl::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.

◆ storePrevIterFields()

void storePrevIterFields ( ) const

protectedvirtual

Store previous iteration fields.

Definition at line 160 of file solutionControl.C.

◆ storePrevIter()

void storePrevIter

protected

Store previous iteration field for vol<Type>Fields.

Definition at line 36 of file solutionControlTemplates.C.

References solutionControl::algorithmName_, DebugInfo, Foam::endl(), fld(), forAllIters, solutionControl::mesh_, and solution::relaxField().

Here is the call graph for this function:

◆ maxTypeResidual()

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 217 of file solutionControl.C.

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

Here is the call 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 171 of file solutionControl.C.

◆ 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 180 of file solutionControl.C.

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

Referenced by 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 206 of file solutionControl.C.

References NotImplemented, and solutionControl::writeData().

Referenced by solutionControl::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "solutionControl" )

Run-time type information.

◆ dict()

const Foam::dictionary dict ( ) const

virtual

Return the solution dictionary.

Reimplemented in SIMPLEControl.

Definition at line 300 of file solutionControl.C.

References dictionary::subOrEmptyDict().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ corr()

Foam::label corr ( ) const

inline

Current corrector loop index.

Definition at line 30 of file solutionControlI.H.

References solutionControl::corr_.

◆ corrNonOrtho()

Foam::label corrNonOrtho ( ) const

inline

Current non-orthogonal corrector index.

Definition at line 36 of file solutionControlI.H.

◆ nNonOrthCorr()

Foam::label nNonOrthCorr ( ) const

inline

Maximum number of non-orthogonal correctors.

Definition at line 42 of file solutionControlI.H.

◆ finalNonOrthogonalIter()

bool finalNonOrthogonalIter ( ) const

inline

Helper function to identify final non-orthogonal iteration.

Definition at line 48 of file solutionControlI.H.

◆ momentumPredictor()

bool momentumPredictor ( ) const

inline

Flag to indicate to solve for momentum.

Definition at line 54 of file solutionControlI.H.

◆ transonic()

bool transonic ( ) const

inline

Flag to indicate to solve using transonic algorithm.

Definition at line 60 of file solutionControlI.H.

◆ consistent()

bool consistent ( ) const

inline

Flag to indicate to relax pressure using the.

"consistent" approach of SIMPLEC

Definition at line 66 of file solutionControlI.H.

◆ frozenFlow()

bool frozenFlow ( ) const

inline

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

be evolved

Definition at line 72 of file solutionControlI.H.

◆ loop()

virtual bool loop ( )

pure virtual

Main control loop.

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

◆ correctNonOrthogonal()

bool correctNonOrthogonal ( )

inline

Non-orthogonal corrector loop.

Definition at line 78 of file solutionControlI.H.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

Reference to the mesh database.

Definition at line 84 of file solutionControl.H.

Referenced by simpleControl::simpleControl(), and solutionControl::storePrevIter().

◆ residualControl_

List<fieldData> residualControl_

protected

List of residual data per field.

Definition at line 87 of file solutionControl.H.

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

◆ algorithmName_

const word algorithmName_

protected

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

Definition at line 90 of file solutionControl.H.

Referenced by pimpleControl::pimpleControl(), simpleControl::simpleControl(), and solutionControl::storePrevIter().

◆ nNonOrthCorr_

label nNonOrthCorr_

protected

Maximum number of non-orthogonal correctors.

Definition at line 96 of file solutionControl.H.

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

◆ momentumPredictor_

bool momentumPredictor_

protected

Flag to indicate to solve for momentum.

Definition at line 99 of file solutionControl.H.

Referenced by solutionControl::read().

◆ transonic_

bool transonic_

protected

Flag to indicate to solve using transonic algorithm.

Definition at line 102 of file solutionControl.H.

Referenced by solutionControl::read().

◆ consistent_

bool consistent_

protected

Flag to indicate to relax pressure using the.

"consistent" approach of SIMPLEC

Definition at line 106 of file solutionControl.H.

Referenced by solutionControl::read().

◆ frozenFlow_

bool frozenFlow_

protected

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

be evolved

Definition at line 110 of file solutionControl.H.

Referenced by solutionControl::read().

◆ corr_

label corr_

protected

Current corrector loop index.

Definition at line 116 of file solutionControl.H.

Referenced by solutionControl::corr().

◆ corrNonOrtho_

label corrNonOrtho_

protected

Current non-orthogonal corrector loop index.

Definition at line 119 of file solutionControl.H.

Referenced by pisoControl::finalInnerIter().

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_