blue_sky::fi_params Class Reference

#include <fi_params.h>

List of all members.

Public Types

typedef smart_ptr< FRead, true > sp_reader_t
 method for access property table

Public Member Functions

 BLUE_SKY_TYPE_DECL (fi_params)
 blue-sky class declaration
virtual PROP_BASE_IDX_DECL_END ~fi_params ()
 virtual dtor
const fi_paramsoperator= (const fi_params &)
 Assignment operator.
const fi_paramsoperator+= (const fi_params &)
 Update operator.
void set_default_values ()
 set default values for properties
void read_from_keyword_data_file (sp_reader_t r)
virtual const std::string & get_params_name (idx_type idx)
 write data to result file

Public Attributes

 FI_PARAMS_START
 enumeration definitions
 PVT_PRESSURE_RANGE_MAX
 PVT tables maximum pressure.
 PVT_PRESSURE_RANGE_MIN
 PVT tables minimal pressure.
 PVTO_RS_RANGE_MAX
 PVTO maximum RS for slop table.
 PVTO_RS_RANGE_MIN
 PVTO minimum RS for slop table.
 MAX_TS
 maximum allowed time step length
 MIN_TS
 minimum allowed time step length
 FIRST_TS
 first simulation time step length
 LIN_SOLV_RESIDUAL
 tolerance for linear solver
 NEWTON_RESIDUAL
 tolerance for newton process
 TS_INC_MULT
 multiplier for incrementing time step length
 TS_DEC_MULT
 multiplier for decrementing time step length
 OVERDRAFT
 overdraft factor (any time step could be multiplied by this factor to achieve end of report time step)
 MAX_P_CORRECTION
 maximum allowed newton correction for pressure
 MAX_S_CORRECTION
 maximum allowed newton correction for saturation
 MAX_RS_CORRECTION
 maximum allowed newton correction for gas oil ratio
 MAX_P_WELL_CORRECTION
 maximum allowed newton correction for well pressure
 WAT_ROW_MULT
 multiplier for water equation in Jacobian
 GAS_ROW_MULT
 multiplier for gas equation in Jacobian
 OIL_ROW_MULT
 multiplier for oil equation in Jacobian
 PRESSURE_COL_MULT
 multiplier for pressure derivates column in Jacobian
 TS_OMEGA
 omega coef in time step controling
 TS_DP
 pressure change for time step controling
 TS_DS
 saturation change for time step controling
 DP_MIN_CHOP
 minimum pressure chop
 DS_MIN_CHOP
 minimum saturation chop
 MAX_ALLOWED_LIN_SOLV_RESID
 maximum allowed residual
 AMG_RESID
 tolerance for AMG preconditioner
 TS_DRS
 Rs change for time step controling.
 MAX_NORM_ON_TS
 if norm on time step is greater than this value restart occur
 DRSDT
 Maximum rate of increase of solution GOR.
 GAS_NORM_MULT
 multiplier for gas norm
 MASS_BALANS_ERROR
 maximum allowed mass balans error
 MAX_NORM_ON_FIRST_N
 maximum allowed norm on first newton iteration
 P_DIMENSION_LESS_SCALE_FACTOR
 scale factor for dimension less pressure
 APPL_CHOP_PERC
 typically (0.25-0.4)
 APPL_CHOP_BND
 typically (0.1-0.25)
 LIN_SOLV_MATBAL_RESIDUAL
 mat. balans tolerance for linear solver
 S_RHS_NORM
 max value for secondary rhs
 D_TOTAL
 all parameters should be before this item
 PVT_INTERP_POINTS
 indexes for integer parameters
 NEWTON_ITERS_NUM
 maximum allowed newton iterations number
 LIN_ITERS_NUM
 maximum allowed linear iterations number
 NEWTON_ITERS_INC
 number of newton iterations to increment step length
 NEWTON_ITERS_AMG
 number of newton iterations to build full amg setup
 APPROX_STEPS
 number of approximation steps
 SELECT_SOL_STEPS
 number of steps to select newton correction force term
 LIN_SOLVER_TYPE
 type of linear solver
 GMRES_ORTONORM_VLEN
 number of vectors in GMRES to ortonorm
 AMG_LIN_ITERS_NUM
 maximum allowed AMG solver iterations
 WELL_NEWTON_ITERS_NUM
 maximum number of well internal newton iterations
 PREC_TYPE
 type of the preconditioner for linear solver
 PREC_TYPE_ONE_PHASE
 type of the preconditioner for linear solver for 1-phase problem
 MIN_CELLS_IN_REGION
 minimum allowed cells in region for ACTNUM = 1
 SAVE_STEP_DATA_PERIOD
 save step data every n step
 I_TOTAL
 all parameters should be before this item
 PRINT_PVTO_TABLE
 indexes for boolean parameters
 PRINT_PVTW_TABLE
 print pvtw interpolation table
 PRINT_PVTG_TABLE
 print pvtg interpolation table
 STORE_PANE_FLOW_RATES
 NEW_TS_SELECTION_ALGORITHM
 use new algorithm for ts selection
 SAVE_STEP_MAPS
 save maps on time step in the rst file
 SAVE_INITIAL_DATA
 save initial data in the rst file
 SAVE_RESTART_DATA
 save restart information
 NEWTRANS
 correct transmissibility calculation between cells
 CHECKS_FOR_MULTI_CONN
 check for multi connections in one cell
 USE_TIMESTEP_FILE
 save time steps into *tsl file
 SIMPLE_GET_CELL_SOLUTION
 enable simple solution restore algorithm
 USE_LOW_SKIN_TRANS_MULT
 if this item is set use calculation of trans mults for low skin
 SAVE_MESH_DATA
 save initial data in the rst file
 SAVE_CALC_DATA
 save solution vector at each large time step into .dmp file
 LOAD_CALC_DATA
 load initial guesses for Newton iterations from .dmp file
 SAVE_NORM_DATA
 save cells norms to .cel file
 DENS_JAC_SCALE
 enable densities based multiplier's for gas and oil equation's in Jacobian
 NEWTON_TUNING
 SAVE_CROSSFLOW
 G_FRACTURE
 CLAMP_PRESSURE
 clamp pressure values at each Newton iteration between possible min and max
 G_FRACTURE_FINAL
 SAVE_CONN_DATA
 save connection rates to rst file
 DISABLE_FRACTURE_CHECK
 COMPRESS_IRR
 compress irregular matrix
 REMOVE_ISOLATED_REGIONS
 make isolated regions with out wells inactive
 SAVE_WRATES_TO_ASCII_FILE
 save well rates to ascii file
 CREATE_HDF5_FILE
 create hdf5 file
 WRITE_PRESSURE_TO_HDF5
 write pressure to hdf5
 WRITE_SATURATION_TO_HDF5
 write saturation to hdf5
 FIX_SOIL_BUG
 DISABLE_CROSSFLOW
 WRITE_GAS_OIL_RATIO_TO_HDF5
 write gas-oil ratio values to hdf5 file
 WRITE_FIP_RESULTS_TO_HDF5
 write data by fip regions to hdf5 file
 WRITE_WELL_RESULTS_TO_HDF5
 write well data to hdf5 file
 WRITE_CONN_RESULTS_TO_HDF5
 write connection data to hdf5 file
 WRITE_PLANE_FLOW_RATES_TO_HDF5
 write plane flow rates to hdf5 file
 USE_CFL
 compute CFL in fi_operator and use csr_ilu_cfl_prec, used only if BS_BOS_CORE_USE_CSR_ILU_CFL_PREC defined
 WRITE_CFL_TO_HDF5
 write CFL vector to hdf5 file
 B_TOTAL
 all parameters should be before this item
 FI_PARAMS_TOTAL


