functions Class Reference

Solver module to execute the functionObjects for a specified solver. More...

Inheritance diagram for functions:
Collaboration diagram for functions:

Public Member Functions

 TypeName ("functions")
 Runtime type information. More...
 
 functions (fvMesh &mesh)
 Construct from region mesh. More...
 
 functions (const functions &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functions ()
 Destructor. More...
 
virtual scalar maxDeltaT () const
 Return the current maximum time-step for stable solution. More...
 
virtual void prePredictor ()
 Called at the beginning of the PIMPLE loop. More...
 
virtual void momentumPredictor ()
 Construct and optionally solve the momentum equation. More...
 
virtual void thermophysicalPredictor ()
 Construct and solve the energy equation,. More...
 
virtual void pressureCorrector ()
 Construct and solve the pressure equation in the PISO loop. More...
 
virtual void postCorrector ()
 Correct the thermophysical transport modelling. More...
 
virtual void postSolve ()
 Called after the PIMPLE loop at the end of the time-step. More...
 
void operator= (const functions &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from movingMesh
 TypeName ("movingMesh")
 Runtime type information. More...
 
 movingMesh (fvMesh &mesh)
 Construct from region mesh. More...
 
 movingMesh (const movingMesh &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~movingMesh ()
 Destructor. More...
 
virtual void preSolve ()
 Called at the start of the time-step, before the PIMPLE loop. More...
 
virtual void moveMesh ()
 Called at the start of the PIMPLE loop to move the mesh. More...
 
virtual void motionCorrector ()
 Corrections that follow mesh motion. More...
 
void operator= (const movingMesh &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from solver
 TypeName ("solver")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, solver, fvMesh,(fvMesh &mesh),(mesh))
 
 solver (fvMesh &mesh)
 Construct from region mesh. More...
 
 solver (const solver &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~solver ()
 Destructor. More...
 
bool transient () const
 
Foam::fvModelsfvModels () const
 Return the fvModels that are created on demand. More...
 
Foam::fvConstraintsfvConstraints () const
 Return the fvConstraints that are created on demand. More...
 
void operator= (const solver &)=delete
 Disallow default bitwise assignment. 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 fileNamecaseName () 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (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 labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. 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 &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) 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 filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- 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< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () 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 fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Protected Attributes

autoPtr< solversolverPtr
 Pointer to the solid or fluid solver. More...
 
- Protected Attributes inherited from solver
fvMeshmesh_
 Region mesh. More...
 
bool steady
 Switch for steady-state. More...
 
bool LTS
 Switch for local time step transient operation. 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 solver
static autoPtr< solverNew (const word &solverName, fvMesh &mesh)
 Select, construct and return the solver. More...
 
static void load (const word &solverName)
 Load the specified solver library. 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...
 
- Public Attributes inherited from solver
const fvMeshmesh
 Region mesh. More...
 
const TimerunTime
 Time. More...
 
pimpleNoLoopControl pimple
 PIMPLE inner-loop controls. More...
 
- Static Public Attributes inherited from solver
static scalar deltaTFactor = 1.2
 deltaT increase factor 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 solver
virtual bool read ()
 Read controls. 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

Solver module to execute the functionObjects for a specified solver.

The solver specified by either the subSolver or if not present the solver entry in the controlDict is instantiated to provide the physical fields needed by the functionObjects. The functionObjects are then instantiated from the specifications are read from the functions entry in the controlDict and executed in a time-loop also controlled by entries in controlDict and the maxDeltaT() returned by the sub-solver.

The fields and other objects registered by the sub-solver are set to NO_WRITE as they are not changed by the execution of the functionObjects and should not be written out each write-time. Fields and other objects created and changed by the execution of the functionObjects are written out.

When restarting from a time directory which does contain the subSolver fields the optional controlDict entry subSolverTime may be provided to specify which time the subSolver should be instantiated for, after which time is reset to startTime for the restart.

Source files

Definition at line 67 of file functions.H.

Constructor & Destructor Documentation

◆ functions() [1/2]

◆ functions() [2/2]

functions ( const functions )
delete

Disallow default bitwise copy construction.

◆ ~functions()

~functions ( )
virtual

Destructor.

Definition at line 104 of file functions.C.

Member Function Documentation

◆ TypeName()

TypeName ( "functions"  )

Runtime type information.

◆ maxDeltaT()

Foam::scalar maxDeltaT ( ) const
virtual

Return the current maximum time-step for stable solution.

Reimplemented from movingMesh.

Definition at line 110 of file functions.C.

◆ prePredictor()

void prePredictor ( )
virtual

Called at the beginning of the PIMPLE loop.

Reimplemented from movingMesh.

Definition at line 116 of file functions.C.

◆ momentumPredictor()

void momentumPredictor ( )
virtual

Construct and optionally solve the momentum equation.

Reimplemented from movingMesh.

Definition at line 120 of file functions.C.

◆ thermophysicalPredictor()

void thermophysicalPredictor ( )
virtual

Construct and solve the energy equation,.

convert to temperature and update thermophysical and transport properties

Reimplemented from movingMesh.

Definition at line 124 of file functions.C.

◆ pressureCorrector()

void pressureCorrector ( )
virtual

Construct and solve the pressure equation in the PISO loop.

Reimplemented from movingMesh.

Definition at line 128 of file functions.C.

◆ postCorrector()

void postCorrector ( )
virtual

Correct the thermophysical transport modelling.

Reimplemented from movingMesh.

Definition at line 132 of file functions.C.

◆ postSolve()

void postSolve ( )
virtual

Called after the PIMPLE loop at the end of the time-step.

Reimplemented from movingMesh.

Definition at line 136 of file functions.C.

◆ operator=()

void operator= ( const functions )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ solverPtr

autoPtr<solver> solverPtr
protected

Pointer to the solid or fluid solver.

Definition at line 75 of file functions.H.

Referenced by functions::functions().


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