Import examples/ and opm/ from opm-polymer w/ history

examples/flow_polymer.cpp

@@ -0,0 +1,338 @@
+/*
+  Copyright 2013 SINTEF ICT, Applied Mathematics.
+  Copyright 2014 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/>.
+*/
+#include "config.h"
+
+#include <opm/core/pressure/FlowBCManager.hpp>
+
+#include <opm/core/grid.h>
+#include <opm/core/grid/GridManager.hpp>
+#include <opm/core/wells.h>
+#include <opm/core/wells/WellsManager.hpp>
+#include <opm/common/ErrorMacros.hpp>
+#include <opm/core/simulator/initState.hpp>
+#include <opm/core/simulator/initStateEquil.hpp>
+#include <opm/core/simulator/SimulatorReport.hpp>
+#include <opm/core/simulator/SimulatorTimer.hpp>
+#include <opm/core/utility/miscUtilities.hpp>
+#include <opm/core/utility/parameters/ParameterGroup.hpp>
+#include <opm/core/utility/thresholdPressures.hpp>
+
+#include <opm/material/fluidmatrixinteractions/EclMaterialLawManager.hpp>
+#include <opm/core/props/BlackoilPropertiesBasic.hpp>
+#include <opm/core/props/BlackoilPropertiesFromDeck.hpp>
+#include <opm/core/props/rock/RockCompressibility.hpp>
+
+#include <opm/core/linalg/LinearSolverFactory.hpp>
+#include <opm/autodiff/NewtonIterationBlackoilSimple.hpp>
+#include <opm/autodiff/NewtonIterationBlackoilCPR.hpp>
+
+#include <opm/polymer/PolymerBlackoilState.hpp>
+#include <opm/autodiff/WellStateFullyImplicitBlackoil.hpp>
+#include <opm/autodiff/moduleVersion.hpp>
+
+#include <opm/polymer/fullyimplicit/SimulatorFullyImplicitBlackoilPolymer.hpp>
+#include <opm/polymer/fullyimplicit/PolymerPropsAd.hpp>
+#include <opm/polymer/PolymerProperties.hpp>
+#include <opm/polymer/PolymerInflow.hpp>
+#include <opm/autodiff/BlackoilPropsAdFromDeck.hpp>
+#include <opm/autodiff/BlackoilPropsAdInterface.hpp>
+#include <opm/autodiff/GridHelpers.hpp>
+#include <opm/autodiff/createGlobalCellArray.hpp>
+
+#include <opm/parser/eclipse/OpmLog/OpmLog.hpp>
+#include <opm/parser/eclipse/OpmLog/StreamLog.hpp>
+#include <opm/parser/eclipse/OpmLog/CounterLog.hpp>
+#include <opm/parser/eclipse/Deck/Deck.hpp>
+#include <opm/parser/eclipse/Parser/Parser.hpp>
+#include <opm/parser/eclipse/Parser/ParseMode.hpp>
+#include <opm/parser/eclipse/EclipseState/checkDeck.hpp>
+#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
+
+#include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
+
+#include <memory>
+#include <algorithm>
+#include <iostream>
+#include <vector>
+#include <numeric>
+
+
+namespace
+{
+    void warnIfUnusedParams(const Opm::parameter::ParameterGroup& param)
+    {
+        if (param.anyUnused()) {
+            std::cout << "--------------------   Unused parameters:   --------------------\n";
+            param.displayUsage();
+            std::cout << "----------------------------------------------------------------" << std::endl;
+        }
+    }
+} // anon namespace
+
+
+
+// ----------------- Main program -----------------
+int
+main(int argc, char** argv)
+try
+{
+    using namespace Opm;
+
+    {
+        std::string version = moduleVersionName();
+        std::cout << "**********************************************************************\n";
+        std::cout << "*                                                                    *\n";
+        std::cout << "*                   This is Flow-Polymer (version " << version << ")"
+                  << std::string(18 - version.size(), ' ') << "*\n";
+        std::cout << "*                                                                    *\n";
+        std::cout << "*     Flow-Polymer is a simulator for fully implicit three-phase,    *\n";
+        std::cout << "*    four-component (black-oil + polymer) flow, and is part of OPM.  *\n";
+        std::cout << "*           For more information see http://opm-project.org          *\n";
+        std::cout << "*                                                                    *\n";
+        std::cout << "**********************************************************************\n\n";
+    }
+
+    // Read parameters, see if a deck was specified on the command line.
+    std::cout << "---------------    Reading parameters     ---------------" << std::endl;
+    parameter::ParameterGroup param(argc, argv, false);
+    if (!param.unhandledArguments().empty()) {
+        if (param.unhandledArguments().size() != 1) {
+            OPM_THROW(std::runtime_error, "You can only specify a single input deck on the command line.");
+        } else {
+            param.insertParameter("deck_filename", param.unhandledArguments()[0]);
+        }
+    }
+
+    // We must have an input deck. Grid and props will be read from that.
+    if (!param.has("deck_filename")) {
+        std::cerr << "This program must be run with an input deck.\n"
+            "Specify the deck filename either\n"
+            "    a) as a command line argument by itself\n"
+            "    b) as a command line parameter with the syntax deck_filename=<path to your deck>, or\n"
+            "    c) as a parameter in a parameter file (.param or .xml) passed to the program.\n";
+        OPM_THROW(std::runtime_error, "Input deck required.");
+    }
+
+    std::shared_ptr<GridManager> grid;
+    std::shared_ptr<BlackoilPropertiesFromDeck> props;
+    std::shared_ptr<BlackoilPropsAdFromDeck> new_props;
+    std::shared_ptr<RockCompressibility> rock_comp;
+    PolymerBlackoilState state;
+    // bool check_well_controls = false;
+    // int max_well_control_iterations = 0;
+    double gravity[3] = { 0.0 };
+    std::string deck_filename = param.get<std::string>("deck_filename");
+
+    // Write parameters used for later reference.
+    bool output = param.getDefault("output", true);
+    std::string output_dir;
+    if (output) {
+        // Create output directory if needed.
+        output_dir =
+            param.getDefault("output_dir", std::string("output"));
+        boost::filesystem::path fpath(output_dir);
+        try {
+            create_directories(fpath);
+        }
+        catch (...) {
+            OPM_THROW(std::runtime_error, "Creating directories failed: " << fpath);
+        }
+        // Write simulation parameters.
+        param.writeParam(output_dir + "/simulation.param");
+    }
+
+    std::string logFile = output_dir + "/LOGFILE.txt";
+    Opm::ParserPtr parser(new Opm::Parser());
+    {
+        std::shared_ptr<Opm::StreamLog> streamLog = std::make_shared<Opm::StreamLog>(logFile , Opm::Log::DefaultMessageTypes);
+        std::shared_ptr<Opm::CounterLog> counterLog = std::make_shared<Opm::CounterLog>(Opm::Log::DefaultMessageTypes);
+
+        Opm::OpmLog::addBackend( "STREAM" , streamLog );
+        Opm::OpmLog::addBackend( "COUNTER" , counterLog );
+    }
+
+
+    Opm::DeckConstPtr deck;
+    std::shared_ptr<EclipseState> eclipseState;
+    Opm::ParseMode parseMode({{ ParseMode::PARSE_RANDOM_SLASH , InputError::IGNORE }});
+    try {
+        deck = parser->parseFile(deck_filename , parseMode);
+        Opm::checkDeck(deck);
+        eclipseState.reset(new Opm::EclipseState(deck , parseMode));
+    }
+    catch (const std::invalid_argument& e) {
+        std::cerr << "Failed to create valid ECLIPSESTATE object. See logfile: " << logFile << std::endl;
+        std::cerr << "Exception caught: " << e.what() << std::endl;
+        return EXIT_FAILURE;
+    }
+
+    // Grid init
+    std::vector<double> porv = eclipseState->getDoubleGridProperty("PORV")->getData();
+    grid.reset(new GridManager(eclipseState->getEclipseGrid(), porv));
+    auto &cGrid = *grid->c_grid();
+    const PhaseUsage pu = Opm::phaseUsageFromDeck(deck);
+
+    // Rock and fluid init
+
+    std::vector<int> compressedToCartesianIdx;
+    Opm::createGlobalCellArray(*grid->c_grid(), compressedToCartesianIdx);
+
+    typedef BlackoilPropsAdFromDeck::MaterialLawManager MaterialLawManager;
+    auto materialLawManager = std::make_shared<MaterialLawManager>();
+    materialLawManager->initFromDeck(deck, eclipseState, compressedToCartesianIdx);
+
+    props.reset(new BlackoilPropertiesFromDeck( deck, eclipseState, materialLawManager,
+                                                Opm::UgGridHelpers::numCells(cGrid),
+                                                Opm::UgGridHelpers::globalCell(cGrid),
+                                                Opm::UgGridHelpers::cartDims(cGrid),
+                                                param));
+    new_props.reset(new BlackoilPropsAdFromDeck(deck, eclipseState, materialLawManager, cGrid));
+    const bool polymer = deck->hasKeyword("POLYMER");
+    const bool use_wpolymer = deck->hasKeyword("WPOLYMER");
+    PolymerProperties polymer_props(deck, eclipseState);
+    PolymerPropsAd polymer_props_ad(polymer_props);
+    // check_well_controls = param.getDefault("check_well_controls", false);
+    // max_well_control_iterations = param.getDefault("max_well_control_iterations", 10);
+    // Rock compressibility.
+    rock_comp.reset(new RockCompressibility(deck, eclipseState));
+
+    // Gravity.
+    gravity[2] = deck->hasKeyword("NOGRAV") ? 0.0 : unit::gravity;
+
+    // Init state variables (saturation and pressure).
+    if (param.has("init_saturation")) {
+        initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        initBlackoilSurfvol(*grid->c_grid(), *props, state);
+        enum { Oil = BlackoilPhases::Liquid, Gas = BlackoilPhases::Vapour };
+        if (pu.phase_used[Oil] && pu.phase_used[Gas]) {
+            const int np = props->numPhases();
+            const int nc = grid->c_grid()->number_of_cells;
+            for (int c = 0; c < nc; ++c) {
+                state.gasoilratio()[c] = state.surfacevol()[c*np + pu.phase_pos[Gas]]
+                    / state.surfacevol()[c*np + pu.phase_pos[Oil]];
+            }
+        }
+    } else if (deck->hasKeyword("EQUIL") && props->numPhases() == 3) {
+        state.init(*grid->c_grid(), props->numPhases());
+        const double grav = param.getDefault("gravity", unit::gravity);
+        initStateEquil(*grid->c_grid(), *props, deck, eclipseState, grav, state);
+        state.faceflux().resize(grid->c_grid()->number_of_faces, 0.0);
+    } else {
+        initBlackoilStateFromDeck(*grid->c_grid(), *props, deck, gravity[2], state);
+    }
+
+    // The capillary pressure is scaled in new_props to match the scaled capillary pressure in props.
+    if (deck->hasKeyword("SWATINIT")) {
+        const int nc = grid->c_grid()->number_of_cells;
+        std::vector<int> cells(nc);
+        for (int c = 0; c < nc; ++c) { cells[c] = c; }
+        std::vector<double> pc = state.saturation();
+        props->capPress(nc, state.saturation().data(), cells.data(), pc.data(),NULL);
+        new_props->setSwatInitScaling(state.saturation(),pc);
+    }
+
+    bool use_gravity = (gravity[0] != 0.0 || gravity[1] != 0.0 || gravity[2] != 0.0);
+    const double *grav = use_gravity ? &gravity[0] : 0;
+
+    // Solver for Newton iterations.
+    std::unique_ptr<NewtonIterationBlackoilInterface> fis_solver;
+    if (param.getDefault("use_cpr", true)) {
+        fis_solver.reset(new NewtonIterationBlackoilCPR(param));
+    } else {
+        fis_solver.reset(new NewtonIterationBlackoilSimple(param));
+    }
+
+    Opm::ScheduleConstPtr schedule = eclipseState->getSchedule();
+    Opm::TimeMapConstPtr timeMap(schedule->getTimeMap());
+    SimulatorTimer simtimer;
+
+    // initialize variables
+    simtimer.init(timeMap);
+    if (polymer){
+        if (!use_wpolymer) {
+            OPM_MESSAGE("Warning: simulate polymer injection without WPOLYMER.");
+        } else {
+            if (param.has("polymer_start_days")) {
+                OPM_MESSAGE("Warning: Using WPOLYMER to control injection since it was found in deck."
+                            "You seem to be trying to control it via parameter poly_start_days (etc.) as well.");
+            }
+        }
+    } else {
+        if (use_wpolymer) {
+            OPM_MESSAGE("Warning: use WPOLYMER in a non-polymer scenario.");
+        }
+    }
+
+    bool use_local_perm = param.getDefault("use_local_perm", true);
+    Opm::DerivedGeology geology(*grid->c_grid(), *new_props, eclipseState, use_local_perm, grav);
+
+    std::map<std::pair<int, int>, double> maxDp;
+    computeMaxDp(maxDp, deck, eclipseState, *grid->c_grid(), state, *props, gravity[2]);
+    std::vector<double> threshold_pressures = thresholdPressures(deck, eclipseState, *grid->c_grid(), maxDp);
+
+    Opm::BlackoilOutputWriter
+        outputWriter(cGrid, param, eclipseState, pu,
+                     new_props->permeability());
+
+    SimulatorFullyImplicitBlackoilPolymer<UnstructuredGrid>
+        simulator(param,
+                  *grid->c_grid(),
+                  geology,
+                  *new_props,
+                  polymer_props_ad,
+                  rock_comp->isActive() ? rock_comp.get() : 0,
+                  *fis_solver,
+                  grav,
+                  deck->hasKeyword("DISGAS"),
+                  deck->hasKeyword("VAPOIL"),
+                  polymer,
+                  deck->hasKeyword("PLYSHLOG"),
+                  deck->hasKeyword("SHRATE"),
+                  eclipseState,
+                  outputWriter,
+                  deck,
+                  threshold_pressures);
+
+    if (!schedule->initOnly()){
+        std::cout << "\n\n================ Starting main simulation loop ===============\n"
+                  << std::flush;
+
+        SimulatorReport fullReport = simulator.run(eclipseState, simtimer, state);
+
+        std::cout << "\n\n================    End of simulation     ===============\n\n";
+        fullReport.report(std::cout);
+
+        if (output) {
+            std::string filename = output_dir + "/walltime.txt";
+            std::fstream tot_os(filename.c_str(),std::fstream::trunc | std::fstream::out);
+            fullReport.reportParam(tot_os);
+            warnIfUnusedParams(param);
+        }
+    } else {
+        outputWriter.writeInit( simtimer );
+        std::cout << "\n\n================ Simulation turned off ===============\n" << std::flush;
+    }
+}
+catch (const std::exception &e) {
+    std::cerr << "Program threw an exception: " << e.what() << "\n";
+    throw;
+}
+