Member Typedef Documentation

typedef smart_ptr<FRead, true> blue_sky::fi_params::sp_reader_t

method for access property table


Constructor & Destructor Documentation

virtual PROP_BASE_IDX_DECL_END blue_sky::fi_params::~fi_params (  )  [virtual]

virtual dtor

Type Constraints


Member Function Documentation

blue_sky::fi_params::BLUE_SKY_TYPE_DECL ( fi_params   ) 

blue-sky class declaration

virtual const std::string& blue_sky::fi_params::get_params_name ( idx_type  idx  )  [virtual]

write data to result file

read data from result file returns name by index

const fi_params& blue_sky::fi_params::operator+= ( const fi_params  ) 

Update operator.

const fi_params& blue_sky::fi_params::operator= ( const fi_params  ) 

Assignment operator.

void blue_sky::fi_params::read_from_keyword_data_file ( sp_reader_t  r  ) 

void blue_sky::fi_params::set_default_values (  ) 

set default values for properties


Member Data Documentation

maximum allowed AMG solver iterations

tolerance for AMG preconditioner

typically (0.1-0.25)

typically (0.25-0.4)

all parameters should be before this item

check for multi connections in one cell

clamp pressure values at each Newton iteration between possible min and max

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::get_clamp_pressure().

compress irregular matrix

