Loading...
Searching...
No Matches
IOobject Class Reference

Defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O. More...

#include <IOobject.H>

Inheritance diagram for IOobject:
Collaboration diagram for IOobject:

Public Types

enum  objectState : char { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
enum  fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
 Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). More...
Public Types inherited from IOobjectOption
enum  readOption : unsigned char {
  NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 ,
  LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4
}
 Enumeration defining read preferences. More...
enum  writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining write preferences. More...
enum  registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
 Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class  Layout : unsigned char { regular , global }
 The layout of the case structure. More...

Public Member Functions

 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch).
 IOobject (const IOobject &)=default
 Copy construct.
virtual ~IOobject ()=default
 Destructor.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from path, registry, io options.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options.
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry.
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name.
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component.
 IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
 Copy construct, resetting read/write options.
 IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
 Copy construct, resetting register option.
autoPtr< IOobject > clone () const
 Clone.
autoPtr< IOobject > clone (const objectRegistry &registry) const
 Clone resetting registry.
const objectRegistrydb () const noexcept
 Return the local objectRegistry.
const Timetime () const noexcept
 Return Time associated with the objectRegistry.
const wordname () const noexcept
 Return the object name.
const wordheaderClassName () const noexcept
 Return name of the class name read from header.
wordheaderClassName () noexcept
 Modifiable access to the class name read from header.
const stringnote () const noexcept
 Return the optional note.
stringnote () noexcept
 Modifiable access to the optional note.
virtual void rename (const word &newName)
 Rename the object.
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header.
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header.
void resetHeader (const word &newName=word::null)
 Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading).
bool isHeaderClass (const word &expectedType) const
 Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName Always true for a void type.
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr.
word group () const
 Return group (extension part of name).
word member () const
 Return member (name without the extension).
const fileNamerootPath () const noexcept
 Return the Time::rootPath().
const fileNamecaseName () const noexcept
 Return the Time::caseName().
const fileNameglobalCaseName () const noexcept
 Return the Time::globalCaseName().
const fileNamecaseName (IOobjectOption::Layout) const noexcept
 Return the Time::caseName() - normal or global.
const fileNameinstance () const noexcept
 Read access to instance path component.
fileNameinstance () noexcept
 Modifiable access to instance path component.
scalar instanceValue () const
 Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileNamelocal () const noexcept
 Read access to local path component.
fileNamelocal () noexcept
 Modifiable access to the local path component.
fileName path () const
 The complete path for the object (with instance, local,...).
fileName globalPath () const
 The complete global path for the object (with instance, local,...).
fileName path (IOobjectOption::Layout) const
 The complete path (normal or global) for the object.
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local.
fileName globalPath (const word &instance, const fileName &local=fileName::null) const
 The complete global path with alternative instance and local.
fileName path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
 The complete path (normal or global) with alternative instance and local.
fileName objectPath () const
 The complete path + object name.
fileName globalObjectPath () const
 The complete global path + object name.
fileName objectPath (IOobjectOption::Layout) const
 The complete path (normal or global) + object name.
fileName objectPath (IOobjectOption::Layout, const word &instance) const
 The complete path (normal or global) + object name with alternative instance.
fileName objectPath (const word &instance) const
 The complete path + object name with alternative instance.
fileName globalObjectPath (const word &instance) const
 The complete global path + object name with alternative instance.
fileName objectRelPath () const
 The object path relative to the case.
fileName localFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching locally.
fileName globalFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption parseHeader (const dictionary &headerDict)
 Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool readHeader (Istream &is)
 Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool readHeader (dictionary &headerDict, Istream &is)
 Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool typeHeaderOk (const bool checkType=true, const bool verbose=true)
 Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.
template<class Type>
fileName typeFilePath (const bool search=true) const
 Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void warnNoRereading () const
 Helper: warn that type does not support re-reading.
bool writeHeader (Ostream &os) const
 Write header with current type().
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type.
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 Write header into a dictionary with current type() and given output format.
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 Write header into a dictionary with override of type and given output format.
bool good () const noexcept
 Did last readHeader() succeed?
bool bad () const noexcept
 Did last readHeader() fail?
InfoProxy< IOobject > info () const noexcept
 Return info proxy, for printing information to a stream.
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry).
template<class Type>
bool isHeaderClassName () const
 Same as isHeaderClass().
template<class StringType>
Foam::word groupName (StringType base, const word &group)
template<class Type>
Foam::fileName typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_WRITE with specified read/register options.
constexpr IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_READ with specified write/register options.
constexpr IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option.
constexpr IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
 Construct from components with specified register option as bool.
constexpr IOobjectOption (bool registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption readOpt () const noexcept
 Get the read option.
readOption readOpt (readOption opt) noexcept
 Set the read option.
writeOption writeOpt () const noexcept
 Get the write option.
writeOption writeOpt (writeOption opt) noexcept
 Set the write option.
bool registerObject () const noexcept
 Should objects created with this IOobject be registered?
bool registerObject (bool on) noexcept
 Change registration preference.
bool globalObject () const noexcept
 True if object is treated the same for all processors.
bool globalObject (bool on) noexcept
 Change global-object status.
bool isAnyRead () const noexcept
 True if any reading may be required (ie, != NO_READ).
bool isReadRequired () const noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set.
bool isReadOptional () const noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOptionreadOpt () noexcept
 Access to the read option.
writeOptionwriteOpt () noexcept
 Access to the write option.
bool & registerObject () noexcept
 Access to the register object option.
bool & globalObject () noexcept
 Access to the global object option.

Static Public Member Functions

static bool bannerEnabled () noexcept
 Status of output file banner.
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner.
static bool fileModificationChecking_masterOnly () noexcept
 Test fileModificationChecking for master-only.
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components.
template<class StringType>
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string.
static word group (const word &name)
 Return group (extension part of name).
static word member (const word &name)
 Return member (name without the extension).
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string.
static word scopedName (const std::string &scope, const word &name1, const word &name2)
 Create scope:name1:name2 or scope_name1_name2 string.
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name.
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner.
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider.
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool isAnyRead (readOption opt) noexcept
 True if any reading may be required (ie, != NO_READ).
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set.
static bool isReadOptional (readOption opt) noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption lazierRead (readOption opt) noexcept
 Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Static Public Attributes

static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes.
static char scopeSeparator
 Character for scoping object names (':' or '_').
static fileCheckTypes fileModificationChecking
 Type of file modification checking.
static float fileModificationSkew
 Time skew (seconds) for file modification checks.
static int maxFileModificationPolls
 Max number of times to poll for file modification changes.

Protected Member Functions

void setBad (const string &s)
 Set the object state to bad.

Static Protected Member Functions

static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 Helper: write content for FoamFile IOobject header with optional meta information.
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 Helper: write dictionary content for FoamFile header with optional meta information.

Detailed Description

Defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O.

An IOobject is constructed with an object name, a class name, an instance path, a reference to a objectRegistry, and parameters determining its storage status.

Read options

Define what is done on object construction and explicit reads:

  • NO_READ
    Do not read
  • MUST_READ
    Object must be read from Istream on construction.
    Error if Istream does not exist or cannot be read. Does not check timestamp or re-read.
  • READ_MODIFIED (MUST_READ_IF_MODIFIED)
    Object must be read from Istream on construction.
    Error if Istream does not exist or cannot be read. If object is registered its timestamp will be checked every timestep and possibly re-read.
  • LAZY_READ (READ_IF_PRESENT)
    Read object from Istream, but only if Istream exists.
    Error only if Istream exists but cannot be read. Does not check timestamp or re-read.
    Write options
    Define what is done on object destruction and explicit writes:
  • NO_WRITE
    No automatic writing, but can be written explicitly
  • AUTO_WRITE
    Object is written automatically when requested to by the objectRegistry.
    When serializing, the IOobject characteristics are typically written as a FoamFile header, which is a sub-dictionary with the following type of content:
Property Description Type Reqd Deflt
version The base format version float no 2.0
format The stream format (ascii/binary) word yes
arch The architecture string string no
note Descriptive note about the object string no
location The relative location of the object string no
class The type of the object word yes
object The name of the object word yes
Note
Specifying registered does not result in the IOobject itself being registered. It is only serves as guidance for a regIOobject using it.
See also
Foam::objectRegistry Foam::regIOobject
Source files

Definition at line 188 of file IOobject.H.

Member Enumeration Documentation

◆ objectState

enum objectState : char

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD 
BAD 

Definition at line 199 of file IOobject.H.

◆ fileCheckTypes

enum fileCheckTypes : char

Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly).

Enumerator
timeStamp 
timeStampMaster 
inotify 
inotifyMaster 

Definition at line 209 of file IOobject.H.

Constructor & Destructor Documentation

◆ IOobject() [1/12]

IOobject ( const IOobject & )
default

Copy construct.

◆ ~IOobject()

virtual ~IOobject ( )
virtualdefault

◆ IOobject() [2/12]

IOobject ( const word & name,
const fileName & instance,
const objectRegistry & registry,
IOobjectOption ioOpt = IOobjectOption() )

Construct from name, instance, registry, io options.

(default: NO_READ, NO_WRITE, REGISTER, non-global)

Definition at line 338 of file IOobject.C.

References Foam::endl(), InfoInFunction, instance(), IOobjectOption::IOobjectOption(), and name().

Here is the call graph for this function:

◆ IOobject() [3/12]

IOobject ( const word & name,
const fileName & instance,
const fileName & local,
const objectRegistry & registry,
IOobjectOption ioOpt = IOobjectOption() )

Construct from name, instance, local, registry, io options.

(default: NO_READ, NO_WRITE, REGISTER, non-global)

Definition at line 359 of file IOobject.C.

References Foam::endl(), InfoInFunction, instance(), IOobjectOption::IOobjectOption(), local(), and name().

Here is the call graph for this function:

◆ IOobject() [4/12]

IOobject ( const fileName & path,
const objectRegistry & registry,
IOobjectOption ioOpt = IOobjectOption() )

Construct from path, registry, io options.

