/// \cond SKIP
/*!
  Copyright 2012 SINTEF ICT, Applied Mathematics.

  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/>.
*/
/// \endcond
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <iostream>
#include <iomanip>
#include <fstream>
#include <vector>
#include <cassert>
#include <opm/grid/UnstructuredGrid.h>
#include <opm/grid/GridManager.hpp>
// 17.03.2016 Temporarily removed while moving functionality to opm-output
#ifdef DISABLE_OUTPUT
#include <opm/core/io/vtk/writeVtkData.hpp>
#endif
#include <opm/core/linalg/LinearSolverUmfpack.hpp>
#include <opm/core/pressure/IncompTpfa.hpp>
#include <opm/core/pressure/FlowBCManager.hpp>
#include <opm/core/props/IncompPropertiesBasic.hpp>

#include <opm/core/transport/reorder/TransportSolverTwophaseReorder.hpp>

#include <opm/core/simulator/initState.hpp>
#include <opm/core/simulator/TwophaseState.hpp>
#include <opm/core/simulator/WellState.hpp>

#include <opm/core/utility/miscUtilities.hpp>
#include <opm/parser/eclipse/Units/Units.hpp>
#include <opm/common/utility/parameters/ParameterGroup.hpp>
#include <opm/core/wells/WellCollection.hpp>

