escript  Revision_
Options.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2020 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-2017 by Centre for Geoscience Computing (GeoComp)
14 * Development from 2019 by School of Earth and Environmental Sciences
15 **
16 *****************************************************************************/
17 
18 
19 /****************************************************************************/
20 
21 /* Paso: Options */
22 
23 /****************************************************************************/
24 
25 /* Copyrights by ACcESS Australia 2003,2004,2005 */
26 /* Author: Lutz Gross, l.gross@uq.edu.au */
27 
28 /****************************************************************************/
29 
30 #ifndef __PASO_OPTIONS_H__
31 #define __PASO_OPTIONS_H__
32 
33 #include "Paso.h"
34 
35 #include <boost/python/object.hpp>
36 
37 // valid solver options
38 #define PASO_DEFAULT 0
39 #define PASO_DIRECT 1
40 #define PASO_CHOLEVSKY 2
41 #define PASO_PCG 3
42 #define PASO_CR 4
43 #define PASO_CGS 5
44 #define PASO_BICGSTAB 6
45 #define PASO_ILU0 8
46 #define PASO_ILUT 9
47 #define PASO_JACOBI 10
48 #define PASO_GMRES 11
49 #define PASO_PRES20 12
50 #define PASO_MKL 15
51 #define PASO_UMFPACK 16
52 #define PASO_NO_REORDERING 17
53 #define PASO_MINIMUM_FILL_IN 18
54 #define PASO_NESTED_DISSECTION 19
55 #define PASO_ITERATIVE 20
56 #define PASO_PASO 21
57 #define PASO_MUMPS 22
58 #define PASO_REC_ILU 23
59 #define PASO_TRILINOS 24
60 #define PASO_NONLINEAR_GMRES 25
61 #define PASO_TFQMR 26
62 #define PASO_MINRES 27
63 #define PASO_GAUSS_SEIDEL 28
64 #define PASO_GS PASO_GAUSS_SEIDEL
65 #define PASO_RILU 29
66 #define PASO_DEFAULT_REORDERING 30
67 #define PASO_NO_PRECONDITIONER 36
68 #define PASO_CLASSIC_INTERPOLATION_WITH_FF_COUPLING 50
69 #define PASO_CLASSIC_INTERPOLATION 51
70 #define PASO_DIRECT_INTERPOLATION 52
71 #define PASO_LINEAR_CRANK_NICOLSON 66
72 #define PASO_CRANK_NICOLSON 67
73 #define PASO_BACKWARD_EULER 68
74 
75 #define PASO_SMOOTHER 99999999
76 
77 namespace paso {
78 
80 {
81  Options() { setDefaults(); }
82 
84  Options(const boost::python::object& options);
85 
87  void setDefaults();
88 
90  void show() const;
91 
93  void showDiagnostics() const;
94 
96  void updateEscriptDiagnostics(boost::python::object& options) const;
97 
99  static int mapEscriptOption(int escriptOption);
100 
101  static const char* name(int key);
102 
103  static int getPackage(int solver, int package, bool symmetry,
104  const escript::JMPI& mpi_info);
105 
107  static int getSolver(int solver, int package, bool symmetry,
108  const escript::JMPI& mpi_info);
109 
110  int method;
111  int package;
112  bool symmetric;
113  bool hermitian;
114  double tolerance;
118  bool verbose;
124  double drop_storage;
127  int sweeps;
133 
134  // diagnostic values
138  double time;
139  double set_up_time;
142  double net_time;
144  bool converged;
145  double preconditioner_size; // in Mbytes
149 };
150 
151 } // namespace paso
152 
153 #endif // __PASO_OPTIONS_H__
154 
escript::SolverBuddy::getDropTolerance
double getDropTolerance() const
Definition: SolverOptions.cpp:650
paso::Options::show
void show() const
prints current option values
Definition: Options.cpp:121
escript::SO_REORDERING_NONE
@ SO_REORDERING_NONE
Definition: SolverOptions.h:141
escript::SolverBuddy
Definition: SolverOptions.h:161
PASO_TRILINOS
#define PASO_TRILINOS
Definition: Options.h:59
PASO_CR
#define PASO_CR
Definition: Options.h:42
paso::Options::Options
Options()
Definition: Options.h:81
PASO_DIRECT
#define PASO_DIRECT
Definition: Options.h:39
paso::Options::setDefaults
void setDefaults()
sets the default values for solver options
Definition: Options.cpp:61
PASO_DLL_API
#define PASO_DLL_API
Definition: paso/src/system_dep.h:29
paso::Options::num_level
dim_t num_level
Definition: Options.h:136
PASO_GAUSS_SEIDEL
#define PASO_GAUSS_SEIDEL
Definition: Options.h:63
escript::SO_METHOD_GMRES
@ SO_METHOD_GMRES
Definition: SolverOptions.h:107
escript::SolverBuddy::useLocalPreconditioner
bool useLocalPreconditioner() const
Definition: SolverOptions.cpp:804
paso::Options::preconditioner_size
double preconditioner_size
Definition: Options.h:145
PASO_ILUT
#define PASO_ILUT
Definition: Options.h:46
paso::Options::accept_failed_convergence
bool accept_failed_convergence
Definition: Options.h:128
paso::Options::package
int package
Definition: Options.h:111
PASO_DEFAULT
#define PASO_DEFAULT
Definition: Options.h:38
escript::SolverBuddy::getTolerance
double getTolerance() const
Definition: SolverOptions.cpp:614
escript::SO_METHOD_DIRECT
@ SO_METHOD_DIRECT
Definition: SolverOptions.h:102
PASO_RILU
#define PASO_RILU
Definition: Options.h:65
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:221
escript::SolverBuddy::getAbsoluteTolerance
double getAbsoluteTolerance() const
Definition: SolverOptions.cpp:626
escript::SO_ODESOLVER_BACKWARD_EULER
@ SO_ODESOLVER_BACKWARD_EULER
Definition: SolverOptions.h:129
escript::SolverBuddy::getTruncation
int getTruncation() const
Definition: SolverOptions.cpp:566
paso::Options::showDiagnostics
void showDiagnostics() const
prints diagnostic data
Definition: Options.cpp:104
paso::Options::time_step_backtracking_used
bool time_step_backtracking_used
Definition: Options.h:146
PASO_ILU0
#define PASO_ILU0
Definition: Options.h:45
escript::SO_PRECONDITIONER_ILU0
@ SO_PRECONDITIONER_ILU0
Definition: SolverOptions.h:121
PASO_ITERATIVE
#define PASO_ITERATIVE
Definition: Options.h:55
escript::SolverBuddy::getNumSweeps
int getNumSweeps() const
Definition: SolverOptions.cpp:602
paso::Options::time
double time
Definition: Options.h:138
paso::Options::getPackage
static int getPackage(int solver, int package, bool symmetry, const escript::JMPI &mpi_info)
Definition: Options.cpp:315
PASO_GMRES
#define PASO_GMRES
Definition: Options.h:48
escript::SolverBuddy::getSolverMethod
SolverOptions getSolverMethod() const
Definition: SolverOptions.cpp:441
paso::Options::tolerance
double tolerance
Definition: Options.h:114
SET
#define SET(__key__, __val__, __type__)
PASO_MINIMUM_FILL_IN
#define PASO_MINIMUM_FILL_IN
Definition: Options.h:53
escript::SolverBuddy::getNumRefinements
int getNumRefinements() const
Definition: SolverOptions.cpp:834
paso::Options::mapEscriptOption
static int mapEscriptOption(int escriptOption)
returns the corresponding paso option code for an escript option code
Definition: Options.cpp:360
PASO_CRANK_NICOLSON
#define PASO_CRANK_NICOLSON
Definition: Options.h:72
escript::SO_ODESOLVER_LINEAR_CRANK_NICOLSON
@ SO_ODESOLVER_LINEAR_CRANK_NICOLSON
Definition: SolverOptions.h:131
escript::SO_PRECONDITIONER_REC_ILU
@ SO_PRECONDITIONER_REC_ILU
Definition: SolverOptions.h:125
escript::SO_REORDERING_MINIMUM_FILL_IN
@ SO_REORDERING_MINIMUM_FILL_IN
Definition: SolverOptions.h:139
paso::Options::num_coarse_unknowns
dim_t num_coarse_unknowns
Definition: Options.h:148
PASO_PRES20
#define PASO_PRES20
Definition: Options.h:49
paso::Options::hermitian
bool hermitian
Definition: Options.h:113
escript::SO_PRECONDITIONER_ILUT
@ SO_PRECONDITIONER_ILUT
Definition: SolverOptions.h:122
escript::SolverBuddy::isHermitian
bool isHermitian() const
Definition: SolverOptions.cpp:712
paso::Options::net_time
double net_time
Definition: Options.h:142
escript::SO_METHOD_NONLINEAR_GMRES
@ SO_METHOD_NONLINEAR_GMRES
Definition: SolverOptions.h:112
PASO_MKL
#define PASO_MKL
Definition: Options.h:50
PASO_NO_REORDERING
#define PASO_NO_REORDERING
Definition: Options.h:52
PASO_NO_PRECONDITIONER
#define PASO_NO_PRECONDITIONER
Definition: Options.h:67
paso::Options::verbose
bool verbose
Definition: Options.h:118
PASO_DEFAULT_REORDERING
#define PASO_DEFAULT_REORDERING
Definition: Options.h:66
Options.h
paso::Options::method
int method
Definition: Options.h:110
escript::SolverBuddy::isVerbose
bool isVerbose() const
Definition: SolverOptions.cpp:735
escript::SO_PACKAGE_PASO
@ SO_PACKAGE_PASO
Definition: SolverOptions.h:91
PASO_PCG
#define PASO_PCG
Definition: Options.h:41
PASO_TFQMR
#define PASO_TFQMR
Definition: Options.h:61
escript::SO_PACKAGE_MUMPS
@ SO_PACKAGE_MUMPS
Definition: SolverOptions.h:94
Paso.h
paso::Options::truncation
index_t truncation
Definition: Options.h:125
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:66
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:74
escript::SO_REORDERING_DEFAULT
@ SO_REORDERING_DEFAULT
Definition: SolverOptions.h:138
paso::Options::reordering
bool reordering
Definition: Options.h:119
escript::SolverBuddy::acceptConvergenceFailure
bool acceptConvergenceFailure() const
Definition: SolverOptions.cpp:781
PASO_LINEAR_CRANK_NICOLSON
#define PASO_LINEAR_CRANK_NICOLSON
Definition: Options.h:71
paso::Options::symmetric
bool symmetric
Definition: Options.h:112
paso::Options::inner_tolerance
double inner_tolerance
Definition: Options.h:116
paso::Options::refinements
dim_t refinements
Definition: Options.h:131
escript::SolverBuddy::getRelaxationFactor
double getRelaxationFactor() const
Definition: SolverOptions.cpp:674
paso::Options::num_inner_iter
dim_t num_inner_iter
Definition: Options.h:137
escript::SolverBuddy::getInnerIterMax
int getInnerIterMax() const
Definition: SolverOptions.cpp:578
escript::SolverBuddy::getInnerTolerance
double getInnerTolerance() const
Definition: SolverOptions.cpp:638
escript::SolverBuddy::_getRestartForC
int _getRestartForC() const
Definition: SolverOptions.cpp:551
escript::SO_ODESOLVER_CRANK_NICOLSON
@ SO_ODESOLVER_CRANK_NICOLSON
Definition: SolverOptions.h:130
paso::Options::drop_storage
double drop_storage
Definition: Options.h:124
PASO_NONLINEAR_GMRES
#define PASO_NONLINEAR_GMRES
Definition: Options.h:60
paso::Options::iter_max
dim_t iter_max
Definition: Options.h:121
escript::SO_METHOD_CGS
@ SO_METHOD_CGS
Definition: SolverOptions.h:99
paso::Options::updateEscriptDiagnostics
void updateEscriptDiagnostics(boost::python::object &options) const
updates SolverBuddy diagnostics from this
Definition: Options.cpp:441
paso::Options::converged
bool converged
Definition: Options.h:144
paso::Options::use_local_preconditioner
bool use_local_preconditioner
Definition: Options.h:130
paso::Options::relaxation_factor
double relaxation_factor
Definition: Options.h:129
PASO_PASO
#define PASO_PASO
Definition: Options.h:56
paso::Options::coarse_level_sparsity
double coarse_level_sparsity
Definition: Options.h:147
PASO_UMFPACK
#define PASO_UMFPACK
Definition: Options.h:51
escript::SolverBuddy::getIterMax
int getIterMax() const
Definition: SolverOptions.cpp:590
paso::Options::adapt_inner_tolerance
bool adapt_inner_tolerance
Definition: Options.h:117
escript::SO_METHOD_ITERATIVE
@ SO_METHOD_ITERATIVE
Definition: SolverOptions.h:109
PASO_BICGSTAB
#define PASO_BICGSTAB
Definition: Options.h:44
escript::SolverBuddy::getReordering
SolverOptions getReordering() const
Definition: SolverOptions.cpp:533
escript::SolverBuddy::isSymmetric
bool isSymmetric() const
Definition: SolverOptions.cpp:689
paso::Options::residual_norm
double residual_norm
Definition: Options.h:143
escript::SO_REORDERING_NESTED_DISSECTION
@ SO_REORDERING_NESTED_DISSECTION
Definition: SolverOptions.h:140
escript::SO_METHOD_BICGSTAB
@ SO_METHOD_BICGSTAB
Definition: SolverOptions.h:97
escript::SolverBuddy::getPreconditioner
SolverOptions getPreconditioner() const
Definition: SolverOptions.cpp:358
paso::Options::ode_solver
int ode_solver
Definition: Options.h:132
paso::Options::drop_tolerance
double drop_tolerance
Definition: Options.h:123
paso::PasoException
PasoException exception class.
Definition: PasoException.h:34
PASO_MINRES
#define PASO_MINRES
Definition: Options.h:62
paso::Options::preconditioner
int preconditioner
Definition: Options.h:120
escript::SO_METHOD_MINRES
@ SO_METHOD_MINRES
Definition: SolverOptions.h:111
PASO_JACOBI
#define PASO_JACOBI
Definition: Options.h:47
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:61
paso::Options::inner_iter_max
dim_t inner_iter_max
Definition: Options.h:122
PASO_CGS
#define PASO_CGS
Definition: Options.h:43
paso::Options::name
static const char * name(int key)
Definition: Options.cpp:149
escript::SO_METHOD_CR
@ SO_METHOD_CR
Definition: SolverOptions.h:101
paso::Options::set_up_time
double set_up_time
Definition: Options.h:139
paso::Options::sweeps
int sweeps
Definition: Options.h:127
PASO_MUMPS
#define PASO_MUMPS
Definition: Options.h:57
escript::SO_PRECONDITIONER_GAUSS_SEIDEL
@ SO_PRECONDITIONER_GAUSS_SEIDEL
Definition: SolverOptions.h:120
escript::SO_DEFAULT
@ SO_DEFAULT
Definition: SolverOptions.h:83
escript::SO_PRECONDITIONER_NONE
@ SO_PRECONDITIONER_NONE
Definition: SolverOptions.h:124
paso::Options::coarsening_selection_time
double coarsening_selection_time
Definition: Options.h:140
PasoException.h
PASO_REC_ILU
#define PASO_REC_ILU
Definition: Options.h:58
PASO_BACKWARD_EULER
#define PASO_BACKWARD_EULER
Definition: Options.h:73
PASO_NESTED_DISSECTION
#define PASO_NESTED_DISSECTION
Definition: Options.h:54
paso::Options::absolute_tolerance
double absolute_tolerance
Definition: Options.h:115
escript::SO_PRECONDITIONER_RILU
@ SO_PRECONDITIONER_RILU
Definition: SolverOptions.h:126
escript::SO_PACKAGE_TRILINOS
@ SO_PACKAGE_TRILINOS
Definition: SolverOptions.h:92
escript::SolverBuddy::adaptInnerTolerance
bool adaptInnerTolerance() const
Definition: SolverOptions.cpp:758
paso
Definition: BiCGStab.cpp:25
paso::Options::coarsening_matrix_time
double coarsening_matrix_time
Definition: Options.h:141
escript::SO_PACKAGE_MKL
@ SO_PACKAGE_MKL
Definition: SolverOptions.h:90
escript::SO_PRECONDITIONER_JACOBI
@ SO_PRECONDITIONER_JACOBI
Definition: SolverOptions.h:123
escript::SO_METHOD_PRES20
@ SO_METHOD_PRES20
Definition: SolverOptions.h:114
escript::SolverBuddy::getDropStorage
double getDropStorage() const
Definition: SolverOptions.cpp:662
escript::SO_PACKAGE_UMFPACK
@ SO_PACKAGE_UMFPACK
Definition: SolverOptions.h:93
escript::SO_METHOD_TFQMR
@ SO_METHOD_TFQMR
Definition: SolverOptions.h:116
escript::SO_METHOD_PCG
@ SO_METHOD_PCG
Definition: SolverOptions.h:113
paso::Options
Definition: Options.h:80
escript::SolverBuddy::getODESolver
SolverOptions getODESolver() const
Definition: SolverOptions.cpp:853
PASO_CHOLEVSKY
#define PASO_CHOLEVSKY
Definition: Options.h:40
paso::Options::num_iter
dim_t num_iter
Definition: Options.h:135
paso::Options::restart
index_t restart
Definition: Options.h:126
escript::SO_METHOD_CHOLEVSKY
@ SO_METHOD_CHOLEVSKY
Definition: SolverOptions.h:100
paso::Options::Options
Options(const boost::python::object &options)
constructor that fills values from an escript SolverBuddy instance