opm-simulators/opm/autodiff/WellStateFullyImplicitBlackoil.hpp

/*
  Copyright 2014 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/>.
*/

#ifndef OPM_WELLSTATEFULLYIMPLICITBLACKOIL_HEADER_INCLUDED
#define OPM_WELLSTATEFULLYIMPLICITBLACKOIL_HEADER_INCLUDED


#include <opm/core/wells.h>
#include <opm/core/well_controls.h>
#include <opm/core/simulator/WellState.hpp>
#include <opm/core/utility/ErrorMacros.hpp>
#include <vector>
#include <cassert>
#include <string>
#include <utility>
#include <map>
#include <algorithm>
#include <array>

namespace Opm
{

    /// The state of a set of wells, tailored for use by the fully
    /// implicit blackoil simulator.
    class WellStateFullyImplicitBlackoil
    {
    public:
        typedef std::array< int, 2 >  mapentry_t;
        typedef std::map< std::string, mapentry_t > WellMapType;


        /// Allocate and initialize if wells is non-null.  Also tries
        /// to give useful initial values to the bhp(), wellRates()
        /// and perfPhaseRates() fields, depending on controls
        template <class State, class PrevState>
        void init(const Wells* wells, const State& state, const PrevState& prevState)
        {
            // clear old name mapping
            wellMap_.clear();

            if (wells == 0) {
                return;
            }

            // We use the WellState::init() function to do bhp and well rates init.
            // The alternative would be to copy that function wholesale.
            basic_well_state_.init(wells, state);

            // Initialize perfphaserates_, which must be done here.
            const int nw = wells->number_of_wells;
            const int np = wells->number_of_phases;
            const int nperf = wells->well_connpos[nw];
            perfphaserates_.resize(nperf * np, 0.0);
            for (int w = 0; w < nw; ++w) {
                assert((wells->type[w] == INJECTOR) || (wells->type[w] == PRODUCER));
                const WellControls* ctrl = wells->ctrls[w];
                std::string name( wells->name[ w ] );
                assert( name.size() > 0 );
                mapentry_t& wellMapEntry = wellMap_[ name ];
                wellMapEntry[ 0 ] = w ;
                wellMapEntry[ 1 ] = wells->well_connpos[w ] ;
                if (well_controls_well_is_shut(ctrl)) {
                    // Shut well: perfphaserates_ are all zero.
                } else {
                    // Open well: Initialize perfphaserates_ to well
                    // rates divided by the number of perforations.
                    const int num_perf_this_well = wells->well_connpos[w + 1] - wells->well_connpos[w];
                    for (int perf = wells->well_connpos[w]; perf < wells->well_connpos[w + 1]; ++perf) {
                        for (int p = 0; p < np; ++p) {
                            perfphaserates_[np*perf + p] = wellRates()[np*w + p] / double(num_perf_this_well);
                        }
                    }
                }
            }

            // Initialize current_controls_.
            // The controls set in the Wells object are treated as defaults,
            // and also used for initial values.
            current_controls_.resize(nw);
            for (int w = 0; w < nw; ++w) {
                current_controls_[w] = well_controls_get_current(wells->ctrls[w]);
            }

            // intialize wells that have been there before
            // order may change so the mapping is based on the well name
            if( ! prevState.wellMap().empty() )
            {
                typedef typename WellMapType :: const_iterator const_iterator;
                const_iterator end = prevState.wellMap().end();
                for (int w = 0; w < nw; ++w) {
                    std::string name( wells->name[ w ] );
                    const_iterator it = prevState.wellMap().find( name );
                    if( it != end )
                    {
                        const int oldIndex = (*it).second[ 0 ];
                        const int newIndex = w;

                        // bhp
                        bhp()[ newIndex ] = prevState.bhp()[ oldIndex ];

                        // wellrates
                        for( int i=0, idx=newIndex*np, oldidx=oldIndex*np; i<np; ++i, ++idx, ++oldidx )
                        {
                            wellRates()[ idx ] = prevState.wellRates()[ oldidx ];
                        }

                        // perfPhaseRates
                        int oldPerf = (*it).second[ 1 ] * np;
                        for (int perf = wells->well_connpos[ newIndex ]*np;
                             perf < wells->well_connpos[ newIndex + 1]*np; ++perf, ++oldPerf )
                        {
                            perfPhaseRates()[ perf ] = prevState.perfPhaseRates()[ oldPerf ];
                        }

                        // currentControls
                        currentControls()[ newIndex ] = prevState.currentControls()[ oldIndex ];
                    }
                }
            }
        }

        /// One bhp pressure per well.
        std::vector<double>& bhp() { return basic_well_state_.bhp(); }
        const std::vector<double>& bhp() const { return basic_well_state_.bhp(); }

        /// One rate per well and phase.
        std::vector<double>& wellRates() { return basic_well_state_.wellRates(); }
        const std::vector<double>& wellRates() const { return basic_well_state_.wellRates(); }

        /// One rate per phase and well connection.
        std::vector<double>& perfPhaseRates() { return perfphaserates_; }
        const std::vector<double>& perfPhaseRates() const { return perfphaserates_; }

        /// One current control per well.
        std::vector<int>& currentControls() { return current_controls_; }
        const std::vector<int>& currentControls() const { return current_controls_; }

        /// For interfacing with functions that take a WellState.
        const WellState& basicWellState() const
        {
            return basic_well_state_;
        }

        /// The number of wells present.
        int numWells() const
        {
            return bhp().size();
        }

        /// The number of phases present.
        int numPhases() const
        {
            return wellRates().size() / numWells();
        }

        const WellMapType& wellMap() const { return wellMap_; }

    private:
        WellState basic_well_state_;
        std::vector<double> perfphaserates_;
        std::vector<int> current_controls_;
        WellMapType wellMap_;
    };

} // namespace Opm


#endif // OPM_WELLSTATEFULLYIMPLICITBLACKOIL_HEADER_INCLUDED