connection.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_CONNECTION_HPP
#define OPM_OUTPUT_ECLIPSE_VECTOR_CONNECTION_HPP

#include <vector>

namespace Opm::RestartIO::Helpers::VectorItems {
    namespace IConn {
        enum index : std::vector<int>::size_type {
            SeqIndex   =  0, // Connection sequence index
            CellI      =  1, // I-location (1-based cell index) of connection
            CellJ      =  2, // J-location (1-based cell index) of connection
            CellK      =  3, // K-location (1-based cell index) of connection
            ConnStat   =  5, // Connection status.
                             //    > 0 => open, shut otherwise

            Drainage   =  6, // Saturation function (table ID) for drainage
            Imbibition =  9, // Saturation function (table ID) for imbibition

            ComplNum   = 12, // Completion ID (1-based)
            ConnDir    = 13, // Penetration direction (1:X, 2:Y, 3:Z)
            Segment    = 14, // Segment ID of connection
                             //   0 for regular connections, > 0 for MSW.

            ConnIdx    = 25, // Connection index (1-based)
        };
    } // IConn

    namespace SConn {
        enum index : std::vector<float>::size_type {
            EffConnTrans =  0, // Effective connection transmissibility factor (incl. ROCKTAB &c)
            Depth        =  1, // Connection centre depth
            Diameter     =  2, // Connection diameter

            EffectiveKH  =  3, // Effective Kh product of connection
            SkinFactor   =  4, // Skinfactor - item 'SKIN' from COMPDAT

            CFDenom = 6,    // Denominator in connection transmissibility
                            // factor expression

            ConnTrans = 11, // Connection transmissibility factor

            SegDistEnd   = 20, // Distance to end of connection in segment
            SegDistStart = 21, // Distance to start of connection in segment

            item30       = 29, // Unknown
            item31       = 30, // Unknown

            EffectiveLength = 31, // Effective length of connection's perforation interval.

            StaticDFacCorrCoeff = 37, // Static component of Forchheimer
                                      // D-factor correlation.

            CFInDeck     = 40,  // = 0 for connection factor not defined in input,
                                // = 1 for connection factor defined in input.

            PressEquivRad = 41, // Connection's pressure equivalent radius.
        };
    } // SConn

    namespace XConn {
        enum index : std::vector<double>::size_type {
            OilRate    =  0,  // Surface flow rate (oil)
            WaterRate  =  1,  // Surface flow rate (water)
            GasRate    =  2,  // Surface Flow rate (gas)

            OilPrTotal =  3,  // Total cumulative oil production
            WatPrTotal =  4,  // Total cumulative water production
            GasPrTotal =  5,  // Total cumulative gas production

            OilInjTotal = 6,  // Total cumulative oil injection
            WatInjTotal = 7,  // Total cumulative water injection
            GasInjTotal = 8,  // Total cumulative gas injection

            GORatio    = 10,  // Producing gas/oil ratio

            OilRate_Copy    =  17,  // Surface flow rate (oil)
            WaterRate_Copy  =  18,  // Surface flow rate (water)
            GasRate_Copy    =  19,  // Surface Flow rate (gas)

            Pressure   = 34,  // Connection pressure value

            ResVRate     = 49,  // Reservoir voidage rate
            VoidPrTotal  = 50,  // Total cumulative reservoir voidage volume production
            VoidInjTotal = 51,  // Total cumulative reservoir voidage volume injection

            TracerOffset = 58,  // Tracer data starts after this index
        };
    } // XConn
} // Opm::RestartIO::Helpers::VectorItems

#endif // OPM_OUTPUT_ECLIPSE_VECTOR_CONNECTION_HPP