Grid.hpp

Go to the documentation of this file.

 
#ifndef __GRID_HEADER__
#define __GRID_HEADER__
 
// Standard header files
#include <iostream>
#include <vector>
 
// OpenCAEPoro header files
#include "CornerGrid.hpp"
#include "OCPConst.hpp"
#include "ParamOutput.hpp"
#include "ParamReservoir.hpp"
#include "UtilOutput.hpp"
 
using namespace std;
 
//  Note: GB_Pair contains two variables, which indicates if a grid cell is active or
//  not and its index among active cells if it is active.
class GB_Pair
{
public:
    GB_Pair() = default;
    GB_Pair(const OCP_BOOL& act, const OCP_USI& i)
        : activity(act)
        , index(i){};
 
    OCP_BOOL IsAct() const { return activity; }
    OCP_USI GetId() const { return index; }
 
private:
    OCP_BOOL activity; 
    OCP_USI  index;    
};
 
class GPair
{
public:
    GPair() = default;
    GPair(const OCP_USI& Id,
          const USI&     Direct,
          const OCP_DBL& AreaB,
          const OCP_DBL& AreaE)
        : id(Id)
        , direction(Direct)
        , areaB(AreaB)
        , areaE(AreaE){};
    static OCP_BOOL lessG(const GPair& G1, const GPair& G2) { return G1.id < G2.id; }
 
    OCP_USI id;        
    USI     direction; 
    OCP_DBL
        areaB; 
    OCP_DBL areaE; 
};
 
class OCPpolyhedron
{
public:
    OCPpolyhedron() = default;
    OCPpolyhedron(const USI& n)
        : numPoints(n)
    {
        Points.reserve(numPoints);
    };
    vector<Point3D> Points;
    USI             numPoints;
};
 
class Grid
{
    friend class Bulk;
    friend class BulkConn;
    friend class Well;
    friend class ScalePcow;
    friend class Out4RPT;
    friend class Out4VTK;
 
    // Input Param and Setup
 
public:
    void InputParam(const ParamReservoir& rs_param, const ParamOutput& output_param);
 
    void SetupIsoT();
    void SetupT();
    void Setup();
 
protected:
    void SetupOrthogonalGrid();
    void CalDepthVOrthogonalGrid();
    void SetupNeighborOrthogonalGrid();
 
    void SetupCornerGrid();
    void SetupBasicCornerGrid(const OCP_COORD& CoTmp);
    void SetupNeighborCornerGrid(const OCP_COORD& CoTmp);
 
    void CalActiveGridIsoT(const OCP_DBL& e1, const OCP_DBL& e2);
    void CalActiveGridT(const OCP_DBL& e1, const OCP_DBL& e2);
 
    void SetupGridLocation();
 
public:
    OCP_USI GetGridNum() const { return numGrid; }
    OCP_INT GetActIndex(const USI& I, const USI& J, const USI& K) const;
 
protected:
    // Grid type
    USI     gridType; 
    OCP_USI numGrid;  
 
    // structured grid
    USI nx; 
    USI ny; 
    USI nz; 
 
    // Corner-point grid
    vector<OCP_DBL> coord; 
    vector<OCP_DBL> zcorn; 
 
    // Grid location
    // Isothermal model: useless now.
    // Thermal model: only top face and bottom face will be recorded.
    vector<USI> gLocation; 
 
    // Orthogonal grid
    vector<OCP_DBL> tops; 
 
    // General informations
    vector<OCP_DBL> dx;    
    vector<OCP_DBL> dy;    
    vector<OCP_DBL> dz;    
    vector<OCP_DBL> v;     
    vector<OCP_DBL> depth; 
 
    // Rock properties
    vector<OCP_DBL> ntg;    
    vector<OCP_DBL> poro;   
    vector<OCP_DBL> kx;     
    vector<OCP_DBL> ky;     
    vector<OCP_DBL> kz;     
    vector<OCP_DBL> thconr; 
 
    // Region
    vector<USI> SATNUM;  
    vector<USI> PVTNUM;  
    vector<USI> ACTNUM;  
    vector<USI> ROCKNUM; 
 
    // Initial Properties
    vector<OCP_DBL> SwatInit; 
 
    // Connections
    vector<vector<GPair>> gNeighbor; 
 
    // Active grid cells
    OCP_USI activeGridNum; 
    vector<OCP_USI>
        map_Act2All; 
    vector<GB_Pair> map_All2Act; 
    // Fluid grid cells
    OCP_USI         fluidGridNum; 
    vector<GB_Pair> map_All2Flu;  
 
    // Output
 
public:
    void     GetIJKGrid(USI& i, USI& j, USI& k, const OCP_USI& n) const;
    void     GetIJKBulk(USI& i, USI& j, USI& k, const OCP_USI& n) const;
    OCP_BOOL IfUseVtk() const
    {
        return useVTK;
    }                                    
    void SetHexaherdronGridOrthogonal(); 
    void SetHexaherdronGridCorner(
        const OCP_COORD& mycord); 
    void SetupGridTag();
    void OutputBaiscInfo() const; 
    void CalNumDigutIJK();        
    USI  GetNumDigitIJK() const { return numDigutIJK; } 
protected:
    OCP_BOOL              useVTK{OCP_FALSE}; 
    vector<OCPpolyhedron> polyhedronGrid;    
    vector<USI>           gridTag;     
    USI                   numDigutIJK; 
};
 
#endif /* end if __GRID_HEADER__ */
 
/*----------------------------------------------------------------------------*/
/*  Brief Change History of This File                                         */
/*----------------------------------------------------------------------------*/
/*  Author              Date             Actions                              */
/*----------------------------------------------------------------------------*/
/*  Shizhe Li           Oct/01/2021      Create file                          */
/*  Chensong Zhang      Oct/15/2021      Format file                          */
/*  Shizhe Li           Nov/18/2021      Add Connections between Grids        */
/*  Chensong Zhang      Jan/16/2022      Finish Doxygen                       */
/*----------------------------------------------------------------------------*/