File size: 3,883 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2022 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/>.
Class
Foam::IOdictionary
Description
IOdictionary is derived from dictionary and IOobject to give the
dictionary automatic IO functionality via the objectRegistry. To facilitate
IO, IOdictionary is provided with a constructor from IOobject and writeData
and write functions.
SourceFiles
IOdictionary.C
IOdictionaryIO.C
\*---------------------------------------------------------------------------*/
#ifndef IOdictionary_H
#define IOdictionary_H
#include "dictionary.H"
#include "regIOobject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class IOdictionary Declaration
\*---------------------------------------------------------------------------*/
class IOdictionary
:
public regIOobject,
public dictionary
{
protected:
// Protected constructors
//- Construct given an IOobject, supply wanted typeName
IOdictionary(const IOobject& io, const word& wantedType);
public:
TypeName("dictionary");
// Public static data
static bool writeDictionaries;
// Constructors
//- Construct given an IOobject
IOdictionary(const IOobject&);
//- Construct given an IOobject and dictionary
IOdictionary(const IOobject&, const dictionary&);
//- Construct given an IOobject and Istream
IOdictionary(const IOobject&, Istream&);
//- Copy constructor
IOdictionary(const IOdictionary&);
//- Move constructor
IOdictionary(IOdictionary&&);
//- Destructor
virtual ~IOdictionary();
// Member Functions
using regIOobject::name;
//- Return true as object is global, i.e. same for all processors
virtual bool global() const
{
return true;
}
//- ReadData function required for regIOobject read operation
virtual bool readData(Istream&);
//- WriteData function required for regIOobject write operation
virtual bool writeData(Ostream&) const;
// Member Operators
//- Assignment of dictionary entries only
void operator=(const IOdictionary&);
//- Move assignment of dictionary entries only
void operator=(IOdictionary&&);
};
//- Trait for obtaining global status
template<>
struct typeGlobal<IOdictionary>
{
static const bool global = true;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|