fi_params.h

Go to the documentation of this file.

#ifndef FI_PARAMS_H
#define FI_PARAMS_H

namespace blue_sky
  {
  class BS_API_PLUGIN fi_params : public named_pbase
    {
    public:
      BLUE_SKY_TYPE_DECL(fi_params);
    public:
      PROP_BASE_IDX_DECL_BEGIN(fi_params,named_pbase)
      FI_PARAMS_START,
      PVT_PRESSURE_RANGE_MAX,                     
      PVT_PRESSURE_RANGE_MIN,                     
      PVTO_RS_RANGE_MAX,                          
      PVTO_RS_RANGE_MIN,                          
      MAX_TS,                                     
      MIN_TS,                                     
      FIRST_TS,                                   
      LIN_SOLV_RESIDUAL,                          
      NEWTON_RESIDUAL,                            
      TS_INC_MULT,                                
      TS_DEC_MULT,                                
      OVERDRAFT,                                  
      MAX_P_CORRECTION,                           
      MAX_S_CORRECTION,                           
      MAX_RS_CORRECTION,                          
      MAX_P_WELL_CORRECTION,                      
      WAT_ROW_MULT,                               
      GAS_ROW_MULT,                               
      OIL_ROW_MULT,                               
      PRESSURE_COL_MULT,                          
      TS_OMEGA,                                   
      TS_DP,                                      
      TS_DS,                                      
      DP_MIN_CHOP,                                
      DS_MIN_CHOP,                                
      MAX_ALLOWED_LIN_SOLV_RESID,                 
      AMG_RESID,                                  
      TS_DRS,                                     
      MAX_NORM_ON_TS,                             
      DRSDT,                                      
      GAS_NORM_MULT,                              
      // compositional
      //COMP_PARAMS_D_MASS_BALANCE,                   //!< Scaled mass balance equation residuals. Equations are scaled by the accumulation terms (component mass dividing timestep size).
      //COMP_PARAMS_D_PHASE_EQUIL,                    //!< Scaled phase equilibrium relation residuals. These are scaled by the component fugacities in the gas phase
      //COMP_PARAMS_D_WELL_RATE,                      //!< Scaled well equation residuals, scaled by well input rate
      //COMP_PARAMS_D_MAX_DP,                         //!< The maximum scaled pressure change (absolute pressure change divided by the average reservoir pressure)
      //COMP_PARAMS_D_MAX_DS,                         //!< The maximum absolute saturation change
      //COMP_PARAMS_D_MAX_DXCP,                       //!< The maximum absolute component mole fraction change
      //COMP_PARAMS_D_TS_DP,                          //!< time step controling pressure change
      //COMP_PARAMS_D_TS_DS,                          //!< time step controling saturation change
      //COMP_PARAMS_D_TS_DXCP,                        //!< time step controling mole fraction change
      //COMP_PARAMS_D_MAX_P_CORRECTION,               //!< maximum allowed newton correction for pressure
      //COMP_PARAMS_D_MAX_S_CORRECTION,               //!< maximum allowed newton correction for saturation
      //COMP_PARAMS_D_MAX_XCP_CORRECTION,             //!< maximum allowed newton correction for mole fraction
      // black oil
      MASS_BALANS_ERROR,                          
      MAX_NORM_ON_FIRST_N,                        
      P_DIMENSION_LESS_SCALE_FACTOR,              
      APPL_CHOP_PERC,                             
      APPL_CHOP_BND,                              
      LIN_SOLV_MATBAL_RESIDUAL,                   
      S_RHS_NORM,                                 
      D_TOTAL,                                    

      PVT_INTERP_POINTS,                          
      NEWTON_ITERS_NUM,                           
      LIN_ITERS_NUM,                              
      NEWTON_ITERS_INC,                           
      NEWTON_ITERS_AMG,                           
      APPROX_STEPS,                               
      SELECT_SOL_STEPS,                           
      LIN_SOLVER_TYPE,                            
      GMRES_ORTONORM_VLEN,                        
      AMG_LIN_ITERS_NUM,                          
      WELL_NEWTON_ITERS_NUM,                      
      PREC_TYPE,                                  
      PREC_TYPE_ONE_PHASE,                        
      MIN_CELLS_IN_REGION,                        
      SAVE_STEP_DATA_PERIOD,                      
      I_TOTAL,                                    

      PRINT_PVTO_TABLE,                           
      PRINT_PVTW_TABLE,                           
      PRINT_PVTG_TABLE,                           
      STORE_PANE_FLOW_RATES,
      NEW_TS_SELECTION_ALGORITHM,                 
      SAVE_STEP_MAPS,                             
      SAVE_INITIAL_DATA,                          
      SAVE_RESTART_DATA,                          
      NEWTRANS,                                   
      CHECKS_FOR_MULTI_CONN,                      
      USE_TIMESTEP_FILE,                          
      SIMPLE_GET_CELL_SOLUTION,                   
      USE_LOW_SKIN_TRANS_MULT,                    
      SAVE_MESH_DATA,                             
      SAVE_CALC_DATA,                             
      LOAD_CALC_DATA,                             
      SAVE_NORM_DATA,                             
      DENS_JAC_SCALE,                             
      NEWTON_TUNING,
      SAVE_CROSSFLOW,
      G_FRACTURE,
      CLAMP_PRESSURE,                             
      G_FRACTURE_FINAL,
      SAVE_CONN_DATA,                             
      DISABLE_FRACTURE_CHECK,
      COMPRESS_IRR,                               
      REMOVE_ISOLATED_REGIONS,                    
      SAVE_WRATES_TO_ASCII_FILE,                  
      CREATE_HDF5_FILE,                           
      WRITE_PRESSURE_TO_HDF5,                     
      WRITE_SATURATION_TO_HDF5,                   
      FIX_SOIL_BUG,
      DISABLE_CROSSFLOW,
      WRITE_GAS_OIL_RATIO_TO_HDF5,                
      WRITE_FIP_RESULTS_TO_HDF5,                  
      WRITE_WELL_RESULTS_TO_HDF5,                 
      WRITE_CONN_RESULTS_TO_HDF5,                 
      WRITE_PLANE_FLOW_RATES_TO_HDF5,             
      USE_CFL,                                    
      WRITE_CFL_TO_HDF5,                          
      B_TOTAL,                                    
      FI_PARAMS_TOTAL,
      PROP_BASE_IDX_DECL_END

      virtual ~fi_params ();

      PBASE_ACCESS_MS(fi_params)

    public:
      typedef smart_ptr<FRead, true> sp_reader_t;

      const fi_params &operator=(const fi_params&);
      const fi_params &operator+=(const fi_params&);

      void set_default_values ();

      // read params from keyword data file
      void read_from_keyword_data_file (sp_reader_t r);

      //int write_data_to_res_file (res_frame_ctrl *parent_frame, int id = YS_ID_FI_PARAMS);

      //int read_data_from_res_file (res_frame_ctrl *parent_frame);

      virtual const std::string &get_params_name (idx_type idx);
    };

#ifdef BSPY_EXPORTING_PLUGIN
  void
  inline py_export_fi_params ()
  {
    using namespace boost::python;
    class_ <fi_params, bases <named_pbase>, boost::noncopyable> ("fi_params", no_init)
      ;

    register_ptr_to_python <smart_ptr <fi_params, true> > ();
    implicitly_convertible <smart_ptr <fi_params, true>, smart_ptr <named_pbase, true> > ();
  }
#endif

}

#endif // FI_PARAMS_H

---