OCPOutput.hpp

Go to the documentation of this file.

 
#ifndef __OCP_OUTPUT_HEADER__
#define __OCP_OUTPUT_HEADER__
 
// Standard header files
#include <iomanip>
#include <iostream>
 
// OpenCAEPoro header files
#include "OCPControl.hpp"
#include "ParamOutput.hpp"
#include "Reservoir.hpp"
#include "UtilOutput.hpp"
 
using namespace std;
 
class OCPIJK
{
public:
    OCPIJK() = default;
    OCPIJK(const USI& i, const USI& j, const USI& k)
        : I(i)
        , J(j)
        , K(k) {};
    OCPIJK(const COOIJK& src)
    {
        I = src.I;
        J = src.J;
        K = src.K;
    };
    OCPIJK& operator=(const COOIJK& src)
    {
        I = src.I;
        J = src.J;
        K = src.K;
        return *this;
    }
    USI I, J, K;
};
 
template <typename T> class OCPType_Sum
{
public:
    OCPType_Sum& operator=(const Type_A_o& src)
    {
        activity = src.activity;
        obj      = src.obj;
        return *this;
    }
    OCPType_Sum& operator=(const Type_B_o& src)
    {
        activity = src.activity;
        obj.assign(src.obj.begin(), src.obj.end());
        return *this;
    }
    bool      activity{false};
    vector<T> obj;
    vector<USI>
        index; 
};
 
class SumPair
{
public:
    SumPair(const string& item, const string& obj, const string& unit)
        : Item(item)
        , Obj(obj)
        , Unit(unit){};
    string          Item;
    string          Obj;
    string          Unit;
    vector<OCP_DBL> val;
};
 
//  Note: It contains the most interested information in each time step, which usually
//  will be convert to figures for later analysis.
class Summary
{
public:
    void InputParam(const OutputSummary& summary_param);
 
    void Setup(const Reservoir& reservoir, const OCP_DBL& totalTime);
 
    void SetVal(const Reservoir& reservoir, const OCPControl& ctrl);
 
    void PrintInfo(const string& dir) const;
 
private:
    vector<SumPair> Sumdata; 
 
    bool FPR{false};  
    bool FOPR{false}; 
    bool FOPT{false}; 
    bool FGPR{false}; 
    bool FGPt{false}; 
    bool FWPR{false}; 
    bool FWPT{false}; 
    bool FGIR{false}; 
    bool FGIT{false}; 
    bool FWIR{false}; 
    bool FWIT{false}; 
 
    OCPType_Sum<string> WOPR; 
    OCPType_Sum<string> WOPT; 
    OCPType_Sum<string> WGPR; 
    OCPType_Sum<string> WGPT; 
    OCPType_Sum<string> WWPR; 
    OCPType_Sum<string> WWPT; 
    OCPType_Sum<string> WGIR; 
    OCPType_Sum<string> WGIT; 
    OCPType_Sum<string> WWIR; 
    OCPType_Sum<string> WWIT; 
    OCPType_Sum<string> WBHP; 
    OCPType_Sum<string> DG;   
 
    OCPType_Sum<OCPIJK> BPR;  
    OCPType_Sum<OCPIJK> SOIL; 
    OCPType_Sum<OCPIJK> SGAS; 
    OCPType_Sum<OCPIJK> SWAT; 
};
 
class CriticalInfo
{
public:
    void Setup(const OCP_DBL& totalTime);
 
    void SetVal(const Reservoir& reservoir, const OCPControl& ctrl);
 
    void PrintInfo(const string& dir) const;
 
private:
    vector<OCP_DBL> time;  
    vector<OCP_DBL> dt;    
    vector<OCP_DBL> dPmax; 
    vector<OCP_DBL> dVmax; 
    vector<OCP_DBL> dSmax; 
    vector<OCP_DBL> dNmax; 
    vector<OCP_DBL> cfl;   
};
 
class DetailInfo
{
public:
    void InputParam(const OutputDetail& detail_param);
    void Setup(const string& dir);
    void PrintInfo(const string& dir, const Reservoir& rs, const OCP_DBL& days) const;
 
private:
    bool PRE{false};  
    bool PGAS{false}; 
    bool PWAT{false}; 
    bool SOIL{false}; 
    bool SGAS{false}; 
    bool SWAT{false}; 
    bool DENO{false}; 
    bool DENG{false}; 
    bool DENW{false}; 
    bool KRO{false}; 
    bool KRG{false}; 
    bool KRW{false}; 
    bool BOIL{false}; 
    bool BGAS{false}; 
    bool BWAT{false}; 
    bool VOIL{false}; 
    bool VGAS{false}; 
    bool VWAT{false}; 
    bool XMF{false}; 
    bool YMF{false}; 
    bool PCW{false}; 
};
 
//  Note: The most commonly used is the summary file, which usually gives the
//  information of bulks and wells in each time step, such as average pressure, oil
//  production rate of wells. If other information at critical dates is of interest, you
//  can chose the PRT file (TODO). Also, some infomation will be printed on the screen
//  at the critical dates to make sure the program is at the right way.
class OCPOutput
{
    friend class OpenCAEPoro;
 
public:
    void InputParam(const ParamOutput& paramOutput);
    void Setup(const Reservoir& reservoir, const OCPControl& ctrl);
    void SetVal(const Reservoir& reservoir, const OCPControl& ctrl);
    void PrintInfo() const;
    void PrintInfoSched(const Reservoir& rs, const OCPControl& ctrl,
                        const OCP_DBL& time) const;
 
private:
    string       wordDir;
    Summary      summary;
    CriticalInfo crtInfo;
    DetailInfo   dtlInfo;
};
 
#endif /* end if __OCPOUTPUT_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/08/2022      Update Doxygen                       */
/*----------------------------------------------------------------------------*/