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

Inheritance diagram for IOobject:
[legend]
Collaboration diagram for IOobject:
[legend]

Public Types

enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
enum  objectState : char { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 

Public Member Functions

 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
virtual void rename (const word &newName)
 Rename the object. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 

Static Public Member Functions

static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 

Static Public Attributes

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

Protected Member Functions

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

Static Protected Member Functions

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

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.
  • 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.
  • 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 169 of file IOobject.H.

Member Enumeration Documentation

◆ readOption

enum readOption : char

Enumeration defining the read options.

Enumerator
NO_READ 
MUST_READ 
MUST_READ_IF_MODIFIED 
READ_IF_PRESENT 

Definition at line 176 of file IOobject.H.

◆ writeOption

enum writeOption : char

Enumeration defining the write options.

Enumerator
NO_WRITE 
AUTO_WRITE 

Definition at line 185 of file IOobject.H.

◆ objectState

enum objectState : char

Enumeration defining the valid states of an IOobject.

Enumerator
GOOD 
BAD 

Definition at line 192 of file IOobject.H.

◆ fileCheckTypes

enum fileCheckTypes : char

Enumeration defining the file checking options.

Enumerator
timeStamp 
timeStampMaster 
inotify 
inotifyMaster 

Definition at line 199 of file IOobject.H.

Constructor & Destructor Documentation

◆ IOobject() [1/8]

IOobject ( const IOobject )
default

Copy construct.

◆ ~IOobject()

virtual ~IOobject ( )
virtualdefault

Destructor.

◆ IOobject() [2/8]

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

Construct from name, instance, registry, io options.

Definition at line 310 of file IOobject.C.

References Foam::endl(), and InfoInFunction.

Here is the call graph for this function:

◆ IOobject() [3/8]

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

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

Definition at line 346 of file IOobject.C.

References Foam::endl(), and InfoInFunction.

Here is the call graph for this function:

◆ IOobject() [4/8]

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

Construct from path, registry, io options.

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 383 of file IOobject.C.

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

Here is the call graph for this function:

◆ IOobject() [5/8]

IOobject ( const IOobject io,
const objectRegistry registry 
)

Copy construct, resetting registry.

Definition at line 425 of file IOobject.C.

◆ IOobject() [6/8]

IOobject ( const IOobject io,
const word name 
)

Copy construct, resetting name.

Definition at line 448 of file IOobject.C.

◆ IOobject() [7/8]

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

Copy construct, resetting name and local component.

Definition at line 471 of file IOobject.C.

References IOobject::local().

Here is the call graph for this function:

◆ IOobject() [8/8]

IOobject ( const IOobject io,
readOption  rOpt,
writeOption  wOpt 
)

Copy construct, resetting read/write options.

Definition at line 484 of file IOobject.C.

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 157 of file IOobjectWriteHeader.C.

References Foam::foamVersion::buildArch, IOobject::db(), objectRegistry::dbDir(), IOstreamOption::format(), IOobject::instance(), io(), IOobject::local(), IOobject::name(), IOobject::note(), os(), IOstreamOption::version(), dictionary::writeEntry(), and Foam::writeHeaderEntry().

Referenced by IOobject::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 196 of file IOobjectWriteHeader.C.

References dictionary::add(), Foam::foamVersion::buildArch, IOobject::db(), objectRegistry::dbDir(), dict, IOstreamOption::format(), IOobject::instance(), io(), IOobject::local(), IOobject::name(), IOobject::note(), dictionary::set(), 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 603 of file IOobject.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, 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]

static bool bannerEnabled ( )
inlinestaticnoexcept

Status of output file banner.

Definition at line 315 of file IOobject.H.

Referenced by decomposedBlockData::writeBlockEntry(), IOobject::writeHeader(), decomposedBlockData::writeHeader(), and collatedFileOperation::writeObject().

Here is the caller graph for this function:

◆ bannerEnabled() [2/2]

static bool bannerEnabled ( bool  on)
inlinestaticnoexcept

Enable/disable output file banner.

Returns
the previous value

Definition at line 322 of file IOobject.H.

◆ 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 146 of file IOobject.C.

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

Referenced by IOobject::fileNameComponents(), and IOobject::IOobject().

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

◆ groupName() [1/2]

static word groupName ( StringType  base,
const word group 
)
inlinestatic

Create dot-delimited name.group string.

An empty group is ignored.