/// \page tutorial4 Well controls
/// This tutorial explains how to construct an example with wells
/// \page tutorial4
/// \section commentedsource1 Program walk-through.
/// \details
/// Main function
/// \snippet tutorial4.cpp main
/// \internal[main]
int main ()
try
{
    /// \internal[main]
    /// \endinternal
    /// \page tutorial4
    /// \details
    /// We define the grid. A Cartesian grid with 1200 cells.
    /// \snippet tutorial4.cpp cartesian grid
    /// \internal[cartesian grid]
    int dim = 3;
    int nx = 20;
    int ny = 20;
    int nz = 1;
    double dx = 10.;
    double dy = 10.;
    double dz = 10.;
    using namespace Opm;
    GridManager grid_manager(nx, ny, nz, dx, dy, dz);
    const UnstructuredGrid& grid = *grid_manager.c_grid();
    int num_cells = grid.number_of_cells;
    /// \internal[cartesian grid]
    /// \endinternal

    /// \page tutorial4
    /// \details
    /// We define the properties of the fluid.\n
    /// Number of phases.
    /// \snippet tutorial4.cpp Number of phases
    /// \internal[Number of phases]
    int num_phases = 2;
    using namespace unit;
    using namespace prefix;
    /// \internal[Number of phases]
    /// \endinternal

    /// \page tutorial4
    /// \details density vector (one component per phase).
    /// \snippet tutorial4.cpp density
    /// \internal[density]
    std::vector<double> rho(2, 1000.);
    /// \internal[density]
    /// \endinternal

    /// \page tutorial4
    /// \details viscosity vector (one component per phase).
    /// \snippet tutorial4.cpp viscosity
    /// \internal[viscosity]
    std::vector<double> mu(2, 1.*centi*Poise);
    /// \internal[viscosity]
    /// \endinternal

    /// \page tutorial4
    /// \details porosity and permeability of the rock.
    /// \snippet tutorial4.cpp rock
    /// \internal[rock]
    double porosity = 0.5;
    double k = 10*milli*darcy;
    /// \internal[rock]
    /// \endinternal

    /// \page tutorial4
    /// \details We define the relative permeability function. We use a basic fluid
    /// description and set this function to be linear. For more realistic fluid, the
    /// saturation function is given by the data.
    /// \snippet tutorial4.cpp relative permeability
    /// \internal[relative permeability]
    SaturationPropsBasic::RelPermFunc rel_perm_func = SaturationPropsBasic::Linear;
    /// \internal[relative permeability]
    /// \endinternal

    /// \page tutorial4
    /// \details We construct a basic fluid with the properties we have defined above.
    /// Each property is constant and hold for all cells.
    /// \snippet tutorial4.cpp fluid properties
    /// \internal[fluid properties]
    IncompPropertiesBasic props(num_phases, rel_perm_func, rho, mu,
                                     porosity, k, dim, num_cells);
    /// \internal[fluid properties]
    /// \endinternal


    /// \page tutorial4
    /// \details Gravity parameters. Here, we set zero gravity.
    /// \snippet tutorial4.cpp Gravity
    /// \internal[Gravity]
    const double *grav = 0;
    std::vector<double> omega;
    /// \internal[Gravity]
    /// \endinternal

    /// \page tutorial4
    /// \details We set up the source term. Positive numbers indicate that the cell is a source,
    /// while negative numbers indicate a sink.
    /// \snippet tutorial4.cpp source
    /// \internal[source]
    std::vector<double> src(num_cells, 0.0);
    src[0] = 1.;
    src[num_cells-1] = -1.;
    /// \internal[source]
    /// \endinternal

    /// \page tutorial4
    /// \details We compute the pore volume
    /// \snippet tutorial4.cpp pore volume
    /// \internal[pore volume]
    std::vector<double> porevol;
    Opm::computePorevolume(grid, props.porosity(), porevol);
    /// \internal[pore volume]
    /// \endinternal

    /// \page tutorial4
    /// \details Set up the transport solver. This is a reordering implicit Euler transport solver.
    /// \snippet tutorial4.cpp transport solver
    /// \internal[transport solver]
    const double tolerance = 1e-9;
    const int max_iterations = 30;
    Opm::TransportSolverTwophaseReorder transport_solver(grid, props, NULL, tolerance, max_iterations);
    /// \internal[transport solver]
    /// \endinternal

    /// \page tutorial4
    /// \details Time integration parameters
    /// \snippet tutorial4.cpp Time integration
    /// \internal[Time integration]
    double dt = 0.1*day;
    int num_time_steps = 20;
    /// \internal[Time integration]
    /// \endinternal


    /// \page tutorial4
    /// \details We define a vector which contains all cell indexes. We use this
    /// vector to set up parameters on the whole domains.
    /// \snippet tutorial4.cpp cell indexes
    /// \internal[cell indexes]
    std::vector<int> allcells(num_cells);
    for (int cell = 0; cell < num_cells; ++cell) {
        allcells[cell] = cell;
    }
    /// \internal[cell indexes]
    /// \endinternal


    /// \page tutorial4
    /// \details We set up the boundary conditions. Letting bcs empty is equivalent
    /// to no flow boundary conditions.
    /// \snippet tutorial4.cpp boundary
    /// \internal[boundary]
    FlowBCManager bcs;
    /// \internal[boundary]
    /// \endinternal

    /// \page tutorial4
    /// \details
    /// We set up a two-phase state object, and
    /// initialise water saturation to minimum everywhere.
    /// \snippet tutorial4.cpp two-phase state
    /// \internal[two-phase state]
    TwophaseState state( grid.number_of_cells , grid.number_of_faces );
    initSaturation( allcells , props , state , MinSat );


    /// \internal[two-phase state]
    /// \endinternal

    /// \page tutorial4
    /// \details This string will contain the name of a VTK output vector.
    /// \snippet tutorial4.cpp VTK output
    /// \internal[VTK output]
    std::ostringstream vtkfilename;
    /// \internal[VTK output]
    /// \endinternal

    /// \page tutorial4
    /// To create wells we need an instance of the PhaseUsage-object
    /// \snippet tutorial4.cpp PhaseUsage-object
    /// \internal[PhaseUsage-object]
    PhaseUsage phase_usage;
    phase_usage.num_phases = num_phases;
    phase_usage.phase_used[BlackoilPhases::Aqua] = 1;
    phase_usage.phase_used[BlackoilPhases::Liquid] = 1;
    phase_usage.phase_used[BlackoilPhases::Vapour] = 0;

    phase_usage.phase_pos[BlackoilPhases::Aqua] = 0;
    phase_usage.phase_pos[BlackoilPhases::Liquid] = 1;
    /// \internal[PhaseUsage-object]
    /// \endinternal

    /// \page tutorial4
    /// \details This will contain our well-specific information
    /// \snippet tutorial4.cpp well_collection
    /// \internal[well_collection]
    WellCollection well_collection;
    /// \internal[well_collection]
    /// \endinternal

    /// \page tutorial4
    /// \details Create the production specification for our top well group.
    ///          We set a target limit for total reservoir rate, and set the controlling
    ///          mode of the group to be controlled by the reservoir rate.
    /// \snippet tutorial4.cpp production specification
    /// \internal[production specification]
    ProductionSpecification well_group_prod_spec;
    well_group_prod_spec.reservoir_flow_max_rate_ = 0.1;
    well_group_prod_spec.control_mode_ = ProductionSpecification::RESV;
    /// \internal[production specification]
    /// \endinternal
    const double group_efficiency_factor = 0.9;

    /// \page tutorial4
    /// \details Create our well group. We hand it an empty injection specification,
    ///          as we don't want to control its injection target. We use the shared_ptr-type because that's
    ///          what the interface expects. The first argument is the (unique) name of the group.
    /// \snippet tutorial4.cpp injection specification
    /// \internal[injection specification]
    std::shared_ptr<WellsGroupInterface> well_group(new WellsGroup("group", group_efficiency_factor, well_group_prod_spec,
                                                                   InjectionSpecification(), phase_usage));
    /// \internal[injection specification]
    /// \endinternal

    /// \page tutorial4
    /// \details We add our well_group to the well_collection
    /// \snippet tutorial4.cpp well_collection
    /// \internal[well_collection]
    well_collection.addChild(well_group);
    /// \internal[well_collection]
    /// \endinternal


    /// \page tutorial4
    /// \details Create the production specification and Well objects (total 4 wells). We set all our wells to be group controlled.
    ///          We pass in the string argument \C "group" to set the parent group.
    /// \snippet tutorial4.cpp create well objects
    /// \internal[create well objects]
    const int num_wells = 4;
    for (int i = 0; i < num_wells; ++i) {
        std::stringstream well_name;
        well_name << "well" << i;
        ProductionSpecification production_specification;
        production_specification.control_mode_ = ProductionSpecification::GRUP;
        const double efficiency_factor = 0.8;
        std::shared_ptr<WellsGroupInterface> well_leaf_node(new WellNode(well_name.str(), efficiency_factor, production_specification,
                                                                         InjectionSpecification(), phase_usage));
        well_collection.addChild(well_leaf_node, "group");

    }
    /// \internal[create well objects]
    /// \endinternal

    /// \page tutorial4
    /// \details Now we create the C struct to hold our wells (this is to interface with the solver code).
    /// \snippet tutorial4.cpp well struct
    /// \internal[well struct]
    Wells* wells = create_wells(num_phases, num_wells, num_wells /*number of perforations. We'll only have one perforation per well*/);
    /// \internal[well struct]
    /// \endinternal


    /// \page tutorial4
    /// \details We need to add each well to the C API.
    /// To do this we need to specify the relevant cells the well will be located in (\C well_cells).
    /// \snippet tutorial4.cpp well cells
    /// \internal[well cells]
    for (int i = 0; i < num_wells; ++i) {
        const int well_cells = i*nx;
        const double well_index = 1;
        const int sat_table_id = -1;
        std::stringstream well_name;
        well_name << "well" << i;
        bool allowCrossFlow = true;
        add_well(PRODUCER, 0, 1, NULL, &well_cells, &well_index, &sat_table_id,
                 well_name.str().c_str(), allowCrossFlow, wells);
    }
    /// \internal[well cells]
    /// \endinternal

    /// \page tutorial4
    /// \details We need to make the well collection aware of our wells object
    /// \snippet tutorial4.cpp set well pointer
    /// \internal[set well pointer]
    well_collection.setWellsPointer(wells);
    /// \internal[set well pointer]
    /// \endinternal

    /// \page tutorial4
    /// We're not using well controls, just group controls, so we need to apply them.
    /// \snippet tutorial4.cpp apply group controls
    /// \internal[apply group controls]
    well_collection.applyGroupControls();
    /// \internal[apply group controls]
    /// \endinternal

    /// \page tutorial4
    /// \details We set up necessary information for the wells
    /// \snippet tutorial4.cpp init wells
    /// \internal[init wells]
    WellState well_state;
    well_state.init(wells, state);
    std::vector<double> well_resflowrates_phase;
    std::vector<double> well_surflowrates_phase;
    std::vector<double> fractional_flows;
    /// \internal[init wells]
    /// \endinternal

    /// \page tutorial4
    /// \details We set up the pressure solver.
    /// \snippet tutorial4.cpp pressure solver
    /// \internal[pressure solver]
    LinearSolverUmfpack linsolver;
    IncompTpfa psolver(grid, props, linsolver,
                       grav, wells, src, bcs.c_bcs());
    /// \internal[pressure solver]
    /// \endinternal


    /// \page tutorial4
    /// \details Loop over the time steps.
    /// \snippet tutorial4.cpp time loop
    /// \internal[time loop]
    for (int i = 0; i < num_time_steps; ++i) {
        /// \internal[time loop]
    /// \endinternal

        /// \page tutorial4
        /// \details We're solving the pressure until the well conditions are met
        ///          or until we reach the maximum number of iterations.
        /// \snippet tutorial4.cpp well iterations
        /// \internal[well iterations]
        const int max_well_iterations = 10;
        int well_iter = 0;
        bool well_conditions_met = false;
        while (!well_conditions_met) {
            /// \internal[well iterations]
	    /// \endinternal

            /// \page tutorial4
            /// \details Solve the pressure equation
            /// \snippet tutorial4.cpp pressure solve
            /// \internal[pressure solve]
            psolver.solve(dt, state, well_state);
	    /// \internal[pressure solve]
	    /// \endinternal

            /// \page tutorial4
            /// \details We compute the new well rates. Notice that we approximate (wrongly) surfflowsrates := resflowsrate
	    /// \snippet tutorial4.cpp compute well rates
	    /// \internal[compute well rates]
            Opm::computeFractionalFlow(props, allcells, state.saturation(), fractional_flows);
            Opm::computePhaseFlowRatesPerWell(*wells, well_state.perfRates(), fractional_flows, well_resflowrates_phase);
            Opm::computePhaseFlowRatesPerWell(*wells, well_state.perfRates(), fractional_flows, well_surflowrates_phase);
            /// \internal[compute well rates]
	    /// \endinternal

            /// \page tutorial4
            /// \details We check if the well conditions are met.
	    /// \snippet tutorial4.cpp check well conditions
	    /// \internal[check well conditions]
            well_conditions_met = well_collection.conditionsMet(well_state.bhp(), well_resflowrates_phase, well_surflowrates_phase);
            ++well_iter;
            if (!well_conditions_met && well_iter == max_well_iterations) {
                OPM_THROW(std::runtime_error, "Conditions not met within " << max_well_iterations<< " iterations.");
            }
        }
        /// \internal[check well conditions]
	/// \endinternal

        /// \page tutorial4
        /// \details  Transport solver
        /// \TODO We must call computeTransportSource() here, since we have wells.
        /// \snippet tutorial4.cpp tranport solver
        /// \internal[tranport solver]
        transport_solver.solve(&porevol[0], &src[0], dt, state);
        /// \internal[tranport solver]
	/// \endinternal

        /// \page tutorial4
        /// \details Write the output to file.
        /// \snippet tutorial4.cpp write output
	/// \internal[write output]
        vtkfilename.str("");
        vtkfilename << "tutorial4-" << std::setw(3) << std::setfill('0') << i << ".vtu";
        std::ofstream vtkfile(vtkfilename.str().c_str());
// 17.03.2016 Temporarily removed while moving functionality to opm-output
#ifdef DISABLE_OUTPUT
        Opm::DataMap dm;
        dm["saturation"] = &state.saturation();
        dm["pressure"] = &state.pressure();
        Opm::writeVtkData(grid, dm, vtkfile);
#endif
    }

    destroy_wells(wells);
}
catch (const std::exception &e) {
    std::cerr << "Program threw an exception: " << e.what() << "\n";
    throw;
}

/// \internal[write output]
/// \endinternal



/// \page tutorial4
/// \section results4 Results.
/// <TABLE>
/// <TR>
/// <TD> \image html tutorial4-000.png </TD>
/// <TD> \image html tutorial4-005.png </TD>
/// </TR>
/// <TR>
/// <TD> \image html tutorial4-010.png </TD>
/// <TD> \image html tutorial4-015.png </TD>
/// </TR>
/// <TR>
/// <TD> \image html tutorial4-019.png </TD>
/// <TD> </TD>
/// </TR>
/// </TABLE>


/// \page tutorial4
/// \details
/// \section completecode4 Complete source code:
/// \include tutorial4.cpp

/// \page tutorial4
/// \details
/// \section pythonscript4 python script to generate figures:
/// \snippet generate_doc_figures.py tutorial4