msw.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_MSW_HPP
#define OPM_OUTPUT_ECLIPSE_VECTOR_MSW_HPP

#include <vector>

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

    namespace ISeg {

        enum index : std::vector<int>::size_type {
            SegNo          = 0, // Segment number (one-based)
            OutSeg         = 1, // Outlet segment (one-based)
            InSegCurBranch = 2, // Inflow segment current branch (one-based)
            BranchNo       = 3, // Branch number (one-based)

            SegmentType    = 11,

            ICDScalingMode  = 18,
            ICDOpenShutFlag = 19,
        };

        namespace Value {
            enum Type {
                AutoICD   = -8, // Segment is an AICD
                SpiralICD = -7, // Segment is an SICD
                Valve     = -5, // Segment is a Valve
                Regular   = -1, // Regular segment (i.e., not a device &c)
            };
        } // Value

    } // ISeg

    namespace ILbr {
        enum index : std::vector<int>::size_type {
            OutletSegment          = 0, // Branch's outlet segment (one-based)
            NumBranchSegments      = 1, // Number of segments on branch
            FirstSegment           = 2, // First segment on branch (kick-off, heel)
            LastSegment            = 3, // Last segment on branch (toe)
            KickOffDiscoveryOffset = 4, // Segment traversal order at which this branch was encountered
        };
    } // ILbr

    namespace RSeg {
        enum index : std::vector<double>::size_type {
            DistOutlet      = 0, // Segment's distance to outlet
            OutletDepthDiff = 1, // Segment's depth differential to outlet
            SegDiam         = 2, // Internal diameter of segment
            SegRough        = 3, // Roughness parameter of segment
            SegArea         = 4, // Cross-sectional area of segment
            SegVolume       = 5, // Physical volume of segment
            DistBHPRef      = 6, // Segment's distance to BHP reference node
            SegNodeDepth    = 7, // Segment's node depth

            TotFlowRate  =  8,  // Normalised total segment flow rate
            WatFlowFract =  9,  // Normalised Water flow rate fraction
            GasFlowFract = 10,  // Normalised Gas flow rate fraction
            Pressure     = 11,  // Segment pressure

            item31  =  30,      // Very close to Normalised Water flow rate fraction - value used pr today

            item40  =  39,      // Unknown

            ValveLength    = 40, // Length of valve
            ValveArea      = 41, // Cross-sectional area of valve
            ValveFlowCoeff = 42, // Valve's dimensionless flow coefficient
            ValveMaxArea   = 43, // Maximal cross-sectional valve area

            DeviceBaseStrength = 86,

            ScalingFactor = 87,

            CalibrFluidDensity   = 88,
            CalibrFluidViscosity = 89,

            CriticalWaterFraction = 90,
            TransitionRegWidth    = 91,
            MaxEmulsionRatio      = 92,

            FlowRateExponent      = 95,
            ViscFuncExponent      = 96,

            MaxValidFlowRate      = 97,

            ICDLength = 102,

            ValveAreaFraction  = 103,

            flowFractionOilDensityExponent      = 105,
            flowFractionWaterDensityExponent    = 106,
            flowFractionGasDensityExponent      = 107,
            flowFractionOilViscosityExponent    = 108,
            flowFractionWaterViscosityExponent  = 109,
            flowFractionGasViscosityExponent    = 110,
        };
    } // RSeg

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

#endif // OPM_OUTPUT_ECLIPSE_VECTOR_MSW_HPP