doubhead.hpp

/*
  Copyright (c) 2018 Equinor ASA

  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef OPM_OUTPUT_ECLIPSE_VECTOR_DOUBHEAD_HPP
#define OPM_OUTPUT_ECLIPSE_VECTOR_DOUBHEAD_HPP

#include <vector>
#include <cmath>

namespace Opm { namespace RestartIO { namespace Helpers { namespace VectorItems {

    // This is a subset of the items in src/opm/output/eclipse/DoubHEAD.cpp .
    // Promote items from that list to this in order to make them public.
    enum doubhead : std::vector<double>::size_type {
        TsInit  = 1,             // Maximum Length of Next Timestep
        TsMaxz  = 2,             // Maximum Length of Timestep After Next
        TsMinz  = 3,             // Minumum Length of All Timesteps
        TsMchp  = 4,
        TsFMax  = 5,
        TsFMin  = 6,
        TsFcnv  = 7,
        TrgTTE  = 8,
        TrgCNV  = 9,
        TrgMBE  = 10,
        TrgLCV  = 11,
        XxxTTE  = 16,
        XxxCNV  = 17,
        XxxMBE  = 18,
        XxxLCV  = 19,
        XxxWFL  = 20,

        dRsDt   = 25,

        OilVapPropensity = 26, // Oil's propensity to vaporise into
                               // unsaturated gas phase (VAPPARS(1)).

        OilVapDensPropensity = 27, // Oil's density increase propensity as
                                   // lighter fractions vaporise
                                   // (VAPPARS(2)).

        Netbalthpc    = 50,    //  Network balancing THP convergence limit (NETBALAN(4))
        Netbalint     = 51,    //  Network balancing interval (NETBALAN(1))
        Netbalnpre    = 53,    //  Network balancing nodal pressure
                               //  convergence limit (NETBALAN(2))

        Netbaltarerr  = 63,    //  Target largest branch network balancing
                               //  error at end of timestep (NETBALAN(6))

        Netbalmaxerr  = 64,    //  Maximum permitted network balancing error
                               //  at end of timestep (NETBALAN(7))

        Netbalstepsz  = 66,    //  Minimum stepsize for steps limited by
                               //  network balancing errors (NETBALAN(8))

        TrgDPR  = 82,
        TfDiff  = 83,
        DdpLim  = 84,
        DdsLim  = 85,
        GRpar_a = 87,     // Guiderate parameter A
        GRpar_b = 88,     // Guiderate parameter B
        GRpar_c = 89,     // Guiderate parameter C
        GRpar_d = 90,     // Guiderate parameter D
        GRpar_e = 91,     // Guiderate parameter E
        GRpar_f = 92,     // Guiderate parameter F
        LOminInt = 93,     // LIFTOP - Minimum interval between gas lift optimizations
        LOincrsz   = 95,     // LIFTOPT - Increment size for lift gas injection rate
        LOminEcGrad = 96,  // LIFTOPT - Minimum economic gradient
        GRpar_int = 97,     // Guiderate parameter delay interval
        ThrUPT  =  99,
        XxxDPR  = 100,
        TrgFIP  = 101,
        TrgSFT  = 102,
        GRpar_damp = 144,     // Guiderate parameter damping factor
        WsegRedFac = 145,     // WSEGITER parameter (item 3) Reduction factor (F_R)
        WsegIncFac = 146,     // WSEGITER parameter (item 4) Increas factor (F_I)
        UdqPar_2 = 212,         // UDQPARAM item number 2 (Permitted range (+/-) of user-defined quantities)
        UdqPar_3 = 213,         // UDQPARAM item number 3 (Value given to undefined elements when outputting data)
        UdqPar_4 = 214,         // UDQPARAM item number 4 (fractional equality tolerance used in ==, <= etc. functions)
    };

    namespace DoubHeadValue {
        // Default if no active network (BRANPROP/NODEPROP)
        constexpr auto NetBalNodPressDefault = 0.0; // Barsa

        // Default => Use TSMINZ from TUNING
        constexpr auto NetBalMinTSDefault = 0.0;

        // Default => Let Simulator choose TSINIT
        constexpr auto TSINITNoValue = 1.00000011;
        inline bool TSINITHasNoValue(const double value) {
            return std::abs(value - TSINITNoValue) < 1.0e-7;
        }
    }

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

#endif // OPM_OUTPUT_ECLIPSE_VECTOR_DOUBHEAD_HPP