opm-simulators/opm/autodiff/SimulatorFullyImplicitBlackoilMultiSegment.hpp

/*
  Copyright 2013 SINTEF ICT, Applied Mathematics.
  Copyright 2015 Andreas Lauser

  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_SIMULATORFULLYIMPLICITBLACKOILMULTISEGMENT_HEADER_INCLUDED
#define OPM_SIMULATORFULLYIMPLICITBLACKOILMULTISEGMENT_HEADER_INCLUDED

#include <opm/autodiff/SimulatorBase.hpp>


#include <opm/autodiff/NonlinearSolver.hpp>
#include <opm/autodiff/BlackoilMultiSegmentModel.hpp>
#include <opm/autodiff/WellStateMultiSegment.hpp>

namespace Opm {

template <class GridT>
class SimulatorFullyImplicitBlackoilMultiSegment;

class MultisegmentWells;

template <class GridT>
struct SimulatorTraits<SimulatorFullyImplicitBlackoilMultiSegment<GridT> >
{
    typedef WellStateMultiSegment WellState;
    typedef BlackoilState ReservoirState;
    typedef BlackoilOutputWriter OutputWriter;
    typedef GridT Grid;
    typedef BlackoilMultiSegmentModel<Grid> Model;
    typedef NonlinearSolver<Model> Solver;
    typedef MultisegmentWells WellModel;
};

/// a simulator for the blackoil model
template <class GridT>
class SimulatorFullyImplicitBlackoilMultiSegment
    : public SimulatorBase<SimulatorFullyImplicitBlackoilMultiSegment<GridT> >
{
public:
    typedef SimulatorBase<SimulatorFullyImplicitBlackoilMultiSegment<GridT> > Base;
    typedef SimulatorFullyImplicitBlackoilMultiSegment<GridT> ThisType;
    typedef SimulatorTraits<ThisType> Traits;
    typedef typename Traits::ReservoirState ReservoirState;
    typedef typename Traits::WellState WellState;
    typedef typename Traits::Solver Solver;
    typedef typename Traits::WellModel WellModel;

    // forward the constructor to the base class
    SimulatorFullyImplicitBlackoilMultiSegment(const ParameterGroup& param,
                                   const GridT& grid,
                                   DerivedGeology& geo,
                                   BlackoilPropsAdFromDeck& props,
                                   const RockCompressibility* rock_comp_props,
                                   NewtonIterationBlackoilInterface& linsolver,
                                   const double* gravity,
                                   const bool disgas,
                                   const bool vapoil,
                                   std::shared_ptr<EclipseState> eclipse_state,
                                   std::shared_ptr<Schedule> schedule,
                                   std::shared_ptr<SummaryConfig> summary_config,
                                   BlackoilOutputWriter& output_writer,
                                   const std::vector<double>& threshold_pressures_by_face,
                                   const std::unordered_set<std::string>& defunct_well_names)
    : Base(param, grid, geo, props, rock_comp_props, linsolver, gravity, disgas, vapoil,
           eclipse_state, schedule, summary_config, output_writer, threshold_pressures_by_face, defunct_well_names)
    {}


    SimulatorReport run(SimulatorTimer& timer,
                        ReservoirState& state);

protected:

    std::unique_ptr<Solver> createSolver(const WellModel& well_model);

    using Base::output_writer_;
    using Base::param_;
    using Base::solver_;
    using Base::terminal_output_;
    using Base::eclipse_state_;
    using Base::schedule_;
    using Base::summary_config_;
    using Base::grid_;
    using Base::props_;
    using Base::is_parallel_run_;
    using Base::allcells_;
    using Base::model_param_;
    using Base::geo_;
    using Base::rock_comp_props_;
    using Base::has_disgas_;
    using Base::has_vapoil_;
};

} // namespace Opm

#include "SimulatorFullyImplicitBlackoilMultiSegment_impl.hpp"

#endif // OPM_SIMULATORFULLYIMPLICITBLACKOILMULTISEGMENT_HEADER_INCLUDED