Referenced by 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(), kOmegaSST::computeG(), turbulentDispersionModel::continuousTurbulence(), populationBalanceModel::continuousTurbulence(), Maxwell< BasicTurbulenceModel >::correct(), DarcyForchheimer::correct(), powerLaw::correct(), solidification::correct(), limitTemperature::correct(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::correctThermo(), Burns::D(), Gosman::D(), kineticTheoryModel::devRhoReff(), phasePressureModel::devRhoReff(), Maxwell< BasicTurbulenceModel >::devRhoReff(), InterfaceCompositionModel< Thermo, OtherThermo >::Dfrom(), MovingPhaseModel< BasePhaseModel >::diffNo(), phaseSystem::dmdt(), InterfaceCompositionModel< Thermo, OtherThermo >::Dto(), LESModel< BasicTurbulenceModel >::epsilon(), SpalartAllmaras< BasicTurbulenceModel >::epsilon(), phaseSystem::fillFields(), kOmegaSSTLM< BasicTurbulenceModel >::Flength(), kOmegaSSTLM< BasicTurbulenceModel >::Fonset(), phaseSystem::foundBlendedSubModel(), phaseSystem::foundSubModel(), kOmegaSSTLM< BasicTurbulenceModel >::Fthetat(), multiphaseInterSystem::generatePairsAndSubModels(), phaseSystem::generatePairsAndSubModels(), hyperbolic::hyperbolic(), IDDESDelta::IDDESDelta(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), MovingPhaseModel< BasePhaseModel >::K(), SpalartAllmaras< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), WALE< BasicTurbulenceModel >::k(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), limitTemperature::limitTemperature(), 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(), LESModel< BasicTurbulenceModel >::New(), TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >::New(), strainRateFunction::nu(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), generalizedNewtonian< BasicMomentumTransportModel >::nuEff(), Stokes< BasicTurbulenceModel >::nuEff(), LESModel< BasicTurbulenceModel >::nuEff(), RASModel< BasicTurbulenceModel >::nuEff(), generalizedNewtonian< BasicMomentumTransportModel >::nut(), Stokes< BasicTurbulenceModel >::nut(), LESModel< BasicTurbulenceModel >::omega(), SpalartAllmaras< BasicTurbulenceModel >::omega(), phaseChange::phaseChange(), phaseForces::phaseForces(), phaseModel::phaseModel(), basicThermo::phasePropertyName(), StaticPhaseModel< BasePhaseModel >::phi(), populationBalanceModel::populationBalanceModel(), PopulationBalancePhaseSystem< BasePhaseSystem >::PopulationBalancePhaseSystem(), PhaseCompressibleTurbulenceModel< TransportModel >::pPrime(), PhaseIncompressibleTurbulenceModel< TransportModel >::pPrime(), PhaseCompressibleTurbulenceModel< TransportModel >::pPrimef(), PhaseIncompressibleTurbulenceModel< TransportModel >::pPrimef(), InertPhaseModel< BasePhaseModel >::Qdot(), kineticTheoryModel::R(), phasePressureModel::R(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), phaseChange::R(), wallBoiling::R(), BilgerMixtureFraction::read(), sampledSurfaces::read(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetac(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetat0(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::ThermalPhaseChangePhaseSystem(), ThermoPhaseModel< BasePhaseModel, ThermoType >::ThermoPhaseModel(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem(), StaticPhaseModel< BasePhaseModel >::U(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), fixedShearStressFvPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), externalCoupledTemperatureMixedFvPatchScalarField::writeData(), Henry< Thermo, OtherThermo >::YfPrime(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUBlendedWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().

◆ group() [1/2]

Foam::word group ( const word name)
static

Return group (extension part of name)

Definition at line 282 of file IOobject.C.

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

Referenced by IDDESDelta::IDDESDelta(), laminarModel< BasicTurbulenceModel >::New(), LESModel< BasicTurbulenceModel >::New(), TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >::New(), and strainRateFunction::nu().

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

◆ member() [1/2]

Foam::word member ( const word name)
static

Return member (name without the extension)

Definition at line 295 of file IOobject.C.

References Foam::name().

Referenced by ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), and alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs().

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

◆ scopedName()

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 46 of file IOobjectI.H.

References Foam::name(), and IOobject::scopeSeparator.

Referenced by solverInfo::createResidualField(), turbulenceFields::initialise(), turbulenceFields::processField(), turbulenceFields::read(), multiFieldValue::read(), multiRegion::read(), functionObject::scopedName(), lduMatrix::setResidualField(), turbulenceFields::write(), and electricPotential::write().

Here is the call graph for this function:
Here is the caller 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 237 of file IOobject.C.

References IOobject::db(), string::expand(), IOobject::globalObject(), io(), Foam::isDir(), IOobject::name(), IOobject::readOpt(), IOobject::registerObject(), and IOobject::writeOpt().

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

Definition at line 459 of file IOobject.H.

References Time::New().

Referenced by searchableSurface::iNew::operator()(), polyBoundaryMesh::polyBoundaryMesh(), and searchableSurfaces::searchableSurfaces().

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

◆ clone() [2/2]

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

Clone resetting registry.

Definition at line 465 of file IOobject.H.

References Time::New().

Here is the call graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const
noexcept

Return the local objectRegistry.

Definition at line 500 of file IOobject.C.

Referenced by refinementHistory::add(), refinementHistory::apply(), Foam::atan2(), SprayParcel< ParcelType >::calcAtomization(), Foam::cmptAv(), ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), relaxedSnGrad< Type >::correction(), faePatchField< Type >::db(), faPatchField< Type >::db(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), IATEsource::Eo(), edgeInterpolationScheme< Type >::euclidianInterpolate(), uncollatedFileOperation::filePathInfo(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), leastSquaresFaGrad< Type >::grad(), hexRef8Data::hexRef8Data(), InflationInjection< CloudType >::InflationInjection(), InjectionModel< CloudType >::inject(), InjectionModel< CloudType >::injectSteadyState(), InjectionModel< Foam::KinematicCloud< Foam::DSMCCloud > >::injectSteadyState(), edgeInterpolationScheme< Type >::interpolate(), pointVolInterpolation::interpolate(), KinematicLookupTableInjection< CloudType >::KinematicLookupTableInjection(), Foam::fam::laplacian(), lnGradScheme< Type >::lnGrad(), fvMeshTools::loadOrCreateMesh(), faMeshTools::loadOrCreateMesh(), Foam::loadPointField(), Foam::mag(), Foam::magSqr(), voxelMeshSearch::makeMesh(), IATEsource::Mo(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), laminarFlameSpeed::New(), adjointRASModel::New(), adjointTurbulenceModel::New(), fvMeshTools::newMesh(), faMeshTools::newMesh(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), sampledSurface::pointAverage(), Foam::pow(), fileOperation::processorsPath(), wallBoiling::R(), ReactingCloud< CloudType >::ReactingCloud(), ReactingLookupTableInjection< CloudType >::ReactingLookupTableInjection(), ReactingMultiphaseLookupTableInjection< CloudType >::ReactingMultiphaseLookupTableInjection(), refinementHistory::refinementHistory(), regionProperties::regionProperties(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), IOobject::selectIO(), motionSmootherAlgo::setDisplacement(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), Foam::sqr(), Foam::stabilise(), surfMesh::surfMesh(), hexRef8Data::sync(), ThermoCloud< CloudType >::ThermoCloud(), ThermoLookupTableInjection< CloudType >::ThermoLookupTableInjection(), KinematicParcel< ParcelType >::trackingData::updateAverages(), MPPICParcel< ParcelType >::trackingData::updateAverages(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

◆ time()

const Foam::Time & time ( ) const

Return Time associated with the objectRegistry.

Definition at line 506 of file IOobject.C.

References objectRegistry::time().

Referenced by objective::accumulateJMean(), interRegionHeatTransferModel::addSup(), fixedTemperatureConstraint::constrain(), InterfaceCompositionModel< Thermo, OtherThermo >::Dfrom(), InterfaceCompositionModel< Thermo, OtherThermo >::Dto(), uncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), objective::isWithinIntegrationTime(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), Foam::fam::laplacian(), Foam::fvm::laplacian(), fvMeshTools::loadOrCreateMesh(), faMeshTools::loadOrCreateMesh(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), laminarFlameSpeed::New(), radiationModel::New(), adjointRASModel::New(), adjointTurbulenceModel::New(), fvMeshTools::newMesh(), faMeshTools::newMesh(), objectiveManager::objectiveManager(), points0MotionSolver::points0MotionSolver(), populationBalanceModel::populationBalanceModel(), fileOperation::processorsCasePath(), randomCoalescence::R(), turbulentBreakUp::R(), dummy::R(), data::setSolverPerformance(), sixDoFRigidBodyMotionSolver::solve(), StandardChemistryModel< ReactionThermo, ThermoType >::StandardChemistryModel(), TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel(), atmTurbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), plenumPressureFvPatchScalarField::updateCoeffs(), Foam::writeCellGraph(), regIOobject::writeObject(), Foam::writePatchGraph(), and subCycleField< GeometricField >::~subCycleField().

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

◆ name()

const Foam::word & name ( ) const
inlinenoexcept

Return the object name.

Definition at line 65 of file IOobjectI.H.

Referenced by multivariateSurfaceInterpolationScheme< Type >::fieldTable::add(), polyMeshAdder::add(), exprDriver::addContextObject(), snappyLayerDriver::addLayers(), snappyLayerDriver::addLayersSinglePass(), polyTopoChange::addMesh(), exprResultGlobals::addValue(), setsToFaceZone::applyToSet(), Foam::atan2(), attachPolyTopoChanger::attach(), Foam::fac::average(), Foam::fvc::average(), meshRefinement::balance(), basicThermo::basicThermo(), blended< Type >::blendingFactor(), cellCoBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), localBlended< Type >::blendingFactor(), Foam::bound(), fourthGrad< Type >::calcGrad(), iterativeGaussGrad< Type >::calcGrad(), cellLimitedGrad< Type, Limiter >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), hydrostaticPressure::calculateAndWrite(), cellZoneSet::cellZoneSet(), meshRefinement::checkCoupledFaceZones(), faBoundaryMesh::checkDefinition(), polyBoundaryMesh::checkDefinition(), objectRegistry::checkIn(), objectRegistry::checkOut(), faBoundaryMesh::checkParallelSync(), polyBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), refinementFeatures::checkSizes(), objectRegistry::classesImpl(), objectRegistry::clear(), meshObject::clear(), meshObject::clearUpto(), CollidingCloud< CloudType >::clone(), KinematicCloud< CloudType >::clone(), MPPICCloud< CloudType >::clone(), ReactingCloud< CloudType >::clone(), ReactingHeterogeneousCloud< CloudType >::clone(), ReactingMultiphaseCloud< CloudType >::clone(), ThermoCloud< CloudType >::clone(), SprayCloud< CloudType >::clone(), injectedParticleCloud::clone(), RASModelVariables::cloneRefPtr(), Foam::cmptAv(), adjointkOmegaSST::convectionMeanFlowSource(), adjointkOmegaSST::convectionScheme(), RASModelVariables::copyAndRename(), atmNutSource::correct(), multiphaseStabilizedTurbulence::correct(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), relaxedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), deferredCorrection< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), cubic< Type >::correction(), localBlended< Type >::correction(), IOobjectList::countImpl(), objectRegistry::countImpl(), IOobjectList::countTypeImpl(), objectRegistry::countTypeImpl(), fvMeshTools::createDummyFvMeshFiles(), Foam::fvc::curl(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), cyclicFaPatchField< Type >::cyclicFaPatchField(), cyclicFvPatchField< Type >::cyclicFvPatchField(), Foam::fac::d2dt2(), Foam::fam::d2dt2(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), Foam::fac::ddt(), Foam::fam::ddt(), Foam::fvc::ddt(), Foam::fvm::ddt(), decomposedBlockData::decomposedBlockData(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), faMeshDistributor::distributeAreaFields(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), faMeshDistributor::distributeEdgeFields(), Foam::fam::div(), Foam::fac::div(), Foam::fvc::div(), Foam::fvm::div(), Foam::fvc::domainIntegrate(), surfaceInterpolationScheme< scalar >::dotInterpolate(), surfaceInterpolationScheme< Type >::dotInterpolate(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), emptyFaPatchField< Type >::emptyFaPatchField(), emptyFvPatchField< Type >::emptyFvPatchField(), edgeInterpolationScheme< Type >::euclidianInterpolate(), removeRegisteredObject::execute(), fileOperation::exists(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), EulerFaD2dt2Scheme< Type >::facD2dt2(), boundedBackwardFaDdtScheme::facDdt(), backwardFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), gaussConvectionScheme< Type >::facDiv(), gaussDivScheme< Type >::facDiv(), faceZoneSet::faceZoneSet(), gaussLaplacianScheme< Type >::facLaplacian(), faMatrix< Type >::faMatrix(), gaussLaplacianScheme< Type >::famLaplacian(), IOobject::fileNameComponents(), uncollatedFileOperation::filePathInfo(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), localPointRegion::findDuplicateFacePairs(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), coupleGroupIdentifier::findOtherPatchID(), adjointkOmegaSST::FISensitivityTerm(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< Type >::fixedValueFvPatchField(), Foam::fvc::flux(), correctedSnGrad< Type >::fullGradCorrection(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), gaussDivScheme< Type >::fvcDiv(), gaussConvectionScheme< Type >::fvcDiv(), gaussLaplacianScheme< Type, GType >::fvcLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvcLaplacian(), fvMatrix< Type >::fvMatrix(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), genericPatchFieldBase::genericFatalSolveError(), genericPointPatchField< Type >::genericPointPatchField(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), exprResultGlobals::get(), exprResultGlobals::getNamespace(), globalIndexAndTransform::globalIndexAndTransform(), gaussGrad< Type >::grad(), leastSquaresFaGrad< Type >::grad(), Foam::fac::grad(), gradScheme< Type >::grad(), Foam::fvc::grad(), fvMatrix< Type >::H(), AnisothermalPhaseModel< BasePhaseModel >::heEqn(), hexRef8Data::hexRef8Data(), thermoSingleLayer::hs(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), injectionModelList::info(), transferModelList::info(), dynamicRefineFvMesh::init(), edgeInterpolationScheme< Type >::interpolate(), faMeshSubset::interpolate(), singleCellFvMesh::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), volPointInterpolation::interpolate(), localBlended< Type >::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), weightedFlux< Type >::interpolate(), fvMeshSubset::interpolate(), Foam::interpolate(), pointVolInterpolation::interpolate(), meshToMesh0::interpolate(), volPointInterpolation::interpolateDimensionedInternalField(), volPointInterpolation::interpolateInternalField(), sizeGroup::keyword(), Foam::fam::laplacian(), Foam::fac::laplacian(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), lnGradScheme< Type >::lnGrad(), Foam::fac::lnGrad(), triSurfaceLoader::load(), fvExpressionField::loadAndStore(), readFields::loadAndStore(), fvMeshTools::loadOrCreateMesh(), faMeshTools::loadOrCreateMesh(), Foam::loadPointField(), LocalInteraction< CloudType >::LocalInteraction(), objectRegistry::lookupClass(), mappedPatchBase::lookupMesh(), objectRegistry::lookupObjectPtr(), objectRegistry::lookupObjectRefPtr(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), voxelMeshSearch::makeMesh(), Foam::MapConsistentSubMesh(), mappedPatchBase::mappedPatchBase(), mappedVelocityFluxFixedValueFvPatchField::mappedVelocityFluxFixedValueFvPatchField(), mappedPatchFieldBase< Type >::mapper(), zoneSubSet::mapToZone(), Foam::fvc::meshPhi(), meshToMesh0::meshToMesh0(), mixedFvPatchField< Type >::mixedFvPatchField(), solidBodyFvGeometryScheme::movePoints(), multiphaseSystem::multiphaseSystem(), faMesh::name(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), Foam::fam::ndiv(), Foam::fac::ndiv(), surfaceInterpolationScheme< scalar >::New(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), topoSet::New(), fvMeshTools::newMesh(), Foam::fac::ngrad(), seriesLess::operator()(), nameOp< T >::operator()(), Foam::operator==(), sampledPatch::patchIDs(), patchInjection::patchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), pointMesh::pointMesh(), pointZoneSet::pointZoneSet(), polyMesh::polyMesh(), populationBalanceModel::populationBalanceModel(), RemoveParcels< CloudType >::postEvolve(), Foam::pow(), genericPatchFieldBase::processEntry(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorFaPatchField< Type >::processorFaPatchField(), processorFvPatchField< Type >::processorFvPatchField(), rawIOField< Type >::rawIOField(), ReactingCloud< CloudType >::ReactingCloud(), wallBoundedStreamLine::read(), wallShearStress::read(), wallHeatFlux::read(), decomposedBlockData::readBlocks(), Foam::fvc::reconstruct(), faFieldReconstructor::reconstructAreaField(), faFieldReconstructor::reconstructAreaFields(), faFieldReconstructor::reconstructEdgeField(), faFieldReconstructor::reconstructEdgeFields(), faFieldReconstructor::reconstructField(), pointFieldReconstructor::reconstructField(), lagrangianReconstructor::reconstructFieldFields(), lagrangianReconstructor::reconstructFields(), fvFieldReconstructor::reconstructInternalField(), fvFieldReconstructor::reconstructInternalFields(), Foam::fvc::reconstructMag(), pointFieldReconstructor::reconstructPointField(), pointFieldReconstructor::reconstructPointFields(), fvFieldReconstructor::reconstructSurfaceField(), fvFieldReconstructor::reconstructSurfaceFields(), fvFieldReconstructor::reconstructVolumeField(), fvFieldReconstructor::reconstructVolumeFields(), triSurfaceMesh::regions(), IOobjectList::remove(), exprDriver::removeContextObject(), exprResultGlobals::removeValue(), variablesSet::renameTurbulenceField(), genericPatchFieldBase::reportMissingEntry(), VollerPrakash::S(), sampledPatchInternalField::sampledPatchInternalField(), searchableSurfaceCollection::searchableSurfaceCollection(), IOobject::selectIO(), refinementSurfaces::setMinLevelFields(), removeCells::setRefinement(), removeFaces::setRefinement(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), skewCorrected< Type >::skewCorrection(), ATCModel::smoothFieldBasedOnCells(), snGradScheme< Type >::snGrad(), Foam::fvc::snGrad(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), multiphaseSystem::solve(), twoPhaseSystem::solve(), fvMatrix< Type >::fvSolver::solve(), dynamicOversetFvMesh::solve(), fvMatrix< Type >::solveSegregated(), kinematicSingleLayer::solveThickness(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), Foam::sqr(), Foam::stabilise(), regIOobject::store(), subCycleField< GeometricField >::subCycleField(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), symmetryFaPatchField< Type >::symmetryFaPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), hexRef8Data::sync(), thermoSingleLayer::T(), ThermoCloud< CloudType >::ThermoCloud(), dictionary::topDict(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), twoPhaseSystem::twoPhaseSystem(), KinematicParcel< ParcelType >::trackingData::updateAverages(), MPPICParcel< ParcelType >::trackingData::updateAverages(), mappedFlowRateFvPatchVectorField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), topoBitSet::updateLabels(), topoBoolSet::updateLabels(), motionSmootherAlgo::updateMesh(), meshObject::updateMesh(), basicThermo::validate(), voxelMeshSearch::voxelMeshSearch(), wedgeFvPatchField< Type >::wedgeFvPatchField(), localBlended< Type >::weights(), ObukhovLength::write(), regionSizeDistribution::write(), writeCellCentres::write(), writeCellVolumes::write(), XiReactionRate::write(), electricPotential::write(), writeObjects::write(), FaceInteraction< CloudType >::write(), FacePostProcessing< CloudType >::write(), internalWriter::write(), PDRblock::writeBlockMeshDict(), Foam::writeCellGraph(), meshToMeshMethod::writeConnectivity(), faBoundaryMesh::writeData(), boundaryRegion::writeDict(), cellTable::writeDict(), mappedPatchBase::writeDict(), molecule::writeFields(), fieldExtents::writeFileHeader(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), regionFunctionObject::writeObject(), Cloud< ParcelType >::writeObject(), regIOobject::writeObject(), Foam::writePatchGraph(), Foam::ensightOutput::writeVolField(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::YiEqn().

◆ headerClassName() [1/2]

◆ headerClassName() [2/2]

Foam::word & headerClassName ( )
inlinenoexcept

Return non-constant access to the class name read from header.

Definition at line 89 of file IOobjectI.H.

◆ note() [1/2]

const Foam::string & note ( ) const
inlinenoexcept

Return the optional note.

Definition at line 95 of file IOobjectI.H.

Referenced by decomposedBlockData::readBlocks(), boundaryDataWriter::write(), decomposedBlockData::writeData(), boundaryRegion::writeDict(), cellTable::writeDict(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), and boundaryDataWriter::writeTemplate().

Here is the caller graph for this function:

◆ note() [2/2]

Foam::string & note ( )
inlinenoexcept

Modifiable access to the optional note.

Definition at line 101 of file IOobjectI.H.

◆ rename()

◆ registerObject() [1/3]

bool registerObject ( ) const
inlinenoexcept

Should object created with this IOobject be registered?

Definition at line 107 of file IOobjectI.H.

Referenced by Foam::loadPointField(), fvMeshTools::newMesh(), faMeshTools::newMesh(), regIOobject::regIOobject(), IOobject::selectIO(), motionSolver::stealRegistration(), blockMesh::topology(), and fvMeshSubsetProxy::zeroGradientField().

Here is the caller graph for this function:

◆ registerObject() [2/3]

bool registerObject ( bool  on)
inlinenoexcept

Change registration preference, return previous value.

Definition at line 113 of file IOobjectI.H.

◆ globalObject() [1/3]

bool globalObject ( ) const
inlinenoexcept

Is object same for all processors?

Definition at line 121 of file IOobjectI.H.

Referenced by IOobject::selectIO().

Here is the caller graph for this function:

◆ globalObject() [2/3]

bool globalObject ( bool  on)
inlinenoexcept

Change global-object status, return previous value.

Definition at line 127 of file IOobjectI.H.

◆ labelByteSize()

unsigned labelByteSize ( ) const
inlinenoexcept

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

Definition at line 135 of file IOobjectI.H.

◆ scalarByteSize()

unsigned scalarByteSize ( ) const
inlinenoexcept

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

Definition at line 141 of file IOobjectI.H.

◆ hasHeaderClass()

bool hasHeaderClass ( ) const
inlinenoexcept

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

Definition at line 149 of file IOobjectI.H.

Referenced by polyMesh::polyMesh().

Here is the caller graph for this function:

◆ isHeaderClass() [1/2]

◆ isHeaderClassName()

bool isHeaderClassName ( ) const
inline

Same as isHeaderClass()

Definition at line 532 of file IOobject.H.

◆ findMetaData()

const Foam::dictionary * findMetaData ( ) const
virtualnoexcept

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

Reimplemented in regIOobject.

Definition at line 33 of file IOobjectMetaData.C.

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

Here is the caller graph for this function:

◆ readOpt() [1/3]

Foam::IOobject::readOption readOpt ( ) const
inlinenoexcept

The read option.

Definition at line 164 of file IOobjectI.H.

Referenced by columnFvMesh::columnFvMesh(), CompactIOField< T, BaseType >::CompactIOField(), CompactIOField< Foam::Field< label >, label >::CompactIOField(), nearWallFields::createFields(), decomposedBlockData::decomposedBlockData(), faMeshDistributor::distribute(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), topoSet::findIOobject(), hexRef8::hexRef8(), dynamicMotionSolverListFvMesh::init(), IOField< Type >::IOField(), IOPtrList< T >::IOPtrList(), IOPtrList< Foam::entry >::IOPtrList(), lumpedPointIOMovement::lumpedPointIOMovement(), voxelMeshSearch::makeMesh(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), fvMeshTools::newMesh(), faMeshTools::newMesh(), CompactIOField< Foam::Field< label >, label >::operator=(), IOPtrList< Foam::entry >::operator=(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), radiationModel::radiationModel(), radiativeIntensityRay::radiativeIntensityRay(), rawIOField< Type >::rawIOField(), regIOobject::readHeaderOk(), codedPoints0MotionSolver::redirectMotionSolver(), refinementHistory::refinementHistory(), schemesLookup::schemesLookup(), IOobject::selectIO(), SimplifiedDynamicFvMesh< DynamicMeshType >::SimplifiedDynamicFvMesh(), solution::solution(), surfZoneIOList::surfZoneIOList(), hexRef8Data::sync(), Time::Time(), topoSet::topoSet(), triSurfaceMesh::triSurfaceMesh(), Foam::ensightOutput::writeCloudField(), and fvMeshSubsetProxy::zeroGradientField().

Here is the caller graph for this function:

◆ readOpt() [2/3]

Foam::IOobject::readOption readOpt ( readOption  opt)
inlinenoexcept

Change the read option, return previous value.

Definition at line 171 of file IOobjectI.H.

◆ writeOpt() [1/3]

◆ writeOpt() [2/3]

Foam::IOobject::writeOption writeOpt ( writeOption  opt)
inlinenoexcept

Change the write option, return previous value.

Definition at line 186 of file IOobjectI.H.

◆ group() [2/2]

Foam::word group ( ) const
inline

Return group (extension part of name)

Definition at line 71 of file IOobjectI.H.

References word::ext().

Referenced by IOobject::groupName().

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

◆ member() [2/2]

Foam::word member ( ) const
inline

Return member (name without the extension)

Definition at line 77 of file IOobjectI.H.

References word::lessExt().

Referenced by diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), 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