examples/sim_poly2p_comp_reorder.cpp

@@ -0,0 +1,318 @@
+/*
+  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/>.
+*/
+
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif // HAVE_CONFIG_H
+
+#include <opm/core/pressure/FlowBCManager.hpp>
+
+#include <opm/core/grid.h>
+#include <opm/core/grid/GridManager.hpp>
+#include <opm/core/wells.h>
+#include <opm/core/wells/WellsManager.hpp>
+#include <opm/common/ErrorMacros.hpp>
+#include <opm/core/simulator/initState.hpp>
+#include <opm/core/simulator/SimulatorReport.hpp>
+#include <opm/core/simulator/SimulatorTimer.hpp>
+#include <opm/core/utility/miscUtilities.hpp>
+#include <opm/core/utility/parameters/ParameterGroup.hpp>
+
+#include <opm/core/props/BlackoilPropertiesBasic.hpp>
+#include <opm/core/props/BlackoilPropertiesFromDeck.hpp>
+#include <opm/core/props/rock/RockCompressibility.hpp>
+
+#include <opm/core/linalg/LinearSolverFactory.hpp>
+
+#include <opm/polymer/PolymerBlackoilState.hpp>
+#include <opm/core/simulator/WellState.hpp>
+#include <opm/polymer/SimulatorCompressiblePolymer.hpp>
+#include <opm/polymer/PolymerInflow.hpp>
+#include <opm/polymer/PolymerProperties.hpp>
+
+#include <opm/parser/eclipse/Parser/Parser.hpp>
+#include <opm/parser/eclipse/Parser/ParseMode.hpp>
+#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
+
+#include <boost/scoped_ptr.hpp>
+#include <boost/filesystem.hpp>
+
+#include <algorithm>
+#include <iostream>
+#include <vector>
+#include <numeric>
+
+
+namespace
+{
+    void warnIfUnusedParams(const Opm::parameter::ParameterGroup& param)
+    {
+        if (param.anyUnused()) {
+            std::cout << "--------------------   Unused parameters:   --------------------\n";
+            param.displayUsage();
+            std::cout << "----------------------------------------------------------------" << std::endl;
+        }
+    }
+} // anon namespace
+
+
+
+// ----------------- Main program -----------------
+int
+main(int argc, char** argv)
+try
+{
+    using namespace Opm;
+
+    std::cout << "\n================    Test program for weakly compressible two-phase flow with polymer    ===============\n\n";
+    parameter::ParameterGroup param(argc, argv, false);
+    std::cout << "---------------    Reading parameters     ---------------" << std::endl;
+
+    // If we have a "deck_filename", grid and props will be read from that.
+    bool use_deck = param.has("deck_filename");
+    boost::scoped_ptr<GridManager> grid;
+    boost::scoped_ptr<BlackoilPropertiesInterface> props;
+    boost::scoped_ptr<RockCompressibility> rock_comp;
+    Opm::DeckConstPtr deck;
+    EclipseStateConstPtr eclipseState;
+    PolymerBlackoilState state;
+    Opm::PolymerProperties poly_props;
+    // bool check_well_controls = false;
+    // int max_well_control_iterations = 0;
+    double gravity[3] = { 0.0 };
+    if (use_deck) {
+        std::string deck_filename = param.get<std::string>("deck_filename");
+        ParserPtr parser(new Opm::Parser());
+        Opm::ParseMode parseMode({{ ParseMode::PARSE_RANDOM_SLASH , InputError::IGNORE }});
+        deck = parser->parseFile(deck_filename , parseMode);
+        eclipseState.reset(new Opm::EclipseState(deck , parseMode));
+
+        // Grid init
+        grid.reset(new GridManager(deck));
+        // Rock and fluid init
+        props.reset(new BlackoilPropertiesFromDeck(deck, eclipseState, *grid->c_grid()));
+        // check_well_controls = param.getDefault("check_well_controls", false);
+        // max_well_control_iterations = param.getDefault("max_well_control_iterations", 10);
+        // Rock compressibility.
+        rock_comp.reset(new RockCompressibility(deck, eclipseState));
+        // Gravity.
+        gravity[2] = deck->hasKeyword("NOGRAV") ? 0.0 : unit::gravity;
+        // Init state variables (saturation and pressure).
+        if (param.has("init_saturation")) {
+            initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        } else {
+            initStateFromDeck(*grid->c_grid(), *props, deck, gravity[2], state);
+        }
+        initBlackoilSurfvol(*grid->c_grid(), *props, state);
+        // Init polymer properties.
+        poly_props.readFromDeck(deck, eclipseState);
+    } else {
+        // Grid init.
+        const int nx = param.getDefault("nx", 100);
+        const int ny = param.getDefault("ny", 100);
+        const int nz = param.getDefault("nz", 1);
+        const double dx = param.getDefault("dx", 1.0);
+        const double dy = param.getDefault("dy", 1.0);
+        const double dz = param.getDefault("dz", 1.0);
+        grid.reset(new GridManager(nx, ny, nz, dx, dy, dz));
+        // Rock and fluid init.
+        props.reset(new BlackoilPropertiesBasic(param, grid->c_grid()->dimensions, grid->c_grid()->number_of_cells));
+        // Rock compressibility.
+        rock_comp.reset(new RockCompressibility(param));
+        // Gravity.
+        gravity[2] = param.getDefault("gravity", 0.0);
+        // Init state variables (saturation and pressure).
+        initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        initBlackoilSurfvol(*grid->c_grid(), *props, state);
+        // Init Polymer state
+        if (param.has("poly_init")) {
+            double poly_init = param.getDefault("poly_init", 0.0);
+            for (int cell = 0; cell < grid->c_grid()->number_of_cells; ++cell) {
+                double smin[2], smax[2];
+                props->satRange(1, &cell, smin, smax);
+                if (state.saturation()[2*cell] > 0.5*(smin[0] + smax[0])) {
+                    state.concentration()[cell] = poly_init;
+                    state.maxconcentration()[cell] = poly_init;
+                } else {
+                    state.saturation()[2*cell + 0] = 0.;
+                    state.saturation()[2*cell + 1] = 1.;
+                    state.concentration()[cell] = 0.;
+                    state.maxconcentration()[cell] = 0.;
+                }
+            }
+        }
+        // Init polymer properties.
+        // Setting defaults to provide a simple example case.
+        double c_max = param.getDefault("c_max_limit", 5.0);
+        double mix_param = param.getDefault("mix_param", 1.0);
+        double rock_density = param.getDefault("rock_density", 1000.0);
+        double dead_pore_vol = param.getDefault("dead_pore_vol", 0.15);
+        double res_factor = param.getDefault("res_factor", 1.) ; // res_factor = 1 gives no change in permeability
+        double c_max_ads = param.getDefault("c_max_ads", 1.);
+        int ads_index = param.getDefault<int>("ads_index", Opm::PolymerProperties::NoDesorption);
+        std::vector<double> c_vals_visc(2, -1e100);
+        c_vals_visc[0] = 0.0;
+        c_vals_visc[1] = 7.0;
+        std::vector<double> visc_mult_vals(2, -1e100);
+        visc_mult_vals[0] = 1.0;
+        // poly_props.visc_mult_vals[1] = param.getDefault("c_max_viscmult", 30.0);
+        visc_mult_vals[1] = 20.0;
+        std::vector<double> c_vals_ads(3, -1e100);
+        c_vals_ads[0] = 0.0;
+        c_vals_ads[1] = 2.0;
+        c_vals_ads[2] = 8.0;
+        std::vector<double> ads_vals(3, -1e100);
+        ads_vals[0] = 0.0;
+        ads_vals[1] = 0.0015;
+        ads_vals[2] = 0.0025;
+        // ads_vals[1] = 0.0;
+        // ads_vals[2] = 0.0;
+        std::vector<double> water_vel_vals(2, -1e100);
+        water_vel_vals[0] = 0.0;
+        water_vel_vals[1] = 10.0;
+        std::vector<double> shear_vrf_vals(2, -1e100);
+        shear_vrf_vals[0] = 1.0;
+        shear_vrf_vals[1] = 1.0;
+        poly_props.set(c_max, mix_param, rock_density, dead_pore_vol, res_factor, c_max_ads,
+                       static_cast<Opm::PolymerProperties::AdsorptionBehaviour>(ads_index),
+                       c_vals_visc,  visc_mult_vals, c_vals_ads, ads_vals, water_vel_vals, shear_vrf_vals);
+    }
+
+    bool use_gravity = (gravity[0] != 0.0 || gravity[1] != 0.0 || gravity[2] != 0.0);
+    const double *grav = use_gravity ? &gravity[0] : 0;
+
+    // Linear solver.
+    LinearSolverFactory linsolver(param);
+
+    // Write parameters used for later reference.
+    bool output = param.getDefault("output", true);
+    if (output) {
+      std::string output_dir =
+        param.getDefault("output_dir", std::string("output"));
+      boost::filesystem::path fpath(output_dir);
+      try {
+        create_directories(fpath);
+      }
+      catch (...) {
+        OPM_THROW(std::runtime_error, "Creating directories failed: " << fpath);
+      }
+      param.writeParam(output_dir + "/simulation.param");
+    }
+
+
+    std::cout << "\n\n================    Starting main simulation loop     ===============\n"
+              << std::flush;
+
+    SimulatorReport rep;
+    if (!use_deck) {
+        // Simple simulation without a deck.
+        PolymerInflowBasic polymer_inflow(param.getDefault("poly_start_days", 300.0)*Opm::unit::day,
+                                          param.getDefault("poly_end_days", 800.0)*Opm::unit::day,
+                                          param.getDefault("poly_amount", poly_props.cMax()));
+        WellsManager wells;
+        SimulatorCompressiblePolymer simulator(param,
+                                               *grid->c_grid(),
+                                               *props,
+                                               poly_props,
+                                               rock_comp->isActive() ? rock_comp.get() : 0,
+                                               wells,
+                                               polymer_inflow,
+                                               linsolver,
+                                               grav);
+        SimulatorTimer simtimer;
+        simtimer.init(param);
+        warnIfUnusedParams(param);
+        WellState well_state;
+        well_state.init(0, state);
+        rep = simulator.run(simtimer, state, well_state);
+    } else {
+        // With a deck, we may have more epochs etc.
+        WellState well_state;
+        int step = 0;
+        Opm::TimeMapPtr timeMap(new Opm::TimeMap(deck));
+        SimulatorTimer simtimer;
+        simtimer.init(timeMap);
+        // Check for WPOLYMER presence in last report step to decide
+        // polymer injection control type.
+        const bool use_wpolymer = deck->hasKeyword("WPOLYMER");
+        if (use_wpolymer) {
+            if (param.has("poly_start_days")) {
+                OPM_MESSAGE("Warning: Using WPOLYMER to control injection since it was found in deck. "
+                        "You seem to be trying to control it via parameter poly_start_days (etc.) as well.");
+            }
+        }
+        for (size_t reportStepIdx = 0; reportStepIdx < timeMap->numTimesteps(); ++reportStepIdx) {
+            simtimer.setCurrentStepNum(reportStepIdx);
+
+            // Report on start of report step.
+            std::cout << "\n\n--------------    Starting report step " << reportStepIdx << "    --------------"
+                      << "\n                  (number of remaining steps: "
+                      << simtimer.numSteps() - step << ")\n\n" << std::flush;
+
+            // Create new wells, polymer inflow controls.
+            WellsManager wells(eclipseState , reportStepIdx , *grid->c_grid(), props->permeability());
+            boost::scoped_ptr<PolymerInflowInterface> polymer_inflow;
+            if (use_wpolymer) {
+                if (wells.c_wells() == 0) {
+                    OPM_THROW(std::runtime_error, "Cannot control polymer injection via WPOLYMER without wells.");
+                }
+                polymer_inflow.reset(new PolymerInflowFromDeck(deck, eclipseState, *wells.c_wells(), props->numCells(), simtimer.currentStepNum()));
+            } else {
+                polymer_inflow.reset(new PolymerInflowBasic(param.getDefault("poly_start_days", 300.0)*Opm::unit::day,
+                                                            param.getDefault("poly_end_days", 800.0)*Opm::unit::day,
+                                                            param.getDefault("poly_amount", poly_props.cMax())));
+            }
+
+            // @@@ HACK: we should really make a new well state and
+            // properly transfer old well state to it every report step,
+            // since number of wells may change etc.
+            if (reportStepIdx == 0) {
+                well_state.init(wells.c_wells(), state);
+            }
+
+            // Create and run simulator.
+            SimulatorCompressiblePolymer simulator(param,
+                                                   *grid->c_grid(),
+                                                   *props,
+                                                   poly_props,
+                                                   rock_comp->isActive() ? rock_comp.get() : 0,
+                                                   wells,
+                                                   *polymer_inflow,
+                                                   linsolver,
+                                                   grav);
+            if (reportStepIdx == 0) {
+                warnIfUnusedParams(param);
+            }
+            SimulatorReport epoch_rep = simulator.run(simtimer, state, well_state);
+
+            // Update total timing report and remember step number.
+            rep += epoch_rep;
+            step = simtimer.currentStepNum();
+        }
+    }
+
+    std::cout << "\n\n================    End of simulation     ===============\n\n";
+    rep.report(std::cout);
+}
+catch (const std::exception &e) {
+    std::cerr << "Program threw an exception: " << e.what() << "\n";
+    throw;
+}
+

