ParamReservoir.hpp

Go to the documentation of this file.

 
#ifndef __PARAMRESERVOIR_HEADER__
#define __PARAMRESERVOIR_HEADER__
 
// Standard header files
#include <fstream>
#include <vector>
 
// OpenCAEPoro header files
#include "OCPConst.hpp"
#include "UtilInput.hpp"
 
using namespace std;
 
class TableSet
{
public:
    void DisplayTable() const; 
 
public:
    string                          name;   
    USI                             colNum; 
    vector<vector<vector<OCP_DBL>>> data;   
};
 
class Dimens
{
public:
    USI nx; 
    USI ny; 
    USI nz; 
};
 
class Rock
{
public:
    OCP_DBL Pref; 
    OCP_DBL Cr;   
};
 
template <typename T> class Type_A_r
{
public:
    bool      activity{false}; 
    vector<T> data;            
};
 
class EoSparam
{
public:
    // Basic params
    void InitEoSparam();
    void InputCOM(ifstream& ifs); // useless now
 
    void InputCOMPONENTS(ifstream& ifs, const string& keyword);
    Type_A_r<vector<OCP_DBL>>* FindPtr(const string& varName);
    void InputCNAMES(ifstream& ifs);
    void InputLBCCOEF(ifstream& ifs);
    void InputBIC(ifstream& ifs);
    // Method params
    void InputSSMSTA(ifstream& ifs);
    void InputNRSTA(ifstream& ifs);
    void InputSSMSP(ifstream& ifs);
    void InputNRSP(ifstream& ifs);
    void InputRR(ifstream& ifs);
 
public:
    USI NTPVT{1}; 
    USI numCom{0};  
    USI numPhase{2}; 
    vector<vector<string>>  COM; 
    vector<string> Cname; 
    Type_A_r<vector<OCP_DBL>> Tc; 
    Type_A_r<vector<OCP_DBL>> Pc; 
    Type_A_r<vector<OCP_DBL>> Vc; 
    Type_A_r<vector<OCP_DBL>> Zc; 
    Type_A_r<vector<OCP_DBL>> MW; 
    Type_A_r<vector<OCP_DBL>> Acf; 
    Type_A_r<vector<OCP_DBL>> OmegaA; 
    Type_A_r<vector<OCP_DBL>> OmegaB; 
    Type_A_r<vector<OCP_DBL>> Vshift; 
    Type_A_r<vector<OCP_DBL>> Parachor; 
    // for viscosity calculation
    Type_A_r<vector<OCP_DBL>> Vcvis; 
    Type_A_r<vector<OCP_DBL>> Zcvis; 
    vector<OCP_DBL> LBCcoef; 
    vector<vector<OCP_DBL>> BIC; 
 
    bool miscible{false}; 
 
    vector<string> SSMparamSTA; 
    vector<string> NRparamSTA;  
    vector<string> SSMparamSP;  
    vector<string> NRparamSP;   
    vector<string> RRparam;     
};
 
class Miscstr
{
public:
    vector<OCP_DBL> surTenRef;
    // 0th entry: reference surface tension - flow is immiscible when the surface tension is greater than or equal to this value.
    // 1th entry: maximum surface tension expected, it should be greater than surTenRef.
    // 2th entry: maximum surface tension used to scale the input capillary pressure curves.
};
 
class ParamReservoir
{
 
public:
    // Grid
    // Cartesian
    Dimens  dimens;  
    OCP_USI numGrid; 
    vector<OCP_DBL> tops; 
    vector<OCP_DBL> dx;   
    vector<OCP_DBL> dy;   
    vector<OCP_DBL> dz;   
 
    // Corner point geometry
    vector<OCP_DBL> coord; 
    vector<OCP_DBL> zcorn; 
 
    // Rock
    vector<OCP_DBL> ntg;    
    vector<OCP_DBL> poro;   
    vector<OCP_DBL> permX;  
    vector<OCP_DBL> permY;  
    vector<OCP_DBL> permZ;  
    OCP_DBL         rsTemp; 
    Rock rock; 
    Miscstr miscstr; 
 
    // If P and Ni are given, then calculation of initial equilibration is unneeded.
    vector<OCP_DBL> P;  
    vector<OCP_DBL> Ni; 
    vector<OCP_DBL> Swat; 
    bool ScalePcow{false}; 
 
    // phase property
    Type_A_r<OCP_DBL> density; 
    Type_A_r<OCP_DBL> gravity; 
 
