version 3.10.0
Loading...
Searching...
No Matches
restart.hh
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3//
4// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
12#ifndef DUMUX_RESTART_HH
13#define DUMUX_RESTART_HH
14#warning "This header is deprecated and will be removed after release 2.10."
15
16#include <dune/common/exceptions.hh>
17#include <dune/common/fvector.hh>
18#include <dune/istl/bvector.hh>
19#include <dune/grid/common/rangegenerators.hh>
20
21#include <list>
22#include <string>
23#include <iostream>
24#include <fstream>
25#include <sstream>
26
27namespace Dumux {
28
33class Restart {
36 template <class GridView>
37 static const std::string magicRestartCookie_(const GridView &gridView)
38 {
39 const std::string gridName = "blubb"; //gridView.grid().name();
40 const int dim = GridView::dimension;
41
42 int numVertices = gridView.size(dim);
43 int numElements = gridView.size(0);
44 int numEdges = gridView.size(dim-1);
45 int numCPUs = gridView.comm().size();
46 int rank = gridView.comm().rank();
47
48 std::ostringstream oss;
49 oss << "DuMux restart file: "
50 << "gridName='"<<gridName<<"' "
51 << "numCPUs="<<numCPUs<<" "
52 << "myRank="<<rank<<" "
53 << "numElements="<<numElements<<" "
54 << "numEdges="<<numEdges<<" "
55 << "numVertices="<<numVertices;
56 return oss.str();
57 }
58
60 template <class GridView>
61 static const std::string restartFileName_(const GridView &gridView,
62 const std::string &simName,
63 double t)
64 {
65 int rank = gridView.comm().rank();
66 std::ostringstream oss;
67 oss << simName<<"_time="<<t<<"_rank="<<rank<<".drs";
68 return oss.str();
69 }
70
71
72public:
76 const std::string &fileName() const
77 { return fileName_; }
78
82 template <class Problem>
83 void serializeBegin(Problem &problem)
84 {
85 const std::string magicCookie = magicRestartCookie_(problem.gridView());
86 fileName_ = restartFileName_(problem.gridView(),
87 problem.name(),
88 problem.timeManager().time()+problem.timeManager().timeStepSize());
89
90 // open output file and write magic cookie
91 outStream_.open(fileName_.c_str());
92 outStream_.precision(20);
93
94 serializeSectionBegin(magicCookie);
96 }
97
101 std::ostream &serializeStream()
102 {
103 return outStream_;
104 }
105
109 void serializeSectionBegin(const std::string &cookie)
110 {
111 outStream_ << cookie << "\n";
112 }
113
118 { outStream_ << "\n"; }
119
125 template <int codim, class Serializer, class GridView>
126 void serializeEntities(Serializer &serializer,
127 const GridView &gridView)
128 {
129 std::ostringstream oss;
130 oss << "Entities: Codim " << codim;
131 std::string cookie = oss.str();
132 serializeSectionBegin(cookie);
133
134 // write entity data
135 for (const auto& entity : entities(gridView, Dune::Codim<codim>())) {
136 serializer.serializeEntity(outStream_, entity);
137 outStream_ << "\n";
138 }
139
141 }
142
147 {
148 outStream_.close();
149 }
150
151
156 template <class Problem>
157 void deserializeBegin(Problem &problem, double t)
158 {
159 fileName_ = restartFileName_(problem.gridView(),
160 problem.name(),
161 t);
162
163
164 // open input file and read magic cookie
165 inStream_.open(fileName_.c_str());
166 if (!inStream_.good()) {
167 DUNE_THROW(Dune::IOError,
168 "Restart file '"
169 << fileName_
170 << "' could not be opened properly");
171 }
172
173 // make sure that we don't open an empty file
174 inStream_.seekg(0, std::ios::end);
175 int pos = inStream_.tellg();
176 if (pos == 0) {
177 DUNE_THROW(Dune::IOError,
178 "Restart file '"
179 << fileName_
180 << "' is empty");
181 }
182 inStream_.seekg(0, std::ios::beg);
183
184 const std::string magicCookie =
185 magicRestartCookie_(problem.gridView());
186
187 deserializeSectionBegin(magicCookie);
189 }
190
195 std::istream &deserializeStream()
196 {
197 return inStream_;
198 }
199
203 void deserializeSectionBegin(const std::string &cookie)
204 {
205 if (!inStream_.good())
206 DUNE_THROW(Dune::IOError,
207 "Encountered unexpected EOF in restart file.");
208 std::string buf;
209 std::getline(inStream_, buf);
210 if (buf != cookie)
211 DUNE_THROW(Dune::IOError,
212 "Could not start section '" << cookie << "'");
213 }
214
219 {
220 std::string dummy;
221 std::getline(inStream_, dummy);
222 for (unsigned int i = 0; i < dummy.length(); ++i) {
223 if (!std::isspace(dummy[i])) {
224 DUNE_THROW(Dune::InvalidStateException,
225 "Encountered unread values while deserializing");
226 }
227 }
228 }
229
230
236 template <int codim, class Deserializer, class GridView>
237 void deserializeEntities(Deserializer &deserializer,
238 const GridView &gridView)
239 {
240 std::ostringstream oss;
241 oss << "Entities: Codim " << codim;
242 std::string cookie = oss.str();
244
245 std::string curLine;
246
247 // read entity data
248 for (const auto& entity : entities(gridView, Dune::Codim<codim>())) {
249 if (!inStream_.good()) {
250 DUNE_THROW(Dune::IOError,
251 "Restart file is corrupted");
252 }
253
254 std::getline(inStream_, curLine);
255 std::istringstream curLineStream(curLine);
256 deserializer.deserializeEntity(curLineStream, entity);
257 }
258
260 }
261
266 {
267 inStream_.close();
268 }
269
273 static void restartFileList(std::list<std::string> &fileList,
274 const std::string directory=".")
275 {
276 DUNE_THROW(Dune::NotImplemented,
277 "Restart::restartFileList()");
278 }
279
280
281private:
282 std::string fileName_;
283 std::ifstream inStream_;
284 std::ofstream outStream_;
285};
286}
287
288#endif
Load or save a state of a model to/from the harddisk.
Definition restart.hh:33
void deserializeBegin(Problem &problem, double t)
Start reading a restart file at a certain simulated time.
Definition restart.hh:157
void serializeSectionBegin(const std::string &cookie)
Start a new section in the serialized output.
Definition restart.hh:109
void deserializeEnd()
Stop reading the restart file.
Definition restart.hh:265
void deserializeEntities(Deserializer &deserializer, const GridView &gridView)
Deserialize all leaf entities of a codim in a grid.
Definition restart.hh:237
void deserializeSectionEnd()
End of a section in the serialized output.
Definition restart.hh:218
std::ostream & serializeStream()
The output stream to write the serialized data.
Definition restart.hh:101
const std::string & fileName() const
Returns the name of the file which is (de-)serialized.
Definition restart.hh:76
void deserializeSectionBegin(const std::string &cookie)
Start reading a new section of the restart file.
Definition restart.hh:203
void serializeEnd()
Finish the restart file.
Definition restart.hh:146
std::istream & deserializeStream()
The input stream to read the data which ought to be deserialized.
Definition restart.hh:195
void serializeSectionEnd()
End of a section in the serialized output.
Definition restart.hh:117
static void restartFileList(std::list< std::string > &fileList, const std::string directory=".")
Returns the list of restart files in the current directory.
Definition restart.hh:273
void serializeBegin(Problem &problem)
Write the current state of the model to disk.
Definition restart.hh:83
void serializeEntities(Serializer &serializer, const GridView &gridView)
Serialize all leaf entities of a codim in a gridView.
Definition restart.hh:126
Definition adapt.hh:17