examples/sim_poly2p_incomp_reorder.cpp

@@ -0,0 +1,356 @@
+/*
+  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/>.
+*/
+
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif // HAVE_CONFIG_H
+
+#include <opm/core/pressure/FlowBCManager.hpp>
+
+#include <opm/core/grid.h>
+#include <opm/core/grid/GridManager.hpp>
+#include <opm/core/wells.h>
+#include <opm/core/wells/WellsManager.hpp>
+#include <opm/common/ErrorMacros.hpp>
+#include <opm/core/simulator/initState.hpp>
+#include <opm/core/simulator/SimulatorReport.hpp>
+#include <opm/core/simulator/SimulatorTimer.hpp>
+#include <opm/core/utility/miscUtilities.hpp>
+#include <opm/core/utility/parameters/ParameterGroup.hpp>
+
+#include <opm/core/props/IncompPropertiesBasic.hpp>
+#include <opm/core/props/IncompPropertiesFromDeck.hpp>
+#include <opm/core/props/rock/RockCompressibility.hpp>
+
+#include <opm/core/linalg/LinearSolverFactory.hpp>
+
+#include <opm/polymer/PolymerState.hpp>
+#include <opm/core/simulator/WellState.hpp>
+#include <opm/polymer/SimulatorPolymer.hpp>
+#include <opm/polymer/PolymerInflow.hpp>
+#include <opm/polymer/PolymerProperties.hpp>
+
+#include <opm/parser/eclipse/Parser/Parser.hpp>
+#include <opm/parser/eclipse/Parser/ParseMode.hpp>
+#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
+
+#include <boost/scoped_ptr.hpp>
+#include <boost/filesystem.hpp>
+
+#include <algorithm>
+#include <iostream>
+#include <vector>
+#include <numeric>
+
+
+namespace
+{
+    void warnIfUnusedParams(const Opm::parameter::ParameterGroup& param)
+    {
+        if (param.anyUnused()) {
+            std::cout << "--------------------   Unused parameters:   --------------------\n";
+            param.displayUsage();
+            std::cout << "----------------------------------------------------------------" << std::endl;
+        }
+    }
+} // anon namespace
+
+
+
+// ----------------- Main program -----------------
+int
+main(int argc, char** argv)
+try
+{
+    using namespace Opm;
+
+    std::cout << "\n================    Test program for incompressible two-phase flow with polymer    ===============\n\n";
+    parameter::ParameterGroup param(argc, argv, false);
+    std::cout << "---------------    Reading parameters     ---------------" << std::endl;
+
+    // If we have a "deck_filename", grid and props will be read from that.
+    bool use_deck = param.has("deck_filename");
+    Opm::DeckConstPtr deck;
+    boost::scoped_ptr<GridManager> grid;
+    boost::scoped_ptr<IncompPropertiesInterface> props;
+    boost::scoped_ptr<RockCompressibility> rock_comp;
+    EclipseStateConstPtr eclipseState;
+    PolymerState state;
+    Opm::PolymerProperties poly_props;
+    // bool check_well_controls = false;
+    // int max_well_control_iterations = 0;
+    double gravity[3] = { 0.0 };
+    if (use_deck) {
+        std::string deck_filename = param.get<std::string>("deck_filename");
+        Opm::ParseMode parseMode({{ ParseMode::PARSE_RANDOM_SLASH , InputError::IGNORE }});
+        ParserPtr parser(new Opm::Parser());
+        deck = parser->parseFile(deck_filename , parseMode);
+        eclipseState.reset(new Opm::EclipseState(deck , parseMode));
+
+        // Grid init
+        grid.reset(new GridManager(deck));
+        // Rock and fluid init
+        props.reset(new IncompPropertiesFromDeck(deck, eclipseState, *grid->c_grid()));
+        // check_well_controls = param.getDefault("check_well_controls", false);
+        // max_well_control_iterations = param.getDefault("max_well_control_iterations", 10);
+        // Rock compressibility.
+        rock_comp.reset(new RockCompressibility(deck, eclipseState));
+        // Gravity.
+        gravity[2] = deck->hasKeyword("NOGRAV") ? 0.0 : unit::gravity;
+        // Init state variables (saturation and pressure).
+        if (param.has("init_saturation")) {
+            initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        } else {
+            initStateFromDeck(*grid->c_grid(), *props, deck, gravity[2], state);
+        }
+        // Init polymer properties.
+        poly_props.readFromDeck(deck, eclipseState);
+    } else {
+        // Grid init.
+        const int nx = param.getDefault("nx", 100);
+        const int ny = param.getDefault("ny", 100);
+        const int nz = param.getDefault("nz", 1);
+        const double dx = param.getDefault("dx", 1.0);
+        const double dy = param.getDefault("dy", 1.0);
+        const double dz = param.getDefault("dz", 1.0);
+        grid.reset(new GridManager(nx, ny, nz, dx, dy, dz));
+        // Rock and fluid init.
+        props.reset(new IncompPropertiesBasic(param, grid->c_grid()->dimensions, grid->c_grid()->number_of_cells));
+        // Rock compressibility.
+        rock_comp.reset(new RockCompressibility(param));
+        // Gravity.
+        gravity[2] = param.getDefault("gravity", 0.0);
+        // Init state variables (saturation and pressure).
+        initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        // Init Polymer state
+        if (param.has("poly_init")) {
+            double poly_init = param.getDefault("poly_init", 0.0);
+            for (int cell = 0; cell < grid->c_grid()->number_of_cells; ++cell) {
+                double smin[2], smax[2];
+                props->satRange(1, &cell, smin, smax);
+                if (state.saturation()[2*cell] > 0.5*(smin[0] + smax[0])) {
+                    state.concentration()[cell] = poly_init;
+                    state.maxconcentration()[cell] = poly_init;
+                } else {
+                    state.saturation()[2*cell + 0] = 0.;
+                    state.saturation()[2*cell + 1] = 1.;
+                    state.concentration()[cell] = 0.;
+                    state.maxconcentration()[cell] = 0.;
+                }
+            }
+        }
+        // Init polymer properties.
+        // Setting defaults to provide a simple example case.
+        double c_max = param.getDefault("c_max_limit", 5.0);
+        double mix_param = param.getDefault("mix_param", 1.0);
+        double rock_density = param.getDefault("rock_density", 1000.0);
+        double dead_pore_vol = param.getDefault("dead_pore_vol", 0.15);
+        double res_factor = param.getDefault("res_factor", 1.) ; // res_factor = 1 gives no change in permeability
+        double c_max_ads = param.getDefault("c_max_ads", 1.);
+        int ads_index = param.getDefault<int>("ads_index", Opm::PolymerProperties::NoDesorption);
+        std::vector<double> c_vals_visc(2, -1e100);
+        c_vals_visc[0] = 0.0;
+        c_vals_visc[1] = 7.0;
+        std::vector<double> visc_mult_vals(2, -1e100);
+        visc_mult_vals[0] = 1.0;
+        // poly_props.visc_mult_vals[1] = param.getDefault("c_max_viscmult", 30.0);
+        visc_mult_vals[1] = 20.0;
+        std::vector<double> c_vals_ads(3, -1e100);
+        c_vals_ads[0] = 0.0;
+        c_vals_ads[1] = 2.0;
+        c_vals_ads[2] = 8.0;
+        std::vector<double> ads_vals(3, -1e100);
+        ads_vals[0] = 0.0;
+        ads_vals[1] = 0.0015;
+        ads_vals[2] = 0.0025;
+        // ads_vals[1] = 0.0;
+        // ads_vals[2] = 0.0;
+        std::vector<double> water_vel_vals(2, -1e100);
+        water_vel_vals[0] = 0.0;
+        water_vel_vals[1] = 10.0;
+        std::vector<double> shear_vrf_vals(2, -1e100);
+        shear_vrf_vals[0] = 1.0;
+        shear_vrf_vals[1] = 1.0;
+        poly_props.set(c_max, mix_param, rock_density, dead_pore_vol, res_factor, c_max_ads,
+                       static_cast<Opm::PolymerProperties::AdsorptionBehaviour>(ads_index),
+                       c_vals_visc,  visc_mult_vals, c_vals_ads, ads_vals, water_vel_vals, shear_vrf_vals);
+    }
+
+    // Warn if gravity but no density difference.
+    bool use_gravity = (gravity[0] != 0.0 || gravity[1] != 0.0 || gravity[2] != 0.0);
+    if (use_gravity) {
+        if (props->density()[0] == props->density()[1]) {
+            std::cout << "**** Warning: nonzero gravity, but zero density difference." << std::endl;
+        }
+    }
+    const double *grav = use_gravity ? &gravity[0] : 0;
+
+    // Initialising src
+    int num_cells = grid->c_grid()->number_of_cells;
+    std::vector<double> src(num_cells, 0.0);
+    if (use_deck) {
+        // Do nothing, wells will be the driving force, not source terms.
+    } else {
+        // Compute pore volumes, in order to enable specifying injection rate
+        // terms of total pore volume.
+        std::vector<double> porevol;
+        if (rock_comp->isActive()) {
+            computePorevolume(*grid->c_grid(), props->porosity(), *rock_comp, state.pressure(), porevol);
+        } else {
+            computePorevolume(*grid->c_grid(), props->porosity(), porevol);
+        }
+        const double tot_porevol_init = std::accumulate(porevol.begin(), porevol.end(), 0.0);
+        const double default_injection = use_gravity ? 0.0 : 0.1;
+        const double flow_per_sec = param.getDefault<double>("injected_porevolumes_per_day", default_injection)
+            *tot_porevol_init/unit::day;
+        src[0] = flow_per_sec;
+        src[num_cells - 1] = -flow_per_sec;
+    }
+
+    // Boundary conditions.
+    FlowBCManager bcs;
+    if (param.getDefault("use_pside", false)) {
+        int pside = param.get<int>("pside");
+        double pside_pressure = param.get<double>("pside_pressure");
+        bcs.pressureSide(*grid->c_grid(), FlowBCManager::Side(pside), pside_pressure);
+    }
+
+    // Linear solver.
+    LinearSolverFactory linsolver(param);
+
+    // Write parameters used for later reference.
+    bool output = param.getDefault("output", true);
+    if (output) {
+      std::string output_dir =
+        param.getDefault("output_dir", std::string("output"));
+      boost::filesystem::path fpath(output_dir);
+      try {
+        create_directories(fpath);
+      }
+      catch (...) {
+        OPM_THROW(std::runtime_error, "Creating directories failed: " << fpath);
+      }
+      param.writeParam(output_dir + "/simulation.param");
+    }
+
+
+    std::cout << "\n\n================    Starting main simulation loop     ===============\n"
+              << std::flush;
+
+    SimulatorReport rep;
+    if (!use_deck) {
+        // Simple simulation without a deck.
+        PolymerInflowBasic polymer_inflow(param.getDefault("poly_start_days", 300.0)*Opm::unit::day,
+                                          param.getDefault("poly_end_days", 800.0)*Opm::unit::day,
+                                          param.getDefault("poly_amount", poly_props.cMax()));
+        WellsManager wells;
+        SimulatorPolymer simulator(param,
+                                   *grid->c_grid(),
+                                   *props,
+                                   poly_props,
+                                   rock_comp->isActive() ? rock_comp.get() : 0,
+                                   wells,
+                                   polymer_inflow,
+                                   src,
+                                   bcs.c_bcs(),
+                                   linsolver,
+                                   grav);
+        SimulatorTimer simtimer;
+        simtimer.init(param);
+        warnIfUnusedParams(param);
+        WellState well_state;
+        well_state.init(0, state);
+        rep = simulator.run(simtimer, state, well_state);
+    } else {
+        // With a deck, we may have more epochs etc.
+
+        WellState well_state;
+        int step = 0;
+        Opm::TimeMapPtr timeMap(new Opm::TimeMap(deck));
+        SimulatorTimer simtimer;
+        simtimer.init(timeMap);
+        // Check for WPOLYMER presence in last epoch to decide
+        // polymer injection control type.
+        const bool use_wpolymer = deck->hasKeyword("WPOLYMER");
+        if (use_wpolymer) {
+            if (param.has("poly_start_days")) {
+                OPM_MESSAGE("Warning: Using WPOLYMER to control injection since it was found in deck. "
+                        "You seem to be trying to control it via parameter poly_start_days (etc.) as well.");
+            }
+        }
+        for (size_t reportStepIdx = 0; reportStepIdx < timeMap->numTimesteps(); ++reportStepIdx) {
+            simtimer.setCurrentStepNum(reportStepIdx);
+
+            // Report on start of report step.
+            std::cout << "\n\n--------------    Starting report step " << reportStepIdx << "    --------------"
+                      << "\n                  (number of remaining steps: "
+                      << simtimer.numSteps() - step << ")\n\n" << std::flush;
+
+            // Create new wells, polymer inflow controls.
+            WellsManager wells(eclipseState , reportStepIdx , *grid->c_grid(), props->permeability());
+            boost::scoped_ptr<PolymerInflowInterface> polymer_inflow;
+            if (use_wpolymer) {
+                if (wells.c_wells() == 0) {
+                    OPM_THROW(std::runtime_error, "Cannot control polymer injection via WPOLYMER without wells.");
+                }
+                polymer_inflow.reset(new PolymerInflowFromDeck(deck, eclipseState, *wells.c_wells(), props->numCells(), simtimer.currentStepNum()));
+            } else {
+                polymer_inflow.reset(new PolymerInflowBasic(param.getDefault("poly_start_days", 300.0)*Opm::unit::day,
+                                                            param.getDefault("poly_end_days", 800.0)*Opm::unit::day,
+                                                            param.getDefault("poly_amount", poly_props.cMax())));
+            }
+
+            // @@@ HACK: we should really make a new well state and
+            // properly transfer old well state to it every report step,
+            // since number of wells may change etc.
+            if (reportStepIdx == 0) {
+                well_state.init(wells.c_wells(), state);
+            }
+
+            // Create and run simulator.
+            SimulatorPolymer simulator(param,
+                                       *grid->c_grid(),
+                                       *props,
+                                       poly_props,
+                                       rock_comp->isActive() ? rock_comp.get() : 0,
+                                       wells,
+                                       *polymer_inflow,
+                                       src,
+                                       bcs.c_bcs(),
+                                       linsolver,
+                                       grav);
+            if (reportStepIdx == 0) {
+                warnIfUnusedParams(param);
+            }
+            SimulatorReport epoch_rep = simulator.run(simtimer, state, well_state);
+
+            // Update total timing report and remember step number.
+            rep += epoch_rep;
+            step = simtimer.currentStepNum();
+        }
+    }
+
+    std::cout << "\n\n================    End of simulation     ===============\n\n";
+    rep.report(std::cout);
+}
+catch (const std::exception &e) {
+    std::cerr << "Program threw an exception: " << e.what() << "\n";
+    throw;
+}

