AggregateWellData.hpp

/*
  Copyright (c) 2018 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_AGGREGATE_WELL_DATA_HPP
#define OPM_AGGREGATE_WELL_DATA_HPP

#include <opm/output/eclipse/WindowedArray.hpp>

#include <opm/io/eclipse/PaddedOutputString.hpp>

#include <cstddef>
#include <string>
#include <vector>

namespace Opm {
    class Schedule;
    class EclipseGrid;
    class SummaryState;
    class UnitSystem;
    class WellTestState;
    class TracerConfig;
    namespace Action {
        class State;
    }
} // Opm

namespace Opm { namespace data {
    class Wells;
}} // Opm::data

namespace Opm { namespace RestartIO { namespace Helpers {

    class AggregateWellData
    {
    public:
        explicit AggregateWellData(const std::vector<int>& inteHead);

        void captureDeclaredWellData(const Schedule&              sched,
                                     const TracerConfig&          tracer,
                                     const std::size_t                sim_step,
                                     const Opm::Action::State&    action_state,
                                     const Opm::WellTestState&    wtest_state,
                                     const Opm::SummaryState&     smry,
                                     const std::vector<int>&      inteHead);

        void captureDeclaredWellData(const Schedule&              sched,
                                     const EclipseGrid&           grid,
                                     const TracerConfig&          tracer,
                                     const std::size_t                sim_step,
                                     const Opm::Action::State&    action_state,
                                     const Opm::WellTestState&    wtest_state,
                                     const Opm::SummaryState&     smry,
                                     const std::vector<int>&      inteHead);

        void captureDeclaredWellDataLGR(const Schedule&               sched,
                                        const EclipseGrid&        grid,
                                        const TracerConfig&       tracer,
                                        const std::size_t                 sim_step,
                                        const Opm::Action::State& action_state,
                                        const Opm::WellTestState& wtest_state,
                                        const Opm::SummaryState&  smry,
                                        const std::vector<int>&   inteHead,
                                        const std::string&        lgr_tag);

        void captureDynamicWellData(const Opm::Schedule&          sched,
                                    const TracerConfig&           tracer,
                                    const std::size_t             sim_step,
                                    const Opm::data::Wells&       xw,
                                    const Opm::SummaryState&      smry);

        void captureDynamicWellDataLGR(const Opm::Schedule&          sched,
                                       const TracerConfig&           tracer,
                                       const std::size_t             sim_step,
                                       const Opm::data::Wells&       xw,
                                       const Opm::SummaryState&      smry,
                                       const std::string&            lgr_tag);


        const std::vector<int>& getIWell() const
        {
            return this->iWell_.data();
        }

        const std::vector<float>& getSWell() const
        {
            return this->sWell_.data();
        }

        const std::vector<double>& getXWell() const
        {
            return this->xWell_.data();
        }

        const std::vector<EclIO::PaddedOutputString<8>>& getZWell() const
        {
            return this->zWell_.data();
        }

        const std::vector<int>& getLGWell() const
        {
            return this->lgWell_.data();
        }



    private:
        WindowedArray<int> iWell_;

        WindowedArray<float> sWell_;

        WindowedArray<double> xWell_;

        WindowedArray<EclIO::PaddedOutputString<8>> zWell_;

        WindowedArray<int> lgWell_;

        int nWGMax_;
    };

}}} // Opm::RestartIO::Helpers

#endif // OPM_AGGREGATE_WELL_DATA_HPP