Defines the attributes of an object for which implicit objectRegistry management is supported, and provides the infrastructure for performing stream I/O. More...
Public Types | |
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 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... | |
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 ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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 ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
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... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global 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 |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
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. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. 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 |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) 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) |
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. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
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 word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Static Public Attributes | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
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) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
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. More... | |
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.
Define what is done on object construction and explicit reads:
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 |
Definition at line 180 of file IOobject.H.
enum objectState : char |
Enumeration defining the valid states of an IOobject.
Enumerator | |
---|---|
GOOD | |
BAD |
Definition at line 191 of file IOobject.H.
enum fileCheckTypes : char |
Enumeration defining the file checking options.
Enumerator | |
---|---|
timeStamp | |
timeStampMaster | |
inotify | |
inotifyMaster |
Definition at line 200 of file IOobject.H.
|
virtualdefault |
Destructor.
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 339 of file IOobject.C.
References Foam::ensightOutput::debug, Foam::endl(), InfoInFunction, and Foam::name().
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 360 of file IOobject.C.
References Foam::ensightOutput::debug, Foam::endl(), InfoInFunction, local, and Foam::name().
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 383 of file IOobject.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, and path().
|
inline |
Construct from name, instance, registry, io options.
Definition at line 90 of file IOobjectI.H.
|
inline |
Construct from name, instance, local, registry, io options.
Definition at line 111 of file IOobjectI.H.
|
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 134 of file IOobjectI.H.
IOobject | ( | const IOobject & | io, |
const objectRegistry & | registry | ||
) |
Copy construct, resetting registry.
Definition at line 407 of file IOobject.C.
Copy construct, resetting name.
Definition at line 428 of file IOobject.C.
Copy construct, resetting name and local component.
Definition at line 153 of file IOobjectI.H.
References local.
|
inline |
Copy construct, resetting read/write options.
Definition at line 166 of file IOobjectI.H.
|
inline |
Copy construct, resetting register option.
Definition at line 180 of file IOobjectI.H.
|
staticprotected |
Helper: write content for FoamFile IOobject header with optional meta information.
Definition at line 151 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().
|
staticprotected |
Helper: write dictionary content for FoamFile header with optional meta information.
Definition at line 190 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().
|
protected |
Set the object state to bad.
Definition at line 568 of file IOobject.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, messageStream::level, and s.
TypeName | ( | "IOobject" | ) |
Declare type-name, virtual type (with debug switch)
|
inlinestaticnoexcept |
Status of output file banner.
Definition at line 369 of file IOobject.H.
Referenced by decomposedBlockData::writeBlockEntry(), decomposedBlockData::writeHeader(), IOobject::writeHeader(), and collatedFileOperation::writeObject().
|
inlinestaticnoexcept |
Enable/disable output file banner.
Definition at line 379 of file IOobject.H.
|
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 165 of file IOobject.C.
References fileName::clean(), Foam::cwd(), Foam::endl(), Foam::isDir(), local, Foam::name(), path(), Foam::stringOps::validate(), and WarningInFunction.
Create dot-delimited name.group string.
An empty group is ignored.
Referenced by phaseChange::addToDriftRate(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUBlendedWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), kEpsilon::computeG(), kOmegaSST::computeG(), turbulentDispersionModel::continuousTurbulence(), populationBalanceModel::continuousTurbulence(), powerLaw::correct(), Maxwell< BasicTurbulenceModel >::correct(), DarcyForchheimer::correct(), limitTemperature::correct(), solidification::correct(), Gosman::D(), Burns::D(), InterfaceCompositionModel< Thermo, OtherThermo >::D(), DeltaOmegaTildeDelta::DeltaOmegaTildeDelta(), Maxwell< BasicTurbulenceModel >::devRhoReff(), phasePressureModel::devRhoReff(), kineticTheoryModel::devRhoReff(), InterfaceCompositionModel< Thermo, OtherThermo >::Dfrom(), phaseSystem::dmdt(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::DnuTildaEff(), InterfaceCompositionModel< Thermo, OtherThermo >::Dto(), sigma< BasicTurbulenceModel >::epsilon(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::epsilon(), kOmegaSSTLM< BasicTurbulenceModel >::Flength(), kOmegaSSTLM< BasicTurbulenceModel >::Fonset(), phaseSystem::foundBlendedSubModel(), phaseSystem::foundSubModel(), kOmegaSSTLM< BasicTurbulenceModel >::Fthetat(), IDDESDelta::IDDESDelta(), WALE< BasicTurbulenceModel >::k(), Smagorinsky< BasicTurbulenceModel >::k(), sigma< BasicTurbulenceModel >::k(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::k(), InterfaceCompositionModel< Thermo, OtherThermo >::L(), continuousGasKEqn< BasicTurbulenceModel >::liquidTurbulence(), continuousGasKEpsilon< BasicTurbulenceModel >::liquidTurbulence(), phaseSystem::lookupBlendedSubModel(), twoPhaseSystem::lookupSubModel(), phaseSystem::lookupSubModel(), MassTransferPhaseSystem< BasePhaseSystem >::MassTransferPhaseSystem(), Stokes< BasicTurbulenceModel >::nuEff(), generalizedNewtonian< BasicMomentumTransportModel >::nuEff(), continuousGasKEpsilon< BasicTurbulenceModel >::nuEff(), LESModel< BasicTurbulenceModel >::nuEff(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::nuEff(), Stokes< BasicTurbulenceModel >::nut(), generalizedNewtonian< BasicMomentumTransportModel >::nut(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::omega(), phaseForces::phaseForces(), basicThermo::phasePropertyName(), basicThermo::phaseScopedName(), populationBalanceModel::populationBalanceModel(), continuousGasKEpsilon< BasicTurbulenceModel >::R(), phasePressureModel::R(), kineticTheoryModel::R(), limitTemperature::read(), BilgerMixtureFraction::read(), sampledSurfaces::read(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetac(), kOmegaSSTLM< BasicTurbulenceModel >::ReThetat0(), continuousGasKEpsilon< BasicTurbulenceModel >::rhoEff(), SLADelta::SLADelta(), JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs(), fixedShearStressFvPatchVectorField::updateCoeffs(), convectiveHeatTransferFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateCoeffs(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), omegaWallFunctionFvPatchScalarField::updateWeightedCoeffs(), epsilonWallFunctionFvPatchScalarField::updateWeightedCoeffs(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutkWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutUBlendedWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), and nutURoughWallFunctionFvPatchScalarField::yPlus().
|
static |
Return group (extension part of name)
Definition at line 300 of file IOobject.C.
References IOobject::name().
Referenced by laminarModel< BasicMomentumTransportModel >::New(), LESModel< BasicTurbulenceModel >::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), and strainRateFunction::nu().
|
static |
Return member (name without the extension)
Definition at line 313 of file IOobject.C.
References Foam::name().
Referenced by singleStepCombustion< ReactionThermo, ThermoType >::R(), laminar< ReactionThermo >::R(), and diffusionMulticomponent< ReactionThermo, ThermoType >::R().
|
inlinestatic |
Create scope:name or scope_name string.
An empty scope is ignored.
Definition at line 40 of file IOobjectI.H.
References Foam::name(), and Foam::output().
Referenced by interRegionExplicitPorositySource::addSup(), acousticDampingSource::addSup(), interRegionHeatTransferModel::addSup(), jouleHeatingSource::addSup(), rotorDiskSource::addSup(), ThermoCloud< Foam::DSMCCloud >::ap(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::beta(), adjointkOmegaSST::beta(), DarcyForchheimer::calcTransformModelData(), kEpsilon::computeG(), kOmegaSST::computeG(), meanVelocityForce::constrain(), directionalPressureGradientExplicitSource::constrain(), kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >::correct(), RNGkEpsilon< BasicTurbulenceModel >::correct(), contactAngleForce::correct(), waxSolventEvaporation::correctModel(), liquidFilmThermo::Cp(), constantFilmThermo::Cp(), solverInfo::createResidualField(), MRFZoneList::DDt(), multiphaseMangrovesSource::dragCoeff(), constantAspectRatio::E(), phaseSystem::E(), ThermoCloud< Foam::DSMCCloud >::Ep(), setFlow::execute(), extractEulerianParticles::execute(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::gamma(), adjointkOmegaSST::gamma(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::GbyNu0(), turbulenceModel::GName(), multiphaseMangrovesSource::inertiaCoeff(), turbulenceFields::initialise(), liquidFilmThermo::kappa(), constantFilmThermo::kappa(), SpalartAllmarasDES< BasicTurbulenceModel >::LESRegion(), kOmegaSSTDES< BasicTurbulenceModel >::LESRegion(), limitFields::limitField(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), liquidFilmThermo::mu(), constantFilmThermo::mu(), laminar::mut(), Schaeffer::nu(), basicThermo::phaseScopedName(), kinematicSingleLayer::pp(), SpalartAllmarasDES< BasicTurbulenceModel >::psi(), kinematicSingleLayer::pu(), multiRegion::read(), turbulenceFields::read(), liquidFilmThermo::rho(), constantFilmThermo::rho(), functionObject::scopedName(), rotorDiskSource::setFaceArea(), lduMatrix::setResidualField(), noFilm::Sh(), thermoSingleLayer::Sh(), kinematicSingleLayer::Sh(), noRadiation::Shs(), primaryRadiation::Shs(), standardRadiation::Shs(), constantRadiation::Shs(), liquidFilmThermo::sigma(), constantFilmThermo::sigma(), phaseSystem::sigma(), ThermoCloud< Foam::DSMCCloud >::sigmap(), noFilm::Srho(), thermoSingleLayer::Srho(), kinematicSingleLayer::Srho(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), dynamicContactAngleForce::theta(), KinematicParcel< ParcelType >::trackingData::updateAverages(), adjointkOmegaSST::updatePrimalRelatedFields(), jouleHeatingSource::updateSigma(), laminar::Us(), turbulenceFields::write(), and electricPotential::write().
|
inlinestatic |
Create scope:name1:name2 or scope_name1_name2 string.
An empty scope is ignored.
Definition at line 61 of file IOobjectI.H.
References Foam::output().
|
static |
Return the IOobject, but also consider an alternative file name.
io | The expected IOobject to use |
altFile | Alternative fileName (ignored if empty). |
ioName | The alternative name for the IOobject when the altFile resolves to a directory. |
Definition at line 256 of file IOobject.C.
References string::expand(), io(), and Foam::isDir().
Referenced by decompositionModel::selectIO().
Clone.
Definition at line 629 of file IOobject.H.
References autoPtr< T >::New().
Referenced by attachPolyTopoChanger::attach(), searchableSurface::iNew::operator()(), polyMesh::readUpdate(), and searchableSurfaces::searchableSurfaces().
|
inline |
Clone resetting registry.
Definition at line 637 of file IOobject.H.
References autoPtr< T >::New().
|
noexcept |
Return the local objectRegistry.
Definition at line 450 of file IOobject.C.
Referenced by refinementHistory::add(), refinementHistory::apply(), SprayParcel< ParcelType >::calcAtomization(), fourthLnGrad< Type >::correction(), correctedLnGrad< Type >::correction(), relaxedSnGrad< Type >::correction(), isothermal::d(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), enthalpySorptionFvPatchScalarField::enthalpySorptionFvPatchScalarField(), IATEsource::Eo(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), hexRef8Data::hexRef8Data(), pointVolInterpolation::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), Foam::fam::laplacian(), lnGradScheme< Type >::lnGrad(), Foam::loadPointField(), voxelMeshSearch::makeMesh(), IATEsource::Mo(), laminarFlameSpeed::New(), adjointTurbulenceModel::New(), adjointRASModel::New(), fvMeshTools::newMesh(), sampledSurface::pointAverage(), lumpedPointDisplacementPointPatchVectorField::points0(), fileOperation::processorsPath(), wallBoiling::R(), regionProperties::regionProperties(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), motionSmootherAlgo::setDisplacement(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), surfMesh::surfMesh(), hexRef8Data::sync(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().
|
noexcept |
Return Time associated with the objectRegistry.
Definition at line 456 of file IOobject.C.
Referenced by objective::accumulateJMean(), objectiveTopOSolidVolume::addColumnValues(), objectiveTopOVolume::addColumnValues(), interRegionHeatTransferModel::addSup(), fixedTemperatureConstraint::constrain(), distributedTriSurfaceMesh::distribute(), masterUncollatedFileOperation::findInstance(), fileOperation::findInstance(), objective::isWithinIntegrationTime(), objectiveTopOSolidVolume::J(), objectiveTopOVolume::J(), Foam::fvm::laplacian(), Foam::fam::laplacian(), laminarFlameSpeed::New(), adjointTurbulenceModel::New(), adjointRASModel::New(), faMeshTools::newMesh(), fvMeshTools::newMesh(), continuousGasKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), NicenoKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), sixDoFRigidBodyMotionSolver::solve(), objectiveTopOSolidVolume::update_dJdb(), objectiveTopOVolume::update_dJdb(), atmTurbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), pressurePIDControlInletVelocityFvPatchVectorField::updateCoeffs(), plenumPressureFvPatchScalarField::updateCoeffs(), subCycleField< GeometricField >::updateTimeIndex(), regIOobject::write(), Foam::writeCellGraph(), triSurfaceMesh::writeObject(), Foam::writePatchGraph(), fvMeshTools::writeProcAddressing(), and subCycleField< GeometricField >::~subCycleField().
|
inlinenoexcept |
Return the object name.
Definition at line 195 of file IOobjectI.H.
Referenced by incompressibleAdjointSolver::accumulateOptionsDxDbMultiplier(), multivariateSurfaceInterpolationScheme< Type >::fieldTable::add(), IOobjectList::add(), exprDriver::addContextObject(), objectiveUniformityCellZone::addHeaderColumns(), snappyLayerDriver::addLayers(), topOSource::addSup(), patchCellsSource::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), externalFileSource::addSup(), contactHeatFluxSource::addSup(), multiphaseStabilizedTurbulence::addSup(), jouleHeatingSource::addSup(), externalHeatFluxSource::addSup(), solidificationMeltingSource::addSup(), exprResultGlobals::addValue(), setsToFaceZone::applyToSet(), Foam::atan2(), attachPolyTopoChanger::attach(), Foam::fac::average(), Foam::fvc::average(), meshRefinement::balance(), blended< Type >::blendingFactor(), localBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), cellCoBlended< Type >::blendingFactor(), Foam::bound(), faceLimitedGrad< Type >::calcGrad(), hydrostaticPressure::calculateAndWrite(), meshRefinement::checkCoupledFaceZones(), faBoundaryMesh::checkDefinition(), polyBoundaryMesh::checkDefinition(), Cloud< passivePositionParticle >::checkFieldFieldIOobject(), Cloud< passivePositionParticle >::checkFieldIOobject(), objectRegistry::checkIn(), objectRegistry::checkOut(), faBoundaryMesh::checkParallelSync(), faceZone::checkParallelSync(), polyBoundaryMesh::checkParallelSync(), refinementFeatures::checkSizes(), Foam::clamp(), objectRegistry::classesImpl(), meshObject::clear(), objectRegistry::clear(), meshObject::clearUpto(), injectedParticleCloud::clone(), SprayCloud< Foam::DSMCCloud >::clone(), ReactingHeterogeneousCloud< Foam::DSMCCloud >::clone(), MPPICCloud< Foam::DSMCCloud >::clone(), CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone(), ReactingCloud< Foam::DSMCCloud >::clone(), ReactingMultiphaseCloud< Foam::DSMCCloud >::clone(), ThermoCloud< Foam::DSMCCloud >::clone(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::clone(), RASModelVariables::cloneRefPtr(), Foam::cmptAv(), adjointkOmegaSST::convectionMeanFlowSource(), adjointkOmegaSST::convectionScheme(), RASModelVariables::copyAndRename(), wallBoiling::correct(), atmNutSource::correct(), multiphaseStabilizedTurbulence::correct(), adjointSpalartAllmaras::correct(), adjointkOmegaSST::correct(), fourthLnGrad< Type >::correction(), cubic< Type >::correction(), correctedLnGrad< Type >::correction(), linearUpwind< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), deferredCorrection< Type >::correction(), relaxedSnGrad< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), localBlended< Type >::correction(), objectRegistry::countImpl(), objectRegistry::countTypeImpl(), fvMeshTools::createDummyFvMeshFiles(), Foam::fvc::curl(), Foam::fvc::d2dt2(), Foam::fam::d2dt2(), Foam::fvm::d2dt2(), Foam::fac::d2dt2(), faMeshRegistry::dbDir(), polyMesh::dbDir(), Foam::fvm::ddt(), Foam::fam::ddt(), Foam::fvc::ddt(), Foam::fac::ddt(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), Foam::fvc::div(), Foam::fvm::div(), Foam::fac::div(), Foam::fam::div(), Foam::fvc::domainIntegrate(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), thermalShell::evolveRegion(), removeRegisteredObject::execute(), fileOperation::exists(), EulerFaD2dt2Scheme< Type >::facD2dt2(), steadyStateFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), steadyStateFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), gaussConvectionScheme< Type >::facDiv(), gaussLaplacianScheme< Type >::facLaplacian(), faMatrix< Type >::faMatrix(), gaussLaplacianScheme< Type >::famLaplacian(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), localPointRegion::findDuplicateFacePairs(), masterUncollatedFileOperation::findInstance(), fileOperation::findInstance(), topoSet::findIOobject(), distributedTriSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findNearest(), coupleGroupIdentifier::findOtherPatchID(), adjointkOmegaSST::FISensitivityTerm(), Foam::fvc::flux(), correctedSnGrad< Type >::fullGradCorrection(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), 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(), genericPatchFieldBase::genericFatalSolveError(), exprResultGlobals::get(), distributedTriSurfaceMesh::getField(), exprResultGlobals::getNamespace(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), distributedTriSurfaceMesh::getVolumeType(), Foam::fac::grad(), Foam::fvc::grad(), IOobject::group(), AnisothermalPhaseModel< BasePhaseModel >::heEqn(), hexRef8Data::hexRef8Data(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), dynamicRefineFvMesh::init(), Foam::interpolate(), singleCellFvMesh::interpolate(), pointVolInterpolation::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), localBlended< Type >::interpolate(), weightedFlux< Type >::interpolate(), volPointInterpolation::interpolate(), meshToMesh0::interpolate(), volPointInterpolation::interpolateDimensionedInternalField(), volPointInterpolation::interpolateInternalField(), objectRegistry::is_cacheTemporaryObject(), isoSurfacePoint::isoSurfacePoint(), triSurfaceMesh::isSurfaceClosed(), sizeGroup::keyword(), Foam::fvm::laplacian(), Foam::fac::laplacian(), Foam::fvc::laplacian(), Foam::fam::laplacian(), Foam::fac::lnGrad(), lnGradScheme< Type >::lnGrad(), triSurfaceLoader::load(), Foam::loadPointField(), objectRegistry::lookupClassTypeImpl(), mappedPatchBase::lookupMesh(), objectRegistry::lookupObjectPtr(), objectRegistry::lookupObjectRefPtr(), Foam::mag(), Foam::magSqr(), adjointSimple::mainIter(), Foam::makeGraph(), voxelMeshSearch::makeMesh(), Foam::MapConsistentSubMesh(), Foam::MapConsistentVolFields(), Foam::MapLagrangianFields(), dynamicRefineFvMesh::mapNewInternalFaces(), mappedPatchFieldBase< scalar >::mapper(), zoneSubSet::mapToZone(), Foam::MapVolFields(), Foam::fvc::meshPhi(), meshObject::movePoints(), solidBodyFvGeometryScheme::movePoints(), multiphaseSystem::multiphaseSystem(), baseIOdictionary::name(), fvMesh::name(), faMesh::name(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), Foam::fam::ndiv(), Foam::fac::ndiv(), fvMeshTools::newMesh(), Foam::fac::ngrad(), objectRegistry::objectsTypeImpl(), sampledPatch::patchIDs(), pointConstraints::pointConstraints(), pointMesh::pointMesh(), RemoveParcels< CloudType >::postEvolve(), Foam::pow(), genericPatchFieldBase::processEntry(), decomposedBlockData::readBlocks(), Foam::readFieldsAndWriteFluent(), polyMesh::readUpdate(), Foam::fvc::reconstruct(), faFieldReconstructor::reconstructAreaField(), faFieldReconstructor::reconstructEdgeField(), pointFieldReconstructor::reconstructField(), faFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructInternalField(), Foam::fvc::reconstructMag(), pointFieldReconstructor::reconstructPointField(), fvFieldReconstructor::reconstructSurfaceField(), fvFieldReconstructor::reconstructVolumeField(), polyMesh::regionName(), faMesh::regionName(), triSurfaceMesh::regions(), exprDriver::removeContextObject(), exprResultGlobals::removeValue(), variablesSet::renameTurbulenceField(), genericPatchFieldBase::reportMissingEntry(), objectRegistry::resetCacheTemporaryObject(), Time::run(), VollerPrakash::S(), refinementSurfaces::setMinLevelFields(), removeCells::setRefinement(), removeFaces::setRefinement(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), skewCorrected< Type >::skewCorrection(), ATCModel::smoothFieldBasedOnCells(), Foam::fvc::snGrad(), snGradScheme< Type >::snGrad(), twoPhaseSystem::solve(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), Foam::sqr(), Foam::stabilise(), regIOobject::store(), subCycleField< GeometricField >::subCycleField(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), thermoSingleLayer::T(), dictionary::topDict(), triSurfaceMesh::triSurfaceMesh(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), topoBitSet::updateLabels(), topoBoolSet::updateLabels(), topoSet::updateLabels(), meshObject::updateMesh(), motionSmootherAlgo::updateMesh(), basicThermo::validate(), LookupField< Type >::value(), localBlended< Type >::weights(), FacePostProcessing< CloudType >::write(), FaceInteraction< CloudType >::write(), internalWriter::write(), XiReactionRate::write(), writeObjects::write(), ObukhovLength::write(), Foam::writeAreaFields(), PDRblock::writeBlockMeshDict(), Foam::writeCellGraph(), meshToMeshMethod::writeConnectivity(), boundaryRegion::writeDict(), cellTable::writeDict(), mappedPatchBase::writeDict(), Foam::writeDimFields(), fieldExtents::writeFileHeader(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), regionFunctionObject::writeObject(), distributedTriSurfaceMesh::writeObject(), Foam::writePatchGraph(), Foam::writePointFields(), Foam::ensightOutput::writeVolField(), Foam::writeVolFields(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::YiEqn().
|
inlinenoexcept |
Return name of the class name read from header.
Definition at line 213 of file IOobjectI.H.
Referenced by fieldToCell::applyToSet(), fvExprDriver::evaluateVariable(), fvExprDriver::foundField(), Foam::loadPointField(), decomposedBlockData::readBlocks(), decomposedBlockData::readHeader(), polyMesh::readUpdate(), decomposedBlockData::writeData(), and Foam::writeMeshObject().
|
inlinenoexcept |
Return non-constant access to the class name read from header.
Definition at line 219 of file IOobjectI.H.
|
inlinenoexcept |
Return the optional note.
Definition at line 225 of file IOobjectI.H.
Referenced by decomposedBlockData::readBlocks(), polyMesh::readUpdate(), debugWriter::write(), boundaryDataWriter::write(), decomposedBlockData::writeData(), boundaryRegion::writeDict(), cellTable::writeDict(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().
|
inlinenoexcept |
Modifiable access to the optional note.
Definition at line 231 of file IOobjectI.H.
|
inlinevirtual |
Rename the object.
Reimplemented in objectRegistry, and regIOobject.
Definition at line 685 of file IOobject.H.
Referenced by faMeshDecomposition::decomposeMesh(), searchableCone::findLine(), searchableCone::findLineAll(), searchableCone::findLineAny(), fvMeshTools::newMesh(), decomposedBlockData::readBlocks(), processorFaMeshes::removeFiles(), processorMeshes::removeFiles(), regIOobject::rename(), faMeshReconstructor::writeAddressing(), faMeshDecomposition::writeDecomposition(), faMeshReconstructor::writeMesh(), faMeshTools::writeProcAddressing(), and fvMeshTools::writeProcAddressing().
|
inlinenoexcept |
The sizeof (label) in bytes, possibly read from the header.
Definition at line 237 of file IOobjectI.H.
|
inlinenoexcept |
The sizeof (scalar) in bytes, possibly read from the header.
Definition at line 243 of file IOobjectI.H.
void resetHeader | ( | const word & | newName = word::null | ) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
newName | if non-null, optionally rename the IOobject |
Definition at line 587 of file IOobject.C.
Referenced by faMesh::faMesh(), and fvMesh::init().
|
inlinenoexcept |
True if headerClassName() is non-empty (after reading)
Definition at line 251 of file IOobjectI.H.
Referenced by polyMesh::polyMesh(), and polyMesh::readUpdate().
|
inline |
Check if headerClassName() equals Type::typeName.
Definition at line 258 of file IOobjectI.H.
Referenced by Foam::loadPointField().
|
inline |
Same as isHeaderClass()
Definition at line 726 of file IOobject.H.
|
virtualnoexcept |
Return pointer to meta-data (if any) or nullptr.
Reimplemented in regIOobject.
Definition at line 26 of file IOobjectMetaData.C.
Referenced by decomposedBlockData::writeExtraHeaderContent(), and decomposedBlockData::writeHeader().
|
inline |
Return group (extension part of name)
Definition at line 201 of file IOobjectI.H.
References word::ext().
|
inline |
Return member (name without the extension)
Definition at line 207 of file IOobjectI.H.
References word::lessExt().
Referenced by diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and kineticGasEvaporation< Thermo, OtherThermo >::kineticGasEvaporation().
|
noexcept |
Return the Time::rootPath()
Definition at line 462 of file IOobject.C.
Referenced by Foam::makeGraph(), and fileOperation::processorsCasePath().
|
noexcept |
Return the Time::caseName()
Definition at line 468 of file IOobject.C.
Referenced by Foam::makeGraph().
|
noexcept |
Return the Time::globalCaseName()
Definition at line 474 of file IOobject.C.
Referenced by fileOperation::processorsCasePath().
|
inlinenoexcept |
Read access to instance path component.
Definition at line 266 of file IOobjectI.H.
Referenced by Foam::fac::average(), Foam::fvc::average(), fourthLnGrad< Type >::correction(), correctedLnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), directions::directions(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), Time::findInstance(), masterUncollatedFileOperation::findInstance(), fileOperation::findInstance(), faceCorrectedSnGrad< Type >::fullGradCorrection(), skewCorrectedSnGrad< Type >::fullGradCorrection(), pointVolInterpolation::interpolate(), leastSquaresEdgeInterpolation< Type >::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), volPointInterpolation::interpolate(), Foam::fam::laplacian(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), lnGradScheme< Type >::lnGrad(), Foam::loadPointField(), Foam::makeGraph(), volPointInterpolationAdjoint::makeWeights(), meshRefinement::mergePatchFacesUndo(), triSurfaceMesh::movePoints(), faMeshTools::newMesh(), fvMeshTools::newMesh(), points0MotionSolver::points0IO(), polyMesh::readUpdate(), Foam::fvc::reconstruct(), Foam::fvc::reconstructMag(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), snGradScheme< Type >::snGrad(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), surfMesh::surfMesh(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), triSurfaceMesh::writeObject(), regIOobject::writeObject(), distributedTriSurfaceMesh::writeObject(), and fvMeshTools::writeProcAddressing().
|
inlinenoexcept |
Write access to instance path component.
Definition at line 272 of file IOobjectI.H.
|
inlinenoexcept |
Read access to local path component.
Definition at line 278 of file IOobjectI.H.
Referenced by masterUncollatedFileOperation::findInstance(), fileOperation::findInstance(), Foam::loadPointField(), fileOperation::processorsPath(), surfMesh::surfMesh(), PDRblock::writeBlockMeshDict(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().
Foam::fileName path | ( | ) | const |
The complete path for the object (with instance, local,...).
Definition at line 480 of file IOobject.C.
References file_isOutsideCase(), and local.
Referenced by searchableSurfaces::checkIntersection(), fileOperation::readObjects(), refinementHistory::removeFiles(), topoSet::removeFiles(), hexRef8::removeFiles(), meshRefinement::removeFiles(), motionSmootherAlgo::setDisplacement(), surfMesh::surfMesh(), and Time::writeObject().
Foam::fileName globalPath | ( | ) | const |
The complete global path for the object (with instance, local,...)
Definition at line 491 of file IOobject.C.
References file_isOutsideCase(), and local.
Foam::fileName path | ( | const word & | instance, |
const fileName & | local = fileName::null |
||
) | const |
The complete path with alternative instance and local.
Definition at line 503 of file IOobject.C.
References local.
Foam::fileName globalPath | ( | const word & | instance, |
const fileName & | local = fileName::null |
||
) | const |
The complete global path with alternative instance and local.
Definition at line 514 of file IOobject.C.
References local.
|
inline |
The complete path + object name.
Definition at line 284 of file IOobjectI.H.
References Foam::name(), and path().
Referenced by hexRef8::consistentSlowRefinement2(), limitedSnGrad< Type >::correction(), fileOperation::exists(), genericPatchFieldBase::genericFatalSolveError(), hexRef8::hexRef8(), mappedPatchFieldBase< scalar >::mapper(), meshRefinement::mergePatchFacesUndo(), fileOperation::objectPath(), genericPatchFieldBase::processEntry(), uncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), fileOperation::readObjects(), processorFaMeshes::removeFiles(), processorMeshes::removeFiles(), genericPatchFieldBase::reportMissingEntry(), hexRef8::setUnrefinement(), syncObjects::sync(), triSurfaceMesh::triSurfaceMesh(), Foam::UnMapped(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), triSurfaceMesh::writeObject(), distributedTriSurfaceMesh::writeObject(), fileOperation::writeObject(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().
|
inline |
The complete global path + object name.
Definition at line 290 of file IOobjectI.H.
References Foam::name().
Foam::fileName objectRelPath | ( | ) | const |
The object path relative to the root.
Definition at line 524 of file IOobject.C.
References file_isOutsideCase(), local, and Foam::name().
Referenced by fvMesh::init(), faMeshTools::readProcAddressing(), fvMeshTools::readProcAddressing(), boundaryRegion::writeDict(), cellTable::writeDict(), objectRegistry::writeObject(), faMeshTools::writeProcAddressing(), and fvMeshTools::writeProcAddressing().
Foam::fileName localFilePath | ( | const word & | typeName, |
const bool | search = true |
||
) | const |
Redirect to fileHandler filePath, searching locally.
When search is false, simply use the current instance, otherwise search previous instances.
Definition at line 536 of file IOobject.C.
References Foam::fileHandler, and Foam::search().
Referenced by distributedTriSurfaceMesh::distributedTriSurfaceMesh(), localIOdictionary::filePath(), distributedTriSurfaceMesh::filePath(), triSurfaceMesh::triSurfaceMesh(), and IOobject::typeFilePath().
Foam::fileName globalFilePath | ( | const word & | typeName, |
const bool | search = true |
||
) | const |
Redirect to fileHandler filePath, searching up if in parallel.
When search is false, simply use the current instance, otherwise search previous instances.
Definition at line 547 of file IOobject.C.
References Foam::fileHandler, and Foam::search().
Referenced by featureEdgeMesh::filePath(), unwatchedIOdictionary::filePath(), GlobalIOList< kinematicParcelInjectionData >::filePath(), GlobalIOField< vector >::filePath(), IOMap< T >::filePath(), IOdictionary::filePath(), UniformDimensionedField< vector >::filePath(), extendedFeatureEdgeMesh::filePath(), searchableSurface::filePath(), porosityModel::filePath(), triSurfaceMesh::filePath(), triSurfaceMesh::triSurfaceMesh(), and IOobject::typeFilePath().
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().
bool readHeader | ( | Istream & | is | ) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
Definition at line 162 of file IOobjectReadHeader.C.
Referenced by decomposedBlockData::read(), decomposedBlockData::readBlock(), decomposedBlockData::readBlocks(), decomposedBlockData::readHeader(), masterUncollatedFileOperation::readStream(), and decomposedBlockData::writeData().
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 68 of file IOobjectReadHeader.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstreamOption::format(), IOstream::good(), Foam::Info, InfoInFunction, IOWarningInFunction, token::isWord(), IOstream::lineNumber(), Foam::name(), IOstream::name(), Foam::nl, dictionary::read(), IOstream::relativeName(), SeriousIOErrorInFunction, IOstream::setLabelByteSize(), IOstream::setScalarByteSize(), IOstreamOption::version(), and Foam::writeHeader().
bool typeHeaderOk | ( | const bool | checkType = true , |
const bool | search = true , |
||
const bool | verbose = true |
||
) |
Read header (respects is_globalIOobject trait) and check its info.
checkType | Check headerClassName against the type-name |
search | Also search previous instances if not found at current instance |
verbose | Report any check-type failures |
Definition at line 32 of file IOobjectTemplates.C.
References Foam::search().
Referenced by fieldToCell::applyToSet(), fvMeshTools::createDummyFvMeshFiles(), fileOperation::exists(), faMesh::faMesh(), topoSet::findIOobject(), hexRef8::hexRef8(), hexRef8Data::hexRef8Data(), fvMesh::init(), Foam::preservePatchTypes(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), particle< Type >::readFields(), TDACChemistryModel< CompType, ThermoType >::TDACChemistryModel(), and Foam::writeMeshObject().
fileName typeFilePath | ( | const bool | search = true | ) | const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
Referenced by fieldToCell::applyToSet().
void warnNoRereading | ( | ) | const |
Helper: warn that type does not support re-reading.
Definition at line 62 of file IOobjectTemplates.C.
References Foam::endl(), Foam::name(), IOobjectOption::READ_MODIFIED, and WarningInFunction.
|
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(), decomposedBlockData::writeHeader(), and IOobject::writeHeader().
|
static |
Write the standard file section divider.
Definition at line 128 of file IOobjectWriteHeader.C.
References os().
Referenced by Foam::listSwitches(), argList::parse(), decomposedBlockData::writeHeader(), and IOobject::writeHeader().
|
static |
Write the standard end file divider.
Definition at line 138 of file IOobjectWriteHeader.C.
References os().
Referenced by PDRblock::writeBlockMeshDict(), decomposedBlockData::writeData(), boundaryRegion::writeDict(), cellTable::writeDict(), collatedFileOperation::writeObject(), masterUncollatedFileOperation::writeObject(), fileOperation::writeObject(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().
bool writeHeader | ( | Ostream & | os | ) | const |
Write header with current type()
Definition at line 273 of file IOobjectWriteHeader.C.
References os(), and Foam::type().
Referenced by PDRblock::blockMeshDict(), interpolationLookUpTable< scalar >::write(), decomposedBlockData::writeBlockEntry(), PDRblock::writeBlockMeshDict(), boundaryRegion::writeDict(), cellTable::writeDict(), IOobject::writeHeader(), fileOperation::writeObject(), boundaryDataWriter::writeTemplate(), and debugWriter::writeTemplate().
Write header with override of type.
Definition at line 232 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(), and IOobject::writeHeaderContent().
void writeHeader | ( | dictionary & | dict, |
IOstreamOption | streamOpt | ||
) | const |
Write header into a dictionary with current type() and given output format.
Definition at line 298 of file IOobjectWriteHeader.C.
References dict, Foam::type(), and IOobject::writeHeader().
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 280 of file IOobjectWriteHeader.C.
References dict, and IOobject::writeHeaderContent().
|
inlinenoexcept |
Did last readHeader() succeed?
Definition at line 298 of file IOobjectI.H.
|
inlinenoexcept |
Did last readHeader() fail?
Definition at line 304 of file IOobjectI.H.
Return info proxy, for printing information to a stream.
Definition at line 963 of file IOobject.H.
Referenced by profiling::create(), searchableSurfaceWithGaps::findNearest(), searchableSurface::findNearest(), searchableSurfaceWithGaps::getField(), searchableSurfaceWithGaps::getNormal(), searchableSurfaceWithGaps::getRegion(), searchableSurfaceWithGaps::getVolumeType(), waveGenerationModel::info(), irregularWaveModel::info(), solitaryWaveModel::info(), Grimshaw::info(), Boussinesq::info(), McCowan::info(), and KinematicCloud< Cloud< basicKinematicCollidingParcel > >::solve().
void operator= | ( | const IOobject & | io | ) |
Copy assignment, copies all values (except the registry)
Definition at line 603 of file IOobject.C.
References IOobjectOption::globalObject(), io(), IOobjectOption::readOpt(), and IOobjectOption::writeOpt().
Referenced by regIOobject::operator=().
|
inline |
Specialization for void
always returns true (no headerClassName check).
Definition at line 981 of file IOobject.H.
|
inline |
Definition at line 25 of file IOobjectI.H.
References Foam::constant::atomic::group.
Foam::fileName typeFilePath | ( | const bool | search | ) | const |
Definition at line 50 of file IOobjectTemplates.C.
References IOobject::globalFilePath(), IOobject::localFilePath(), and Foam::search().
|
static |
Names for the fileCheckTypes.
Definition at line 211 of file IOobject.H.
Referenced by argList::parse().
|
static |
Character for scoping object names (':' or '_')
Change with caution.
Definition at line 346 of file IOobject.H.
Referenced by dsmcFields::write().
|
static |
Type of file modification checking.
Definition at line 351 of file IOobject.H.
Referenced by unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), fileOperation::lookupAndCacheProcessorsPath(), fileOperation::monitor(), faMeshTools::newMesh(), fvMeshTools::newMesh(), argList::parse(), regIOobject::read(), and Time::readModifiedObjects().
|
static |
Time skew (seconds) for file modification checks.
Definition at line 356 of file IOobject.H.
Referenced by argList::parse(), and dynamicCode::waitForFile().
|
static |
Max number of times to poll for file modification changes.
Definition at line 361 of file IOobject.H.
Referenced by argList::parse(), and dynamicCode::waitForFile().