Return the Time::rootPath()

Definition at line 512 of file IOobject.C.

Referenced by uncollatedFileOperation::filePathInfo(), Foam::makeGraph(), and fileOperation::processorsCasePath().

Here is the caller graph for this function:

◆ caseName()

const Foam::fileName & caseName ( ) const

Return the Time::caseName()

Definition at line 518 of file IOobject.C.

Referenced by uncollatedFileOperation::filePathInfo(), and Foam::makeGraph().

Here is the caller graph for this function:

◆ instance() [1/2]

const Foam::fileName & instance ( ) const
inlinenoexcept

Read access to instance path component.

Definition at line 196 of file IOobjectI.H.

Referenced by snappyLayerDriver::addLayers(), Foam::atan2(), Foam::fac::average(), Foam::fvc::average(), fourthGrad< Type >::calcGrad(), leastSquaresGrad< Type >::calcGrad(), LeastSquaresGrad< Type, Stencil >::calcGrad(), Foam::cmptAv(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), directions::directions(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), edgeInterpolationScheme< Type >::euclidianInterpolate(), IOobject::fileNameComponents(), uncollatedFileOperation::filePathInfo(), Time::findInstance(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), leastSquaresFaGrad< Type >::grad(), gaussGrad< Type >::gradf(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), edgeInterpolationScheme< Type >::interpolate(), volPointInterpolation::interpolate(), pointVolInterpolation::interpolate(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::fam::laplacian(), lnGradScheme< Type >::lnGrad(), fvMeshTools::loadOrCreateMesh(), faMeshTools::loadOrCreateMesh(), Foam::loadPointField(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), triSurfaceMesh::movePoints(), fvMeshTools::newMesh(), faMeshTools::newMesh(), points0MotionSolver::points0IO(), Foam::pow(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), surfMesh::setInstance(), polyMesh::setInstance(), topoSet::setInstance(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), snGradScheme< Type >::snGrad(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), triSurfaceMesh::writeObject(), regIOobject::writeObject(), and distributedTriSurfaceMesh::writeObject().

◆ instance() [2/2]

Foam::fileName & instance ( )
inlinenoexcept

Write access to instance path component.

Definition at line 202 of file IOobjectI.H.

◆ local()

const Foam::fileName & local ( ) const
inlinenoexcept

Read access to local path component.

Definition at line 208 of file IOobjectI.H.

Referenced by IOobject::fileNameComponents(), uncollatedFileOperation::filePathInfo(), fileOperation::findInstance(), masterUncollatedFileOperation::findInstance(), IOobject::IOobject(), Foam::loadPointField(), fileOperation::processorsPath(), surfMesh::surfMesh(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

Here is the caller graph for this function:

◆ path() [1/2]

Foam::fileName path ( ) const

◆ path() [2/2]

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

The complete path with alternative instance and local.

Definition at line 547 of file IOobject.C.

◆ objectPath()

Foam::fileName objectPath ( ) const
inline

The complete path + object name.

Definition at line 214 of file IOobjectI.H.

References Foam::name(), and path().

Referenced by baseIOdictionary::baseIOdictionary(), hexRef8::consistentSlowRefinement2(), limitedSnGrad< Type >::correction(), distanceSurface::createGeometry(), fileOperation::exists(), uncollatedFileOperation::filePathInfo(), genericPatchFieldBase::genericFatalSolveError(), hexRef8::hexRef8(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), mappedPatchFieldBase< Type >::mapper(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), fileOperation::objectPath(), genericPatchFieldBase::processEntry(), rawIOField< Type >::rawIOField(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), uncollatedFileOperation::readObjects(), processorFaMeshes::removeFiles(), processorMeshes::removeFiles(), genericPatchFieldBase::reportMissingEntry(), hexRef8::setRefinement(), hexRef8::setUnrefinement(), surfZoneIOList::surfZoneIOList(), syncObjects::sync(), triSurfaceMesh::triSurfaceMesh(), trackingInverseDistance::update(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), fileOperation::writeObject(), triSurfaceMesh::writeObject(), regIOobject::writeObject(), distributedTriSurfaceMesh::writeObject(), and boundaryDataWriter::writeTemplate().

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

◆ objectRelPath()

Foam::fileName objectRelPath ( ) const

The object path relative to the root.

Definition at line 558 of file IOobject.C.

References Foam::name().

Referenced by isoSurfaceTopo::isoSurfaceTopo(), faMeshTools::readProcAddressing(), fvMeshTools::readProcAddressing(), objectRegistry::writeObject(), faMeshTools::writeProcAddressing(), and fvMeshTools::writeProcAddressing().

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

◆ localFilePath()

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

Helper for filePath that searches locally.

When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 581 of file IOobject.C.

References Foam::fileHandler(), fileOperation::filePath(), and Foam::search().

Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), triSurfaceMesh::triSurfaceMesh(), and Foam::typeFilePath().

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

Helper for filePath that searches up if in parallel.

When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 592 of file IOobject.C.

References Foam::fileHandler(), fileOperation::filePath(), and Foam::search().

Referenced by extendedFeatureEdgeMesh::filePath(), GlobalIOField< Type >::filePath(), triSurfaceMesh::triSurfaceMesh(), Foam::typeFilePath(), and Foam::typeFilePath< IOMap< dictionary > >().

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

◆ parseHeader()

Foam::IOstreamOption parseHeader ( const dictionary headerDict)

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

Definition at line 35 of file IOobjectReadHeader.C.

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

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

References IOobject::readHeader().

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

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

◆ readHeader() [2/2]

bool readHeader ( dictionary headerDict,
Istream is 
)

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

Saves the header content in the given dictionary.

Definition at line 73 of file IOobjectReadHeader.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstreamOption::format(), IOstream::good(), Foam::Info, InfoInFunction, IOWarningInFunction, token::isWord(), IOstream::lineNumber(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOstream::name(), Foam::name(), Foam::nl, dictionary::read(), IOstream::relativeName(), SeriousIOErrorInFunction, IOstream::setLabelByteSize(), IOstream::setScalarByteSize(), IOstreamOption::version(), and Foam::writeHeader().

Here is the call graph for this function:

◆ typeHeaderOk()

bool typeHeaderOk ( const bool  checkType = true,
const bool  search = true,
const bool  verbose = true 
)

Read header (uses typeFilePath to find file) and check its info.

Optionally checks headerClassName against the type-name. When search is false, simply use the current instance, otherwise search previous instances.

Definition at line 38 of file IOobjectTemplates.C.

References Pstream::broadcast(), Foam::endl(), Foam::fileHandler(), IOobject::fileModificationChecking, IOobject::inotifyMaster, splitCell::master(), fileOperation::readHeader(), Foam::search(), IOobject::timeStampMaster, and WarningInFunction.

Referenced by fieldToCell::applyToSet(), basicMultiComponentMixture::basicMultiComponentMixture(), boundaryRadiationProperties::boundaryRadiationProperties(), cellVolumeWeight::cellVolumeWeight(), fvMeshTools::createDummyFvMeshFiles(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), fileOperation::exists(), topoSet::findIOobject(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), inverseDistance::inverseDistance(), Foam::MapConsistentVolFields(), Foam::MapVolFields(), surfaceFilmModel::New(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), radiationModel::New(), combustionModel::New(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), phaseModel::phaseModel(), points0MotionSolver::points0IO(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), radiativeIntensityRay::radiativeIntensityRay(), particle< Type >::readFields(), lagrangianReconstructor::reconstructField(), lagrangianReconstructor::reconstructFieldField(), variablesSet::renameTurbulenceField(), globalMeshData::sharedPointGlobalLabels(), sensitivitySurface::smoothSensitivities(), solidBodyDisplacementLaplacianFvMotionSolver::solidBodyDisplacementLaplacianFvMotionSolver(), stabilityBlendingFactor::stabilityBlendingFactor(), TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel(), uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField(), and Foam::writeMeshObject().

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

◆ warnNoRereading()

void warnNoRereading

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

Definition at line 90 of file IOobjectTemplates.C.

References Foam::endl(), IOobject::MUST_READ_IF_MODIFIED, Foam::name(), and WarningInFunction.

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

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

Referenced by argList::parse(), IOobject::writeHeader(), and decomposedBlockData::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 135 of file IOobjectWriteHeader.C.

References os().

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

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

◆ writeEndDivider()

Foam::Ostream & writeEndDivider ( Ostream os)
static

Write the standard end file divider.

Definition at line 145 of file IOobjectWriteHeader.C.

References os().

Referenced by PDRblock::blockMeshDict(), MeshedSurfaceProxy< Face >::write(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeData(), collatedFileOperation::writeObject(), fileOperation::writeObject(), masterUncollatedFileOperation::writeObject(), and boundaryDataWriter::writeTemplate().

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

◆ writeHeader() [1/4]

bool writeHeader ( Ostream os) const

Write header with current type()

Definition at line 280 of file IOobjectWriteHeader.C.

References os(), Foam::type(), and IOobject::writeHeader().

Referenced by PDRblock::blockMeshDict(), interpolationLookUpTable< Type >::write(), decomposedBlockData::writeBlockEntry(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), IOobject::writeHeader(), fileOperation::writeObject(), and boundaryDataWriter::writeTemplate().

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

◆ writeHeader() [2/4]

bool writeHeader ( Ostream os,
const word objectType 
) const

Write header with override of type.

Definition at line 238 of file IOobjectWriteHeader.C.

References IOobject::bannerEnabled(), Ostream::beginBlock(), Ostream::endBlock(), Foam::endl(), IOstream::good(), IOstream::info(), InfoInFunction, Foam::nl, os(), IOobject::writeBanner(), IOobject::writeDivider(), IOobject::writeHeader(), and IOobject::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 304 of file IOobjectWriteHeader.C.

References dict, Foam::type(), and IOobject::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 286 of file IOobjectWriteHeader.C.

References dict, IOobject::writeHeader(), and IOobject::writeHeaderContent().

Here is the call graph for this function:

◆ good()

bool good ( ) const
inlinenoexcept

Did last readHeader() succeed?

Definition at line 222 of file IOobjectI.H.

Referenced by decomposedBlockData::readBlocks(), topoSet::topoSet(), CompactIOList< T, BaseType >::writeData(), CompactIOField< T, BaseType >::writeData(), GlobalIOField< Type >::writeData(), GlobalIOList< Type >::writeData(), IOPtrList< T >::writeData(), and regIOobject::writeObject().

Here is the caller graph for this function:

◆ bad()

bool bad ( ) const
inlinenoexcept

Did last readHeader() fail?

Definition at line 228 of file IOobjectI.H.

◆ info()

InfoProxy< IOobject > info ( ) const
inline

Return info proxy, for printing information to a stream.

Definition at line 690 of file IOobject.H.

Referenced by profiling::create(), searchableSurface::findNearest(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), searchableSurfaceWithGaps::getNormal(), searchableSurfaceWithGaps::getRegion(), Foam::operator<<(), profiling::profiling(), and KinematicCloud< CloudType >::solve().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const IOobject io)

Copy assignment, copies all values (except the registry)

Definition at line 624 of file IOobject.C.

References io().

Referenced by regIOobject::operator=().

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

◆ readOpt() [3/3]

readOption & readOpt ( )
inlinenoexcept

Access to the read option.

Deprecated:
(2021-03) - use readOpt(readOption)

Definition at line 706 of file IOobject.H.

◆ writeOpt() [3/3]

writeOption & writeOpt ( )
inlinenoexcept

Access to the write option.

Deprecated:
(2021-03) - use writeOpt(writeOption)

Definition at line 710 of file IOobject.H.

◆ registerObject() [3/3]

bool & registerObject ( )
inlinenoexcept

Access to the register object option.

Deprecated:
(2021-03) - use registerObject(bool)

Definition at line 714 of file IOobject.H.

◆ globalObject() [3/3]

bool & globalObject ( )
inlinenoexcept

Access to the global object option.

Deprecated:
(2021-03) - use globalObject(bool)

Definition at line 718 of file IOobject.H.

◆ isHeaderClass() [2/2]

bool isHeaderClass ( ) const
inline

Specialization for void always returns true (no headerClassName check).

Definition at line 724 of file IOobject.H.

◆ groupName() [2/2]

Foam::word groupName ( StringType  base,
const word group 
)
inline

Definition at line 31 of file IOobjectI.H.

References IOobject::group().

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 208 of file IOobject.H.

Referenced by argList::parse().

◆ scopeSeparator

char scopeSeparator
static

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

Change with caution.

Definition at line 300 of file IOobject.H.

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

◆ fileModificationChecking

◆ fileModificationSkew

float fileModificationSkew
static

Time skew (seconds) for file modification checks.

Definition at line 306 of file IOobject.H.

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

◆ maxFileModificationPolls

int maxFileModificationPolls
static

Max number of times to poll for file modification changes.

Definition at line 309 of file IOobject.H.

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


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