FlowUnit.hpp

Go to the documentation of this file.

 
#ifndef __FLOWUNIT_HEADER__
#define __FLOWUNIT_HEADER__
 
#include <math.h>
 
// OpenCAEPoro header files
#include "OCPConst.hpp"
#include "OCPTable.hpp"
#include "OptionalFeatures.hpp"
#include "ParamReservoir.hpp"
 
class FlowUnit
{
public:
    FlowUnit()                                                        = default;
    virtual void SetupOptionalFeatures(const Grid&       myGrid,
                                       OptionalFeatures& optFeatures) = 0;
    virtual void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) = 0;
    virtual OCP_DBL GetPcowBySw(const OCP_DBL& sw)   = 0;
    virtual OCP_DBL GetSwByPcow(const OCP_DBL& pcow) = 0;
    virtual OCP_DBL GetPcgoBySg(const OCP_DBL& sg)   = 0;
    virtual OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) = 0;
    virtual OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) = 0;
    virtual const vector<OCP_DBL>& GetScm() const = 0;
 
    virtual void CalKrPc(const OCP_DBL* S_in,
                         OCP_DBL*       kr_out,
                         OCP_DBL*       pc_out,
                         const OCP_USI& bId) = 0;
 
    virtual void CalKrPcDeriv(const OCP_DBL* S_in,
                              OCP_DBL*       kr_out,
                              OCP_DBL*       pc_out,
                              OCP_DBL*       dkrdS,
                              OCP_DBL*       dPcjdS,
                              const OCP_USI& bId) = 0;
 
    OCP_DBL GetSwco() const { return Swco; };
 
protected:
    OCP_DBL         Swco;
    vector<OCP_DBL> data;  
    vector<OCP_DBL> cdata; 
};
 
// FlowUnit_W
 
class FlowUnit_W : public FlowUnit
{
public:
    FlowUnit_W() = default;
    FlowUnit_W(const ParamReservoir& rs_param, const USI& i){};
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override{};
    void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override{};
    void CalKrPc(const OCP_DBL* S_in,
                 OCP_DBL*       kr_out,
                 OCP_DBL*       pc_out,
                 const OCP_USI& bId) override;
    void CalKrPcDeriv(const OCP_DBL* S_in,
                      OCP_DBL*       kr_out,
                      OCP_DBL*       pc_out,
                      OCP_DBL*       dkrdS,
                      OCP_DBL*       dPcjdS,
                      const OCP_USI& bId) override;
 
    OCP_DBL GetPcowBySw(const OCP_DBL& sw) override { return 0; }
    OCP_DBL GetSwByPcow(const OCP_DBL& pcow) override { return 0; }
    OCP_DBL GetPcgoBySg(const OCP_DBL& sg) override { return 0; }
    OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) override { return 0; }
    OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) override { return 0; }
 
    const vector<OCP_DBL>& GetScm() const override
    {
        OCP_ABORT("Not Completed in this Condition!");
    }
};
 
// FlowUnit_OW
 
class FlowUnit_OW : public FlowUnit
{
public:
    FlowUnit_OW() = default;
    FlowUnit_OW(const ParamReservoir& rs_param, const USI& i);
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override{};
    void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override{};
    void CalKrPc(const OCP_DBL* S_in,
                 OCP_DBL*       kr_out,
                 OCP_DBL*       pc_out,
                 const OCP_USI& bId) override;
    void CalKrPcDeriv(const OCP_DBL* S_in,
                      OCP_DBL*       kr_out,
                      OCP_DBL*       pc_out,
                      OCP_DBL*       dkrdS,
                      OCP_DBL*       dPcjdS,
                      const OCP_USI& bId) override;
 
    OCP_DBL GetPcowBySw(const OCP_DBL& sw) override { return SWOF.Eval(0, sw, 3); }
    OCP_DBL GetSwByPcow(const OCP_DBL& pcow) override
    {
        return SWOF.Eval_Inv(3, pcow, 0);
    }
 
    // useless
    OCP_DBL GetPcgoBySg(const OCP_DBL& sg) override { return 0; }
    OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) override { return 0; }
    OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) override { return 0; }
 
    const vector<OCP_DBL>& GetScm() const override
    {
        OCP_ABORT("Not Completed in this Condition!");
    }
 
protected:
    OCPTable SWOF; 
};
 
// FlowUnit_OG
 
