/*
Copyright 2015 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see .
*/
#ifndef OPM_BLACKOILMODELPARAMETERS_HEADER_INCLUDED
#define OPM_BLACKOILMODELPARAMETERS_HEADER_INCLUDED
#include
#include
#include
#include
#include
#include
#include
#include
#include
namespace Opm::Properties::TTag {
struct FlowModelParameters {};
}
namespace Opm::Parameters {
template
struct EclDeckFileName { using type = Properties::UndefinedProperty; };
template
struct DbhpMaxRel { using type = Properties::UndefinedProperty; };
template
struct DwellFractionMax { using type = Properties::UndefinedProperty; };
template
struct MaxResidualAllowed { using type = Properties::UndefinedProperty; };
template
struct RelaxedMaxPvFraction { using type = Properties::UndefinedProperty; };
template
struct ToleranceMb { using type = Properties::UndefinedProperty; };
template
struct ToleranceMbRelaxed { using type = Properties::UndefinedProperty; };
template
struct ToleranceCnv { using type = Properties::UndefinedProperty; };
template
struct ToleranceCnvRelaxed { using type = Properties::UndefinedProperty; };
template
struct ToleranceWells { using type = Properties::UndefinedProperty; };
template
struct ToleranceWellControl { using type = Properties::UndefinedProperty; };
template
struct MaxWelleqIter { using type = Properties::UndefinedProperty; };
template
struct UseMultisegmentWell { using type = Properties::UndefinedProperty; };
template
struct MaxSinglePrecisionDays { using type = Properties::UndefinedProperty; };
template
struct MinStrictCnvIter { using type = Properties::UndefinedProperty; };
template
struct MinStrictMbIter { using type = Properties::UndefinedProperty; };
template
struct SolveWelleqInitially { using type = Properties::UndefinedProperty; };
template
struct UpdateEquationsScaling { using type = Properties::UndefinedProperty; };
template
struct UseUpdateStabilization { using type = Properties::UndefinedProperty; };
template
struct MatrixAddWellContributions { using type = Properties::UndefinedProperty; };
template
struct EnableWellOperabilityCheck { using type = Properties::UndefinedProperty; };
template
struct EnableWellOperabilityCheckIter { using type = Properties::UndefinedProperty; };
template
struct DebugEmitCellPartition { using type = Properties::UndefinedProperty; };
// parameters for multisegment wells
template
struct TolerancePressureMsWells { using type = Properties::UndefinedProperty; };
template
struct MaxPressureChangeMsWells { using type = Properties::UndefinedProperty; };
template
struct MaxInnerIterMsWells { using type = Properties::UndefinedProperty; };
template
struct StrictInnerIterWells { using type = Properties::UndefinedProperty; };
template
struct RelaxedWellFlowTol { using type = Properties::UndefinedProperty; };
template
struct StrictOuterIterWells { using type = Properties::UndefinedProperty; };
template
struct RelaxedPressureTolMsw { using type = Properties::UndefinedProperty; };
template
struct RegularizationFactorWells { using type = Properties::UndefinedProperty; };
template
struct MaxNewtonIterationsWithInnerWellIterations { using type = Properties::UndefinedProperty; };
template
struct ShutUnsolvableWells { using type = Properties::UndefinedProperty; };
template
struct MaxInnerIterWells { using type = Properties::UndefinedProperty; };
template
struct AlternativeWellRateInit { using type = Properties::UndefinedProperty; };
template
struct MaximumNumberOfWellSwitches { using type = Properties::UndefinedProperty; };
template
struct UseAverageDensityMsWells { using type = Properties::UndefinedProperty; };
template
struct LocalWellSolveControlSwitching { using type = Properties::UndefinedProperty; };
template
struct UseImplicitIpr { using type = Properties::UndefinedProperty; };
// Network solver parameters
template
struct NetworkMaxStrictIterations { using type = Properties::UndefinedProperty; };
template
struct NetworkMaxIterations { using type = Properties::UndefinedProperty; };
template
struct NonlinearSolver { using type = Properties::UndefinedProperty; };
template
struct LocalSolveApproach { using type = Properties::UndefinedProperty; };
template
struct MaxLocalSolveIterations { using type = Properties::UndefinedProperty; };
template
struct LocalToleranceScalingMb { using type = Properties::UndefinedProperty; };
template
struct LocalToleranceScalingCnv { using type = Properties::UndefinedProperty; };
template
struct NlddNumInitialNewtonIter { using type = Properties::UndefinedProperty; };
template
struct NumLocalDomains { using type = Properties::UndefinedProperty; };
template
struct LocalDomainsPartitioningImbalance { using type = Properties::UndefinedProperty; };
template
struct LocalDomainsPartitioningMethod { using type = Properties::UndefinedProperty; };
template
struct LocalDomainsOrderingMeasure { using type = Properties::UndefinedProperty; };
template
struct DbhpMaxRel
{
using type = GetPropType;
static constexpr type value = 1.0;
};
template
struct DwellFractionMax
{
using type = GetPropType;
static constexpr type value = 0.2;
};
template
struct MaxResidualAllowed
{
using type = GetPropType;
static constexpr type value = 1e7;
};
template
struct RelaxedMaxPvFraction
{
using type = GetPropType;
static constexpr type value = 0.03;
};
template
struct ToleranceMb
{
using type = GetPropType;
static constexpr type value = 1e-6;
};
template
struct ToleranceMbRelaxed
{
using type = GetPropType;
static constexpr type value = 1e-6;
};
template
struct ToleranceCnv
{
using type = GetPropType;
static constexpr type value = 1e-2;
};
template
struct ToleranceCnvRelaxed
{
using type = GetPropType;
static constexpr type value = 1;
};
template
struct ToleranceWells
{
using type = GetPropType;
static constexpr type value = 1e-4;
};
template
struct ToleranceWellControl
{
using type = GetPropType;
static constexpr type value = 1e-7;
};
template
struct MaxWelleqIter
{ static constexpr int value = 30; };
template
struct UseMultisegmentWell
{ static constexpr bool value = true; };
template
struct MaxSinglePrecisionDays
{
using type = GetPropType;
static constexpr type value = 20.0;
};
template
struct MinStrictCnvIter
{ static constexpr int value = 0; };
template
struct MinStrictMbIter
{ static constexpr int value = -1; };
template
struct SolveWelleqInitially
{ static constexpr bool value = true; };
template
struct UpdateEquationsScaling
{ static constexpr bool value = false; };
template
struct UseUpdateStabilization
{ static constexpr bool value = true; };
template
struct MatrixAddWellContributions
{ static constexpr bool value = false; };
template
struct TolerancePressureMsWells
{
using type = GetPropType;
static constexpr type value = 0.01*1e5;
};
template
struct MaxPressureChangeMsWells
{
using type = GetPropType;
static constexpr type value = 10*1e5;
};
template
struct MaxNewtonIterationsWithInnerWellIterations
{ static constexpr int value = 8; };
template
struct MaxInnerIterMsWells
{ static constexpr int value = 100; };
template
struct MaxInnerIterWells
{ static constexpr int value = 50; };
template
struct ShutUnsolvableWells
{ static constexpr bool value = true; };
template
struct AlternativeWellRateInit
{ static constexpr bool value = true; };
template
struct StrictOuterIterWells
{ static constexpr int value = 6; };
template
struct StrictInnerIterWells
{ static constexpr int value = 40; };
template
struct RegularizationFactorWells
{
using type = GetPropType;
static constexpr type value = 100;
};
template
struct EnableWellOperabilityCheck
{ static constexpr bool value = true; };
template
struct EnableWellOperabilityCheckIter
{ static constexpr bool value = false; };
template
struct DebugEmitCellPartition
{ static constexpr bool value = false; };
template
struct RelaxedWellFlowTol
{
using type = GetPropType;
static constexpr type value = 1e-3;
};
template
struct RelaxedPressureTolMsw
{
using type = GetPropType;
static constexpr type value = 1.0e4;
};
template
struct MaximumNumberOfWellSwitches
{ static constexpr int value = 3; };
template
struct UseAverageDensityMsWells
{ static constexpr bool value = false; };
template
struct LocalWellSolveControlSwitching
{ static constexpr bool value = false; };
template
struct UseImplicitIpr
{ static constexpr bool value = false; };
// Network solver parameters
template
struct NetworkMaxStrictIterations
{ static constexpr int value = 100; };
template
struct NetworkMaxIterations
{ static constexpr int value = 200; };
template
struct NonlinearSolver
{ static constexpr auto value = "newton"; };
template
struct LocalSolveApproach
{ static constexpr auto value = "gauss-seidel"; };
template
struct MaxLocalSolveIterations
{ static constexpr int value = 20; };
template
struct LocalToleranceScalingMb
{
using type = GetPropType;
static constexpr type value = 1.0;
};
template
struct LocalToleranceScalingCnv
{
using type = GetPropType;
static constexpr type value = 0.1;
};
template
struct NlddNumInitialNewtonIter
{ static constexpr int value = 1;
};
template
struct NumLocalDomains
{ static constexpr int value = 0; };
template
struct LocalDomainsPartitioningImbalance
{
using type = GetPropType;
static constexpr auto value = type{1.03};
};
template
struct LocalDomainsPartitioningMethod
{ static constexpr auto value = "zoltan"; };
template
struct LocalDomainsOrderingMeasure
{ static constexpr auto value = "maxpressure"; };
} // namespace Opm::Parameters
namespace Opm {
/// Solver parameters for the BlackoilModel.
template
struct BlackoilModelParameters
{
private:
using Scalar = GetPropType;
public:
/// Max relative change in bhp in single iteration.
Scalar dbhp_max_rel_;
/// Max absolute change in well volume fraction in single iteration.
Scalar dwell_fraction_max_;
/// Absolute max limit for residuals.
Scalar max_residual_allowed_;
//// Max allowed pore volume faction where CNV is violated. Below the
//// relaxed tolerance tolerance_cnv_relaxed_ is used.
Scalar relaxed_max_pv_fraction_;
/// Relative mass balance tolerance (total mass balance error).
Scalar tolerance_mb_;
/// Relaxed mass balance tolerance (can be used when iter >= min_strict_mb_iter_).
Scalar tolerance_mb_relaxed_;
/// Local convergence tolerance (max of local saturation errors).
Scalar tolerance_cnv_;
/// Relaxed local convergence tolerance (can be used when iter >= min_strict_cnv_iter_ && cnvViolatedPV < relaxed_max_pv_fraction_).
Scalar tolerance_cnv_relaxed_;
/// Well convergence tolerance.
Scalar tolerance_wells_;
/// Tolerance for the well control equations
// TODO: it might need to distinguish between rate control and pressure control later
Scalar tolerance_well_control_;
/// Tolerance for the pressure equations for multisegment wells
Scalar tolerance_pressure_ms_wells_;
/// Relaxed tolerance for for the well flow residual
Scalar relaxed_tolerance_flow_well_;
/// Relaxed tolerance for the MSW pressure solution
Scalar relaxed_tolerance_pressure_ms_well_;
/// Maximum pressure change over an iteratio for ms wells
Scalar max_pressure_change_ms_wells_;
/// Maximum inner iteration number for ms wells
int max_inner_iter_ms_wells_;
/// Strict inner iteration number for wells
int strict_inner_iter_wells_;
/// Newton iteration where wells are stricly convergent
int strict_outer_iter_wells_;
/// Regularization factor for wells
Scalar regularization_factor_wells_;
/// Maximum newton iterations with inner well iterations
int max_niter_inner_well_iter_;
/// Whether to shut unsolvable well
bool shut_unsolvable_wells_;
/// Maximum inner iteration number for standard wells
int max_inner_iter_wells_;
/// Maximum iteration number of the well equation solution
int max_welleq_iter_;
/// Tolerance for time step in seconds where single precision can be used
/// for solving for the Jacobian
Scalar maxSinglePrecisionTimeStep_;
/// Minimum number of Newton iterations before we can use relaxed CNV convergence criterion
int min_strict_cnv_iter_;
/// Minimum number of Newton iterations before we can use relaxed MB convergence criterion
int min_strict_mb_iter_;
/// Solve well equation initially
bool solve_welleq_initially_;
/// Update scaling factors for mass balance equations
bool update_equations_scaling_;
/// Try to detect oscillation or stagnation.
bool use_update_stabilization_;
/// Whether to use MultisegmentWell to handle multisegment wells
/// it is something temporary before the multisegment well model is considered to be
/// well developed and tested.
/// if it is false, we will handle multisegment wells as standard wells, which will be
/// the default behavoir for the moment. Later, we might set it to be true by default if necessary
bool use_multisegment_well_;
/// The file name of the deck
std::string deck_file_name_;
/// Whether to add influences of wells between cells to the matrix and preconditioner matrix
bool matrix_add_well_contributions_;
/// Whether to check well operability
bool check_well_operability_;
/// Whether to check well operability during iterations
bool check_well_operability_iter_;
/// Maximum number of times a well can switch to the same controt
int max_number_of_well_switches_;
/// Whether to approximate segment densities by averaging over segment and its outlet
bool use_average_density_ms_wells_;
/// Whether to allow control switching during local well solutions
bool local_well_solver_control_switching_;
/// Whether to use implicit IPR for thp stability checks and solution search
bool use_implicit_ipr_;
/// Maximum number of iterations in the network solver before relaxing tolerance
int network_max_strict_iterations_;
/// Maximum number of iterations in the network solver before giving up
int network_max_iterations_;
/// Nonlinear solver type: newton or nldd.
std::string nonlinear_solver_;
/// 'jacobi' and 'gauss-seidel' supported.
DomainSolveApproach local_solve_approach_{DomainSolveApproach::Jacobi};
int max_local_solve_iterations_;
Scalar local_tolerance_scaling_mb_;
Scalar local_tolerance_scaling_cnv_;
int nldd_num_initial_newton_iter_{1};
int num_local_domains_{0};
Scalar local_domain_partition_imbalance_{1.03};
std::string local_domain_partition_method_;
DomainOrderingMeasure local_domain_ordering_{DomainOrderingMeasure::MaxPressure};
bool write_partitions_{false};
/// Construct from user parameters or defaults.
BlackoilModelParameters()
{
dbhp_max_rel_= Parameters::get();
dwell_fraction_max_ = Parameters::get();
max_residual_allowed_ = Parameters::get();
relaxed_max_pv_fraction_ = Parameters::get();
tolerance_mb_ = Parameters::get();
tolerance_mb_relaxed_ = std::max(tolerance_mb_, Parameters::get());
tolerance_cnv_ = Parameters::get();
tolerance_cnv_relaxed_ = std::max(tolerance_cnv_, Parameters::get());
tolerance_wells_ = Parameters::get();
tolerance_well_control_ = Parameters::get();
max_welleq_iter_ = Parameters::get();
use_multisegment_well_ = Parameters::get();
tolerance_pressure_ms_wells_ = Parameters::get();
relaxed_tolerance_flow_well_ = Parameters::get();
relaxed_tolerance_pressure_ms_well_ = Parameters::get();
max_pressure_change_ms_wells_ = Parameters::get();
max_inner_iter_ms_wells_ = Parameters::get();
strict_inner_iter_wells_ = Parameters::get();
strict_outer_iter_wells_ = Parameters::get();
regularization_factor_wells_ = Parameters::get();
max_niter_inner_well_iter_ = Parameters::get();
shut_unsolvable_wells_ = Parameters::get();
max_inner_iter_wells_ = Parameters::get();
maxSinglePrecisionTimeStep_ = Parameters::get() * 24 * 60 * 60;
min_strict_cnv_iter_ = Parameters::get();
min_strict_mb_iter_ = Parameters::get();
solve_welleq_initially_ = Parameters::get();
update_equations_scaling_ = Parameters::get();
use_update_stabilization_ = Parameters::get();
matrix_add_well_contributions_ = Parameters::get();
check_well_operability_ = Parameters::get();
check_well_operability_iter_ = Parameters::get();
max_number_of_well_switches_ = Parameters::get();
use_average_density_ms_wells_ = Parameters::get();
local_well_solver_control_switching_ = Parameters::get();
use_implicit_ipr_ = Parameters::get();
nonlinear_solver_ = Parameters::get();
const auto approach = Parameters::get();
if (approach == "jacobi") {
local_solve_approach_ = DomainSolveApproach::Jacobi;
} else if (approach == "gauss-seidel") {
local_solve_approach_ = DomainSolveApproach::GaussSeidel;
} else {
throw std::runtime_error("Invalid domain solver approach '" + approach + "' specified.");
}
max_local_solve_iterations_ = Parameters::get();
local_tolerance_scaling_mb_ = Parameters::get();
local_tolerance_scaling_cnv_ = Parameters::get();
nldd_num_initial_newton_iter_ = Parameters::get();
num_local_domains_ = Parameters::get();
local_domain_partition_imbalance_ = std::max(Scalar{1.0}, Parameters::get());
local_domain_partition_method_ = Parameters::get();
deck_file_name_ = Parameters::get();
network_max_strict_iterations_ = Parameters::get();
network_max_iterations_ = Parameters::get();
local_domain_ordering_ = domainOrderingMeasureFromString(Parameters::get());
write_partitions_ = Parameters::get();
}
static void registerParameters()
{
Parameters::registerParam
("Maximum relative change of the bottom-hole pressure in a single iteration");
Parameters::registerParam
("Maximum absolute change of a well's volume fraction in a single iteration");
Parameters::registerParam
("Absolute maximum tolerated for residuals without cutting the time step size");
Parameters::registerParam
("The fraction of the pore volume of the reservoir "
"where the volumetric error (CNV) may be voilated "
"during strict Newton iterations.");
Parameters::registerParam
("Tolerated mass balance error relative to total mass present");
Parameters::registerParam
("Relaxed tolerated mass balance error that applies for iterations "
"after the iterations with the strict tolerance");
Parameters::registerParam
("Local convergence tolerance (Maximum of local saturation errors)");
Parameters::registerParam
("Relaxed local convergence tolerance that applies for iterations "
"after the iterations with the strict tolerance");
Parameters::registerParam
("Well convergence tolerance");
Parameters::registerParam
("Tolerance for the well control equations");
Parameters::registerParam
("Maximum number of iterations to determine solution the well equations");
Parameters::registerParam
("Use the well model for multi-segment wells instead of the "
"one for single-segment wells");
Parameters::registerParam
("Tolerance for the pressure equations for multi-segment wells");
Parameters::registerParam
("Relaxed tolerance for the well flow residual");
Parameters::registerParam
("Relaxed tolerance for the MSW pressure solution");
Parameters::registerParam
("Maximum relative pressure change for a single iteration "
"of the multi-segment well model");
Parameters::registerParam
("Maximum number of inner iterations for multi-segment wells");
Parameters::registerParam
("Number of inner well iterations with strict tolerance");
Parameters::registerParam
("Number of newton iterations for which wells are checked with strict tolerance");
Parameters::registerParam
("Maximum newton iterations with inner well iterations");
Parameters::registerParam
("Shut unsolvable wells");
Parameters::registerParam
("Maximum number of inner iterations for standard wells");
Parameters::registerParam
("Use alternative well rate initialization procedure");
Parameters::registerParam