Single-region-specific derivation of the solution control class. More...

Inheritance diagram for singleRegionSolutionControl:

Collaboration diagram for singleRegionSolutionControl:

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

	singleRegionSolutionControl (fvMesh &mesh, const word &algorithmName)
	Construct from a mesh and the name of the algorithm. More...

virtual	~singleRegionSolutionControl ()
	Destructor. More...

const fvMesh &	mesh () const
	Return the mesh. More...

fvMesh &	mesh ()
	Return the mesh. More...

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

void	storePrevIterFields ()
	Store previous iteration for fields. 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...

virtual bool	read ()
	Dummy read. 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 &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

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

bool	checkOut ()
	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...

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

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. Return. 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 valid) const
	Write using given format, version and compression. 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 &)

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, 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)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. 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...

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

bool	globalObject () const
	Is object same for all processors. 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...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

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

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. 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)

Protected Member Functions
template<class Type >
void	storePrevIterTypeFields () const
	Store previous iteration for fields. 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 PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

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

Protected Attributes
fvMesh &	mesh_
	Reference to the mesh. 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...

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 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 Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

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

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

Detailed Description

Single-region-specific derivation of the solution control class.

Source files

Definition at line 51 of file singleRegionSolutionControl.H.

Constructor & Destructor Documentation

◆ singleRegionSolutionControl()

singleRegionSolutionControl	(	fvMesh &	mesh,
		const word &	algorithmName
	)

Construct from a mesh and the name of the algorithm.

Definition at line 40 of file singleRegionSolutionControl.C.

◆ ~singleRegionSolutionControl()

~singleRegionSolutionControl ( )

virtual

Destructor.

Definition at line 52 of file singleRegionSolutionControl.C.

Member Function Documentation

◆ storePrevIterTypeFields()

void storePrevIterTypeFields ( ) const

protected

Store previous iteration for fields.

Definition at line 29 of file singleRegionSolutionControlTemplates.C.

References fld(), forAllIter, singleRegionSolutionControl::mesh_, and solution::relaxField().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "singleRegionSolutionControl" )

Run-time type information.

◆ mesh() [1/2]

const Foam::fvMesh & mesh ( ) const

inline

Return the mesh.

Definition at line 28 of file singleRegionSolutionControlI.H.

References singleRegionSolutionControl::mesh_.

Referenced by pimpleControl::loop().

Here is the caller graph for this function:

◆ mesh() [2/2]

Foam::fvMesh & mesh ( )

inline

Return the mesh.

Definition at line 34 of file singleRegionSolutionControlI.H.

References singleRegionSolutionControl::mesh_.

◆ dict()

const Foam::dictionary & dict ( ) const

virtual

Return the solution dictionary.

Implements solutionControl.

Definition at line 58 of file singleRegionSolutionControl.C.

References dictionary::subDict().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storePrevIterFields()

void storePrevIterFields ( )

Store previous iteration for fields.

Definition at line 64 of file singleRegionSolutionControl.C.

Referenced by simpleControl::loop(), pimpleControl::loop(), simpleControl::run(), and pimpleControl::run().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

Reference to the mesh.

Definition at line 60 of file singleRegionSolutionControl.H.

Referenced by singleRegionSolutionControl::mesh(), and singleRegionSolutionControl::storePrevIterTypeFields().

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

src/finiteVolume/cfdTools/general/solutionControl/solutionControl/singleRegionSolutionControl/singleRegionSolutionControl.H
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/singleRegionSolutionControl/singleRegionSolutionControl.C
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/singleRegionSolutionControl/singleRegionSolutionControlI.H
src/finiteVolume/cfdTools/general/solutionControl/solutionControl/singleRegionSolutionControl/singleRegionSolutionControlTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ singleRegionSolutionControl()

◆ ~singleRegionSolutionControl()

Member Function Documentation

◆ storePrevIterTypeFields()

◆ TypeName()

◆ mesh() [1/2]

◆ mesh() [2/2]

◆ dict()

◆ storePrevIterFields()

Member Data Documentation

◆ mesh_