class FlowUnit_OG : public FlowUnit
{
public:
    FlowUnit_OG() = default;
    FlowUnit_OG(const ParamReservoir& rs_param, const USI& i);
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override{};
    void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override{};
    void    CalKrPc(const OCP_DBL* S_in,
                    OCP_DBL*       kr_out,
                    OCP_DBL*       pc_out,
                    const OCP_USI& bId) override;
    void    CalKrPcDeriv(const OCP_DBL* S_in,
                         OCP_DBL*       kr_out,
                         OCP_DBL*       pc_out,
                         OCP_DBL*       dkrdS,
                         OCP_DBL*       dPcjdS,
                         const OCP_USI& bId) override;
    OCP_DBL GetPcgoBySg(const OCP_DBL& sg) override { return SGOF.Eval(0, sg, 3); }
    OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) override { return SGOF.Eval(3, pcgo, 0); }
 
    // useless
    OCP_DBL GetPcowBySw(const OCP_DBL& sw) override { return 0; }
    OCP_DBL GetSwByPcow(const OCP_DBL& pcow) override { return 0; }
    OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) override { return 0; }
 
    const vector<OCP_DBL>& GetScm() const override
    {
        OCP_ABORT("Not Completed in this Condition!");
    }
 
protected:
    OCPTable SGOF; 
    OCP_DBL  kroMax;
};
 
// FlowUnit_ODGW
 
class FlowUnit_ODGW : public FlowUnit
{
public:
    OCP_DBL CalKro_Stone2(const OCP_DBL& krow,
                          const OCP_DBL& krog,
                          const OCP_DBL& krw,
                          const OCP_DBL& krg) const;
 
    OCP_DBL CalKro_Default(const OCP_DBL& Sg,
                           const OCP_DBL& Sw,
                           const OCP_DBL& krog,
                           const OCP_DBL& krow) const;
 
    const vector<OCP_DBL>& GetScm() const override { return Scm; }
 
protected:
    OCP_DBL         kroMax;
    vector<OCP_DBL> Scm; 
};
 
// FlowUnit_ODGW01
 
class FlowUnit_ODGW01 : public FlowUnit_ODGW
{
public:
    FlowUnit_ODGW01() = default;
    FlowUnit_ODGW01(const ParamReservoir& rs_param, const USI& i);
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override{};
    void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override{};
    virtual void CalKrPc(const OCP_DBL* S_in,
                         OCP_DBL*       kr_out,
                         OCP_DBL*       pc_out,
                         const OCP_USI& bId) override;
    virtual void CalKrPcDeriv(const OCP_DBL* S_in,
                              OCP_DBL*       kr_out,
                              OCP_DBL*       pc_out,
                              OCP_DBL*       dkrdS,
                              OCP_DBL*       dPcjdS,
                              const OCP_USI& bId) override;
 
    OCP_DBL CalKro_Stone2Der(OCP_DBL  krow,
                             OCP_DBL  krog,
                             OCP_DBL  krw,
                             OCP_DBL  krg,
                             OCP_DBL  dkrwdSw,
                             OCP_DBL  dkrowdSw,
                             OCP_DBL  dkrgdSg,
                             OCP_DBL  dkrogdSg,
                             OCP_DBL& out_dkrodSw,
                             OCP_DBL& out_dkrodSg) const;
    OCP_DBL CalKro_DefaultDer(const OCP_DBL& Sg,
                              const OCP_DBL& Sw,
                              const OCP_DBL& krog,
                              const OCP_DBL& krow,
                              const OCP_DBL& dkrogSg,
                              const OCP_DBL& dkrowSw,
                              OCP_DBL&       dkroSg,
                              OCP_DBL&       dkroSw) const;
 
    OCP_DBL GetPcowBySw(const OCP_DBL& sw) override { return SWOF.Eval(0, sw, 3); }
    OCP_DBL GetSwByPcow(const OCP_DBL& pcow) override
    {
        return SWOF.Eval_Inv(3, pcow, 0);
    }
 
    OCP_DBL GetPcgoBySg(const OCP_DBL& sg) override { return SGOF.Eval(0, sg, 3); }
    OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) override { return SGOF.Eval(3, pcgo, 0); }
    OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) override
    {
        return SWPCGW.Eval_Inv(1, pcgw, 0);
    }
 
    void Generate_SWPCWG();
 
protected:
    OCPTable SGOF;   
    OCPTable SWOF;   
    OCPTable SWPCGW; 
};
 
// FlowUnit_ODGW01_Miscible
 