(default: NO_READ, NO_WRITE, REGISTER, non-global)

Uses fileNameComponents() to split path into components. A path that starts with a '/' is regarded as a file system path. Paths starting with either './' or '../' are relative to current working directory (and replaced with absolute equivalents). All other paths are considered to be relative to the case.

Definition at line 382 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fileNameComponents(), InfoInFunction, IOobjectOption::IOobjectOption(), and path().

Here is the call graph for this function:

◆ IOobject() [5/12]

IOobject ( const word & name,
const fileName & instance,
const objectRegistry & registry,
IOobjectOption::readOption rOpt,
IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
bool registerObject = true,
bool globalObject = false )
inline

Construct from name, instance, registry, io options.

Definition at line 99 of file IOobjectI.H.

References IOobjectOption::globalObject(), instance(), IOobjectOption::IOobjectOption(), name(), and IOobjectOption::registerObject().

Here is the call graph for this function:

◆ IOobject() [6/12]

IOobject ( const word & name,
const fileName & instance,
const fileName & local,
const objectRegistry & registry,
IOobjectOption::readOption rOpt,
IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
bool registerObject = true,
bool globalObject = false )
inline

Construct from name, instance, local, registry, io options.

Definition at line 120 of file IOobjectI.H.

References IOobjectOption::globalObject(), instance(), IOobjectOption::IOobjectOption(), local(), name(), and IOobjectOption::registerObject().

Here is the call graph for this function:

◆ IOobject() [7/12]

IOobject ( const fileName & path,
const objectRegistry & registry,
IOobjectOption::readOption rOpt,
IOobjectOption::writeOption wOpt = IOobjectOption::NO_WRITE,
bool registerObject = true,
bool globalObject = false )
inline

Construct from path, registry, io options.

Uses fileNameComponents() to split path into components. A path that starts with a '/' is regarded as a file system path. Paths starting with either './' or '../' are relative to current working directory (and replaced with absolute equivalents). All other paths are considered to be relative to the case.

Definition at line 143 of file IOobjectI.H.

References IOobjectOption::globalObject(), IOobjectOption::IOobjectOption(), path(), and IOobjectOption::registerObject().

Here is the call graph for this function:

◆ IOobject() [8/12]

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

Copy construct, resetting registry.

Definition at line 406 of file IOobject.C.

References io, and IOobjectOption::IOobjectOption().

Here is the call graph for this function:

◆ IOobject() [9/12]

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

Copy construct, resetting name.

Definition at line 427 of file IOobject.C.

References io, IOobjectOption::IOobjectOption(), and name().

Here is the call graph for this function:

◆ IOobject() [10/12]

IOobject ( const IOobject & io,
const word & name,
const fileName & local )
inline

Copy construct, resetting name and local component.

Definition at line 162 of file IOobjectI.H.

References io, local(), and name().

Here is the call graph for this function:

◆ IOobject() [11/12]

IOobject ( const IOobject & io,
IOobjectOption::readOption rOpt,
IOobjectOption::writeOption wOpt )
inline

Copy construct, resetting read/write options.

Definition at line 175 of file IOobjectI.H.

References io, IOobjectOption::readOpt(), and IOobjectOption::writeOpt().

Here is the call graph for this function:

◆ IOobject() [12/12]

IOobject ( const IOobject & io,
IOobjectOption::registerOption regOpt )
inline

Copy construct, resetting register option.

Definition at line 189 of file IOobjectI.H.

References io, and IOobjectOption::registerObject().

Here is the call graph for this function:

Member Function Documentation

◆ writeHeaderContent() [1/2]

void writeHeaderContent ( Ostream & os,
const IOobject & io,
const word & objectType,
const dictionary * metaDataDict = nullptr )
staticprotected

Helper: write content for FoamFile IOobject header with optional meta information.

Definition at line 150 of file IOobjectWriteHeader.C.

References Foam::foamVersion::buildArch, DLListBase::empty(), io, os(), dictionary::writeEntry(), and Foam::writeHeaderEntry().

Referenced by writeHeader(), and writeHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeHeaderContent() [2/2]

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

Helper: write dictionary content for FoamFile header with optional meta information.

Definition at line 189 of file IOobjectWriteHeader.C.

References Foam::foamVersion::buildArch, dict, DLListBase::empty(), IOstreamOption::format(), io, and IOstreamOption::version().

Here is the call graph for this function:

◆ setBad()

void setBad ( const string & s)
protected

Set the object state to bad.

Definition at line 625 of file IOobject.C.

References BAD, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, GOOD, info(), InfoInFunction, messageStream::level, and s().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "IOobject" )

Declare type-name, virtual type (with debug switch).

◆ bannerEnabled() [1/2]

bool bannerEnabled ( )
inlinestaticnoexcept

Status of output file banner.

Definition at line 376 of file IOobject.H.

References Foam::noexcept.

Referenced by decomposedBlockData::writeBlockEntry(), decomposedBlockData::writeHeader(), decomposedBlockData::writeHeader(), and writeHeader().

Here is the caller graph for this function:

◆ bannerEnabled() [2/2]

bool bannerEnabled ( bool on)
inlinestaticnoexcept

Enable/disable output file banner.

Returns
the previous value

Definition at line 386 of file IOobject.H.

◆ fileModificationChecking_masterOnly()

bool fileModificationChecking_masterOnly ( )
inlinestaticnoexcept

◆ fileNameComponents()

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

Split path into instance, local, name components.

The splitting behaviour is as follows:

*   input       | instance   | local | name
*   ----------- | ---------- | ----- | ----
*   a           |            |       | a
*   a/b         | a          |       | b
*   a/b/c/d     | a          | b/c   | d
*   /a/b/c      | /a/b       |       | c
*   ./a/b/c     | PWD/a/b    |       | c
*   ../a/b/c    | PWD/../a/b |       | c
*   a/b/        | ERROR      |       |
* 

where PWD is the Foam::cwd() current working directory

Definition at line 164 of file IOobject.C.

References fileName::clean(), Foam::cwd(), Foam::endl(), fileNameComponents(), instance(), Foam::isDir(), local(), name(), path(), word::validate(), and WarningInFunction.

Referenced by fileNameComponents(), and IOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ groupName() [1/2]

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

Create dot-delimited name.group string.

An empty group is ignored.

References group(), groupName(), io, member(), name(), scopedName(), and selectIO().

