OCP.hpp

Go to the documentation of this file.

 
#ifndef __OCP_HEADER__
#define __OCP_HEADER__
 
// OpenCAEPoro header files
#include "OCPControl.hpp"
#include "OCPOutput.hpp"
#include "ParamRead.hpp"
#include "Reservoir.hpp"
#include "Solver.hpp"
#include "UtilTiming.hpp"
 
#define OCPVersion "0.2.1" 
 
class OpenCAEPoro
{
public:
    void PrintVersion() const
    {
        cout << "=========================================" << endl
             << "OpenCAEPoro Version-" << OCPVersion << endl
             << "=========================================" << endl
             << endl;
    };
 
    void PrintUsage(string cmdname) const
    {
        cout << "Usage: " << endl
             << "  " << cmdname << " <InputFileName> [<options>]" << endl
             << endl;
 
        cout << "The simplest usage is as follows, where parameters are read from file:"
             << endl
             << "  " << cmdname
             << " examples/spe1a/spe1a.data  %% Solve SPE1a in default setting" << endl
             << endl;
 
        cout << "You can also pass cmd options after the input file:" << endl
             << "  method: solution method to use " << endl
             << "  dtInit: initial time stepsize  " << endl
             << "  dtMax:  maximum time stepsize  " << endl
             << "  dtMin:  minimum time stepsize  " << endl
             << "  pl:     print level on screen  " << endl
             << endl;
 
        cout << "Attention: " << endl
             << "  - These cmd options will override those in the input file;" << endl
             << "  - Only if `method' is set, other options will take effect;" << endl
             << "  - If (dtInit,dtMax,dtMin) are not set, default values will be used."
             << endl;
 
        cout << endl
             << "For example: solve SPE1a using FIM" << endl
             << "  " << cmdname
             << " examples/spe1a/spe1a.data method=FIM dtInit=1 dtMax=10 dtMin=0.1 pl=1"
             << endl;
    }
 
    void InputParam(ParamRead& param);
 
    void SetupSimulator(ParamRead& param, const USI& argc, const char* options[]);
 
    void InitReservoir();
 
    void RunSimulation();
 
    void OutputResults() const;
 
private:
    Reservoir reservoir;
 
    Solver solver;
 
    OCPControl control;
 
    OCPOutput output;
};
 
#endif /* end if __OCP_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      New tag info                         */
/*  Chensong Zhang      Sep/21/2022      Add PrintUsage                       */
/*----------------------------------------------------------------------------*/