BlackoilModelParameters.hpp
1 /*
2  Copyright 2015 SINTEF ICT, Applied Mathematics.
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #ifndef OPM_BLACKOILMODELPARAMETERS_HEADER_INCLUDED
21 #define OPM_BLACKOILMODELPARAMETERS_HEADER_INCLUDED
22 
23 #include <string>
24 
25 namespace Opm
26 {
27 
28  class ParameterGroup;
29 
32  {
34  double dp_max_rel_;
36  double ds_max_;
38  double dr_max_rel_;
40  double dbhp_max_rel_;
46  double tolerance_mb_;
52  // TODO: it might need to distinguish between rate control and pressure control later
58 
61 
64 
67 
71 
74 
77 
80 
83 
90 
92  std::string deck_file_name_;
93 
95  explicit BlackoilModelParameters( const ParameterGroup& param );
96 
99 
101  void reset();
102  };
103 
104 } // namespace Opm
105 
106 #endif // OPM_BLACKOILMODELPARAMETERS_HEADER_INCLUDED
int max_strict_iter_
Maximum number of Newton iterations before we give up on the CNV convergence criterion.
Definition: BlackoilModelParameters.hpp:73
double tolerance_cnv_
Local convergence tolerance (max of local saturation errors).
Definition: BlackoilModelParameters.hpp:48
double dp_max_rel_
Max relative change in pressure in single iteration.
Definition: BlackoilModelParameters.hpp:34
double dbhp_max_rel_
Max relative change in bhp in single iteration.
Definition: BlackoilModelParameters.hpp:40
double tolerance_mb_
Relative mass balance tolerance (total mass balance error).
Definition: BlackoilModelParameters.hpp:46
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: AdditionalObjectDeleter.hpp:22
double max_residual_allowed_
Absolute max limit for residuals.
Definition: BlackoilModelParameters.hpp:44
Solver parameters for the BlackoilModel.
Definition: BlackoilModelParameters.hpp:31
int max_inner_iter_ms_wells_
Maximum inner iteration number for ms wells.
Definition: BlackoilModelParameters.hpp:63
bool use_inner_iterations_ms_wells_
Whether to use inner iterations for ms wells.
Definition: BlackoilModelParameters.hpp:60
void reset()
Set default parameters.
Definition: BlackoilModelParameters.cpp:73
double tolerance_wells_
Well convergence tolerance.
Definition: BlackoilModelParameters.hpp:50
std::string deck_file_name_
The file name of the deck.
Definition: BlackoilModelParameters.hpp:92
double dwell_fraction_max_
Max absolute change in well volume fraction in single iteration.
Definition: BlackoilModelParameters.hpp:42
double maxSinglePrecisionTimeStep_
Tolerance for time step in seconds where single precision can be used for solving for the Jacobian...
Definition: BlackoilModelParameters.hpp:70
double tolerance_well_control_
Tolerance for the well control equations.
Definition: BlackoilModelParameters.hpp:53
bool update_equations_scaling_
Update scaling factors for mass balance equations.
Definition: BlackoilModelParameters.hpp:79
BlackoilModelParameters()
Construct with default parameters.
Definition: BlackoilModelParameters.cpp:28
double ds_max_
Max absolute change in saturation in single iteration.
Definition: BlackoilModelParameters.hpp:36
double dr_max_rel_
Max relative change in gas-oil or oil-gas ratio in single iteration.
Definition: BlackoilModelParameters.hpp:38
double max_pressure_change_ms_wells_
Maximum pressure change over an iteratio for ms wells.
Definition: BlackoilModelParameters.hpp:57
int max_welleq_iter_
Maximum iteration number of the well equation solution.
Definition: BlackoilModelParameters.hpp:66
double tolerance_pressure_ms_wells_
Tolerance for the pressure equations for multisegment wells.
Definition: BlackoilModelParameters.hpp:55
bool solve_welleq_initially_
Solve well equation initially.
Definition: BlackoilModelParameters.hpp:76
bool use_multisegment_well_
Whether to use MultisegmentWell to handle multisegment wells it is something temporary before the mul...
Definition: BlackoilModelParameters.hpp:89
bool use_update_stabilization_
Try to detect oscillation or stagnation.
Definition: BlackoilModelParameters.hpp:82