mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
337 lines
9.8 KiB
C++
337 lines
9.8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2017 OpenFOAM Foundation
|
|
Copyright (C) 2018-2019 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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/>.
|
|
|
|
Class
|
|
Foam::regIOobject
|
|
|
|
Description
|
|
regIOobject is an abstract class derived from IOobject to handle
|
|
automatic object registration with the objectRegistry.
|
|
|
|
SourceFiles
|
|
regIOobject.C
|
|
regIOobjectRead.C
|
|
regIOobjectWrite.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef regIOobject_H
|
|
#define regIOobject_H
|
|
|
|
#include "IOobject.H"
|
|
#include "typeInfo.H"
|
|
#include "OSspecific.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
namespace functionEntries
|
|
{
|
|
class codeStream;
|
|
}
|
|
namespace fileOperations
|
|
{
|
|
class uncollatedFileOperation;
|
|
class masterUncollatedFileOperation;
|
|
}
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class regIOobject Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class regIOobject
|
|
:
|
|
public IOobject
|
|
{
|
|
protected:
|
|
|
|
//- Helper: check readOpt flags and read if necessary
|
|
bool readHeaderOk
|
|
(
|
|
const IOstream::streamFormat PstreamFormat,
|
|
const word& typeName
|
|
);
|
|
|
|
//- Construct and return an IFstream for the object.
|
|
// The results is NULL if the stream construction failed
|
|
Istream* objectStream();
|
|
|
|
//- To flag master-only reading of objects
|
|
static bool masterOnlyReading;
|
|
|
|
|
|
private:
|
|
|
|
// Private data
|
|
|
|
//- Is this object registered with the registry
|
|
bool registered_;
|
|
|
|
//- Is this object owned by the registry
|
|
bool ownedByRegistry_;
|
|
|
|
//- List of modification watch indices
|
|
mutable labelList watchIndices_;
|
|
|
|
//- eventNo of last update
|
|
label eventNo_;
|
|
|
|
//- Istream for reading
|
|
autoPtr<ISstream> isPtr_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Return Istream
|
|
Istream& readStream(const bool valid = true);
|
|
|
|
//- No copy assignment
|
|
void operator=(const regIOobject&) = delete;
|
|
|
|
|
|
public:
|
|
|
|
//- Declare friendship with any classes that need access to
|
|
// masterOnlyReading
|
|
friend class functionEntries::codeStream;
|
|
friend class fileOperations::uncollatedFileOperation;
|
|
friend class fileOperations::masterUncollatedFileOperation;
|
|
|
|
|
|
// Static data
|
|
|
|
//- Runtime type information
|
|
TypeName("regIOobject");
|
|
|
|
static float fileModificationSkew;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from IOobject. The optional flag adds special handling
|
|
//- if the object is the top-level regIOobject (eg, Time).
|
|
regIOobject(const IOobject& io, const bool isTime = false);
|
|
|
|
//- Copy construct
|
|
regIOobject(const regIOobject& rio);
|
|
|
|
//- Copy construct, transferring registry registration to the copy
|
|
//- if registerCopy is true
|
|
regIOobject(const regIOobject& rio, bool registerCopy);
|
|
|
|
//- Copy construct with new name, transferring registry registration
|
|
//- to the copy f registerCopy is true
|
|
regIOobject(const word& newName, const regIOobject&, bool registerCopy);
|
|
|
|
//- Copy construct with new IO parameters
|
|
regIOobject(const IOobject& io, const regIOobject& rio);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~regIOobject();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Registration
|
|
|
|
//- Add object to registry, if not already registered
|
|
// \return true if object was newly registered
|
|
bool checkIn();
|
|
|
|
//- Remove all file watches and remove object from registry
|
|
// \return true if object was registered and was removed
|
|
bool checkOut();
|
|
|
|
//- Add file watch on object (if registered and READ_IF_MODIFIED)
|
|
virtual void addWatch();
|
|
|
|
//- Is this object owned by the registry?
|
|
inline bool ownedByRegistry() const;
|
|
|
|
//- Transfer ownership of this object to its registry
|
|
inline void store();
|
|
|
|
//- Transfer ownership of the given object pointer to its registry
|
|
// \return reference to the object.
|
|
template<class Type>
|
|
inline static Type& store(Type* p);
|
|
|
|
//- Transfer ownership of the given object pointer to its registry
|
|
// \return reference to the object.
|
|
template<class Type>
|
|
inline static Type& store(autoPtr<Type>& aptr);
|
|
|
|
//- Transfer ownership of the given object pointer to its registry
|
|
// \return reference to the object.
|
|
template<class Type>
|
|
inline static Type& store(autoPtr<Type>&& aptr);
|
|
|
|
//- Release ownership of this object from its registry
|
|
// \param unregister optionally set as non-registered
|
|
inline void release(const bool unregister = false);
|
|
|
|
|
|
// Dependency checking
|
|
|
|
//- Event number at last update.
|
|
inline label eventNo() const;
|
|
|
|
//- Event number at last update.
|
|
inline label& eventNo();
|
|
|
|
//- Return true if up-to-date with respect to given object
|
|
bool upToDate(const regIOobject&) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
//- Return true if up-to-date with respect to given objects
|
|
bool upToDate
|
|
(
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&,
|
|
const regIOobject&
|
|
) const;
|
|
|
|
|
|
//- Set as up-to-date
|
|
void setUpToDate();
|
|
|
|
|
|
// Edit
|
|
|
|
//- Rename
|
|
virtual void rename(const word& newName);
|
|
|
|
|
|
// Reading
|
|
|
|
//- Return complete path + object name if the file exists
|
|
// in the case directory otherwise null. Does not search
|
|
// up if parallel. Can be overridden to provide this functionality
|
|
// (e.g. IOdictionary)
|
|
virtual fileName filePath() const;
|
|
|
|
//- Read and check header info
|
|
bool headerOk();
|
|
|
|
//- Return Istream and check object type against that given
|
|
Istream& readStream(const word&, const bool valid = true);
|
|
|
|
//- Close Istream
|
|
void close();
|
|
|
|
//- Virtual readData function.
|
|
// Must be defined in derived types for which
|
|
// re-reading is required
|
|
virtual bool readData(Istream&);
|
|
|
|
//- Read object
|
|
virtual bool read();
|
|
|
|
//- Add file watch for fileName on object if not yet watched. Return
|
|
// index of watch
|
|
virtual label addWatch(const fileName&);
|
|
|
|
//- Return file-monitoring handles
|
|
inline const labelList& watchIndices() const;
|
|
|
|
//- Return file-monitoring handles
|
|
inline labelList& watchIndices();
|
|
|
|
//- Return true if the object's file (or files for objectRegistry)
|
|
// have been modified. (modified state is cached by Time)
|
|
virtual bool modified() const;
|
|
|
|
//- Read object if modified (as set by call to modified)
|
|
virtual bool readIfModified();
|
|
|
|
|
|
// Writing
|
|
|
|
//- Pure virtual writeData function.
|
|
// Must be defined in derived types
|
|
virtual bool writeData(Ostream&) const = 0;
|
|
|
|
//- Write using given format, version and compression
|
|
virtual bool writeObject
|
|
(
|
|
IOstream::streamFormat,
|
|
IOstream::versionNumber,
|
|
IOstream::compressionType,
|
|
const bool valid
|
|
) const;
|
|
|
|
//- Write using setting from DB
|
|
virtual bool write(const bool valid = true) const;
|
|
|
|
|
|
// Other
|
|
|
|
//- Is object global
|
|
virtual bool global() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
|
|
// Member operators
|
|
|
|
void operator=(const IOobject&);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "regIOobjectI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|