class FlowUnit_ODGW01_Miscible : public FlowUnit_ODGW01
{
public:
    FlowUnit_ODGW01_Miscible(const ParamReservoir& rs_param, const USI& i)
        : FlowUnit_ODGW01(rs_param, i)
    {
        // gas is moveable all the time
        Scm[1]  = 0;
        maxPcow = SWOF.GetCol(3).front();
        minPcow = SWOF.GetCol(3).back();
    }
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override
    {
        misTerm   = &optFeatures.miscible;
        scaleTerm = &optFeatures.scalePcow;
        scaleTerm->Setup(myGrid);
    };
    void SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override;
    void CalKrPc(const OCP_DBL* S_in,
                 OCP_DBL*       kr_out,
                 OCP_DBL*       pc_out,
                 const OCP_USI& bId) override;
    void CalKrPcDeriv(const OCP_DBL* S_in,
                      OCP_DBL*       kr_out,
                      OCP_DBL*       pc_out,
                      OCP_DBL*       dkrdS,
                      OCP_DBL*       dPcjdS,
                      const OCP_USI& bId) override;
 
protected:
    ScalePcow* scaleTerm;
    Miscible*  misTerm;
 
    OCP_DBL maxPcow;
    OCP_DBL minPcow;
 
    OCP_DBL Fk;     
    OCP_DBL Fp;     
    OCP_DBL surTen; 
 
    /*
    OCP_DBL kroMis{0};  ///< miscible oil relative permeability
    OCP_DBL krgMis{0};  ///< miscible gas relative permeability
    OCP_DBL PcogMis{0}; ///< miscible gas capillary pressure
    OCP_DBL socrMis{0}; ///< oil critical miscible saturations
    OCP_DBL sgcrMis{0}; ///< gas critical miscible saturations
    */
};
 
// FlowUnit_ODGW02
 
class FlowUnit_ODGW02 : public FlowUnit_ODGW
{
public:
    FlowUnit_ODGW02() = default;
    FlowUnit_ODGW02(const ParamReservoir& rs_param, const USI& i);
    void SetupOptionalFeatures(const Grid&       myGrid,
                               OptionalFeatures& optFeatures) override{};
    void
    SetupScale(const OCP_USI& bId, OCP_DBL& Swin, const OCP_DBL& Pcowin) override{};
    void    CalKrPc(const OCP_DBL* S_in,
                    OCP_DBL*       kr_out,
                    OCP_DBL*       pc_out,
                    const OCP_USI& bId) override;
    void    CalKrPcDeriv(const OCP_DBL* S_in,
                         OCP_DBL*       kr_out,
                         OCP_DBL*       pc_out,
                         OCP_DBL*       dkrdS,
                         OCP_DBL*       dPcjdS,
                         const OCP_USI& bId) override;
    OCP_DBL CalKro_Stone2Der(OCP_DBL  krow,
                             OCP_DBL  krog,
                             OCP_DBL  krw,
                             OCP_DBL  krg,
                             OCP_DBL  dkrwdSw,
                             OCP_DBL  dkrowdSo,
                             OCP_DBL  dkrgdSg,
                             OCP_DBL  dkrogdSo,
                             OCP_DBL& out_dkrodSo) const;
    OCP_DBL CalKro_DefaultDer(const OCP_DBL& Sg,
                              const OCP_DBL& Sw,
                              const OCP_DBL& krog,
                              const OCP_DBL& krow,
                              const OCP_DBL& dkrogSo,
                              const OCP_DBL& dkrowSo,
                              OCP_DBL&       dkroSo) const;
 
    OCP_DBL GetPcowBySw(const OCP_DBL& sw) override { return SWFN.Eval(0, sw, 2); }
    OCP_DBL GetSwByPcow(const OCP_DBL& pcow) override
    {
        return SWFN.Eval_Inv(2, pcow, 0);
    }
    OCP_DBL GetPcgoBySg(const OCP_DBL& sg) override { return SGFN.Eval(0, sg, 2); }
    OCP_DBL GetSgByPcgo(const OCP_DBL& pcgo) override { return SGFN.Eval(2, pcgo, 0); }
    OCP_DBL GetSwByPcgw(const OCP_DBL& pcgw) override
    {
        return SWPCGW.Eval_Inv(1, pcgw, 0);
    }
    void Generate_SWPCWG();
 
protected:
    OCPTable SWFN;   
    OCPTable SGFN;   
    OCPTable SOF3;   
    OCPTable SWPCGW; 
};
 
#endif /* end if __FLOWUNIT_HEADER__ */
 
/*----------------------------------------------------------------------------*/
/*  Brief Change History of This File                                         */
/*----------------------------------------------------------------------------*/
/*  Author              Date             Actions                              */
/*----------------------------------------------------------------------------*/
/*  Shizhe Li           Oct/01/2021      Create file                          */
/*  Chensong Zhang      Oct/05/2022      Format file                          */
/*----------------------------------------------------------------------------*/