c8a1c95b06
For many information and diagnostic messages the absolute path of the object is not required and the local path relative to the current case is sufficient; the new localObjectPath() member function of IOobject provides a convenient way of printing this.
442 lines
9.1 KiB
C
442 lines
9.1 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration | Website: https://openfoam.org
|
|
\\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "IOobject.H"
|
|
#include "Time.H"
|
|
#include "IFstream.H"
|
|
#include "registerNamedEnum.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
defineTypeNameAndDebug(IOobject, 0);
|
|
|
|
template<>
|
|
const char* NamedEnum<IOobject::fileCheckTypes, 4>::names[] =
|
|
{
|
|
"timeStamp",
|
|
"timeStampMaster",
|
|
"inotify",
|
|
"inotifyMaster"
|
|
};
|
|
}
|
|
|
|
const Foam::NamedEnum<Foam::IOobject::fileCheckTypes, 4>
|
|
Foam::IOobject::fileCheckTypesNames;
|
|
|
|
// Default fileCheck type
|
|
Foam::IOobject::fileCheckTypes Foam::IOobject::fileModificationChecking
|
|
(
|
|
fileCheckTypesNames.read
|
|
(
|
|
debug::optimisationSwitches().lookup
|
|
(
|
|
"fileModificationChecking"
|
|
)
|
|
)
|
|
);
|
|
|
|
// Register re-reader
|
|
registerOptNamedEnum
|
|
(
|
|
"fileModificationChecking",
|
|
Foam::IOobject::fileCheckTypesNames,
|
|
Foam::IOobject::fileModificationChecking
|
|
);
|
|
|
|
|
|
// * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * * //
|
|
|
|
bool Foam::IOobject::fileNameComponents
|
|
(
|
|
const fileName& path,
|
|
fileName& instance,
|
|
fileName& local,
|
|
word& name
|
|
)
|
|
{
|
|
instance.clear();
|
|
local.clear();
|
|
name.clear();
|
|
|
|
// called with directory
|
|
if (isDir(path))
|
|
{
|
|
WarningInFunction
|
|
<< " called with directory: " << path << endl;
|
|
|
|
return false;
|
|
}
|
|
|
|
if (path.isAbsolute())
|
|
{
|
|
string::size_type last = path.rfind('/');
|
|
instance = path.substr(0, last);
|
|
|
|
// Check afterwards
|
|
name.string::operator=(path.substr(last+1));
|
|
}
|
|
else
|
|
{
|
|
string::size_type first = path.find('/');
|
|
|
|
if (first == string::npos)
|
|
{
|
|
// no '/' found - no instance or local
|
|
|
|
// check afterwards
|
|
name.string::operator=(path);
|
|
}
|
|
else
|
|
{
|
|
instance = path.substr(0, first);
|
|
|
|
string::size_type last = path.rfind('/');
|
|
if (last > first)
|
|
{
|
|
// with local
|
|
local = path.substr(first+1, last-first-1);
|
|
}
|
|
|
|
// check afterwards
|
|
name.string::operator=(path.substr(last+1));
|
|
}
|
|
}
|
|
|
|
|
|
// Check for valid (and stripped) name, regardless of the debug level
|
|
if (name.empty() || string::stripInvalid<word>(name))
|
|
{
|
|
WarningInFunction
|
|
<< "has invalid word for name: \"" << name
|
|
<< "\"\nwhile processing path: " << path << endl;
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
Foam::word Foam::IOobject::group(const word& name)
|
|
{
|
|
word::size_type i = name.find_last_of('.');
|
|
|
|
if (i == word::npos || i == 0)
|
|
{
|
|
return word::null;
|
|
}
|
|
else
|
|
{
|
|
return name.substr(i+1, word::npos);
|
|
}
|
|
}
|
|
|
|
|
|
Foam::word Foam::IOobject::member(const word& name)
|
|
{
|
|
word::size_type i = name.find_last_of('.');
|
|
|
|
if (i == word::npos || i == 0)
|
|
{
|
|
return name;
|
|
}
|
|
else
|
|
{
|
|
return name.substr(0, i);
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::IOobject::IOobject
|
|
(
|
|
const word& name,
|
|
const fileName& instance,
|
|
const objectRegistry& registry,
|
|
readOption ro,
|
|
writeOption wo,
|
|
bool registerObject
|
|
)
|
|
:
|
|
name_(name),
|
|
headerClassName_(typeName),
|
|
note_(),
|
|
instance_(instance),
|
|
local_(),
|
|
db_(registry),
|
|
rOpt_(ro),
|
|
wOpt_(wo),
|
|
registerObject_(registerObject),
|
|
objState_(GOOD)
|
|
{
|
|
if (objectRegistry::debug)
|
|
{
|
|
InfoInFunction
|
|
<< "Constructing IOobject called " << name_
|
|
<< " of type " << headerClassName_
|
|
<< endl;
|
|
}
|
|
}
|
|
|
|
|
|
Foam::IOobject::IOobject
|
|
(
|
|
const word& name,
|
|
const fileName& instance,
|
|
const fileName& local,
|
|
const objectRegistry& registry,
|
|
readOption ro,
|
|
writeOption wo,
|
|
bool registerObject
|
|
)
|
|
:
|
|
name_(name),
|
|
headerClassName_(typeName),
|
|
note_(),
|
|
instance_(instance),
|
|
local_(local),
|
|
db_(registry),
|
|
rOpt_(ro),
|
|
wOpt_(wo),
|
|
registerObject_(registerObject),
|
|
objState_(GOOD)
|
|
{
|
|
if (objectRegistry::debug)
|
|
{
|
|
InfoInFunction
|
|
<< "Constructing IOobject called " << name_
|
|
<< " of type " << headerClassName_
|
|
<< endl;
|
|
}
|
|
}
|
|
|
|
|
|
Foam::IOobject::IOobject
|
|
(
|
|
const fileName& path,
|
|
const objectRegistry& registry,
|
|
readOption ro,
|
|
writeOption wo,
|
|
bool registerObject
|
|
)
|
|
:
|
|
name_(),
|
|
headerClassName_(typeName),
|
|
note_(),
|
|
instance_(),
|
|
local_(),
|
|
db_(registry),
|
|
rOpt_(ro),
|
|
wOpt_(wo),
|
|
registerObject_(registerObject),
|
|
objState_(GOOD)
|
|
{
|
|
if (!fileNameComponents(path, instance_, local_, name_))
|
|
{
|
|
FatalErrorInFunction
|
|
<< " invalid path specification"
|
|
<< exit(FatalError);
|
|
}
|
|
|
|
if (objectRegistry::debug)
|
|
{
|
|
InfoInFunction
|
|
<< "Constructing IOobject called " << name_
|
|
<< " of type " << headerClassName_
|
|
<< endl;
|
|
}
|
|
}
|
|
|
|
|
|
Foam::IOobject::IOobject
|
|
(
|
|
const IOobject& io,
|
|
const objectRegistry& registry
|
|
)
|
|
:
|
|
name_(io.name_),
|
|
headerClassName_(io.headerClassName_),
|
|
note_(io.note_),
|
|
instance_(io.instance_),
|
|
local_(io.local_),
|
|
db_(registry),
|
|
rOpt_(io.rOpt_),
|
|
wOpt_(io.wOpt_),
|
|
registerObject_(io.registerObject_),
|
|
objState_(io.objState_)
|
|
{}
|
|
|
|
|
|
Foam::IOobject::IOobject
|
|
(
|
|
const IOobject& io,
|
|
const word& name
|
|
)
|
|
:
|
|
name_(name),
|
|
headerClassName_(io.headerClassName_),
|
|
note_(io.note_),
|
|
instance_(io.instance_),
|
|
local_(io.local_),
|
|
db_(io.db_),
|
|
rOpt_(io.rOpt_),
|
|
wOpt_(io.wOpt_),
|
|
registerObject_(io.registerObject_),
|
|
objState_(io.objState_)
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * * //
|
|
|
|
Foam::IOobject::~IOobject()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
const Foam::objectRegistry& Foam::IOobject::db() const
|
|
{
|
|
return db_;
|
|
}
|
|
|
|
|
|
const Foam::Time& Foam::IOobject::time() const
|
|
{
|
|
return db_.time();
|
|
}
|
|
|
|
|
|
const Foam::fileName& Foam::IOobject::caseName() const
|
|
{
|
|
return time().caseName();
|
|
}
|
|
|
|
|
|
Foam::word Foam::IOobject::group() const
|
|
{
|
|
return group(name_);
|
|
}
|
|
|
|
|
|
Foam::word Foam::IOobject::member() const
|
|
{
|
|
return member(name_);
|
|
}
|
|
|
|
|
|
const Foam::fileName& Foam::IOobject::rootPath() const
|
|
{
|
|
return time().rootPath();
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::IOobject::path() const
|
|
{
|
|
if (instance().isAbsolute())
|
|
{
|
|
return instance();
|
|
}
|
|
else
|
|
{
|
|
return rootPath()/caseName()/instance()/db_.dbDir()/local();
|
|
}
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::IOobject::path
|
|
(
|
|
const word& instance,
|
|
const fileName& local
|
|
) const
|
|
{
|
|
// Note: can only be called with relative instance since is word type
|
|
return rootPath()/caseName()/instance/db_.dbDir()/local;
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::IOobject::localPath() const
|
|
{
|
|
if (instance().isAbsolute())
|
|
{
|
|
return instance();
|
|
}
|
|
else
|
|
{
|
|
return instance()/db_.dbDir()/local();
|
|
}
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::IOobject::localFilePath(const word& typeName) const
|
|
{
|
|
// Do not check for undecomposed files
|
|
return fileHandler().filePath(false, *this, typeName);
|
|
}
|
|
|
|
|
|
Foam::fileName Foam::IOobject::globalFilePath(const word& typeName) const
|
|
{
|
|
// Check for undecomposed files
|
|
return fileHandler().filePath(true, *this, typeName);
|
|
}
|
|
|
|
|
|
void Foam::IOobject::setBad(const string& s)
|
|
{
|
|
if (objState_ != GOOD)
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Recurrent failure for object " << s
|
|
<< exit(FatalError);
|
|
}
|
|
|
|
if (error::level)
|
|
{
|
|
InfoInFunction
|
|
<< "Broken object " << s << info() << endl;
|
|
}
|
|
|
|
objState_ = BAD;
|
|
}
|
|
|
|
|
|
void Foam::IOobject::operator=(const IOobject& io)
|
|
{
|
|
name_ = io.name_;
|
|
headerClassName_ = io.headerClassName_;
|
|
note_ = io.note_;
|
|
instance_ = io.instance_;
|
|
local_ = io.local_;
|
|
rOpt_ = io.rOpt_;
|
|
wOpt_ = io.wOpt_;
|
|
objState_ = io.objState_;
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|