mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-01-16 17:41:56 -06:00
113 lines
4.3 KiB
C++
113 lines
4.3 KiB
C++
/*
|
|
Copyright 2015 SINTEF ICT, Applied Mathematics.
|
|
Copyright 2015 Statoil ASA.
|
|
|
|
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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef OPM_FULLYIMPLICITSOLVER_HEADER_INCLUDED
|
|
#define OPM_FULLYIMPLICITSOLVER_HEADER_INCLUDED
|
|
|
|
#include <opm/autodiff/AutoDiffBlock.hpp>
|
|
#include <opm/autodiff/NewtonRelaxation.hpp>
|
|
#include <opm/core/utility/parameters/ParameterGroup.hpp>
|
|
|
|
namespace Opm {
|
|
|
|
|
|
/// A fully implicit solver class suitable for general models.
|
|
template <class PhysicalModel>
|
|
class FullyImplicitSolver
|
|
{
|
|
public:
|
|
// --------- Types and enums ---------
|
|
typedef AutoDiffBlock<double> ADB;
|
|
typedef ADB::V V;
|
|
typedef ADB::M M;
|
|
|
|
// The Newton relaxation scheme type
|
|
enum RelaxType { DAMPEN, SOR };
|
|
|
|
// Solver parameters controlling nonlinear Newton process.
|
|
struct SolverParameter
|
|
{
|
|
enum RelaxType relax_type_;
|
|
double relax_max_;
|
|
double relax_increment_;
|
|
double relax_rel_tol_;
|
|
int max_iter_; // max newton iterations
|
|
int min_iter_; // min newton iterations
|
|
|
|
SolverParameter( const parameter::ParameterGroup& param );
|
|
SolverParameter();
|
|
|
|
void reset();
|
|
};
|
|
|
|
// Forwarding types from PhysicalModel.
|
|
typedef typename PhysicalModel::ReservoirState ReservoirState;
|
|
typedef typename PhysicalModel::WellState WellState;
|
|
|
|
// --------- Public methods ---------
|
|
|
|
/// Construct solver for a given model.
|
|
/// \param[in] param parameters controlling nonlinear Newton process
|
|
/// \param[in, out] model physical simulation model
|
|
explicit FullyImplicitSolver(const SolverParameter& param,
|
|
PhysicalModel& model);
|
|
|
|
/// Take a single forward step, after which the states will be modified
|
|
/// according to the physical model.
|
|
/// \param[in] dt time step size
|
|
/// \param[in] reservoir_state reservoir state variables
|
|
/// \param[in] well_state well state variables
|
|
/// \return number of linear iterations used
|
|
int
|
|
step(const double dt,
|
|
ReservoirState& reservoir_state,
|
|
WellState& well_state);
|
|
|
|
/// Number of Newton iterations used in all calls to step().
|
|
unsigned int newtonIterations() const;
|
|
|
|
/// Number of linear solver iterations used in all calls to step().
|
|
unsigned int linearIterations() const;
|
|
|
|
private:
|
|
// --------- Data members ---------
|
|
SolverParameter param_;
|
|
PhysicalModel& model_;
|
|
unsigned int newtonIterations_;
|
|
unsigned int linearIterations_;
|
|
|
|
// --------- Private methods ---------
|
|
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_; }
|
|
void detectNewtonOscillations(const std::vector<std::vector<double>>& residual_history,
|
|
const int it, const double relaxRelTol,
|
|
bool& oscillate, bool& stagnate) const;
|
|
void stabilizeNewton(V& dx, V& dxOld, const double omega, const RelaxType relax_type) const;
|
|
};
|
|
} // namespace Opm
|
|
|
|
#include "FullyImplicitSolver_impl.hpp"
|
|
|
|
#endif // OPM_FULLYIMPLICITSOLVER_HEADER_INCLUDED
|