escript  Revision_
Options.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2016 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 "esysUtils/types.h"
33 
34 // valid solver options
35 #define PASO_DEFAULT 0
36 #define PASO_DIRECT 1
37 #define PASO_CHOLEVSKY 2
38 #define PASO_PCG 3
39 #define PASO_CR 4
40 #define PASO_CGS 5
41 #define PASO_BICGSTAB 6
42 #define PASO_ILU0 8
43 #define PASO_ILUT 9
44 #define PASO_JACOBI 10
45 #define PASO_GMRES 11
46 #define PASO_PRES20 12
47 #define PASO_MKL 15
48 #define PASO_UMFPACK 16
49 #define PASO_NO_REORDERING 17
50 #define PASO_MINIMUM_FILL_IN 18
51 #define PASO_NESTED_DISSECTION 19
52 #define PASO_ITERATIVE 20
53 #define PASO_PASO 21
54 #define PASO_AMG 22
55 #define PASO_REC_ILU 23
56 #define PASO_TRILINOS 24
57 #define PASO_NONLINEAR_GMRES 25
58 #define PASO_TFQMR 26
59 #define PASO_MINRES 27
60 #define PASO_GAUSS_SEIDEL 28
61 #define PASO_GS PASO_GAUSS_SEIDEL
62 #define PASO_RILU 29
63 #define PASO_DEFAULT_REORDERING 30
64 #define PASO_SUPER_LU 31
65 #define PASO_PASTIX 32
66 #define PASO_YAIR_SHAPIRA_COARSENING 33
67 #define PASO_RUGE_STUEBEN_COARSENING 34
68 #define PASO_AGGREGATION_COARSENING 35
69 #define PASO_NO_PRECONDITIONER 36
70 #define PASO_AMLI 38
71 #define PASO_STANDARD_COARSENING 39
72 #define PASO_CLASSIC_INTERPOLATION_WITH_FF_COUPLING 50
73 #define PASO_CLASSIC_INTERPOLATION 51
74 #define PASO_DIRECT_INTERPOLATION 52
75 #define PASO_BOOMERAMG 60
76 #define PASO_CIJP_FIXED_RANDOM_COARSENING 61
77 #define PASO_CIJP_COARSENING 62
78 #define PASO_FALGOUT_COARSENING 63
79 #define PASO_PMIS_COARSENING 64
80 #define PASO_HMIS_COARSENING 65
81 #define PASO_LINEAR_CRANK_NICOLSON 66
82 #define PASO_CRANK_NICOLSON 67
83 #define PASO_BACKWARD_EULER 68
84 
85 #define PASO_SMOOTHER 99999999
86 
87 namespace paso {
88 
90 struct Options
91 {
93 
95  void setDefaults();
96 
98  void show() const;
99 
101  void showDiagnostics() const;
102 
103  static const char* name(int key);
104 
105  static int getPackage(int solver, int package, bool symmetry,
106  const esysUtils::JMPI& mpi_info);
107 
109  static int getSolver(int solver, int package, bool symmetry,
110  const esysUtils::JMPI& mpi_info);
111 
112  int method;
113  int package;
114  bool symmetric;
115  double tolerance;
119  bool verbose;
125  double drop_storage;
128  int sweeps;
134  int smoother;
144  bool usePanel;
147 
148  // diagnostic values
152  double time;
153  double set_up_time;
156  double net_time;
158  bool converged;
159  double preconditioner_size; // in Mbytes
163 };
164 
165 } // namespace paso
166 
167 #endif // __PASO_OPTIONS_H__
168 
static int getPackage(int solver, int package, bool symmetry, const esysUtils::JMPI &mpi_info)
Definition: Options.cpp:330
void showDiagnostics() const
prints diagnostic data
Definition: Options.cpp:89
double residual_norm
Definition: Options.h:157
double relaxation_factor
Definition: Options.h:138
int ode_solver
Definition: Options.h:146
#define PASO_DLL_API
Definition: Paso.h:41
dim_t num_inner_iter
Definition: Options.h:151
double min_coarse_sparsity
Definition: Options.h:140
bool reordering
Definition: Options.h:120
int sweeps
Definition: Options.h:128
static const char * name(int key)
Definition: Options.cpp:141
bool symmetric
Definition: Options.h:114
double set_up_time
Definition: Options.h:153
double inner_tolerance
Definition: Options.h:117
Definition: Options.h:90
static int getSolver(int solver, int package, bool symmetry, const esysUtils::JMPI &mpi_info)
returns the solver to be used with given combination
Definition: Options.cpp:239
double coarse_level_sparsity
Definition: Options.h:161
void show() const
prints current option values
Definition: Options.cpp:106
bool converged
Definition: Options.h:158
bool use_local_preconditioner
Definition: Options.h:139
int post_sweeps
Definition: Options.h:130
double coarsening_selection_time
Definition: Options.h:154
dim_t inner_iter_max
Definition: Options.h:123
dim_t coarse_matrix_refinements
Definition: Options.h:142
index_t restart
Definition: Options.h:127
double drop_tolerance
Definition: Options.h:124
int preconditioner
Definition: Options.h:121
bool usePanel
Definition: Options.h:144
dim_t num_level
Definition: Options.h:150
int interpolation_method
Definition: Options.h:145
double absolute_tolerance
Definition: Options.h:116
Definition: AMG.cpp:38
double preconditioner_size
Definition: Options.h:159
int pre_sweeps
Definition: Options.h:129
int package
Definition: Options.h:113
double diagonal_dominance_threshold
Definition: Options.h:143
dim_t min_coarse_matrix_size
Definition: Options.h:133
dim_t num_iter
Definition: Options.h:149
double coarsening_matrix_time
Definition: Options.h:155
bool accept_failed_convergence
Definition: Options.h:136
int cycle_type
Definition: Options.h:131
double tolerance
Definition: Options.h:115
bool time_step_backtracking_used
Definition: Options.h:160
dim_t num_coarse_unknowns
Definition: Options.h:162
void setDefaults()
sets the default values for solver options
Definition: Options.cpp:34
Options()
Definition: Options.h:92
int index_t
Definition: types.h:24
int method
Definition: Options.h:112
index_t dim_t
Definition: types.h:27
double coarsening_threshold
Definition: Options.h:135
double time
Definition: Options.h:152
dim_t refinements
Definition: Options.h:141
double net_time
Definition: Options.h:156
index_t truncation
Definition: Options.h:126
int level_max
Definition: Options.h:132
double drop_storage
Definition: Options.h:125
boost::shared_ptr< JMPI_ > JMPI
Definition: Esys_MPI.h:79
int smoother
Definition: Options.h:134
index_t coarsening_method
Definition: Options.h:137
bool adapt_inner_tolerance
Definition: Options.h:118
dim_t iter_max
Definition: Options.h:122
bool verbose
Definition: Options.h:119