IOdistributionMap.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2014-2022 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "IOdistributionMap.H"
27 
28 /* * * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * */
29 
30 namespace Foam
31 {
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 :
40  regIOobject(io)
41 {
42  // Temporary warning
44  {
46  << "IOdistributionMap " << name()
47  << " constructed with IOobject::MUST_READ_IF_MODIFIED"
48  " but IOdistributionMap does not support automatic rereading."
49  << endl;
50  }
51 
52  if
53  (
54  (
57  )
59  )
60  {
61  readStream(typeName) >> *this;
62  close();
63  }
64 }
65 
66 
68 (
69  const IOobject& io,
70  const distributionMap& map
71 )
72 :
73  regIOobject(io)
74 {
75  // Temporary warning
77  {
79  << "IOdistributionMap " << name()
80  << " constructed with IOobject::MUST_READ_IF_MODIFIED"
81  " but IOdistributionMap does not support automatic rereading."
82  << endl;
83  }
84 
85  if
86  (
87  (
90  )
92  )
93  {
94  readStream(typeName) >> *this;
95  close();
96  }
97  else
98  {
100  }
101 }
102 
103 
105 (
106  const IOobject& io,
107  distributionMap&& map
108 )
109 :
110  regIOobject(io),
111  distributionMap(move(map))
112 {
113  // Temporary warning
115  {
117  << "IOdistributionMap " << name()
118  << " constructed with IOobject::MUST_READ_IF_MODIFIED"
119  " but IOdistributionMap does not support automatic rereading."
120  << endl;
121  }
122 
123  if
124  (
125  (
128  )
129  || (io.readOpt() == IOobject::READ_IF_PRESENT && headerOk())
130  )
131  {
132  readStream(typeName) >> *this;
133  close();
134  }
135 }
136 
137 
138 // * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * * //
139 
141 {}
142 
143 
144 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
145 
147 {
148  return (is >> *this).good();
149 }
150 
151 
153 {
154  return (os << *this).good();
155 }
156 
157 
158 // ************************************************************************* //
IOdistributionMap is derived from distributionMap and IOobject to give the distributionMap automatic ...
IOdistributionMap(const IOobject &)
Construct given an IOobject.
virtual bool writeData(Ostream &) const
WriteData function required for regIOobject write operation.
virtual ~IOdistributionMap()
Destructor.
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
@ MUST_READ_IF_MODIFIED
Definition: IOobject.H:119
readOption readOpt() const
Definition: IOobject.H:360
const word & name() const
Return name.
Definition: IOobject.H:310
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
Class containing processor-to-processor mapping information.
void operator=(const distributionMap &)
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:55
void close()
Close Istream.
bool headerOk()
Read and check header info.
Definition: regIOobject.C:453
Istream & readStream(const word &, const bool read=true)
Return Istream and check object type against that given.
#define WarningInFunction
Report a warning using Foam::Warning.
Namespace for OpenFOAM.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:257
defineTypeNameAndDebug(combustionModel, 0)