restart.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_RESTART_HH
#define DUMUX_RESTART_HH
 
#include <dune/common/exceptions.hh>
#include <dune/common/fvector.hh>
#include <dune/istl/bvector.hh>
#include <dune/grid/common/rangegenerators.hh>
 
#include <list>
#include <string>
#include <iostream>
#include <fstream>
#include <sstream>
 
namespace Dumux {
 
class Restart {
    template <class GridView>
    static const std::string magicRestartCookie_(const GridView &gridView)
    {
        const std::string gridName = "blubb"; //gridView.grid().name();
        const int dim = GridView::dimension;
 
        int numVertices = gridView.size(dim);
        int numElements = gridView.size(0);
        int numEdges = gridView.size(dim-1);
        int numCPUs = gridView.comm().size();
        int rank = gridView.comm().rank();
 
        std::ostringstream oss;
        oss << "DuMux restart file: "
            << "gridName='"<<gridName<<"' "
            << "numCPUs="<<numCPUs<<" "
            << "myRank="<<rank<<" "
            << "numElements="<<numElements<<" "
            << "numEdges="<<numEdges<<" "
            << "numVertices="<<numVertices;
        return oss.str();
    }
 
    template <class GridView>
    static const std::string restartFileName_(const GridView &gridView,
                                              const std::string &simName,
                                              double t)
    {
        int rank = gridView.comm().rank();
        std::ostringstream oss;
        oss << simName<<"_time="<<t<<"_rank="<<rank<<".drs";
        return oss.str();
    }
 
 
public:
    const std::string &fileName() const
    { return fileName_; }
 
    template <class Problem>
    void serializeBegin(Problem &problem)
    {
        const std::string magicCookie = magicRestartCookie_(problem.gridView());
        fileName_ = restartFileName_(problem.gridView(),
                                     problem.name(),
                                     problem.timeManager().time()+problem.timeManager().timeStepSize());
 
        // open output file and write magic cookie
        outStream_.open(fileName_.c_str());
        outStream_.precision(20);
 
        serializeSectionBegin(magicCookie);
        serializeSectionEnd();
    }
 
    std::ostream &serializeStream()
    {
        return outStream_;
    }
 
    void serializeSectionBegin(const std::string &cookie)
    {
        outStream_ << cookie << "\n";
    }
 
    void serializeSectionEnd()
    { outStream_ << "\n"; }
 
    template <int codim, class Serializer, class GridView>
    void serializeEntities(Serializer &serializer,
                           const GridView &gridView)
    {
        std::ostringstream oss;
        oss << "Entities: Codim " << codim;
        std::string cookie = oss.str();
        serializeSectionBegin(cookie);
 
        // write entity data
        for (const auto& entity : entities(gridView, Dune::Codim<codim>())) {
            serializer.serializeEntity(outStream_, entity);
            outStream_ << "\n";
        }
 
        serializeSectionEnd();
    }
 
    void serializeEnd()
    {
        outStream_.close();
    }
 
 
    template <class Problem>
    void deserializeBegin(Problem &problem, double t)
    {
        fileName_ = restartFileName_(problem.gridView(),
                                     problem.name(),
                                     t);
 
 
        // open input file and read magic cookie
        inStream_.open(fileName_.c_str());
        if (!inStream_.good()) {
            DUNE_THROW(Dune::IOError,
                       "Restart file '"
                       << fileName_
                       << "' could not be opened properly");
        }
 
        // make sure that we don't open an empty file
        inStream_.seekg(0, std::ios::end);
        int pos = inStream_.tellg();
        if (pos == 0) {
            DUNE_THROW(Dune::IOError,
                       "Restart file '"
                       << fileName_
                       << "' is empty");
        }
        inStream_.seekg(0, std::ios::beg);
 
        const std::string magicCookie =
            magicRestartCookie_(problem.gridView());
 
        deserializeSectionBegin(magicCookie);
        deserializeSectionEnd();
    }
 
    std::istream &deserializeStream()
    {
        return inStream_;
    }
 
    void deserializeSectionBegin(const std::string &cookie)
    {
        if (!inStream_.good())
            DUNE_THROW(Dune::IOError,
                       "Encountered unexpected EOF in restart file.");
        std::string buf;
        std::getline(inStream_, buf);
        if (buf != cookie)
            DUNE_THROW(Dune::IOError,
                       "Could not start section '" << cookie << "'");
    }
 
    void deserializeSectionEnd()
    {
        std::string dummy;
        std::getline(inStream_, dummy);
        for (unsigned int i = 0; i < dummy.length(); ++i) {
            if (!std::isspace(dummy[i])) {
                DUNE_THROW(Dune::InvalidStateException,
                           "Encountered unread values while deserializing");
            }
        }
    }
 
 
    template <int codim, class Deserializer, class GridView>
    void deserializeEntities(Deserializer &deserializer,
                             const GridView &gridView)
    {
        std::ostringstream oss;
        oss << "Entities: Codim " << codim;
        std::string cookie = oss.str();
        deserializeSectionBegin(cookie);
 
        std::string curLine;
 
        // read entity data
        for (const auto& entity : entities(gridView, Dune::Codim<codim>())) {
            if (!inStream_.good()) {
                DUNE_THROW(Dune::IOError,
                           "Restart file is corrupted");
            }
 
            std::getline(inStream_, curLine);
            std::istringstream curLineStream(curLine);
            deserializer.deserializeEntity(curLineStream, entity);
        }
 
        deserializeSectionEnd();
    }
 
    void deserializeEnd()
    {
        inStream_.close();
    }
 
    static void restartFileList(std::list<std::string> &fileList,
                                const std::string directory=".")
    {
        DUNE_THROW(Dune::NotImplemented,
                   "Restart::restartFileList()");
    }
 
 
private:
    std::string fileName_;
    std::ifstream inStream_;
    std::ofstream outStream_;
};
}
 
#endif