escript  Revision_
Options.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2018 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 
18 /****************************************************************************/
19 
20 /* Paso: Options */
21 
22 /****************************************************************************/
23 
24 /* Copyrights by ACcESS Australia 2003,2004,2005 */
25 /* Author: Lutz Gross, l.gross@uq.edu.au */
26 
27 /****************************************************************************/
28 
29 #ifndef __PASO_OPTIONS_H__
30 #define __PASO_OPTIONS_H__
31 
32 #include "Paso.h"
33 
34 #include <boost/python/object.hpp>
35 
36 // valid solver options
37 #define PASO_DEFAULT 0
38 #define PASO_DIRECT 1
39 #define PASO_CHOLEVSKY 2
40 #define PASO_PCG 3
41 #define PASO_CR 4
42 #define PASO_CGS 5
43 #define PASO_BICGSTAB 6
44 #define PASO_ILU0 8
45 #define PASO_ILUT 9
46 #define PASO_JACOBI 10
47 #define PASO_GMRES 11
48 #define PASO_PRES20 12
49 #define PASO_MKL 15
50 #define PASO_UMFPACK 16
51 #define PASO_NO_REORDERING 17
52 #define PASO_MINIMUM_FILL_IN 18
53 #define PASO_NESTED_DISSECTION 19
54 #define PASO_ITERATIVE 20
55 #define PASO_PASO 21
56 #define PASO_REC_ILU 23
57 #define PASO_TRILINOS 24
58 #define PASO_NONLINEAR_GMRES 25
59 #define PASO_TFQMR 26
60 #define PASO_MINRES 27
61 #define PASO_GAUSS_SEIDEL 28
62 #define PASO_GS PASO_GAUSS_SEIDEL
63 #define PASO_RILU 29
64 #define PASO_DEFAULT_REORDERING 30
65 #define PASO_NO_PRECONDITIONER 36
66 #define PASO_CLASSIC_INTERPOLATION_WITH_FF_COUPLING 50
67 #define PASO_CLASSIC_INTERPOLATION 51
68 #define PASO_DIRECT_INTERPOLATION 52
69 #define PASO_LINEAR_CRANK_NICOLSON 66
70 #define PASO_CRANK_NICOLSON 67
71 #define PASO_BACKWARD_EULER 68
72 
73 #define PASO_SMOOTHER 99999999
74 
75 namespace paso {
76 
77 struct Options
78 {
79  Options() { setDefaults(); }
80 
82  Options(const boost::python::object& options);
83 
85  void setDefaults();
86 
88  void show() const;
89 
91  void showDiagnostics() const;
92 
94  void updateEscriptDiagnostics(boost::python::object& options) const;
95 
97  static int mapEscriptOption(int escriptOption);
98 
99  static const char* name(int key);
100 
101  static int getPackage(int solver, int package, bool symmetry,
102  const escript::JMPI& mpi_info);
103 
105  static int getSolver(int solver, int package, bool symmetry,
106  const escript::JMPI& mpi_info);
107 
108  int method;
109  int package;
110  bool symmetric;
111  bool hermitian;
112  double tolerance;
116  bool verbose;
122  double drop_storage;
125  int sweeps;
130  int ode_solver;
131 
132  // diagnostic values
136  double time;
137  double set_up_time;
140  double net_time;
142  bool converged;
143  double preconditioner_size; // in Mbytes
147 };
148 
149 } // namespace paso
150 
151 #endif // __PASO_OPTIONS_H__
152 
escript::SolverBuddy::getDropTolerance
double getDropTolerance() const
Definition: SolverOptions.cpp:624
paso::Options::show
void show() const
prints current option values
Definition: Options.cpp:132
escript::SO_REORDERING_NONE
Definition: SolverOptions.h:161
escript::SolverBuddy
Definition: SolverOptions.h:168
PASO_TRILINOS
#define PASO_TRILINOS
Definition: Options.h:56
PASO_CR
#define PASO_CR
Definition: Options.h:40
paso::Options::Options
Options()
Definition: Options.h:78
PASO_DIRECT
#define PASO_DIRECT
Definition: Options.h:37
paso::Options::setDefaults
void setDefaults()
sets the default values for solver options
Definition: Options.cpp:72
paso::Options::num_level
dim_t num_level
Definition: Options.h:133
PASO_GAUSS_SEIDEL
#define PASO_GAUSS_SEIDEL
Definition: Options.h:60
escript::SO_METHOD_GMRES
Definition: SolverOptions.h:127
escript::SolverBuddy::useLocalPreconditioner
bool useLocalPreconditioner() const
Definition: SolverOptions.cpp:778
paso::Options::preconditioner_size
double preconditioner_size
Definition: Options.h:142
PASO_ILUT
#define PASO_ILUT
Definition: Options.h:44
paso::Options::accept_failed_convergence
bool accept_failed_convergence
Definition: Options.h:125
paso::Options::package
int package
Definition: Options.h:108
PASO_DEFAULT
#define PASO_DEFAULT
Definition: Options.h:36
escript::SolverBuddy::getTolerance
double getTolerance() const
Definition: SolverOptions.cpp:588
escript::SO_METHOD_DIRECT
Definition: SolverOptions.h:122
PASO_RILU
#define PASO_RILU
Definition: Options.h:62
paso::Options::getSolver
static int getSolver(int solver, int package, bool symmetry, const escript::JMPI &mpi_info)
returns the solver to be used with given combination
Definition: Options.cpp:230
escript::SolverBuddy::getAbsoluteTolerance
double getAbsoluteTolerance() const
Definition: SolverOptions.cpp:600
escript::SO_ODESOLVER_BACKWARD_EULER
Definition: SolverOptions.h:149
escript::SolverBuddy::getTruncation
int getTruncation() const
Definition: SolverOptions.cpp:540
paso::Options::showDiagnostics
void showDiagnostics() const
prints diagnostic data
Definition: Options.cpp:115
paso::Options::time_step_backtracking_used
bool time_step_backtracking_used
Definition: Options.h:143
PASO_ILU0
#define PASO_ILU0
Definition: Options.h:43
escript::SO_PRECONDITIONER_ILU0
Definition: SolverOptions.h:141
PASO_ITERATIVE
#define PASO_ITERATIVE
Definition: Options.h:53
escript::SolverBuddy::getNumSweeps
int getNumSweeps() const
Definition: SolverOptions.cpp:576
paso::Options::time
double time
Definition: Options.h:135
paso::Options::getPackage
static int getPackage(int solver, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: Options.cpp:321
PASO_GMRES
#define PASO_GMRES
Definition: Options.h:46
escript::SolverBuddy::getSolverMethod
SolverOptions getSolverMethod() const
Definition: SolverOptions.cpp:424
paso::Options::tolerance
double tolerance
Definition: Options.h:111
SET
#define SET(__key__, __val__, __type__)
PASO_MINIMUM_FILL_IN
#define PASO_MINIMUM_FILL_IN
Definition: Options.h:51
escript::SolverBuddy::getNumRefinements
int getNumRefinements() const
Definition: SolverOptions.cpp:808
paso::Options::mapEscriptOption
static int mapEscriptOption(int escriptOption)
returns the corresponding paso option code for an escript option code
Definition: Options.cpp:361
PASO_CRANK_NICOLSON
#define PASO_CRANK_NICOLSON
Definition: Options.h:69
escript::SO_ODESOLVER_LINEAR_CRANK_NICOLSON
Definition: SolverOptions.h:151
escript::SO_PRECONDITIONER_REC_ILU
Definition: SolverOptions.h:145
escript::SO_REORDERING_MINIMUM_FILL_IN
Definition: SolverOptions.h:159
paso::Options::num_coarse_unknowns
dim_t num_coarse_unknowns
Definition: Options.h:145
PASO_PRES20
#define PASO_PRES20
Definition: Options.h:47
paso::Options::hermitian
bool hermitian
Definition: Options.h:110
escript::SO_PRECONDITIONER_ILUT
Definition: SolverOptions.h:142
escript::SolverBuddy::isHermitian
bool isHermitian() const
Definition: SolverOptions.cpp:686
paso::Options::net_time
double net_time
Definition: Options.h:139
escript::SO_METHOD_NONLINEAR_GMRES
Definition: SolverOptions.h:132
PASO_MKL
#define PASO_MKL
Definition: Options.h:48
PASO_NO_REORDERING
#define PASO_NO_REORDERING
Definition: Options.h:50
PASO_NO_PRECONDITIONER
#define PASO_NO_PRECONDITIONER
Definition: Options.h:64
paso::Options::verbose
bool verbose
Definition: Options.h:115
PASO_DEFAULT_REORDERING
#define PASO_DEFAULT_REORDERING
Definition: Options.h:63
Options.h
paso::Options::method
int method
Definition: Options.h:107
escript::SolverBuddy::isVerbose
bool isVerbose() const
Definition: SolverOptions.cpp:709
escript::SO_PACKAGE_PASO
Definition: SolverOptions.h:112
PASO_PCG
#define PASO_PCG
Definition: Options.h:39
PASO_TFQMR
#define PASO_TFQMR
Definition: Options.h:58
Paso.h
paso::Options::truncation
index_t truncation
Definition: Options.h:122
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:70
escript::SO_REORDERING_DEFAULT
Definition: SolverOptions.h:158
paso::Options::reordering
bool reordering
Definition: Options.h:116
escript::SolverBuddy::acceptConvergenceFailure
bool acceptConvergenceFailure() const
Definition: SolverOptions.cpp:755
PASO_LINEAR_CRANK_NICOLSON
#define PASO_LINEAR_CRANK_NICOLSON
Definition: Options.h:68
paso::Options::symmetric
bool symmetric
Definition: Options.h:109
paso::Options::inner_tolerance
double inner_tolerance
Definition: Options.h:113
paso::Options::refinements
dim_t refinements
Definition: Options.h:128
escript::SolverBuddy::getRelaxationFactor
double getRelaxationFactor() const
Definition: SolverOptions.cpp:648
paso::Options::num_inner_iter
dim_t num_inner_iter
Definition: Options.h:134
escript::SolverBuddy::getInnerIterMax
int getInnerIterMax() const
Definition: SolverOptions.cpp:552
escript::SolverBuddy::getInnerTolerance
double getInnerTolerance() const
Definition: SolverOptions.cpp:612
escript::SolverBuddy::_getRestartForC
int _getRestartForC() const
Definition: SolverOptions.cpp:525
escript::SO_ODESOLVER_CRANK_NICOLSON
Definition: SolverOptions.h:150
paso::Options::drop_storage
double drop_storage
Definition: Options.h:121
PASO_NONLINEAR_GMRES
#define PASO_NONLINEAR_GMRES
Definition: Options.h:57
paso::Options::iter_max
dim_t iter_max
Definition: Options.h:118
escript::SO_METHOD_CGS
Definition: SolverOptions.h:119
paso::Options::updateEscriptDiagnostics
void updateEscriptDiagnostics(boost::python::object &options) const
updates SolverBuddy diagnostics from this
Definition: Options.cpp:440
paso::Options::converged
bool converged
Definition: Options.h:141
paso::Options::use_local_preconditioner
bool use_local_preconditioner
Definition: Options.h:127
paso::Options::relaxation_factor
double relaxation_factor
Definition: Options.h:126
PASO_PASO
#define PASO_PASO
Definition: Options.h:54
paso::Options::coarse_level_sparsity
double coarse_level_sparsity
Definition: Options.h:144
PASO_UMFPACK
#define PASO_UMFPACK
Definition: Options.h:49
escript::SolverBuddy::getIterMax
int getIterMax() const
Definition: SolverOptions.cpp:564
paso::Options::adapt_inner_tolerance
bool adapt_inner_tolerance
Definition: Options.h:114
escript::SO_METHOD_ITERATIVE
Definition: SolverOptions.h:129
PASO_BICGSTAB
#define PASO_BICGSTAB
Definition: Options.h:42
escript::SolverBuddy::getReordering
SolverOptions getReordering() const
Definition: SolverOptions.cpp:507
escript::SolverBuddy::isSymmetric
bool isSymmetric() const
Definition: SolverOptions.cpp:663
paso::Options::residual_norm
double residual_norm
Definition: Options.h:140
escript::SO_REORDERING_NESTED_DISSECTION
Definition: SolverOptions.h:160
escript::SO_METHOD_BICGSTAB
Definition: SolverOptions.h:117
escript::SolverBuddy::getPreconditioner
SolverOptions getPreconditioner() const
Definition: SolverOptions.cpp:355
paso::Options::ode_solver
int ode_solver
Definition: Options.h:129
paso::Options::drop_tolerance
double drop_tolerance
Definition: Options.h:120
paso::PasoException
PasoException exception class.
Definition: PasoException.h:43
PASO_MINRES
#define PASO_MINRES
Definition: Options.h:59
paso::Options::preconditioner
int preconditioner
Definition: Options.h:117
escript::SO_METHOD_MINRES
Definition: SolverOptions.h:131
PASO_JACOBI
#define PASO_JACOBI
Definition: Options.h:45
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:82
paso::Options::inner_iter_max
dim_t inner_iter_max
Definition: Options.h:119
PASO_CGS
#define PASO_CGS
Definition: Options.h:41
paso::Options::name
static const char * name(int key)
Definition: Options.cpp:160
escript::SO_METHOD_CR
Definition: SolverOptions.h:121
paso::Options::set_up_time
double set_up_time
Definition: Options.h:136
paso::Options::sweeps
int sweeps
Definition: Options.h:124
escript::SO_PRECONDITIONER_GAUSS_SEIDEL
Definition: SolverOptions.h:140
escript::SO_DEFAULT
Definition: SolverOptions.h:104
escript::SO_PRECONDITIONER_NONE
Definition: SolverOptions.h:144
paso::Options::coarsening_selection_time
double coarsening_selection_time
Definition: Options.h:137
PasoException.h
PASO_REC_ILU
#define PASO_REC_ILU
Definition: Options.h:55
PASO_BACKWARD_EULER
#define PASO_BACKWARD_EULER
Definition: Options.h:70
PASO_NESTED_DISSECTION
#define PASO_NESTED_DISSECTION
Definition: Options.h:52
paso::Options::absolute_tolerance
double absolute_tolerance
Definition: Options.h:112
escript::SO_PRECONDITIONER_RILU
Definition: SolverOptions.h:146
escript::SO_PACKAGE_TRILINOS
Definition: SolverOptions.h:113
escript::SolverBuddy::adaptInnerTolerance
bool adaptInnerTolerance() const
Definition: SolverOptions.cpp:732
paso
Definition: BiCGStab.cpp:25
paso::Options::coarsening_matrix_time
double coarsening_matrix_time
Definition: Options.h:138
escript::SO_PACKAGE_MKL
Definition: SolverOptions.h:111
escript::SO_PRECONDITIONER_JACOBI
Definition: SolverOptions.h:143
escript::SO_METHOD_PRES20
Definition: SolverOptions.h:134
escript::SolverBuddy::getDropStorage
double getDropStorage() const
Definition: SolverOptions.cpp:636
escript::SO_PACKAGE_UMFPACK
Definition: SolverOptions.h:114
escript::SO_METHOD_TFQMR
Definition: SolverOptions.h:136
escript::SO_METHOD_PCG
Definition: SolverOptions.h:133
paso::Options
Definition: Options.h:76
escript::SolverBuddy::getODESolver
SolverOptions getODESolver() const
Definition: SolverOptions.cpp:827
PASO_CHOLEVSKY
#define PASO_CHOLEVSKY
Definition: Options.h:38
paso::Options::num_iter
dim_t num_iter
Definition: Options.h:132
paso::Options::restart
index_t restart
Definition: Options.h:123
escript::SO_METHOD_CHOLEVSKY
Definition: SolverOptions.h:120