examples/sim_poly_fi2p_comp_ad.cpp

@@ -0,0 +1,274 @@
+/*
+  Copyright 2014 SINTEF ICT, Applied Mathematics.
+  Copyright 2014 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/>.
+*/
+
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif // HAVE_CONFIG_H
+
+#include <opm/core/pressure/FlowBCManager.hpp>
+
+#include <opm/core/grid.h>
+#include <opm/core/grid/GridManager.hpp>
+#include <opm/core/wells.h>
+#include <opm/core/wells/WellsManager.hpp>
+#include <opm/common/ErrorMacros.hpp>
+#include <opm/core/simulator/initState.hpp>
+#include <opm/core/simulator/SimulatorReport.hpp>
+#include <opm/core/simulator/SimulatorTimer.hpp>
+#include <opm/core/utility/miscUtilities.hpp>
+#include <opm/core/utility/parameters/ParameterGroup.hpp>
+
+#include <opm/material/fluidmatrixinteractions/EclMaterialLawManager.hpp>
+#include <opm/core/io/eclipse/EclipseWriter.hpp>
+#include <opm/core/props/BlackoilPropertiesBasic.hpp>
+#include <opm/core/props/BlackoilPropertiesFromDeck.hpp>
+#include <opm/core/props/rock/RockCompressibility.hpp>
+
+#include <opm/core/linalg/LinearSolverFactory.hpp>
+#include <opm/autodiff/NewtonIterationBlackoilSimple.hpp>
+#include <opm/autodiff/NewtonIterationBlackoilCPR.hpp>
+#include <opm/autodiff/createGlobalCellArray.hpp>
+
+#include <opm/polymer/PolymerBlackoilState.hpp>
+#include <opm/core/simulator/WellState.hpp>
+
+#include <opm/polymer/fullyimplicit/SimulatorFullyImplicitCompressiblePolymer.hpp>
+#include <opm/polymer/fullyimplicit/PolymerPropsAd.hpp>
+#include <opm/polymer/PolymerProperties.hpp>
+#include <opm/polymer/PolymerInflow.hpp>
+#include <opm/polymer/PolymerState.hpp>
+
+#include <opm/autodiff/BlackoilPropsAdFromDeck.hpp>
+#include <opm/autodiff/BlackoilPropsAdInterface.hpp>
+#include <opm/autodiff/GeoProps.hpp>
+#include <opm/autodiff/GridHelpers.hpp>
+
+#include <opm/parser/eclipse/OpmLog/OpmLog.hpp>
+#include <opm/parser/eclipse/OpmLog/StreamLog.hpp>
+#include <opm/parser/eclipse/OpmLog/CounterLog.hpp>
+#include <opm/parser/eclipse/Deck/Deck.hpp>
+#include <opm/parser/eclipse/Parser/Parser.hpp>
+#include <opm/parser/eclipse/Parser/ParseMode.hpp>
+#include <opm/parser/eclipse/EclipseState/checkDeck.hpp>
+#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>
+
+#include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
+
+#include <memory>
+#include <algorithm>
+#include <iostream>
+#include <vector>
+#include <numeric>
+
+
+namespace
+{
+    void warnIfUnusedParams(const Opm::parameter::ParameterGroup& param)
+    {
+        if (param.anyUnused()) {
+            std::cout << "--------------------   Unused parameters:   --------------------\n";
+            param.displayUsage();
+            std::cout << "----------------------------------------------------------------" << std::endl;
+        }
+    }
+} // anon namespace
+
+
+
+// ----------------- Main program -----------------
+int
+main(int argc, char** argv)
+try
+{
+    using namespace Opm;
+
+    std::cout << "\n================    Test program for fully implicit three-phase black-oil flow     ===============\n\n";
+    parameter::ParameterGroup param(argc, argv, false);
+    std::cout << "---------------    Reading parameters     ---------------" << std::endl;
+
+    // If we have a "deck_filename", grid and props will be read from that.
+    bool use_deck = param.has("deck_filename");
+    if (!use_deck) {
+        OPM_THROW(std::runtime_error, "This program must be run with an input deck. "
+                  "Specify the deck with deck_filename=deckname.data (for example).");
+    }
+    std::shared_ptr<GridManager> grid;
+    std::shared_ptr<BlackoilPropertiesInterface> props;
+    std::shared_ptr<BlackoilPropsAdInterface> new_props;
+    std::shared_ptr<RockCompressibility> rock_comp;
+    PolymerBlackoilState state;
+    // bool check_well_controls = false;
+    // int max_well_control_iterations = 0;
+    double gravity[3] = { 0.0 };
+    std::string deck_filename = param.get<std::string>("deck_filename");
+
+    // Write parameters used for later reference.
+    bool output = param.getDefault("output", true);
+    std::string output_dir;
+    if (output) {
+        // Create output directory if needed.
+        output_dir =
+            param.getDefault("output_dir", std::string("output"));
+        boost::filesystem::path fpath(output_dir);
+        try {
+            create_directories(fpath);
+        }
+        catch (...) {
+            std::cerr << "Creating directories failed: " << fpath << std::endl;
+            return EXIT_FAILURE;
+        }
+        // Write simulation parameters.
+        param.writeParam(output_dir + "/simulation.param");
+    }
+
+    std::string logFile = output_dir + "/LOGFILE.txt";
+    Opm::ParseMode parseMode({{ ParseMode::PARSE_RANDOM_SLASH , InputError::IGNORE }});
+    Opm::ParserPtr parser(new Opm::Parser());
+    {
+        std::shared_ptr<Opm::StreamLog> streamLog = std::make_shared<Opm::StreamLog>(logFile , Opm::Log::DefaultMessageTypes);
+        std::shared_ptr<Opm::CounterLog> counterLog = std::make_shared<Opm::CounterLog>(Opm::Log::DefaultMessageTypes);
+
+        Opm::OpmLog::addBackend( "STREAM" , streamLog );
+        Opm::OpmLog::addBackend( "COUNTER" , counterLog );
+    }
+
+    Opm::DeckConstPtr deck;
+    std::shared_ptr<EclipseState> eclipseState;
+    try {
+        deck = parser->parseFile(deck_filename , parseMode);
+        Opm::checkDeck(deck);
+        eclipseState.reset(new Opm::EclipseState(deck , parseMode));
+    }
+    catch (const std::invalid_argument& e) {
+        std::cerr << "Failed to create valid ECLIPSESTATE object. See logfile: " << logFile << std::endl;
+        std::cerr << "Exception caught: " << e.what() << std::endl;
+        return EXIT_FAILURE;
+    }
+
+    // Grid init
+    std::vector<double> porv;
+    if (eclipseState->hasDoubleGridProperty("PORV")) {
+        porv = eclipseState->getDoubleGridProperty("PORV")->getData();
+    }
+    grid.reset(new GridManager(eclipseState->getEclipseGrid(), porv));
+    auto &cGrid = *grid->c_grid();
+    const PhaseUsage pu = Opm::phaseUsageFromDeck(deck);
+
+    // Rock and fluid init
+
+    std::vector<int> compressedToCartesianIdx;
+    Opm::createGlobalCellArray(*grid->c_grid(), compressedToCartesianIdx);
+
+    typedef BlackoilPropsAdFromDeck::MaterialLawManager MaterialLawManager;
+    auto materialLawManager = std::make_shared<MaterialLawManager>();
+    materialLawManager->initFromDeck(deck, eclipseState, compressedToCartesianIdx);
+
+    props.reset(new BlackoilPropertiesFromDeck( deck, eclipseState, materialLawManager,
+                                                Opm::UgGridHelpers::numCells(cGrid),
+                                                Opm::UgGridHelpers::globalCell(cGrid),
+                                                Opm::UgGridHelpers::cartDims(cGrid),
+                                                param));
+    new_props.reset(new BlackoilPropsAdFromDeck(deck, eclipseState, materialLawManager, cGrid));
+    PolymerProperties polymer_props(deck, eclipseState);
+    PolymerPropsAd polymer_props_ad(polymer_props);
+
+    // Rock compressibility.
+    rock_comp.reset(new RockCompressibility(deck, eclipseState));
+
+    // Gravity.
+    gravity[2] = deck->hasKeyword("NOGRAV") ? 0.0 : unit::gravity;
+
+    // Init state variables (saturation and pressure).
+    if (param.has("init_saturation")) {
+        initStateBasic(*grid->c_grid(), *props, param, gravity[2], state);
+        initBlackoilSurfvol(*grid->c_grid(), *props, state);
+    } else {
+        initStateFromDeck(*grid->c_grid(), *props, deck, gravity[2], state);
+    }
+
+    bool use_gravity = (gravity[0] != 0.0 || gravity[1] != 0.0 || gravity[2] != 0.0);
+    const double *grav = use_gravity ? &gravity[0] : 0;
+    // Solver for Newton iterations.
+    std::unique_ptr<NewtonIterationBlackoilInterface> fis_solver;
+    if (param.getDefault("use_cpr", true)) {
+        fis_solver.reset(new NewtonIterationBlackoilCPR(param));
+    } else {
+        fis_solver.reset(new NewtonIterationBlackoilSimple(param));
+    }
+
+    Opm::TimeMapConstPtr timeMap(eclipseState->getSchedule()->getTimeMap());
+    SimulatorTimer simtimer;
+    simtimer.init(timeMap);
+
+
+    SimulatorReport rep;
+    // With a deck, we may have more epochs etc.
+    WellState well_state;
+    // Check for WPOLYMER presence in last epoch to decide
+    // polymer injection control type.
+    const bool use_wpolymer = deck->hasKeyword("WPOLYMER");
+    if (use_wpolymer) {
+        if (param.has("poly_start_days")) {
+            OPM_MESSAGE("Warning: Using WPOLYMER to control injection since it was found in deck. "
+                        "You seem to be trying to control it via parameter poly_start_days (etc.) as well.");
+        }
+    }
+    std::cout << "\n\n================    Starting main simulation loop     ===============\n"
+              << std::flush;
+
+    Opm::BlackoilOutputWriter
+        outputWriter(cGrid, param, eclipseState, pu,
+                     new_props->permeability());
+
+    SimulatorReport fullReport;
+    // Create and run simulator.
+    Opm::DerivedGeology geology(*grid->c_grid(), *new_props, eclipseState, grav);
+    SimulatorFullyImplicitCompressiblePolymer<UnstructuredGrid>
+        simulator(param,
+                  *grid->c_grid(),
+                  geology,
+                  *new_props,
+                  polymer_props_ad,
+                  rock_comp->isActive() ? rock_comp.get() : 0,
+                  eclipseState,
+                  outputWriter,
+                  deck,
+                  *fis_solver,
+                  grav);
+    fullReport= simulator.run(eclipseState, simtimer, state);
+
+    std::cout << "\n\n================    End of simulation     ===============\n\n";
+    fullReport.report(std::cout);
+
+    if (output) {
+        std::string filename = output_dir + "/walltime.param";
+        std::fstream tot_os(filename.c_str(),std::fstream::trunc | std::fstream::out);
+        fullReport.reportParam(tot_os);
+        warnIfUnusedParams(param);
+    }
+
+}
+catch (const std::exception &e) {
+    std::cerr << "Program threw an exception: " << e.what() << "\n";
+    throw;
+}
+