Referenced by phaseSystem::addField(), phaseSystem::addField(), phaseChange::addToDriftRate(), StaticPhaseModel< BasePhaseModel >::alphaPhi(), ThermalDiffusivity< BasicTurbulenceModel >::alphat(), basicMultiComponentMixture::basicMultiComponentMixture(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUBlendedWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), kEpsilon::computeG(), kOmegaSST::computeG(), populationBalanceModel::continuousTurbulence(), turbulentDispersionModel::continuousTurbulence(), limitTemperature::correct(), Maxwell< BasicTurbulenceModel >::correct(), DarcyForchheimer::correct(), DarcyForchheimer::correct(), powerLaw::correct(), powerLaw::correct(), solidification::correct(), solidification::correct(), EddyDiffusivity< phaseCompressibleTurbulenceModel >::correctNut(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::correctThermo(), InterfaceCompositionModel< Thermo, OtherThermo >::D(), Burns::D(), Gosman::D(), DeltaOmegaTildeDelta::DeltaOmegaTildeDelta(), Maxwell< BasicTurbulenceModel >::devRhoReff(), linearViscousStress< BasicTurbulenceModel >::devRhoReff(), kineticTheoryModel::devRhoReff(), phasePressureModel::devRhoReff(), ReynoldsStress< BasicTurbulenceModel >::devRhoReff(), InterfaceCompositionModel< Thermo, OtherThermo >::Dfrom(), MovingPhaseModel< BasePhaseModel >::diffNo(), phaseSystem::dmdt(), SpalartAllmarasBase< BasicEddyViscosityModel >::DnuTildaEff(), dragModel::dragModel(), dragModel::dragModel(), InterfaceCompositionModel< Thermo, OtherThermo >::Dto(), laminarModel< BasicTurbulenceModel >::epsilon(), LESModel< BasicTurbulenceModel >::epsilon(), sigma< BasicTurbulenceModel >::epsilon(), RASModel< BasicTurbulenceModel >::epsilon(), SpalartAllmarasBase< BasicEddyViscosityModel >::epsilon(), DispersionRASModel< CloudType >::epsilonModel(), phaseSystem::fillFields(), phaseSystem::fillFields(), kOmegaSSTLM< BasicTurbulenceModel >::Flength(), kOmegaSSTLM< BasicTurbulenceModel >::Fonset(), phaseSystem::foundBlendedSubModel(), phaseSystem::foundSubModel(), kOmegaSSTLM< BasicTurbulenceModel >::Fthetat(), multiphaseInterSystem::generatePairsAndSubModels(), phaseSystem::generatePairsAndSubModels(), groupName(), hyperbolic::hyperbolic(), IDDESDelta::IDDESDelta(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), BlendedInterfacialModel< Foam::dragModel >::K(), MovingPhaseModel< BasePhaseModel >::K(), laminarModel< BasicTurbulenceModel >::k(), sigma< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), WALE< BasicTurbulenceModel >::k(), SpalartAllmarasBase< BasicEddyViscosityModel >::k(), DispersionRASModel< CloudType >::kModel(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), linear::linear(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), phaseSystem::lookupBlendedSubModel(), multiphaseInterSystem::lookupSubModel(), phaseSystem::lookupSubModel(), twoPhaseSystem::lookupSubModel(), kaqRWallFunctionFvPatchScalarField::manipulateMatrix(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), MassTransferPhaseSystem< BasePhaseSystem >::MassTransferPhaseSystem(), moleFractions< ThermoType >::moleFractions(), MomentumTransferPhaseSystem< BasePhaseSystem >::MomentumTransferPhaseSystem(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::MultiComponentPhaseModel(), laminarModel< BasicTurbulenceModel >::New(), LESModel< BasicTurbulenceModel >::New(), RASModel< BasicTurbulenceModel >::New(), TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >::New(), strainRateFunction::nu(), laminarModel< BasicTurbulenceModel >::nuEff(), generalizedNewtonian< BasicMomentumTransportModel >::nuEff(), Stokes< BasicTurbulenceModel >::nuEff(), LESModel< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >::nuEff(), RASModel< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >::nuEff(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), laminarModel< BasicMomentumTransportModel >::nut(), generalizedNewtonian< BasicMomentumTransportModel >::nut(), Stokes< BasicTurbulenceModel >::nut(), laminarModel< BasicTurbulenceModel >::omega(), LESModel< BasicTurbulenceModel >::omega(), RASModel< BasicTurbulenceModel >::omega(), SpalartAllmarasBase< BasicEddyViscosityModel >::omega(), phaseChange::phaseChange(), phaseModel::phaseModel(), phaseModel::phaseModel(), phaseModel::phaseModel(), phaseModel::phaseModel(), basicThermo::phasePropertyName(), basicThermo::phasePropertyName(), basicThermo::phaseScopedName(), StaticPhaseModel< BasePhaseModel >::phi(), populationBalanceModel::populationBalanceModel(), PopulationBalancePhaseSystem< BasePhaseSystem >::PopulationBalancePhaseSystem(), porousModel::porousModel(), PhaseCompressibleTurbulenceModel< TransportModel >::pPrime(), PhaseIncompressibleTurbulenceModel< TransportModel >::pPrime(), PhaseCompressibleTurbulenceModel< TransportModel >::pPrimef(), PhaseIncompressibleTurbulenceModel< TransportModel >::pPrimef(), InertPhaseModel< BasePhaseModel >::Qdot(), phaseChange::R(), wallBoiling::R(), laminarModel< BasicTurbulenceModel >::R(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), kineticTheoryModel::R(), phasePressureModel::R(), BilgerMixtureFraction::read(), limitTemperature::read(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::read(), sampledSurfaces::read(), reconstructionSchemes::reconstructionSchemes(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetac(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetat0(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), faBoundaryMesh::setGroup(), polyBoundaryMesh::setGroup(), ZoneMesh< ZoneType, MeshType >::setGroup(), ZoneMesh< faFaceZone, faMesh >::setGroup(), sizeGroup::sizeGroup(), SLADelta::SLADelta(), surfaceTensionModel::surfaceTensionModel(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::ThermalPhaseChangePhaseSystem(), ThermoPhaseModel< BasePhaseModel, ThermoType >::ThermoPhaseModel(), turbulenceModel::turbulenceModel(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem(), StaticPhaseModel< BasePhaseModel >::U(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), fixedShearStressFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), virtualMassModel::virtualMassModel(), Henry< Thermo, OtherThermo >::YfPrime(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUBlendedWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), StationaryPhaseModel< BasePhaseModel >::zeroField(), and BlendedInterfacialModel< Foam::dragModel >::~BlendedInterfacialModel().

Here is the call graph for this function:

◆ group() [1/2]

◆ member() [1/2]

◆ scopedName() [1/2]

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

Create scope:name or scope_name string.

An empty scope is ignored.

Definition at line 49 of file IOobjectI.H.

References name(), and scopeSeparator.

Referenced by acousticDampingSource::addSup(), acousticDampingSource::addSup(), acousticDampingSource::addSup(), interRegionExplicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), interRegionHeatTransferModel::addSup(), rotorDiskSource::addSup(), rotorDiskSource::addSup(), KinematicCloud< CloudType >::alpha(), adjointkOmegaSST::beta(), adjointkOmegaSST::beta(), kOmegaSSTBase< BasicEddyViscosityModel >::beta(), Relaxation< CloudType >::cacheFields(), Explicit< CloudType >::cacheFields(), Implicit< CloudType >::cacheFields(), DarcyForchheimer::calcTransformModelData(), Stochastic< CloudType >::calculate(), PatchInteractionFields< CloudType >::clearOrReset(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::cloudReset(), SuppressionCollision< CloudType >::collide(), kEpsilon::computeG(), kOmegaSST::computeG(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::constProps(), directionalPressureGradientExplicitSource::constrain(), meanVelocityForce::constrain(), kEpsilon< BasicTurbulenceModel >::correct(), RNGkEpsilon< BasicTurbulenceModel >::correct(), contactAngleForce::correct(), contactAngleForce::correct(), waxSolventEvaporation::correctModel(), IsothermalPhaseModel< BasePhaseModel >::correctThermo(), constantFilmThermo::Cp(), liquidFilmThermo::Cp(), solverInfo::createResidualField(), MRFZoneList::DDt(), multiphaseMangrovesSource::dragCoeff(), DSMCCloud< ParcelType >::DSMCCloud(), DSMCCloud< ParcelType >::DSMCCloud(), dynamicContactAngleForce::dynamicContactAngleForce(), constantAspectRatio::E(), phaseSystem::E(), ThermoCloud< CloudType >::Ep(), multiphaseMangrovesTurbulenceModel::epsilonCoeff(), BlendedInterfacialModel< Foam::dragModel >::evaluate(), extractEulerianParticles::execute(), setFlow::execute(), filmTurbulenceModel::filmTurbulenceModel(), adjointkOmegaSST::gamma(), adjointkOmegaSST::gamma(), kOmegaSSTBase< BasicEddyViscosityModel >::gamma(), kOmegaSSTBase< BasicEddyViscosityModel >::GbyNu0(), turbulenceModel::GName(), groupName(), multiphaseMangrovesSource::inertiaCoeff(), turbulenceFields::initialise(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::injectors(), constantFilmThermo::kappa(), liquidFilmThermo::kappa(), multiphaseMangrovesTurbulenceModel::kCoeff(), KinematicCloud< CloudType >::KinematicCloud(), kOmegaSSTDES< BasicTurbulenceModel >::LESRegion(), SpalartAllmarasDES< BasicTurbulenceModel >::LESRegion(), limitFields::limitField(), LocalInteraction< CloudType >::LocalInteraction(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), LocalInteraction< CloudType >::massEscape(), LocalInteraction< CloudType >::massStick(), constantFilmThermo::mu(), liquidFilmThermo::mu(), laminar::mut(), AveragingMethod< Foam::Vector< scalar > >::New(), Schaeffer::nu(), strainRateFunction::nu(), ThermoCloud< Foam::DSMCCloud< dsmcParcel > >::p(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::pAmbient(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), phaseChange::phaseChange(), basicThermo::phaseScopedName(), kinematicSingleLayer::pp(), turbulenceFields::processField(), SpalartAllmarasDES< BasicTurbulenceModel >::psi(), kinematicSingleLayer::pu(), ThermoCloud< Foam::DSMCCloud< dsmcParcel > >::radAreaP(), ReactingCloud< CloudType >::ReactingCloud(), multiFieldValue::read(), multiRegion::read(), turbulenceFields::read(), constantFilmThermo::rho(), liquidFilmThermo::rho(), KinematicCloud< CloudType >::rhoEff(), functionObject::scopedName(), scopedName(), rotorDiskSource::setFaceArea(), ReactingCloud< Foam::DSMCCloud< dsmcParcel > >::setModels(), ThermoCloud< CloudType >::setModels(), lduMatrix::setResidualField(), kinematicSingleLayer::Sh(), noFilm::Sh(), thermoSingleLayer::Sh(), constantRadiation::Shs(), noRadiation::Shs(), primaryRadiation::Shs(), standardRadiation::Shs(), phaseSystem::sigma(), constantFilmThermo::sigma(), liquidFilmThermo::sigma(), ReactingCloud< CloudType >::Srho(), ReactingCloud< CloudType >::Srho(), ReactingCloud< CloudType >::Srho(), kinematicSingleLayer::Srho(), kinematicSingleLayer::Srho(), noFilm::Srho(), noFilm::Srho(), thermoSingleLayer::Srho(), thermoSingleLayer::Srho(), ReactingCloud< CloudType >::SYi(), ThermoCloud< CloudType >::ThermoCloud(), ThermoCloud< CloudType >::ThermoCloud(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), temperatureDependentContactAngleForce::theta(), MPPICParcel< KinematicParcel< particle > >::trackingData::trackingData(), KinematicParcel< ParcelType >::trackingData::updateAverages(), adjointkOmegaSST::updatePrimalRelatedFields(), laminar::Us(), AveragingMethod< Type >::write(), electricPotential::write(), turbulenceFields::write(), and PatchCollisionDensity< CloudType >::write().

Here is the call graph for this function:

◆ scopedName() [2/2]

Foam::word scopedName ( const std::string & scope,
const word & name1,
const word & name2 )
inlinestatic

Create scope:name1:name2 or scope_name1_name2 string.

An empty scope is ignored.

Definition at line 70 of file IOobjectI.H.

References scopedName(), and scopeSeparator.

Here is the call graph for this function:

◆ selectIO()

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

Return the IOobject, but also consider an alternative file name.

Parameters
ioThe expected IOobject to use
altFileAlternative fileName (ignored if empty).
ioNameThe alternative name for the IOobject when the altFile resolves to a directory.
Note
If the alternative fileName is a non-empty string, it defines the location but uses all other properties of the expected IOobject. The location may be an absolute or a relative path. If it corresponds to a directory, the name of the expected IOobject will be used in its resolution. This expected name can provided via the ioName parameter.

Definition at line 255 of file IOobject.C.

References string::expand(), io, and Foam::isDir().

Referenced by groupName(), and decompositionModel::selectIO().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clone() [1/2]

autoPtr< IOobject > clone ( ) const
inline

◆ clone() [2/2]

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

Clone resetting registry.

Definition at line 649 of file IOobject.H.

References autoPtr< T >::New().

Here is the call graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const
noexcept

Return the local objectRegistry.

Definition at line 450 of file IOobject.C.

References Foam::noexcept.

Referenced by refinementHistory::add(), adjointRASModel::adjointRASModel(), adjointTurbulenceModel::adjointTurbulenceModel(), Antoine::Antoine(), AntoineExtended::AntoineExtended(), refinementHistory::apply(), ArdenBuck::ArdenBuck(), basicChemistryModel::basicChemistryModel(), SprayParcel< ParcelType >::calcAtomization(), leastSquaresFaGrad< Type >::calcGrad(), regIOobject::checkIn(), regIOobject::checkOut(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::cloudReset(), ReactingCloud< Foam::DSMCCloud< dsmcParcel > >::cloudReset(), ReactingCloud< Foam::DSMCCloud< dsmcParcel > >::composition(), constantSaturationConditions::constantSaturationConditions(), ReactingCloud< Foam::DSMCCloud< dsmcParcel > >::constProps(), ThermoCloud< Foam::DSMCCloud< dsmcParcel > >::constProps(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), relaxedSnGrad< Type >::correction(), saturationModel::declareRunTimeSelectionTable(), refinementHistory::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), surfaceInterpolationScheme< scalar >::dotInterpolate(), DSMCCloud< ParcelType >::dumpParticlePositions(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), enthalpySorptionFvPatchScalarField::enthalpySorptionFvPatchScalarField(), edgeInterpolationScheme< Type >::euclidianInterpolate(), freePiston::freePiston(), function1::function1(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), ThermoCloud< Foam::DSMCCloud< dsmcParcel > >::heatTransfer(), incompressibleTwoPhaseMixture::incompressibleTwoPhaseMixture(), edgeInterpolationScheme< Type >::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), pointVolInterpolation::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), KinematicCloud< CloudType >::KinematicCloud(), Foam::fam::laplacian(), Foam::fam::laplacian(), Foam::fam::laplacian(), Foam::fam::laplacian(), lnGradScheme< Type >::lnGrad(), CollidingCloud< CloudType >::motion(), MPPICCloud< CloudType >::motion(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::mu(), multiphaseSystem::multiphaseSystem(), DimensionedField< Type, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), adjointRASModel::New(), adjointTurbulenceModel::New(), laminarFlameSpeed::New(), saturationModel::New(), objectRegistry::objectRegistry(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::patchData(), sampledSurface::pointAverage(), pointPatchDist::pointPatchDist(), polynomial::polynomial(), polySurface::polySurface(), KinematicCloud< CloudType >::postEvolve(), ThermoCloud< Foam::DSMCCloud< dsmcParcel > >::radAreaP(), ReactingCloud< CloudType >::ReactingCloud(), reconstructionSchemes::reconstructionSchemes(), refinementHistory::refinementHistory(), regIOobject::regIOobject(), regIOobject::regIOobject(), regIOobject::regIOobject(), regIOobject::regIOobject(), regIOobject::regIOobject(), solution::relaxEquation(), solution::relaxField(), surfMesh::removeFiles(), saturationModel::saturationModel(), searchableRotatedBox::searchableRotatedBox(), ThermoCloud< CloudType >::setModels(), regIOobject::setUpToDate(), ThermoCloud< CloudType >::Sh(), singlePhaseTransportModel::singlePhaseTransportModel(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::solution(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), SRFModel::SRFModel(), ReactingCloud< CloudType >::Srho(), ReactingCloud< CloudType >::Srho(), surfMesh::surfMesh(), surfMesh::surfMesh(), surfMesh::surfMesh(), ReactingCloud< CloudType >::SYi(), ThermoCloud< CloudType >::ThermoCloud(), ThermoCloud< CloudType >::ThermoCloud(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), turbulenceModel::turbulenceModel(), objectRegistry::TypeName(), Antoine::TypeName(), AntoineExtended::TypeName(), ArdenBuck::TypeName(), constantSaturationConditions::TypeName(), function1::TypeName(), polynomial::TypeName(), uniformInterpolationTable< Type >::uniformInterpolationTable(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), KinematicParcel< ParcelType >::trackingData::updateAverages(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeData(), Cloud< ParticleType >::writePositions(), basicThermo::~basicThermo(), MPPICCloud< Foam::DSMCCloud< dsmcParcel > >::~MPPICCloud(), and regIOobject::~regIOobject().

◆ time()

const Foam::Time & time ( ) const
noexcept

Return Time associated with the objectRegistry.

Definition at line 456 of file IOobject.C.

References Foam::noexcept.

Referenced by objective::accumulateJMean(), objectiveTopOSolidVolume::addColumnValues(), objectiveTopOVolume::addColumnValues(), externalFileSource::addSup(), regIOobject::addWatch(), regIOobject::addWatch(), adjointRASModel::adjointRASModel(), adjointSolverManager::adjointSolverManager(), adjointTurbulenceModel::adjointTurbulenceModel(), ATCModel::ATCModel(), ATCstandard::ATCstandard(), basicChemistryModel::basicChemistryModel(), basicThermo::basicThermo(), basicThermo::basicThermo(), basicThermo::basicThermo(), caseName(), caseName(), SIMPLEControlSingleRun::checkEndTime(), componentDisplacementMotionSolver::componentDisplacementMotionSolver(), componentVelocityMotionSolver::componentVelocityMotionSolver(), coordinateSystems::coordinateSystems(), laminar< ReactionThermo >::correct(), displacementInterpolationMotionSolver::curPoints(), StandardChemistryModel< ReactionThermo, ThermoType >::derivatives(), TDACChemistryModel< ReactionThermo, ThermoType >::derivatives(), displacementComponentLaplacianFvMotionSolver::displacementComponentLaplacianFvMotionSolver(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), displacementMotionSolver::displacementMotionSolver(), displacementSBRStressFvMotionSolver::displacementSBRStressFvMotionSolver(), displacementSBRStressFvMotionSolver::displacementSBRStressFvMotionSolver(), distributedTriSurfaceMesh::distribute(), dragModel::dragModel(), dragModel::dragModel(), EDC< ReactionThermo >::EDC(), elasticityMotionSolver::elasticityMotionSolver(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faMeshesRegistry::faMeshesRegistry(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), FSD< ReactionThermo, ThermoType >::FSD(), fvDOM::fvDOM(), fvDOM::fvDOM(), fvExprDriverWriter::fvExprDriverWriter(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), globalCaseName(), incompressibleTwoPhaseMixture::incompressibleTwoPhaseMixture(), IOPosition< CloudType >::IOPosition(), objective::isWithinIntegrationTime(), objectiveTopOSolidVolume::J(), objectiveTopOVolume::J(), BlendedInterfacialModel< Foam::dragModel >::Kf(), Foam::fam::laplacian(), Foam::fam::laplacian(), Foam::fvm::laplacian(), Foam::fvm::laplacian(), laplacianMotionSolver::laplacianMotionSolver(), levelSetDesignVariables::levelSetDesignVariables(), codeStream::libs(), TDACChemistryModel< ReactionThermo, ThermoType >::logFile(), meshState::meshState(), motionSolver::motionSolver(), multiphaseInterSystem::multiphaseInterSystem(), multiphaseSystem::multiphaseSystem(), multiphaseSystem::multiphaseSystem(), GAMGAgglomeration::New(), adjointRASModel::New(), adjointTurbulenceModel::New(), laminarFlameSpeed::New(), NURBS3DVolume::NURBS3DVolume(), objective::objective(), objectiveManager::objectiveManager(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), optimisationManager::optimisationManager(), P1::P1(), P1::P1(), PaSR< ReactionThermo >::PaSR(), phaseModel::phaseModel(), phaseModel::phaseModel(), phaseModel::phaseModel(), phaseModel::phaseModel(), phaseSystem::phaseSystem(), pLaplacianMotionSolver::pLaplacianMotionSolver(), pointPatchDist::pointPatchDist(), polyTopoChanger::polyTopoChanger(), populationBalanceModel::populationBalanceModel(), porosityModel::porosityModel(), porousModel::porousModel(), psiThermo::psiThermo(), psiThermo::psiThermo(), radiationModel::radiationModel(), radiationModel::radiationModel(), radiationModel::radiationModel(), reconstructedDistanceFunction::reconstructedDistanceFunction(), reconstructionSchemes::reconstructionSchemes(), solution::relaxEquation(), solution::relaxField(), GAMGAgglomeration::requiresUpdate(), rhoThermo::rhoThermo(), rhoThermo::rhoThermo(), rhoThermo::rhoThermo(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rootPath(), saturationModel::saturationModel(), schemesLookup::schemesLookup(), searchableExtrudedCircle::searchableExtrudedCircle(), meshState::setSolverPerformance(), singlePhaseTransportModel::singlePhaseTransportModel(), singleStepCombustion< ReactionThermo, ThermoType >::singleStepCombustion(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), sizeGroup::sizeGroup(), solarLoad::solarLoad(), solarLoad::solarLoad(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), solidBodyMotionSolver::solidBodyMotionSolver(), solution::solution(), solutionControl::solutionControl(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), velocityDisplacementMotionSolver::solve(), RASTurbulenceModel::solveIter(), solver::solver(), SRFModel::SRFModel(), StandardChemistryModel< ReactionThermo, ThermoType >::StandardChemistryModel(), GeometricField< Type, PatchField, GeoMesh >::storeOldTimes(), surfaceAlignedSBRStressFvMotionSolver::surfaceAlignedSBRStressFvMotionSolver(), surfaceTensionModel::surfaceTensionModel(), surfaceTensionModel::surfaceTensionModel(), TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel(), faMesh::time(), fvMesh::time(), topoBitSet::topoBitSet(), topoBoolSet::topoBoolSet(), topOVariablesBase::topOVariablesBase(), twoPhaseSystem::twoPhaseSystem(), uniformInterpolationTable< Type >::uniformInterpolationTable(), objectiveTopOSolidVolume::update_dJdb(), objectiveTopOVolume::update_dJdb(), points0MotionSolver::updateMesh(), updateMethod::updateMethod(), velocityComponentLaplacianFvMotionSolver::velocityComponentLaplacianFvMotionSolver(), velocityLaplacianFvMotionSolver::velocityLaplacianFvMotionSolver(), velocityMotionSolver::velocityMotionSolver(), viewFactor::viewFactor(), viewFactor::viewFactor(), virtualMassModel::virtualMassModel(), volumetricBSplinesDesignVariables::volumetricBSplinesDesignVariables(), wallDist::wallDist(), wallDistAddressing::wallDistAddressing(), wallDistAddressing::wallDistAddressing(), wallDistData< TransferType >::wallDistData(), waveModel::waveModel(), regIOobject::write(), SIMPLEControlSingleRun::write(), Foam::writeCellGraph(), SIMPLEControlSingleRun::writeNow(), regIOobject::writeObject(), rigidBodyMeshMotion::writeObject(), rigidBodyMeshMotionSolver::writeObject(), sixDoFRigidBodyMotionSolver::writeObject(), triSurfaceMesh::writeObject(), Foam::writePatchGraph(), fvMeshTools::writeProcAddressing(), and BlendedInterfacialModel< Foam::dragModel >::~BlendedInterfacialModel().

◆ name()

const Foam::word & name ( ) const
inlinenoexcept

Return the object name.

Definition at line 205 of file IOobjectI.H.

References Foam::noexcept.

Referenced by incompressibleAdjointSolver::accumulateOptionsDxDbMultiplier(), multivariateSurfaceInterpolationScheme< Type >::fieldTable::add(), exprDriver::addContextObject(), snappyLayerDriver::addLayers(), objectiveIncompressible::addSource(), objectiveNutSqr::addSource(), objectivePowerDissipation::addSource(), contactHeatFluxSource::addSup(), externalFileSource::addSup(), externalHeatFluxSource::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), multiphaseStabilizedTurbulence::addSup(), patchCellsSource::addSup(), solidificationMeltingSource::addSup(), topOSource::addSup(), topOSource::addSup(), topOSource::addSup(), topOSource::addSup(), exprResultGlobals::addValue(), exprResultGlobals::addValue(), exprResultGlobals::addValue(), advectiveFvPatchField< Type >::advectiveFvPatchField(), solutionControl::applyToField(), setsToFaceZone::applyToSet(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), attachPolyTopoChanger::attach(), Foam::fac::average(), Foam::fvc::average(), blended< Type >::blendingFactor(), cellCoBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), localBlended< Type >::blendingFactor(), Foam::bound(), cellLimitedGrad< Type, Limiter >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fourthGrad< Type >::calcGrad(), fusedGaussGrad< Type >::calcGrad(), fusedGaussGrad< Type >::calcGrad(), fusedLeastSquaresGrad< Type >::calcGrad(), gaussGrad< Type >::calcGrad(), gradScheme< Type >::calcGrad(), iterativeGaussGrad< Type >::calcGrad(), hydrostaticPressure::calculateAndWrite(), coordinateSystems::cfind(), objectRegistry::cfindIOobject(), objectRegistry::cfindObject(), meshRefinement::checkCoupledFaceZones(), faBoundaryMesh::checkDefinition(), polyBoundaryMesh::checkDefinition(), Cloud< ParticleType >::checkFieldIOobject(), Foam::checkMethod(), Foam::checkMethod(), Foam::checkMethod(), Foam::checkMethod(), Foam::checkMethod(), Foam::checkMethod(), faBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), polyBoundaryMesh::checkParallelSync(), refinementFeatures::checkSizes(), Foam::clamp(), Foam::clamp(), objectRegistry::classesImpl(), objectRegistry::clear(), RASModelVariables::cloneRefPtr(), Foam::cmptAv(), Foam::cmptAv(), optionList::constrain(), objectRegistry::contains(), adjointkOmegaSST::convectionMeanFlowSource(), adjointkOmegaSST::convectionScheme(), RASModelVariables::copyAndRename(), atmNutSource::correct(), multiphaseStabilizedTurbulence::correct(), adjointkOmegaSST::correct(), adjointSpalartAllmaras::correct(), fusedGaussGrad< Type >::correctBoundaryConditions(), cubic< Type >::correction(), deferredCorrection< Type >::correction(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), relaxedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), linearUpwind< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindNormal< Type >::correction(), linearUpwindV< Type >::correction(), localBlended< Type >::correction(), objectRegistry::countImpl(), objectRegistry::countTypeImpl(), Foam::fvc::curl(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), cyclicFvPatchField< Type >::cyclicFvPatchField(), cyclicFvPatchField< Type >::cyclicFvPatchField(), Foam::fac::d2dt2(), Foam::fac::d2dt2(), Foam::fac::d2dt2(), Foam::fam::d2dt2(), Foam::fam::d2dt2(), Foam::fam::d2dt2(), Foam::fvc::d2dt2(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), Foam::fvm::d2dt2(), Foam::fvm::d2dt2(), faMeshRegistry::dbDir(), polyMesh::dbDir(), Foam::fac::ddt(), Foam::fac::ddt(), Foam::fac::ddt(), Foam::fam::ddt(), Foam::fam::ddt(), Foam::fam::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), Foam::fvm::ddt(), topoSet::declareRunTimeSelectionTable(), topoSet::declareRunTimeSelectionTable(), topoSet::declareRunTimeSelectionTable(), decomposedBlockData::decomposedBlockData(), DimensionedField< Type, GeoMesh >::DimensionedField(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), Foam::fac::div(), Foam::fac::div(), Foam::fam::div(), Foam::fvc::div(), Foam::fvc::div(), Foam::fvc::div(), Foam::fvm::div(), Foam::fvc::domainIntegrate(), Foam::fvc::domainIntegrate(), surfaceInterpolationScheme< Type >::dotInterpolate(), surfaceInterpolationScheme< scalar >::dotInterpolate(), dragModel::dragModel(), dragModel::dragModel(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), triSurfaceMesh::edgeTree(), emptyFaPatchField< Type >::emptyFaPatchField(), emptyFaPatchField< Type >::emptyFaPatchField(), emptyFvPatchField< Type >::emptyFvPatchField(), emptyFvPatchField< Type >::emptyFvPatchField(), edgeInterpolationScheme< Type >::euclidianInterpolate(), edgeInterpolationScheme< Type >::euclidianInterpolate(), BlendedInterfacialModel< Foam::dragModel >::evaluate(), electricPotential::execute(), removeRegisteredObject::execute(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), gaussConvectionScheme< Type >::facDiv(), gaussDivScheme< Type >::facDiv(), gaussLaplacianScheme< Type >::facLaplacian(), gaussLaplacianScheme< Type >::facLaplacian(), gaussLaplacianScheme< Type >::famLaplacian(), fileNameComponents(), masterUncollatedFileOperation::findInstance(), topoSet::findIOobject(), topoSet::findIOobject(), topoSet::findIOobject(), triSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), triSurfaceMesh::findLineAll(), triSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), distributedTriSurfaceMesh::findNearest(), triSurfaceMesh::findNearest(), triSurfaceMesh::findNearest(), objectRegistry::findObject(), objectRegistry::findObject(), coupleGroupIdentifier::findOtherPatchID(), adjointkOmegaSST::FISensitivityTerm(), distributedTriSurfaceMesh::flip(), triSurfaceMesh::flip(), Foam::fvc::flux(), Foam::fvc::flux(), objectRegistry::found(), objectRegistry::foundObject(), correctedSnGrad< Type >::fullGradCorrection(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), fusedGaussConvectionScheme< Type >::fvcDiv(), fusedGaussDivScheme< Type >::fvcDiv(), gaussConvectionScheme< Type >::fvcDiv(), gaussDivScheme< Type >::fvcDiv(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), gaussLaplacianScheme< Type, GType >::fvcLaplacian(), gaussLaplacianScheme< Type, GType >::fvcLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvcLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fvExprDriverWriter::fvExprDriverWriter(), CrankNicolsonDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), fusedGaussConvectionScheme< Type >::fvmDiv(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacian(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), genericPointPatchField< Type >::genericPointPatchField(), exprResultGlobals::get(), distributedTriSurfaceMesh::getField(), triSurfaceMesh::getField(), exprResultGlobals::getNamespace(), distributedTriSurfaceMesh::getNormal(), smoothTriSurfaceMesh::getNormal(), triSurfaceMesh::getNormal(), objectRegistry::getObjectPtr(), distributedTriSurfaceMesh::getRegion(), triSurfaceMesh::getRegion(), distributedTriSurfaceMesh::getVolumeType(), triSurfaceMesh::getVolumeType(), gradScheme< Type >::grad(), Foam::fac::grad(), Foam::fac::grad(), gradScheme< Type >::grad(), Foam::fvc::grad(), Foam::fvc::grad(), fusedGaussGrad< Type >::gradf(), group(), groupName(), AnisothermalPhaseModel< BasePhaseModel >::heEqn(), hexRef8Data::hexRef8Data(), dynamicRefineFvMesh::init(), edgeInterpolationScheme< Type >::interpolate(), edgeInterpolationScheme< Type >::interpolate(), edgeInterpolationScheme< Type >::interpolate(), cellDecomposer::interpolate(), fvMeshSubset::interpolate(), fvMeshSubset::interpolate(), fvMeshSubset::interpolate(), fvMeshSubset::interpolate(), Foam::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), localBlended< Type >::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), meshToMesh0::interpolate(), pointVolInterpolation::interpolate(), singleCellFvMesh::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), weightedFlux< Type >::interpolate(), volPointInterpolation::interpolateDimensionedInternalField(), volPointInterpolation::interpolateInternalField(), IOobject(), IOobject(), IOobject(), IOobject(), IOobject(), IOobject(), objectRegistry::is_cacheTemporaryObject(), triSurfaceMesh::isSurfaceClosed(), BlendedInterfacialModel< Foam::dragModel >::K(), sizeGroup::keyword(), Foam::fac::laplacian(), Foam::fac::laplacian(), Foam::fac::laplacian(), Foam::fac::laplacian(), Foam::fam::laplacian(), Foam::fvc::laplacian(), Foam::fvc::laplacian(), Foam::fvc::laplacian(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::fvm::laplacian(), Foam::fvm::laplacian(), lnGradScheme< Type >::lnGrad(), Foam::fac::lnGrad(), topoSet::localPath(), coordinateSystems::lookup(), objectRegistry::lookupClass(), objectRegistry::lookupClassTypeImpl(), mappedPatchBase::lookupMesh(), objectRegistry::lookupObject(), objectRegistry::lookupObjectPtr(), objectRegistry::lookupObjectRef(), objectRegistry::lookupObjectRefPtr(), coordinateSystems::lookupPtr(), Foam::mag(), Foam::mag(), Foam::magSqr(), Foam::magSqr(), adjointSimple::mainIter(), Foam::makeGraph(), Foam::MapConsistentSubMesh(), mappedPatchFieldBase< Type >::mapper(), zoneSubSet::mapToZone(), Foam::MapVolFields(), member(), Foam::fvc::meshPhi(), Foam::fvc::meshPhi(), Foam::fvc::meshPhi(), triSurfaceMesh::movePoints(), multiphaseSystem::multiphaseSystem(), baseIOdictionary::name(), faMesh::name(), fvMesh::name(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), Foam::fac::ndiv(), Foam::fac::ndiv(), Foam::fam::ndiv(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), DimensionedField< Type, areaMesh >::New(), topoSet::New(), topoSet::New(), topoSet::New(), DimensionedField< Type, areaMesh >::New_impl(), objectRegistry::newIOobject(), objectRegistry::newIOobject(), Foam::fac::ngrad(), oversetFvMeshBase::normalisation(), objectRegistry::objectRegistry(), objectRegistry::objectRegistry(), objectRegistry::objectsTypeImpl(), coordinateSystems::operator=(), triSurfaceMesh::outsideVolumeType(), sampledPatch::patchIDs(), pointBoundaryMesh::pointBoundaryMesh(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), polyMesh::polyMesh(), populationBalanceModel::populationBalanceModel(), porousModel::porousModel(), RemoveParcels< CloudType >::postEvolve(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFvPatchField< Type >::processorFvPatchField(), processorFvPatchField< Type >::processorFvPatchField(), wallBoundedStreamLine::read(), decomposedBlockData::readBlocks(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), faMesh::regionName(), polyMesh::regionName(), triSurfaceMesh::regions(), exprDriver::removeContextObject(), exprResultGlobals::removeValue(), variablesSet::renameTurbulenceField(), Time::run(), VollerPrakash::S(), sampledMeshedSurface::sampleOnFaces(), sampledMeshedSurface::sampleOnPoints(), scopedName(), searchableSurfaceCollection::searchableSurfaceCollection(), triSurfaceMesh::setField(), refinementSurfaces::setMinLevelFields(), removeFaces::setRefinement(), sizeGroup::sizeGroup(), skewCorrected< Type >::skewCorrection(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), ATCModel::smoothFieldBasedOnCells(), snGradScheme< Type >::snGrad(), Foam::fvc::snGrad(), oversetFvMeshBase::solveOverset(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), objectRegistry::sortedNames(), Foam::sqr(), Foam::sqr(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), objectRegistry::subRegistry(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfaceTensionModel::surfaceTensionModel(), surfaceTensionModel::surfaceTensionModel(), symmetryFaPatchField< Type >::symmetryFaPatchField(), symmetryFaPatchField< Type >::symmetryFaPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), triSurfaceMesh::triSurfaceMesh(), Time::TypeName(), fvExprDriverWriter::TypeNameNoDebug(), UniformDimensionedField< Type >::UniformDimensionedField(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), uniformMixedFvPatchField< Type >::uniformMixedFvPatchField(), KinematicParcel< ParcelType >::trackingData::updateAverages(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), topoBitSet::updateLabels(), topoBoolSet::updateLabels(), adjointSolverManager::updatePrimalBasedQuantities(), basicThermo::validate(), basicThermo::validate(), basicThermo::validate(), basicThermo::validate(), LookupField< Type >::value(), populationBalanceModel::velocityGroup, virtualMassModel::virtualMassModel(), wedgeFvPatchField< Type >::wedgeFvPatchField(), wedgeFvPatchField< Type >::wedgeFvPatchField(), localBlended< Type >::weights(), FaceInteraction< CloudType >::write(), FacePostProcessing< CloudType >::write(), ObukhovLength::write(), regionSizeDistribution::write(), writeCellCentres::write(), writeObjects::write(), XiReactionRate::write(), Foam::writeCellGraph(), meshToMeshMethod::writeConnectivity(), decomposedBlockData::writeData(), boundaryRegion::writeDict(), cellTable::writeDict(), mappedPatchBase::writeDict(), molecule::writeFields(), distributedTriSurfaceMesh::writeObject(), regionFunctionObject::writeObject(), regIOobject::writeObject(), Foam::writePatchGraph(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::YiEqn(), adjointSolverManager::~adjointSolverManager(), BlendedInterfacialModel< Foam::dragModel >::~BlendedInterfacialModel(), exprResultGlobals::~exprResultGlobals(), and ~IOobject().

◆ headerClassName() [1/2]

const Foam::word & headerClassName ( ) const
inlinenoexcept

Return name of the class name read from header.

Definition at line 223 of file IOobjectI.H.

References Foam::noexcept.

Referenced by fieldToCell::applyToSet(), fvExprDriver::evaluateVariable(), fvExprDriver::foundField(), decomposedBlockData::readBlocks(), regIOobject::readStream(), and polyMesh::readUpdate().

Here is the caller graph for this function:

◆ headerClassName() [2/2]

Foam::word & headerClassName ( )
inlinenoexcept

Modifiable access to the class name read from header.

Definition at line 229 of file IOobjectI.H.

References Foam::noexcept.

◆ note() [1/2]

◆ note() [2/2]

Foam::string & note ( )
inlinenoexcept

Modifiable access to the optional note.

Definition at line 241 of file IOobjectI.H.

References Foam::noexcept.

◆ rename()

virtual void rename ( const word & newName)
inlinevirtual

Rename the object.

Reimplemented in objectRegistry, and regIOobject.

Definition at line 697 of file IOobject.H.

References rename().

Referenced by fvMeshTools::newMesh(), decomposedBlockData::readBlocks(), fvMeshTools::readProcAddressing(), rename(), regIOobject::rename(), and fvMeshTools::writeProcAddressing().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ labelByteSize()

unsigned labelByteSize ( ) const
inlinenoexcept

The sizeof (label) in bytes, possibly read from the header.

Definition at line 247 of file IOobjectI.H.

References Foam::noexcept.

◆ scalarByteSize()

unsigned scalarByteSize ( ) const
inlinenoexcept

The sizeof (scalar) in bytes, possibly read from the header.

Definition at line 253 of file IOobjectI.H.

References Foam::noexcept.

◆ resetHeader()

◆ hasHeaderClass()

bool hasHeaderClass ( ) const
inlinenoexcept

True if headerClassName() is non-empty (after reading).

Definition at line 261 of file IOobjectI.H.

References Foam::noexcept.

◆ isHeaderClass() [1/2]

bool isHeaderClass ( const word & expectedType) const
inline

Check if headerClassName() equals the expected type. Always true if the expected type is empty.

Definition at line 267 of file IOobjectI.H.

Referenced by fieldToCell::applyToSet().

Here is the caller graph for this function:

◆ isHeaderClass() [2/2]

template<class Type>
bool isHeaderClass ( ) const
inline

Check if headerClassName() equals Type::typeName Always true for a void type.

Definition at line 274 of file IOobjectI.H.

Referenced by isHeaderClassName().

Here is the caller graph for this function:

◆ findMetaData()

const Foam::dictionary * findMetaData ( ) const
virtualnoexcept

Return pointer to meta-data (if any) or nullptr.

Reimplemented in regIOobject.

Definition at line 26 of file IOobjectMetaData.C.

References Foam::noexcept.

Referenced by writeHeader(), and writeHeader().

Here is the caller graph for this function:

◆ group() [2/2]

Foam::word group ( ) const
inline

Return group (extension part of name).

Definition at line 211 of file IOobjectI.H.

References word::ext().

Here is the call graph for this function:

◆ member() [2/2]

Foam::word member ( ) const
inline

Return member (name without the extension).

Definition at line 217 of file IOobjectI.H.

References word::lessExt().

Referenced by kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and kineticGasEvaporation< Thermo, OtherThermo >::kineticGasEvaporation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rootPath()

const Foam::fileName & rootPath ( ) const
noexcept

Return the Time::rootPath().

Definition at line 462 of file IOobject.C.

References Foam::noexcept, and time().

Referenced by globalPath(), globalPath(), Foam::makeGraph(), objectPath(), path(), path(), path(), path(), and fileOperation::readObjects().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ caseName() [1/2]

const Foam::fileName & caseName ( ) const
noexcept

Return the Time::caseName().

Definition at line 468 of file IOobject.C.

References Foam::noexcept, and time().

Referenced by Foam::makeGraph(), objectPath(), objectRegistry::objectRegistry(), path(), path(), path(), path(), and fileOperation::readObjects().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ globalCaseName()

const Foam::fileName & globalCaseName ( ) const
noexcept

Return the Time::globalCaseName().

Definition at line 474 of file IOobject.C.

References Foam::noexcept, and time().

Referenced by globalPath(), and globalPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ caseName() [2/2]

const Foam::fileName & caseName ( IOobjectOption::Layout layout) const
noexcept

Return the Time::caseName() - normal or global.

Definition at line 481 of file IOobject.C.

References time().

Here is the call graph for this function:

◆ instance() [1/2]

const Foam::fileName & instance ( ) const
inlinenoexcept

Read access to instance path component.

Definition at line 289 of file IOobjectI.H.

References Foam::noexcept.

Referenced by snappyLayerDriver::addLayers(), Foam::fac::average(), Foam::fvc::average(), leastSquaresFaGrad< Type >::calcGrad(), cellLimitedGrad< Type, Limiter >::calcGrad(), fourthGrad< Type >::calcGrad(), fusedGaussGrad< Type >::calcGrad(), fusedLeastSquaresGrad< Type >::calcGrad(), LeastSquaresGrad< Type, Stencil >::calcGrad(), leastSquaresGrad< Type >::calcGrad(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), surfaceInterpolationScheme< scalar >::dotInterpolate(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), edgeInterpolationScheme< Type >::euclidianInterpolate(), faMesh::faMesh(), faMesh::faMesh(), faMesh::faMesh(), faMesh::faMesh(), fileNameComponents(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), fusedGaussConvectionScheme< Type >::fvcDiv(), fusedGaussDivScheme< Type >::fvcDiv(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvcLaplacian(), globalObjectPath(), globalPath(), globalPath(), fusedGaussGrad< Type >::gradf(), gaussGrad< Type >::gradf(), edgeInterpolationScheme< Type >::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), pointVolInterpolation::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), IOobject(), IOobject(), IOobject(), IOobject(), Foam::fam::laplacian(), Foam::fam::laplacian(), Foam::fvc::laplacian(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::fvm::laplacian(), lnGradScheme< Type >::lnGrad(), Foam::makeGraph(), volPointInterpolationAdjoint::makeWeights(), topoSet::maxSize(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), triSurfaceMesh::movePoints(), DimensionedField< Type, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), fvMeshTools::newMesh(), objectPath(), objectPath(), objectRelPath(), path(), path(), path(), path(), pointBoundaryMesh::pointBoundaryMesh(), points0MotionSolver::points0IO(), polyMesh::polyMesh(), polyMesh::polyMesh(), polyMesh::polyMesh(), polyMesh::polyMesh(), polyMesh::polyMesh(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), regIOobject::regIOobject(), faMesh::removeFiles(), polyMesh::removeFiles(), surfMesh::removeFiles(), searchableRotatedBox::searchableRotatedBox(), pointMesh::setInstance(), surfMesh::setInstance(), topoSet::setInstance(), singleCellFvMesh::singleCellFvMesh(), singleCellFvMesh::singleCellFvMesh(), singleCellFvMesh::singleCellFvMesh(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), SLGThermo::SLGThermo(), snGradScheme< Type >::snGrad(), solarLoadBase::solarLoadBase(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), surfMesh::surfMesh(), surfMesh::surfMesh(), polyMesh::tetBasePtIs(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), polyTopoChanger::update(), topoSet::updateMesh(), decomposedBlockData::writeData(), distributedTriSurfaceMesh::writeObject(), regIOobject::writeObject(), triSurfaceMesh::writeObject(), fvMeshTools::writeProcAddressing(), and ~IOobject().

◆ instance() [2/2]

Foam::fileName & instance ( )
inlinenoexcept

Modifiable access to instance path component.

Definition at line 295 of file IOobjectI.H.

References Foam::noexcept.

◆ instanceValue()

Foam::scalar instanceValue ( ) const

Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.

Definition at line 487 of file IOobject.C.

◆ local() [1/2]

◆ local() [2/2]

Foam::fileName & local ( )
inlinenoexcept

Modifiable access to the local path component.

Definition at line 307 of file IOobjectI.H.

References Foam::noexcept.

◆ path() [1/4]

Foam::fileName path ( ) const

The complete path for the object (with instance, local,...).

Definition at line 500 of file IOobject.C.

References caseName(), file_isOutsideCase(), instance(), local, and rootPath().

Referenced by searchableSurfaces::checkIntersection(), fileNameComponents(), IOobject(), IOobject(), objectRegistry::objectRegistry(), fileOperation::readObjects(), caseInfo::writeFileDicts(), Time::writeObject(), and ~IOobject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ globalPath() [1/2]

Foam::fileName globalPath ( ) const

The complete global path for the object (with instance, local,...).

Definition at line 512 of file IOobject.C.

References file_isOutsideCase(), globalCaseName(), instance(), local, and rootPath().

Referenced by globalObjectPath(), topOVariablesBase::topOVariablesBase(), and updateMethod::updateMethod().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ path() [2/4]

Foam::fileName path ( IOobjectOption::Layout layout) const

The complete path (normal or global) for the object.

Definition at line 524 of file IOobject.C.

References caseName(), file_isOutsideCase(), instance(), local, and rootPath().

Here is the call graph for this function:

◆ path() [3/4]

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

The complete path with alternative instance and local.

Definition at line 536 of file IOobject.C.

References caseName(), instance(), local(), and rootPath().

Here is the call graph for this function:

◆ globalPath() [2/2]

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

The complete global path with alternative instance and local.

Definition at line 547 of file IOobject.C.

References globalCaseName(), instance(), local(), and rootPath().

Here is the call graph for this function:

◆ path() [4/4]

Foam::fileName path ( IOobjectOption::Layout layout,
const word & instance,
const fileName & local = fileName::null ) const

The complete path (normal or global) with alternative instance and local.

Definition at line 558 of file IOobject.C.

References caseName(), instance(), local(), and rootPath().

Here is the call graph for this function:

◆ objectPath() [1/4]

Foam::fileName objectPath ( ) const
inline

The complete path + object name.

Definition at line 313 of file IOobjectI.H.

References name, and path().

Referenced by regIOobject::addWatch(), unwatchedIOdictionary::addWatch(), advectiveFvPatchField< Type >::advectiveFvPatchField(), baseIOdictionary::baseIOdictionary(), baseIOdictionary::baseIOdictionary(), hexRef8::consistentSlowRefinement2(), limitedSnGrad< Type >::correction(), distanceSurface::createGeometry(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), cyclicFvPatchField< Type >::cyclicFvPatchField(), cyclicFvPatchField< Type >::cyclicFvPatchField(), emptyFaPatchField< Type >::emptyFaPatchField(), emptyFaPatchField< Type >::emptyFaPatchField(), emptyFvPatchField< Type >::emptyFvPatchField(), emptyFvPatchField< Type >::emptyFvPatchField(), globalObjectPath(), regIOobject::headerOk(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), mappedPatchFieldBase< Type >::mapper(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), objectPath(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFvPatchField< Type >::processorFvPatchField(), processorFvPatchField< Type >::processorFvPatchField(), edgeSlipDisplacementPointPatchVectorField::read(), baseIOdictionary::readData(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readObjects(), schemesLookup::schemesLookup(), searchableExtrudedCircle::searchableExtrudedCircle(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), symmetryFaPatchField< Type >::symmetryFaPatchField(), symmetryFaPatchField< Type >::symmetryFaPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), syncObjects::sync(), trackingInverseDistance::update(), wedgeFvPatchField< Type >::wedgeFvPatchField(), wedgeFvPatchField< Type >::wedgeFvPatchField(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), decomposedBlockData::writeObject(), distributedTriSurfaceMesh::writeObject(), regIOobject::writeObject(), triSurfaceMesh::writeObject(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().

Here is the call graph for this function:

◆ globalObjectPath() [1/2]

Foam::fileName globalObjectPath ( ) const
inline

The complete global path + object name.

Definition at line 319 of file IOobjectI.H.

References globalPath(), and name.

Here is the call graph for this function:

◆ objectPath() [2/4]

Foam::fileName objectPath ( IOobjectOption::Layout layout) const
inline

The complete path (normal or global) + object name.

Definition at line 325 of file IOobjectI.H.

References name, and path().

Here is the call graph for this function:

◆ objectPath() [3/4]

Foam::fileName objectPath ( IOobjectOption::Layout layout,
const word & instance ) const

The complete path (normal or global) + object name with alternative instance.

Definition at line 570 of file IOobject.C.

References caseName(), instance(), local, name, and rootPath().

Here is the call graph for this function:

◆ objectPath() [4/4]

Foam::fileName objectPath ( const word & instance) const
inline

The complete path + object name with alternative instance.

Definition at line 334 of file IOobjectI.H.

References instance(), objectPath(), and IOobjectOption::regular.

Here is the call graph for this function:

◆ globalObjectPath() [2/2]

Foam::fileName globalObjectPath ( const word & instance) const
inline

The complete global path + object name with alternative instance.

Definition at line 343 of file IOobjectI.H.

References IOobjectOption::global, instance(), and objectPath().

Here is the call graph for this function:

◆ objectRelPath()

◆ localFilePath()

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

Redirect to fileHandler filePath, searching locally.

Parameters
searchFalse: use current instance; True: search previous instances

Definition at line 592 of file IOobject.C.

References Foam::fileHandler, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and Foam::search().

Referenced by distributedTriSurfaceMesh::filePath(), localIOdictionary::filePath(), regIOobject::filePath(), typeFilePath(), and fvExprDriver::updateSet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ globalFilePath()

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

◆ parseHeader()

Foam::IOstreamOption parseHeader ( const dictionary & headerDict)

Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.

Definition at line 30 of file IOobjectReadHeader.C.

References IOstreamOption::format(), dictionary::get(), Foam::foamVersion::labelByteSize(), dictionary::readIfPresent(), Foam::foamVersion::scalarByteSize(), and IOstreamOption::version().

Referenced by readHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readHeader() [1/2]

bool readHeader ( Istream & is)

Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.

Definition at line 162 of file IOobjectReadHeader.C.

References readHeader().

Referenced by decomposedBlockData::read(), decomposedBlockData::readBlock(), decomposedBlockData::readBlocks(), readHeader(), and masterUncollatedFileOperation::readStream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readHeader() [2/2]

◆ typeHeaderOk() [1/2]

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

Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks.

Parameters
checkTypeCheck headerClassName against the type-name
searchAlso search previous instances if not found at current instance
verboseReport any check-type failures

Definition at line 31 of file IOobjectTemplates.C.

References word::null, and Foam::search().

Referenced by fieldToCell::applyToSet(), basicMultiComponentMixture::basicMultiComponentMixture(), boundaryRadiationProperties::boundaryRadiationProperties(), NURBS3DVolume::computeParametricCoordinates(), faMesh::faMesh(), faMesh::faMesh(), hexRef8Data::hexRef8Data(), fvMesh::init(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), Foam::MapVolFields(), combustionModel::New(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), phaseModel::phaseModel(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), radiativeIntensityRay::radiativeIntensityRay(), topODesignVariables::readField(), particle< Type >::readFields(), variablesSet::renameTurbulenceField(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), globalMeshData::sharedPointGlobalLabels(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), stabilityBlendingFactor::stabilityBlendingFactor(), TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel(), typeHeaderOk(), and fvExprDriver::updateSet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ typeHeaderOk() [2/2]

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

Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.

Parameters
checkTypeCheck headerClassName against the type-name
verboseReport any check-type failures

Definition at line 64 of file IOobjectTemplates.C.

References typeHeaderOk().

Here is the call graph for this function:

◆ typeFilePath() [1/2]

template<class Type>
fileName typeFilePath ( const bool search = true) const

Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.

References bad(), dict, good(), Foam::noexcept, os(), Foam::search(), typeFilePath(), warnNoRereading(), writeBanner(), writeDivider(), writeEndDivider(), and writeHeader().

Referenced by fieldToCell::applyToSet(), edgeSlipDisplacementPointPatchVectorField::read(), and typeFilePath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ warnNoRereading()

template<class Type>
void warnNoRereading ( ) const

Helper: warn that type does not support re-reading.

Definition at line 85 of file IOobjectTemplates.C.

References Foam::endl(), name, IOobjectOption::READ_MODIFIED, IOobjectOption::readOpt(), and WarningInFunction.

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOmapDistribute::IOmapDistribute(), IOmapDistribute::IOmapDistribute(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), polyTopoChanger::polyTopoChanger(), rawIOField< Type >::rawIOField(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), and typeFilePath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeBanner()

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

Write the standard OpenFOAM file/dictionary banner.

Optionally without editor syntax hint (eg, for logs)

Definition at line 72 of file IOobjectWriteHeader.C.

References Foam::foamVersion::api, and os().

Referenced by argList::parse(), typeFilePath(), decomposedBlockData::writeHeader(), decomposedBlockData::writeHeader(), and writeHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeDivider()

Foam::Ostream & writeDivider ( Ostream & os)
static

Write the standard file section divider.

Definition at line 128 of file IOobjectWriteHeader.C.

References os().

Referenced by Foam::listSwitches(), argList::parse(), typeFilePath(), edgeMeshFormat::write(), decomposedBlockData::writeHeader(), decomposedBlockData::writeHeader(), and writeHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeEndDivider()

◆ writeHeader() [1/4]

bool writeHeader ( Ostream & os) const

◆ writeHeader() [2/4]

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

Write header with override of type.

Definition at line 231 of file IOobjectWriteHeader.C.

References bannerEnabled(), Foam::endl(), findMetaData(), InfoInFunction, Foam::nl, os(), writeBanner(), writeDivider(), and writeHeaderContent().

Here is the call graph for this function:

◆ writeHeader() [3/4]

void writeHeader ( dictionary & dict,
IOstreamOption streamOpt ) const

Write header into a dictionary with current type() and given output format.

Definition at line 297 of file IOobjectWriteHeader.C.

References dict, Foam::type(), and writeHeader().

Here is the call graph for this function:

◆ writeHeader() [4/4]

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

Write header into a dictionary with override of type and given output format.

Definition at line 279 of file IOobjectWriteHeader.C.

References dict, findMetaData(), and writeHeaderContent().

Here is the call graph for this function:

◆ good()

bool good ( ) const
inlinenoexcept

Did last readHeader() succeed?

Definition at line 354 of file IOobjectI.H.

References GOOD, and Foam::noexcept.

Referenced by typeFilePath(), CompactIOField< T >::writeObject(), CompactIOList< T >::writeObject(), and regIOobject::writeObject().

Here is the caller graph for this function:

◆ bad()

bool bad ( ) const
inlinenoexcept

Did last readHeader() fail?

Definition at line 360 of file IOobjectI.H.

References BAD, and Foam::noexcept.

Referenced by typeFilePath().

Here is the caller graph for this function:

◆ info()

InfoProxy< IOobject > info ( ) const
inlinenoexcept

Return info proxy, for printing information to a stream.

Definition at line 1041 of file IOobject.H.

References info(), and Foam::noexcept.

Referenced by profiling::beginTimer(), GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >::clearOldTimes(), GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >::clone(), profiling::create(), profiling::create(), profiling::endTimer(), distributedTriSurfaceMesh::findLine(), searchableBox::findLine(), searchableBox::findLine(), searchableCone::findLine(), searchableCylinder::findLine(), searchableDisk::findLine(), searchablePlane::findLine(), searchablePlate::findLine(), searchableRotatedBox::findLine(), searchableSphere::findLine(), searchableSurfaceCollection::findLine(), searchableSurfaceWithGaps::findLine(), triSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), searchableBox::findLineAll(), searchableCone::findLineAll(), searchableCylinder::findLineAll(), searchableDisk::findLineAll(), searchablePlane::findLineAll(), searchablePlate::findLineAll(), searchableRotatedBox::findLineAll(), searchableSphere::findLineAll(), searchableSurfaceCollection::findLineAll(), searchableSurfaceWithGaps::findLineAll(), triSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findLineAny(), searchableBox::findLineAny(), searchableCone::findLineAny(), searchableCylinder::findLineAny(), searchableDisk::findLineAny(), searchablePlane::findLineAny(), searchablePlate::findLineAny(), searchableRotatedBox::findLineAny(), searchableSphere::findLineAny(), searchableSurfaceCollection::findLineAny(), searchableSurfaceWithGaps::findLineAny(), triSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), distributedTriSurfaceMesh::findNearest(), searchableBox::findNearest(), searchableCone::findNearest(), searchableCylinder::findNearest(), searchableDisk::findNearest(), searchableExtrudedCircle::findNearest(), searchablePlane::findNearest(), searchablePlate::findNearest(), searchableRotatedBox::findNearest(), searchableSphere::findNearest(), searchableSurface::findNearest(), searchableSurface::findNearest(), searchableSurfaceWithGaps::findNearest(), triSurfaceMesh::findNearest(), triSurfaceMesh::findNearest(), searchableBox::findNearestOnEdge(), searchableExtrudedCircle::findParametricNearest(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), distributedTriSurfaceMesh::getField(), searchableSurfaceCollection::getField(), searchableSurfaceWithGaps::getField(), triSurfaceMesh::getField(), distributedTriSurfaceMesh::getNormal(), searchableBox::getNormal(), searchableCone::getNormal(), searchableCylinder::getNormal(), searchableDisk::getNormal(), searchableExtrudedCircle::getNormal(), searchablePlane::getNormal(), searchablePlate::getNormal(), searchableRotatedBox::getNormal(), searchableSphere::getNormal(), searchableSurfaceCollection::getNormal(), searchableSurfaceWithGaps::getNormal(), smoothTriSurfaceMesh::getNormal(), triSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), searchableBox::getRegion(), searchableCone::getRegion(), searchableCylinder::getRegion(), searchableDisk::getRegion(), searchableExtrudedCircle::getRegion(), searchablePlane::getRegion(), searchablePlate::getRegion(), searchableRotatedBox::getRegion(), searchableSphere::getRegion(), searchableSurfaceCollection::getRegion(), searchableSurfaceWithGaps::getRegion(), triSurfaceMesh::getRegion(), searchableSurfaceWithGaps::getVolumeType(), info(), Boussinesq::info(), cnoidal::info(), Grimshaw::info(), irregularMultiDirectional::info(), irregularWaveModel::info(), McCowan::info(), regularWaveModel::info(), solitaryWaveModel::info(), StokesI::info(), StokesII::info(), StokesV::info(), streamFunction::info(), waveGenerationModel::info(), distributedTriSurfaceMesh::localQueries(), profiling::New(), profiling::operator=(), GeometricField< Type, PatchField, GeoMesh >::prevIter(), profiling::profiling(), setBad(), KinematicCloud< CloudType >::solve(), GeometricField< Type, PatchField, GeoMesh >::storeOldTime(), profiling::unstack(), profiling::writeData(), topOVariablesBase::writeFluidSolidInterface(), and GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >::~GeometricField().

Here is the call graph for this function:

◆ operator=()

void operator= ( const IOobject & io)

Copy assignment, copies all values (except the registry).

Definition at line 660 of file IOobject.C.

References IOobjectOption::globalObject(), io, IOobjectOption::readOpt(), and IOobjectOption::writeOpt().

Referenced by regIOobject::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isHeaderClassName()

template<class Type>
bool isHeaderClassName ( ) const
inline

Same as isHeaderClass().

Definition at line 1058 of file IOobject.H.

References isHeaderClass().

Here is the call graph for this function:

◆ groupName() [2/2]

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

Definition at line 34 of file IOobjectI.H.

References group().

Here is the call graph for this function:

◆ typeFilePath() [2/2]

template<class Type>
Foam::fileName typeFilePath ( const bool search) const

Definition at line 71 of file IOobjectTemplates.C.

References globalFilePath(), localFilePath(), and Foam::search().

Here is the call graph for this function:

Member Data Documentation

◆ fileCheckTypesNames

const Foam::Enum< Foam::IOobject::fileCheckTypes > fileCheckTypesNames
static

Names for the fileCheckTypes.

Definition at line 218 of file IOobject.H.

Referenced by argList::parse().

◆ scopeSeparator

char scopeSeparator
static

Character for scoping object names (':' or '_').

Change with caution.

Definition at line 353 of file IOobject.H.

Referenced by scopedName(), scopedName(), and dsmcFields::write().

◆ fileModificationChecking

Foam::IOobject::fileCheckTypes fileModificationChecking
static

Type of file modification checking.

Definition at line 358 of file IOobject.H.

Referenced by fileModificationChecking_masterOnly(), fileOperation::monitor(), fvMeshTools::newMesh(), and argList::parse().

◆ fileModificationSkew

float fileModificationSkew
static

Time skew (seconds) for file modification checks.

Definition at line 363 of file IOobject.H.

Referenced by codeStream::getFunction(), argList::parse(), registerOptSwitch(), and dynamicCode::waitForFile().

◆ maxFileModificationPolls

int maxFileModificationPolls
static

Max number of times to poll for file modification changes.

Definition at line 368 of file IOobject.H.

Referenced by argList::parse(), registerOptSwitch(), and dynamicCode::waitForFile().


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