opm-simulators
setupPropertyTree.hpp
1 /*
2  Copyright 2019 SINTEF Digital, Mathematics and Cybernetics.
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_SETUPPROPERTYTREE_HEADER_INCLUDED
21 #define OPM_SETUPPROPERTYTREE_HEADER_INCLUDED
22 
23 #include <opm/simulators/linalg/PropertyTree.hpp>
24 
25 #include <string>
26 
27 namespace Opm
28 {
29 
30 struct FlowLinearSolverParameters;
31 
32 PropertyTree setupPropertyTree(FlowLinearSolverParameters p,
33  bool linearSolverMaxIterSet,
34  bool linearSolverReductionSet,
35  bool tpsaSetup = false);
36 
37 PropertyTree setupCPRW(const std::string& conf, const FlowLinearSolverParameters& p);
38 PropertyTree setupCPR(const std::string& conf, const FlowLinearSolverParameters& p);
39 PropertyTree setupAMG(const std::string& conf, const FlowLinearSolverParameters& p);
40 PropertyTree setupILU(const std::string& conf, const FlowLinearSolverParameters& p);
41 PropertyTree setupMixedILU(const std::string& conf, const FlowLinearSolverParameters& p);
42 PropertyTree setupDILU(const std::string& conf, const FlowLinearSolverParameters& p);
43 PropertyTree setupMixedDILU(const std::string& conf, const FlowLinearSolverParameters& p);
44 PropertyTree setupUMFPack(const std::string& conf, const FlowLinearSolverParameters& p);
45 
46 } // namespace Opm
47 
48 #endif // OPM_SETUPPROPERTYTREE_HEADER_INCLUDED
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
PropertyTree setupPropertyTree(FlowLinearSolverParameters p, bool linearSolverMaxIterSet, bool linearSolverReductionSet, bool tpsaSetup)
Set up a property tree intended for FlexibleSolver by either reading the tree from a JSON file or cre...
Definition: setupPropertyTree.cpp:182