create hdf5 file

all parameters should be before this item

enable densities based multiplier's for gas and oil equation's in Jacobian

minimum pressure chop

Maximum rate of increase of solution GOR.

minimum saturation chop

enumeration definitions

indexes for floating point parameters

first simulation time step length

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::get_first_ts().

multiplier for gas norm

multiplier for gas equation in Jacobian

number of vectors in GMRES to ortonorm

all parameters should be before this item

maximum allowed linear iterations number

mat. balans tolerance for linear solver

tolerance for linear solver

type of linear solver

load initial guesses for Newton iterations from .dmp file

maximum allowed mass balans error

maximum allowed norm on first newton iteration

Referenced by blue_sky::fi_operator_impl< strategy_t >::do_dt_reduce().

if norm on time step is greater than this value restart occur

Referenced by blue_sky::fi_operator_impl< strategy_t >::do_dt_tuning().

maximum allowed newton correction for pressure

maximum allowed newton correction for well pressure

maximum allowed newton correction for gas oil ratio

maximum allowed newton correction for saturation

minimum allowed cells in region for ACTNUM = 1

use new algorithm for ts selection

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

number of newton iterations to build full amg setup

number of newton iterations to increment step length

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

tolerance for newton process

correct transmissibility calculation between cells

multiplier for oil equation in Jacobian

overdraft factor (any time step could be multiplied by this factor to achieve end of report time step)

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::decrease_ts(), and blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

scale factor for dimension less pressure

type of the preconditioner for linear solver

type of the preconditioner for linear solver for 1-phase problem

multiplier for pressure derivates column in Jacobian

print pvtg interpolation table

indexes for boolean parameters

if this item is set print PVTO to LOG file

print pvtw interpolation table

indexes for integer parameters

number of interpolation points

PVT tables maximum pressure.

PVT tables minimal pressure.

PVTO maximum RS for slop table.

PVTO minimum RS for slop table.

make isolated regions with out wells inactive

max value for secondary rhs

save solution vector at each large time step into .dmp file

save connection rates to rst file

save initial data in the rst file

save initial data in the rst file

save cells norms to .cel file

save restart information

save step data every n step

save maps on time step in the rst file

save well rates to ascii file

number of steps to select newton correction force term

Referenced by blue_sky::fi_operator_impl< strategy_t >::save_prev_niter_vars().

enable simple solution restore algorithm

multiplier for decrementing time step length

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::decrease_ts().

pressure change for time step controling

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

Rs change for time step controling.

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

saturation change for time step controling

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

multiplier for incrementing time step length

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

omega coef in time step controling

Referenced by blue_sky::main_loop_calc< strategy_t, is_w, is_g, is_o >::increase_ts().

compute CFL in fi_operator and use csr_ilu_cfl_prec, used only if BS_BOS_CORE_USE_CSR_ILU_CFL_PREC defined

Referenced by blue_sky::mpfa::block_connections_mpfa().

if this item is set use calculation of trans mults for low skin

save time steps into *tsl file

multiplier for water equation in Jacobian

maximum number of well internal newton iterations

write CFL vector to hdf5 file

write connection data to hdf5 file

Referenced by blue_sky::save_well_data< strategy_t >::copy_well_data_to_storage().

write data by fip regions to hdf5 file

write gas-oil ratio values to hdf5 file

write plane flow rates to hdf5 file

write pressure to hdf5

write saturation to hdf5

write well data to hdf5 file


The documentation for this class was generated from the following file:

Generated on Fri Nov 13 12:07:13 2009 for TheBSEagleProject by  doxygen 1.5.8