Summary.hpp

/*
  Copyright 2016 Statoil 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 OPM_OUTPUT_SUMMARY_HPP
#define OPM_OUTPUT_SUMMARY_HPP

#include <opm/output/data/Aquifer.hpp>
#include <opm/output/data/Groups.hpp>
#include <opm/output/data/InterRegFlowMap.hpp>

#include <map>
#include <memory>
#include <optional>
#include <string>
#include <tuple>
#include <unordered_map>
#include <utility>
#include <vector>

namespace Opm {
    class EclipseGrid;
    class EclipseState;
    class Inplace;
    class Schedule;
    class SummaryConfig;
    class SummaryState;
} // namespace Opm

namespace Opm::data {
    class GroupAndNetworkValues;
    class InterRegFlowMap;
    struct WellBlockAveragePressures;
    class Wells;
} // namespace Opm::data

namespace Opm::out {

class Summary
{
public:
    struct DynamicSimulatorState
    {
        using GlobalProcessParameters = std::map<std::string, double>;

        using RegionParameters = std::map<std::string, std::vector<double>>;

        using BlockValues = std::map<std::pair<std::string, int>, double>;

        using LgrBlockValues = std::map<std::tuple<std::string, int, int>, double>;

        using InterRegFlowValues = std::unordered_map<std::string, data::InterRegFlowMap>;

        struct VolumeInPlace
        {
            const Inplace* current {nullptr};

            const Inplace* initial {nullptr};
        };

        const data::Wells* well_solution {nullptr};

        const data::WellBlockAveragePressures* wbp {nullptr};

        const data::GroupAndNetworkValues* group_and_nwrk_solution {nullptr};

        const GlobalProcessParameters* single_values {nullptr};

        const RegionParameters* region_values {nullptr};

        const BlockValues* block_values {nullptr};

        const data::Aquifers* aquifer_values {nullptr};

        const InterRegFlowValues* interreg_flows {nullptr};

        const data::ReservoirCouplingGroupRates* rc_group_rates {nullptr};

        VolumeInPlace inplace{};

        const LgrBlockValues* lgr_block_values {nullptr};
    };

    using DynamicConns = std::vector<std::pair<std::string, std::vector<std::size_t>>>;

    Summary(SummaryConfig&      sumcfg,
            const EclipseState& es,
            const EclipseGrid&  grid,
            const Schedule&     sched,
            const std::string&  basename = "",
            const bool          writeEsmry = false);

    ~Summary();

    void add_timestep(const SummaryState& st,
                      const int           report_step,
                      const int           ministep_id,
                      const bool          isSubstep);

    void recordNewDynamicWellConns(const DynamicConns& newConns);

    void eval(const int                    report_step,
              const double                 secs_elapsed,
              const DynamicSimulatorState& values,
              SummaryState&                summary_state) const;

    void write(const bool is_final_summary = false) const;

private:
    class SummaryImplementation;

    std::unique_ptr<SummaryImplementation> pImpl_;
};

} // namespace Opm::out

#endif // OPM_OUTPUT_SUMMARY_HPP