ExtraConvergenceOutputThread.hpp

/*
  Copyright 2022 Equinor ASA.

  This file is part of the Open Porous Media project (OPM).

  OPM 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.

  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef EXTRA_CONVERGENCE_OUTPUT_THREAD_HPP
#define EXTRA_CONVERGENCE_OUTPUT_THREAD_HPP

#include <opm/simulators/timestepping/ConvergenceReport.hpp>

#include <condition_variable>
#include <functional>
#include <memory>
#include <mutex>
#include <string_view>
#include <vector>

namespace Opm {
    class ConvergenceOutputConfiguration;
} // namespace Opm


namespace Opm
{

class ConvergenceOutputThread;

class ConvergenceReportQueue
{
public:
    struct OutputRequest
    {
        int reportStep{-1};

        int currentStep{-1};

        std::vector<ConvergenceReport> reports{};
    };

    void enqueue(std::vector<OutputRequest>&& requests);

    void signalLastOutputRequest();

    friend class ConvergenceOutputThread;

private:
    std::mutex mtx_{};

    std::condition_variable cv_{};

    std::vector<OutputRequest> requests_{};
};

class ConvergenceOutputThread
{
public:
    using ComponentToPhaseName = std::function<std::string_view(int)>;

    using ConvertToTimeUnits = std::function<double(double)>;

    explicit ConvergenceOutputThread(std::string_view               outputDir,
                                     std::string_view               baseName,
                                     ComponentToPhaseName           getPhaseName,
                                     ConvertToTimeUnits             convertTime,
                                     ConvergenceOutputConfiguration config,
                                     ConvergenceReportQueue&        queue);

    ConvergenceOutputThread(const ConvergenceOutputThread& src) = delete;

    ConvergenceOutputThread(ConvergenceOutputThread&& src);

    ConvergenceOutputThread& operator=(const ConvergenceOutputThread& src) = delete;

    ConvergenceOutputThread& operator=(ConvergenceOutputThread&& src) = delete;

    ~ConvergenceOutputThread();

    void writeSynchronous(std::vector<ConvergenceReportQueue::OutputRequest>&& requests);

    void writeASynchronous();

private:
    class Impl;

    std::unique_ptr<Impl> pImpl_;
};

} // namespace Opm

#endif //  EXTRA_CONVERGENCE_OUTPUT_THREAD_HPP