NewtonIterationUtilities.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_NEWTONITERATIONUTILITIES_HEADER_INCLUDED
21 #define OPM_NEWTONITERATIONUTILITIES_HEADER_INCLUDED
22 
23 #include <opm/autodiff/AutoDiffBlock.hpp>
24 #include <boost/any.hpp>
25 #include <vector>
26 
27 namespace Opm
28 {
29 
36  std::vector< AutoDiffBlock<double> >
37  eliminateVariable(const std::vector< AutoDiffBlock<double> >& eqs,
38  const int n);
39 
45  AutoDiffBlock<double>::V recoverVariable(const AutoDiffBlock<double>& equation,
46  const AutoDiffBlock<double>::V& partial_solution,
47  const int n);
48 
57  void formEllipticSystem(const int num_phases,
58  const std::vector< AutoDiffBlock<double> >& eqs,
59  Eigen::SparseMatrix<double, Eigen::RowMajor>& A,
61 
63  bool isIORank(const boost::any& parallel_info);
64 
65 } // namespace Opm
66 
67 #endif // OPM_NEWTONITERATIONUTILITIES_HEADER_INCLUDED
std::vector< ADB > eliminateVariable(const std::vector< ADB > &eqs, const int n)
Eliminate a variable via Schur complement.
Definition: NewtonIterationUtilities.cpp:46
void formEllipticSystem(const int num_phases, const std::vector< ADB > &eqs_in, Eigen::SparseMatrix< double, Eigen::RowMajor > &A, V &b)
Form an elliptic system of equations.
Definition: NewtonIterationUtilities.cpp:198
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: AdditionalObjectDeleter.hpp:22
bool isIORank(const boost::any &parallel_info)
Return true if this is a serial run, or rank zero on an MPI run.
Definition: NewtonIterationUtilities.cpp:294
Eigen::Array< double, Eigen::Dynamic, 1 > V
Underlying type for values.
Definition: AutoDiffBlock.hpp:99