mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-11-24 18:20:22 -06:00
4527ce8ffd
We need it serveral places and all of them seem to have access to NewtonIterationBlackoilInterface. This makes it natural to give access to it and prevent users from having to forward it manually at several places in the simulator driver.
56 lines
2.0 KiB
C++
56 lines
2.0 KiB
C++
/*
|
|
Copyright 2014 SINTEF ICT, Applied Mathematics.
|
|
Copyright 2014 IRIS AS
|
|
|
|
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_NEWTONITERATIONBLACKOILINTERFACE_HEADER_INCLUDED
|
|
#define OPM_NEWTONITERATIONBLACKOILINTERFACE_HEADER_INCLUDED
|
|
|
|
#include <opm/autodiff/LinearisedBlackoilResidual.hpp>
|
|
|
|
#include <boost/any.hpp>
|
|
namespace Opm
|
|
{
|
|
|
|
/// Interface class for (linear) solvers for the fully implicit black-oil system.
|
|
class NewtonIterationBlackoilInterface
|
|
{
|
|
public:
|
|
/// Return type for linearSolve(). A simple, non-ad vector type.
|
|
typedef LinearisedBlackoilResidual::ADB::V SolutionVector;
|
|
|
|
/// Solve the linear system Ax = b, with A being the
|
|
/// combined derivative matrix of the residual and b
|
|
/// being the residual itself.
|
|
/// \param[in] residual residual object containing A and b.
|
|
/// \return the solution x
|
|
virtual SolutionVector computeNewtonIncrement(const LinearisedBlackoilResidual& residual) const = 0;
|
|
|
|
/// \return number of linear iterations used during last call of computeNewtonIncrement
|
|
virtual int iterations () const = 0;
|
|
|
|
|
|
/// \brief Get the information about the parallelization of the grid.
|
|
virtual const boost::any& parallelInformation() const = 0;
|
|
};
|
|
|
|
} // namespace Opm
|
|
|
|
|
|
#endif // OPM_NEWTONITERATIONBLACKOILINTERFACE_HEADER_INCLUDED
|