    // Model and Phase
    bool blackOil{false}; 
    bool comps{false};    
    bool oil{false};      
    bool gas{false};      
    bool water{false};    
    bool disGas{false};   
 
 
    // Compositional Model
    EoSparam EoSp; 
 
    // SAT Region & PVT Region
    USI               NTSFUN{1}; 
    USI               NTPVT{1};  
    Type_A_r<OCP_DBL> SATNUM;    
    Type_A_r<OCP_DBL> PVTNUM;    
    Type_A_r<OCP_DBL> ACTNUM;    
 
    // Saturation tables & bubble point pressure
    TableSet        SWFN_T; 
    TableSet        SWOF_T; 
    TableSet        SGFN_T; 
    TableSet        SGOF_T; 
    TableSet        SOF3_T; 
    TableSet        PBVD_T; 
    // initial zi vs depth
    TableSet        ZMFVD_T;
    vector<OCP_DBL> EQUIL;  
 
    // PVT properties
    USI      numPhase; 
    USI      numCom;   
    TableSet PVCO_T;   
    TableSet PVDO_T;   
    TableSet PVDG_T;   
    TableSet PVTW_T;   
 
    vector<OCP_DBL>* FindPtr(const string& varName);
 
    TableSet* FindPtr_T(const string& varName);
 
    void Init();
 
    void InitTable();
 
    template <typename T>
    void setVal(vector<T>& obj, const T& val, const vector<USI>& index);
 
    template <typename T>
    void CopyVal(vector<T>& obj, const vector<T>& src, const vector<USI>& index);
 
    void MultiplyVal(vector<OCP_DBL>& obj, const OCP_DBL& val,
                     const vector<USI>& index);
 
    void InputCOMPS(ifstream& ifs);
 
    void InputDIMENS(ifstream& ifs);
 
    void DisplayDIMENS();
 
    void InputRTEMP(ifstream& ifs);
 
    void InputEQUALS(ifstream& ifs);
 
    void InputGRID(ifstream& ifs, string& keyword);
 
    void InputCOPY(ifstream& ifs);
 
    void InputMULTIPLY(ifstream& ifs);
 
    void InputTABLE(ifstream& ifs, const string& tabName);
 
    void InputROCK(ifstream& ifs);
 
    void InputMISCSTR(ifstream& ifs);
 
    void InputGRAVITY(ifstream& ifs);
 
    void InputDENSITY(ifstream& ifs);
 
    void InputEQUIL(ifstream& ifs);
 
    // SATNUM & PVTNUM  -- Region
    void InputTABDIMS(ifstream& ifs);
 
    void InputRegion(ifstream& ifs, const string& keyword);
 
    // Input EoSparam
    // Basic params
    void InputCNAMES(ifstream& ifs) { EoSp.InputCNAMES(ifs); };
    void InputCOM(ifstream& ifs) { EoSp.InputCOM(ifs); };
    void InputCOMPONENTS(ifstream& ifs, const string& keyword) { EoSp.InputCOMPONENTS(ifs, keyword); }
    void InputLBCCOEF(ifstream& ifs) { EoSp.InputLBCCOEF(ifs); }
    void InputBIC(ifstream& ifs) { EoSp.InputBIC(ifs); };
 
 
    // Method params
    void InputSSMSTA(ifstream& ifs) { EoSp.InputSSMSTA(ifs); };
    void InputNRSTA(ifstream& ifs) { EoSp.InputNRSTA(ifs); };
    void InputSSMSP(ifstream& ifs) { EoSp.InputSSMSP(ifs); };
    void InputNRSP(ifstream& ifs) { EoSp.InputNRSP(ifs); };
    void InputRR(ifstream& ifs) { EoSp.InputRR(ifs); };
 
    // check
    void CheckParam();
 
    void CheckGrid();
 
    void CheckEQUIL() const;
 
    void CheckDenGra() const;
 
    void CheckPhase() const;
 
    void CheckPhaseTab() const;
 
    void CheckRegion() const;
 
    void CheckEqlRegion() const;
};
 
#endif /* end if __PARAMRESERVOIR_HEADER__ */
 
/*----------------------------------------------------------------------------*/
/*  Brief Change History of This File                                         */
/*----------------------------------------------------------------------------*/
/*  Author              Date             Actions                              */
/*----------------------------------------------------------------------------*/
/*  Shizhe Li           Oct/01/2021      Create file                          */
/*  Chensong Zhang      Oct/15/2021      Format file                          */
/*  Chensong Zhang      Jan/09/2022      Update Doxygen                       */
/*----------------------------------------------------------------------------*/