examples/test_singlecellsolves.cpp

@@ -0,0 +1,259 @@
+/*
+  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/>.
+*/
+
+
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif // HAVE_CONFIG_H
+
+#include <opm/core/pressure/FlowBCManager.hpp>
+
+#include <opm/core/grid.h>
+#include <opm/core/grid/GridManager.hpp>
+#include <opm/core/wells.h>
+#include <opm/core/wells/WellsManager.hpp>
+#include <opm/common/ErrorMacros.hpp>
+#include <opm/core/simulator/initState.hpp>
+#include <opm/core/simulator/SimulatorReport.hpp>
+#include <opm/core/simulator/SimulatorTimer.hpp>
+#include <opm/core/utility/miscUtilities.hpp>
+#include <opm/core/utility/parameters/ParameterGroup.hpp>
+
+#include <opm/core/props/IncompPropertiesBasic.hpp>
+#include <opm/core/props/IncompPropertiesFromDeck.hpp>
+#include <opm/core/props/rock/RockCompressibility.hpp>
+
+#include <opm/core/linalg/LinearSolverFactory.hpp>
+
+#include <opm/polymer/PolymerState.hpp>
+#include <opm/core/simulator/WellState.hpp>
+#include <opm/polymer/IncompTpfaPolymer.hpp>
+#include <opm/polymer/TransportSolverTwophasePolymer.hpp>
+#include <opm/polymer/PolymerProperties.hpp>
+
+#include <boost/scoped_ptr.hpp>
+
+#include <algorithm>
+#include <iostream>
+#include <vector>
+#include <numeric>
+
+
+
+
+// ----------------- Main program -----------------
+int
+main(int argc, char** argv)
+try
+{
+    using namespace Opm;
+
+    // std::cout << "\n================    Test program for single-cell solves with polymer    ===============\n\n";
+    parameter::ParameterGroup param(argc, argv, false);
+    param.disableOutput();
+    // std::cout << "---------------    Reading parameters     ---------------" << std::endl;
+
+    boost::scoped_ptr<GridManager> grid;
+    boost::scoped_ptr<IncompPropertiesInterface> props;
+    PolymerState state;
+    Opm::PolymerProperties poly_props;
+    // bool check_well_controls = false;
+    // int max_well_control_iterations = 0;
+
+    // -------- Initialising section ----------
+
+    // Grid init.
+    grid.reset(new GridManager(2, 1, 1, 1.0, 1.0, 1.0));
+    // Rock and fluid init.
+    props.reset(new IncompPropertiesBasic(param, grid->c_grid()->dimensions, grid->c_grid()->number_of_cells));
+    // Init state variables (saturation and pressure).
+    initStateBasic(*grid->c_grid(), *props, param, 0.0, state);
+    // Init Polymer state
+    if (param.has("poly_init")) {
+        double poly_init = param.getDefault("poly_init", 0.0);
+        for (int cell = 0; cell < grid->c_grid()->number_of_cells; ++cell) {
+            double smin[2], smax[2];
+            props->satRange(1, &cell, smin, smax);
+            if (state.saturation()[2*cell] > 0.5*(smin[0] + smax[0])) {
+                state.concentration()[cell] = poly_init;
+                state.maxconcentration()[cell] = poly_init;
+            } else {
+                state.saturation()[2*cell + 0] = 0.;
+                state.saturation()[2*cell + 1] = 1.;
+                state.concentration()[cell] = 0.;
+                state.maxconcentration()[cell] = 0.;
+            }
+        }
+    }
+    // Init polymer properties.
+    // Setting defaults to provide a simple example case.
+    double c_max = param.getDefault("c_max_limit", 5.0);
+    double mix_param = param.getDefault("mix_param", 1.0);
+    double rock_density = param.getDefault("rock_density", 1000.0);
+    double dead_pore_vol = param.getDefault("dead_pore_vol", 0.0); // Note that we default to no dps here!
+    double res_factor = param.getDefault("res_factor", 1.) ; // res_factor = 1 gives no change in permeability
+    double c_max_ads = param.getDefault("c_max_ads", 1.);
+    int ads_index = param.getDefault<int>("ads_index", Opm::PolymerProperties::NoDesorption);
+    std::vector<double> c_vals_visc(2, -1e100);
+    c_vals_visc[0] = 0.0;
+    c_vals_visc[1] = 7.0;
+    std::vector<double> visc_mult_vals(2, -1e100);
+    visc_mult_vals[0] = 1.0;
+    // poly_props.visc_mult_vals[1] = param.getDefault("c_max_viscmult", 30.0);
+    visc_mult_vals[1] = 20.0;
+    std::vector<double> c_vals_ads(3, -1e100);
+    c_vals_ads[0] = 0.0;
+    c_vals_ads[1] = 2.0;
+    c_vals_ads[2] = 8.0;
+    std::vector<double> ads_vals(3, -1e100);
+    ads_vals[0] = 0.0;
+    ads_vals[1] = 0.0015;
+    ads_vals[2] = 0.0025;
+    // ads_vals[1] = 0.0;
+    // ads_vals[2] = 0.0;
+    std::vector<double> water_vel_vals(2, -1e100);
+    water_vel_vals[0] = 0.0;
+    water_vel_vals[1] = 10.0;
+    std::vector<double> shear_vrf_vals(2, -1e100);
+    shear_vrf_vals[0] = 1.0;
+    shear_vrf_vals[1] = 1.0;
+    poly_props.set(c_max, mix_param, rock_density, dead_pore_vol, res_factor, c_max_ads,
+                   static_cast<Opm::PolymerProperties::AdsorptionBehaviour>(ads_index),
+                   c_vals_visc,  visc_mult_vals, c_vals_ads, ads_vals, water_vel_vals, shear_vrf_vals);
+
+    // Initialising src
+    int num_cells = grid->c_grid()->number_of_cells;
+    std::vector<double> src(num_cells, 0.0);
+    // Compute pore volumes, in order to enable specifying injection rate
+    // terms of total pore volume.
+    std::vector<double> porevol;
+    computePorevolume(*grid->c_grid(), props->porosity(), porevol);
+    const double default_injection = 1.0;
+    const double flow_per_sec = param.getDefault<double>("injected_porevolumes_per_sec", default_injection)
+        *porevol[0];
+    src[0] = flow_per_sec;
+    src[num_cells - 1] = -flow_per_sec;
+
+    // Boundary conditions.
+    FlowBCManager bcs;
+
+    // Linear solver.
+    LinearSolverFactory linsolver(param);
+
+    // Reordering solver.
+    const double nl_tolerance = param.getDefault("nl_tolerance", 1e-9);
+    const int nl_maxiter = param.getDefault("nl_maxiter", 30);
+    Opm::TransportSolverTwophasePolymer::SingleCellMethod method;
+    std::string method_string = param.getDefault("single_cell_method", std::string("Bracketing"));
+    if (method_string == "Bracketing") {
+        method = Opm::TransportSolverTwophasePolymer::Bracketing;
+    } else if (method_string == "Newton") {
+        method = Opm::TransportSolverTwophasePolymer::Newton;
+    } else if (method_string == "Gradient") {
+        method = Opm::TransportSolverTwophasePolymer::Gradient;
+    } else if (method_string == "NewtonSimpleSC") {
+        method = Opm::TransportSolverTwophasePolymer::NewtonSimpleSC;
+    } else if (method_string == "NewtonSimpleC") {
+        method = Opm::TransportSolverTwophasePolymer::NewtonSimpleC;
+    } else {
+        OPM_THROW(std::runtime_error, "Unknown method: " << method_string);
+    }
+    Opm::TransportSolverTwophasePolymer reorder_model(*grid->c_grid(), *props, poly_props,
+                                             method, nl_tolerance, nl_maxiter);
+
+    // Warn if any parameters are unused.
+    // if (param.anyUnused()) {
+    //     std::cout << "--------------------   Unused parameters:   --------------------\n";
+    //     param.displayUsage();
+    //     std::cout << "----------------------------------------------------------------" << std::endl;
+    // }
+
+    // Write parameters to file for later reference.
+    param.writeParam("test_singlecellsolves.param");
+
+    // Setting up a number of input (s, c) pairs and solving.
+    // HACK warning: we manipulate the source term,
+    // but the compressibility term in the solver
+    // assumes that all inflow is water inflow. Therefore
+    // one must zero the compressibility term in
+    // TransportSolverTwophasePolymer line 365 before compiling this program.
+    // (To fix this we should add proper all-phase src terms.)
+    std::vector<double> transport_src = src;
+    const double dt = param.getDefault("dt", 1.0);
+    const int num_sats = 501;
+    const int num_concs = 501;
+    // Find the face between cell 0 and 1...
+    const UnstructuredGrid& ug = *grid->c_grid();
+    int face01 = -1;
+    for (int f = 0; f < ug.number_of_faces; ++f) {
+        if (ug.face_cells[2*f] == 0 && ug.face_cells[2*f+1] == 1) {
+            face01 = f;
+            break;
+        }
+    }
+    if (face01 == -1) {
+        OPM_THROW(std::runtime_error, "Could not find face adjacent to cells [0 1]");
+    }
+    state.faceflux()[face01] = src[0];
+    for (int sats = 0; sats < num_sats; ++sats) {
+        const double s = double(sats)/double(num_sats - 1);
+        const double ff = s; // Simplified a lot...
+        for (int conc = 0; conc < num_concs; ++conc) {
+            const double c = poly_props.cMax()*double(conc)/double(num_concs - 1);
+            std::vector<double> polymer_inflow_c(num_cells, c);
+            // std::cout << "(s, c) = (" << s << ", " << c << ")\n";
+            transport_src[0] = src[0]*ff;
+            // Resetting the state for next run.
+            state.saturation()[0] = 0.0;
+            state.saturation()[1] = 0.0;
+            state.concentration()[0] = 0.0;
+            state.concentration()[1] = 0.0;
+            state.maxconcentration()[0] = 0.0;
+            state.maxconcentration()[1] = 0.0;
+            reorder_model.solve(&state.faceflux()[0],
+                                &porevol[0],
+                                &transport_src[0],
+                                &polymer_inflow_c[0],
+                                dt,
+                                state.saturation(),
+                                state.concentration(),
+                                state.maxconcentration());
+
+#ifdef PROFILING
+            // Extract residual counts.
+            typedef std::list<Opm::TransportSolverTwophasePolymer::Newton_Iter> ListRes;
+            const ListRes& res_counts = reorder_model.res_counts;
+            double counts[2] = { 0, 0 };
+            for (ListRes::const_iterator it = res_counts.begin(); it != res_counts.end(); ++it) {
+                if (it->cell == 0) {
+                    ++counts[it->res_s];
+                }
+            }
+            // std::cout << "c residual count: " << counts[0] << '\n';
+            // std::cout << "s residual count: " << counts[1] << '\n';
+            std::cout << counts[0] << ' ' << counts[1] << ' ' << s << ' ' << c << '\n';
+#endif
+        }
+    }
+}
+catch (const std::exception &e) {
+    std::cerr << "Program threw an exception: " << e.what() << "\n";
+    throw;
+}
+