OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Create BlackoilModelBase class.

Browse Source 
The class is identical to BlackoilModel class at this stage, but
since it was renamed from FullyImplicitBlackoilSolver it keeps the
commit history better.
This commit is contained in:
Atgeirr Flø Rasmussen
2015-05-24 09:59:40 +02:00
parent 1d2ef11ec7
commit 620ef2a3dd
3 changed files with 349 additions and 429 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CMakeLists_files.cmake
View File

@@ -96,6 +96,8 @@ list (APPEND PUBLIC_HEADER_FILES
opm/autodiff/BackupRestore.hpp opm/autodiff/BackupRestore.hpp
opm/autodiff/BlackoilModel.hpp opm/autodiff/BlackoilModel.hpp
opm/autodiff/BlackoilModel_impl.hpp opm/autodiff/BlackoilModel_impl.hpp
opm/autodiff/BlackoilModelBase.hpp
opm/autodiff/BlackoilModelBase_impl.hpp
opm/autodiff/BlackoilPropsAdFromDeck.hpp opm/autodiff/BlackoilPropsAdFromDeck.hpp
opm/autodiff/BlackoilPropsAdInterface.hpp opm/autodiff/BlackoilPropsAdInterface.hpp
opm/autodiff/CPRPreconditioner.hpp opm/autodiff/CPRPreconditioner.hpp
@@ -105,8 +107,6 @@ list (APPEND PUBLIC_HEADER_FILES
opm/autodiff/GeoProps.hpp opm/autodiff/GeoProps.hpp
opm/autodiff/GridHelpers.hpp opm/autodiff/GridHelpers.hpp
opm/autodiff/ImpesTPFAAD.hpp opm/autodiff/ImpesTPFAAD.hpp
opm/autodiff/FullyImplicitBlackoilSolver.hpp
opm/autodiff/FullyImplicitBlackoilSolver_impl.hpp
opm/autodiff/NewtonIterationBlackoilCPR.hpp opm/autodiff/NewtonIterationBlackoilCPR.hpp
opm/autodiff/NewtonIterationBlackoilInterface.hpp opm/autodiff/NewtonIterationBlackoilInterface.hpp
opm/autodiff/NewtonIterationBlackoilSimple.hpp opm/autodiff/NewtonIterationBlackoilSimple.hpp

211
opm/autodiff/FullyImplicitBlackoilSolver.hpp → opm/autodiff/BlackoilModelBase.hpp
View File

@@ -1,7 +1,7 @@
/* /*
Copyright 2013 SINTEF ICT, Applied Mathematics. Copyright 2013, 2015 SINTEF ICT, Applied Mathematics.
Copyright 2014, 2015 Statoil ASA.
Copyright 2014, 2015 Dr. Markus Blatt - HPC-Simulation-Software & Services Copyright 2014, 2015 Dr. Markus Blatt - HPC-Simulation-Software & Services
Copyright 2014, 2015 Statoil AS
Copyright 2015 NTNU Copyright 2015 NTNU
This file is part of the Open Porous Media project (OPM). This file is part of the Open Porous Media project (OPM).
@@ -20,8 +20,8 @@
along with OPM. If not, see <http://www.gnu.org/licenses/>. along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/ */
#ifndef OPM_FULLYIMPLICITBLACKOILSOLVER_HEADER_INCLUDED #ifndef OPM_BLACKOILMODELBASE_HEADER_INCLUDED
#define OPM_FULLYIMPLICITBLACKOILSOLVER_HEADER_INCLUDED #define OPM_BLACKOILMODELBASE_HEADER_INCLUDED
#include <cassert> #include <cassert>
@@ -46,48 +46,46 @@ namespace Opm {
class WellStateFullyImplicitBlackoil; class WellStateFullyImplicitBlackoil;
/// A fully implicit solver for the black-oil problem. /// A model implementation for three-phase black oil.
/// ///
/// The simulator is capable of handling three-phase problems /// The simulator is capable of handling three-phase problems
/// where gas can be dissolved in oil (but not vice versa). It /// where gas can be dissolved in oil and vice versa. It
/// uses an industry-standard TPFA discretization with per-phase /// uses an industry-standard TPFA discretization with per-phase
/// upwind weighting of mobilities. /// upwind weighting of mobilities.
/// ///
/// It uses automatic differentiation via the class AutoDiffBlock /// It uses automatic differentiation via the class AutoDiffBlock
/// to simplify assembly of the jacobian matrix. /// to simplify assembly of the jacobian matrix.
template<class T> template<class Grid>
class FullyImplicitBlackoilSolver class BlackoilModelBase
{ {
public: public:
// the Newton relaxation type // --------- Types and enums ---------
enum RelaxType { DAMPEN, SOR }; typedef AutoDiffBlock<double> ADB;
typedef ADB::V V;
typedef ADB::M M;
typedef BlackoilState ReservoirState;
typedef WellStateFullyImplicitBlackoil WellState;
// class holding the solver parameters /// Model-specific solver parameters.
struct SolverParameter struct ModelParameters
{ {
double dp_max_rel_; double dp_max_rel_;
double ds_max_; double ds_max_;
double dr_max_rel_; double dr_max_rel_;
enum RelaxType relax_type_; double max_residual_allowed_;
double relax_max_; double tolerance_mb_;
double relax_increment_; double tolerance_cnv_;
double relax_rel_tol_; double tolerance_wells_;
double max_residual_allowed_;
double tolerance_mb_;
double tolerance_cnv_;
double tolerance_wells_;
int max_iter_; // max newton iterations
int min_iter_; // min newton iterations
SolverParameter( const parameter::ParameterGroup& param ); explicit ModelParameters( const parameter::ParameterGroup& param );
SolverParameter(); ModelParameters();
void reset(); void reset();
}; };
/// \brief The type of the grid that we use. // --------- Public methods ---------
typedef T Grid;
/// Construct a solver. It will retain references to the /// Construct the model. It will retain references to the
/// arguments of this functions, and they are expected to /// arguments of this functions, and they are expected to
/// remain in scope for the lifetime of the solver. /// remain in scope for the lifetime of the solver.
/// \param[in] param parameters /// \param[in] param parameters
@@ -97,16 +95,19 @@ namespace Opm {
/// \param[in] rock_comp_props if non-null, rock compressibility properties /// \param[in] rock_comp_props if non-null, rock compressibility properties
/// \param[in] wells well structure /// \param[in] wells well structure
/// \param[in] linsolver linear solver /// \param[in] linsolver linear solver
FullyImplicitBlackoilSolver(const SolverParameter& param, /// \param[in] has_disgas turn on dissolved gas
const Grid& grid , /// \param[in] has_vapoil turn on vaporized oil feature
const BlackoilPropsAdInterface& fluid, /// \param[in] terminal_output request output to cout/cerr
const DerivedGeology& geo , BlackoilModelBase(const ModelParameters& param,
const RockCompressibility* rock_comp_props, const Grid& grid ,
const Wells* wells, const BlackoilPropsAdInterface& fluid,
const NewtonIterationBlackoilInterface& linsolver, const DerivedGeology& geo ,
const bool has_disgas, const RockCompressibility* rock_comp_props,
const bool has_vapoil, const Wells* wells,
const bool terminal_output); const NewtonIterationBlackoilInterface& linsolver,
const bool has_disgas,
const bool has_vapoil,
const bool terminal_output);
/// \brief Set threshold pressures that prevent or reduce flow. /// \brief Set threshold pressures that prevent or reduce flow.
/// This prevents flow across faces if the potential /// This prevents flow across faces if the potential
@@ -118,29 +119,71 @@ namespace Opm {
/// of the grid passed in the constructor. /// of the grid passed in the constructor.
void setThresholdPressures(const std::vector<double>& threshold_pressures_by_face); void setThresholdPressures(const std::vector<double>& threshold_pressures_by_face);
/// Take a single forward step, modifiying /// Called once before each time step.
/// state.pressure() /// \param[in] dt time step size
/// state.faceflux() /// \param[in, out] reservoir_state reservoir state variables
/// state.saturation() /// \param[in, out] well_state well state variables
/// state.gasoilratio() void prepareStep(const double dt,
/// wstate.bhp() ReservoirState& reservoir_state,
/// \param[in] dt time step size WellState& well_state);
/// \param[in] state reservoir state
/// \param[in] wstate well state
/// \return number of linear iterations used
int
step(const double dt ,
BlackoilState& state ,
WellStateFullyImplicitBlackoil& wstate);
unsigned int newtonIterations () const { return newtonIterations_; } /// Called once after each time step.
unsigned int linearIterations () const { return linearIterations_; } /// In this class, this function does nothing.
/// \param[in] dt time step size
/// \param[in, out] reservoir_state reservoir state variables
/// \param[in, out] well_state well state variables
void afterStep(const double dt,
ReservoirState& reservoir_state,
WellState& well_state);
/// Assemble the residual and Jacobian of the nonlinear system.
/// \param[in] reservoir_state reservoir state variables
/// \param[in, out] well_state well state variables
/// \param[in] initial_assembly pass true if this is the first call to assemble() in this timestep
void assemble(const BlackoilState& reservoir_state,
WellStateFullyImplicitBlackoil& well_state,
const bool initial_assembly);
/// \brief Compute the residual norms of the mass balance for each phase,
/// the well flux, and the well equation.
/// \return a vector that contains for each phase the norm of the mass balance
/// and afterwards the norm of the residual of the well flux and the well equation.
std::vector<double> computeResidualNorms() const;
/// The size (number of unknowns) of the nonlinear system of equations.
int sizeNonLinear() const;
/// Number of linear iterations used in last call to solveJacobianSystem().
int linearIterationsLastSolve() const;
/// Solve the Jacobian system Jx = r where J is the Jacobian and
/// r is the residual.
V solveJacobianSystem() const;
/// Apply an update to the primary variables, chopped if appropriate.
/// \param[in] dx updates to apply to primary variables
/// \param[in, out] reservoir_state reservoir state variables
/// \param[in, out] well_state well state variables
void updateState(const V& dx,
BlackoilState& reservoir_state,
WellStateFullyImplicitBlackoil& well_state);
/// Return true if output to cout is wanted.
bool terminalOutputEnabled() const;
/// Compute convergence based on total mass balance (tol_mb) and maximum
/// residual mass balance (tol_cnv).
/// \param[in] dt timestep length
/// \param[in] iteration current iteration number
bool getConvergence(const double dt, const int iteration);
/// The number of active phases in the model.
int numPhases() const;
private: private:
// Types and enums
typedef AutoDiffBlock<double> ADB; // --------- Types and enums ---------
typedef ADB::V V;
typedef ADB::M M;
typedef Eigen::Array<double, typedef Eigen::Array<double,
Eigen::Dynamic, Eigen::Dynamic,
Eigen::Dynamic, Eigen::Dynamic,
@@ -182,7 +225,8 @@ namespace Opm {
enum PrimalVariables { Sg = 0, RS = 1, RV = 2 }; enum PrimalVariables { Sg = 0, RS = 1, RV = 2 };
// Member data // --------- Data members ---------
const Grid& grid_; const Grid& grid_;
const BlackoilPropsAdInterface& fluid_; const BlackoilPropsAdInterface& fluid_;
const DerivedGeology& geo_; const DerivedGeology& geo_;
@@ -199,7 +243,7 @@ namespace Opm {
const bool has_disgas_; const bool has_disgas_;
const bool has_vapoil_; const bool has_vapoil_;
SolverParameter param_; ModelParameters param_;
bool use_threshold_pressure_; bool use_threshold_pressure_;
V threshold_pressures_by_interior_face_; V threshold_pressures_by_interior_face_;
@@ -211,12 +255,11 @@ namespace Opm {
/// \brief Whether we print something to std::cout /// \brief Whether we print something to std::cout
bool terminal_output_; bool terminal_output_;
unsigned int newtonIterations_;
unsigned int linearIterations_;
std::vector<int> primalVariable_; std::vector<int> primalVariable_;
V pvdt_;
// Private methods. // --------- Private methods ---------
// return true if wells are available // return true if wells are available
bool wellsActive() const { return wells_ ? wells_->number_of_wells > 0 : false ; } bool wellsActive() const { return wells_ ? wells_->number_of_wells > 0 : false ; }
@@ -253,18 +296,6 @@ namespace Opm {
void updateWellControls(WellStateFullyImplicitBlackoil& xw) const; void updateWellControls(WellStateFullyImplicitBlackoil& xw) const;
void
assemble(const V& dtpv,
const BlackoilState& x,
const bool initial_assembly,
WellStateFullyImplicitBlackoil& xw);
V solveJacobianSystem() const;
void updateState(const V& dx,
BlackoilState& state,
WellStateFullyImplicitBlackoil& well_state);
std::vector<ADB> std::vector<ADB>
computePressures(const SolutionState& state) const; computePressures(const SolutionState& state) const;
@@ -292,12 +323,6 @@ namespace Opm {
void applyThresholdPressures(ADB& dp); void applyThresholdPressures(ADB& dp);
/// \brief Compute the residual norms of the mass balance for each phase,
/// the well flux, and the well equation.
/// \return a vector that contains for each phase the norm of the mass balance
/// and afterwards the norm of the residual of the well flux and the well equation.
std::vector<double> computeResidualNorms() const;
ADB ADB
fluidViscosity(const int phase, fluidViscosity(const int phase,
const ADB& p , const ADB& p ,
@@ -371,10 +396,6 @@ namespace Opm {
void void
updatePhaseCondFromPrimalVariable(); updatePhaseCondFromPrimalVariable();
/// Compute convergence based on total mass balance (tol_mb) and maximum
/// residual mass balance (tol_cnv).
bool getConvergence(const double dt, const int iteration);
/// \brief Compute the reduction within the convergence check. /// \brief Compute the reduction within the convergence check.
/// \param[in] B A matrix with MaxNumPhases columns and the same number rows /// \param[in] B A matrix with MaxNumPhases columns and the same number rows
/// as the number of cells of the grid. B.col(i) contains the values /// as the number of cells of the grid. B.col(i) contains the values
@@ -407,26 +428,14 @@ namespace Opm {
int nc, int nc,
int nw) const; int nw) const;
void detectNewtonOscillations(const std::vector<std::vector<double>>& residual_history,
const int it, const double relaxRelTol,
bool& oscillate, bool& stagnate) const;
void stablizeNewton(V& dx, V& dxOld, const double omega, const RelaxType relax_type) const;
double dpMaxRel() const { return param_.dp_max_rel_; } double dpMaxRel() const { return param_.dp_max_rel_; }
double dsMax() const { return param_.ds_max_; } double dsMax() const { return param_.ds_max_; }
double drMaxRel() const { return param_.dr_max_rel_; } double drMaxRel() const { return param_.dr_max_rel_; }
enum RelaxType relaxType() const { return param_.relax_type_; }
double relaxMax() const { return param_.relax_max_; };
double relaxIncrement() const { return param_.relax_increment_; };
double relaxRelTol() const { return param_.relax_rel_tol_; };
double maxIter() const { return param_.max_iter_; }
double minIter() const { return param_.min_iter_; }
double maxResidualAllowed() const { return param_.max_residual_allowed_; } double maxResidualAllowed() const { return param_.max_residual_allowed_; }
}; };
} // namespace Opm } // namespace Opm
#include "FullyImplicitBlackoilSolver_impl.hpp" #include "BlackoilModelBase_impl.hpp"
#endif // OPM_FULLYIMPLICITBLACKOILSOLVER_HEADER_INCLUDED #endif // OPM_BLACKOILMODELBASE_HEADER_INCLUDED

563
opm/autodiff/FullyImplicitBlackoilSolver_impl.hpp → opm/autodiff/BlackoilModelBase_impl.hpp
View File

File diff suppressed because it is too large Load Diff