#include <Options.h>
◆ Options() [1/2]
paso::Options::Options |
( |
| ) |
|
|
inline |
◆ Options() [2/2]
paso::Options::Options |
( |
const boost::python::object & |
options | ) |
|
constructor that fills values from an escript SolverBuddy instance
◆ getPackage()
int paso::Options::getPackage |
( |
int |
solver, |
|
|
int |
package, |
|
|
bool |
symmetry, |
|
|
const escript::JMPI & |
mpi_info |
|
) |
| |
|
static |
◆ getSolver()
int paso::Options::getSolver |
( |
int |
solver, |
|
|
int |
package, |
|
|
bool |
symmetry, |
|
|
const escript::JMPI & |
mpi_info |
|
) |
| |
|
static |
returns the solver to be used with given combination
References PASO_BICGSTAB, PASO_CHOLEVSKY, PASO_DEFAULT, PASO_DIRECT, PASO_GMRES, PASO_MINRES, PASO_MKL, PASO_NONLINEAR_GMRES, PASO_PASO, PASO_PCG, PASO_PRES20, PASO_TFQMR, PASO_TRILINOS, and PASO_UMFPACK.
Referenced by Options(), and paso::Solver().
◆ mapEscriptOption()
int paso::Options::mapEscriptOption |
( |
int |
escriptOption | ) |
|
|
static |
returns the corresponding paso option code for an escript option code
References PASO_AGGREGATION_COARSENING, PASO_AMG, PASO_AMLI, PASO_BACKWARD_EULER, PASO_BICGSTAB, PASO_BOOMERAMG, PASO_CGS, PASO_CHOLEVSKY, PASO_CIJP_COARSENING, PASO_CIJP_FIXED_RANDOM_COARSENING, PASO_CLASSIC_INTERPOLATION, PASO_CLASSIC_INTERPOLATION_WITH_FF_COUPLING, PASO_CR, PASO_CRANK_NICOLSON, PASO_DEFAULT, PASO_DEFAULT_REORDERING, PASO_DIRECT, PASO_DIRECT_INTERPOLATION, PASO_FALGOUT_COARSENING, PASO_GAUSS_SEIDEL, PASO_GMRES, PASO_HMIS_COARSENING, PASO_ILU0, PASO_ILUT, PASO_ITERATIVE, PASO_JACOBI, PASO_LINEAR_CRANK_NICOLSON, PASO_MINIMUM_FILL_IN, PASO_MINRES, PASO_MKL, PASO_NESTED_DISSECTION, PASO_NO_PRECONDITIONER, PASO_NO_REORDERING, PASO_NONLINEAR_GMRES, PASO_PASO, PASO_PCG, PASO_PMIS_COARSENING, PASO_PRES20, PASO_REC_ILU, PASO_RILU, PASO_RUGE_STUEBEN_COARSENING, PASO_STANDARD_COARSENING, PASO_TFQMR, PASO_TRILINOS, PASO_UMFPACK, PASO_YAIR_SHAPIRA_COARSENING, escript::SO_COARSENING_AGGREGATION, escript::SO_COARSENING_CIJP, escript::SO_COARSENING_CIJP_FIXED_RANDOM, escript::SO_COARSENING_FALGOUT, escript::SO_COARSENING_HMIS, escript::SO_COARSENING_PMIS, escript::SO_COARSENING_RUGE_STUEBEN, escript::SO_COARSENING_STANDARD, escript::SO_COARSENING_YAIR_SHAPIRA, escript::SO_DEFAULT, escript::SO_INTERPOLATION_CLASSIC, escript::SO_INTERPOLATION_CLASSIC_WITH_FF_COUPLING, escript::SO_INTERPOLATION_DIRECT, escript::SO_METHOD_BICGSTAB, escript::SO_METHOD_CGS, escript::SO_METHOD_CHOLEVSKY, escript::SO_METHOD_CR, escript::SO_METHOD_DIRECT, escript::SO_METHOD_GMRES, escript::SO_METHOD_ITERATIVE, escript::SO_METHOD_MINRES, escript::SO_METHOD_NONLINEAR_GMRES, escript::SO_METHOD_PCG, escript::SO_METHOD_PRES20, escript::SO_METHOD_TFQMR, escript::SO_ODESOLVER_BACKWARD_EULER, escript::SO_ODESOLVER_CRANK_NICOLSON, escript::SO_ODESOLVER_LINEAR_CRANK_NICOLSON, escript::SO_PACKAGE_MKL, escript::SO_PACKAGE_PASO, escript::SO_PACKAGE_TRILINOS, escript::SO_PACKAGE_UMFPACK, escript::SO_PRECONDITIONER_AMG, escript::SO_PRECONDITIONER_AMLI, escript::SO_PRECONDITIONER_BOOMERAMG, escript::SO_PRECONDITIONER_GAUSS_SEIDEL, escript::SO_PRECONDITIONER_ILU0, escript::SO_PRECONDITIONER_ILUT, escript::SO_PRECONDITIONER_JACOBI, escript::SO_PRECONDITIONER_NONE, escript::SO_PRECONDITIONER_REC_ILU, escript::SO_PRECONDITIONER_RILU, escript::SO_REORDERING_DEFAULT, escript::SO_REORDERING_MINIMUM_FILL_IN, escript::SO_REORDERING_NESTED_DISSECTION, and escript::SO_REORDERING_NONE.
Referenced by paso::SystemMatrix::getSystemMatrixTypeId(), and Options().
◆ name()
const char * paso::Options::name |
( |
int |
key | ) |
|
|
static |
References PASO_AGGREGATION_COARSENING, PASO_AMG, PASO_AMLI, PASO_BACKWARD_EULER, PASO_BICGSTAB, PASO_BOOMERAMG, PASO_CGS, PASO_CHOLEVSKY, PASO_CIJP_COARSENING, PASO_CIJP_FIXED_RANDOM_COARSENING, PASO_CR, PASO_CRANK_NICOLSON, PASO_DEFAULT, PASO_DEFAULT_REORDERING, PASO_DIRECT, PASO_FALGOUT_COARSENING, PASO_GAUSS_SEIDEL, PASO_GMRES, PASO_HMIS_COARSENING, PASO_ILU0, PASO_ILUT, PASO_ITERATIVE, PASO_JACOBI, PASO_LINEAR_CRANK_NICOLSON, PASO_MINIMUM_FILL_IN, PASO_MINRES, PASO_MKL, PASO_NESTED_DISSECTION, PASO_NO_PRECONDITIONER, PASO_NO_REORDERING, PASO_NONLINEAR_GMRES, PASO_PASO, PASO_PCG, PASO_PMIS_COARSENING, PASO_PRES20, PASO_REC_ILU, PASO_RILU, PASO_RUGE_STUEBEN_COARSENING, PASO_STANDARD_COARSENING, PASO_TFQMR, PASO_TRILINOS, PASO_UMFPACK, and PASO_YAIR_SHAPIRA_COARSENING.
Referenced by Options(), and show().
◆ setDefaults()
void paso::Options::setDefaults |
( |
| ) |
|
sets the default values for solver options
References absolute_tolerance, accept_failed_convergence, adapt_inner_tolerance, coarse_level_sparsity, coarse_matrix_refinements, coarsening_matrix_time, coarsening_method, coarsening_selection_time, coarsening_threshold, converged, cycle_type, diagonal_dominance_threshold, drop_storage, drop_tolerance, inner_iter_max, inner_tolerance, interpolation_method, level_max, method, min_coarse_matrix_size, min_coarse_sparsity, net_time, num_coarse_unknowns, num_inner_iter, num_iter, num_level, PASO_DEFAULT, PASO_DIRECT_INTERPOLATION, PASO_GS, PASO_JACOBI, PASO_LINEAR_CRANK_NICOLSON, PASO_NO_REORDERING, post_sweeps, pre_sweeps, preconditioner_size, refinements, reordering, residual_norm, restart, set_up_time, sweeps, symmetric, time, time_step_backtracking_used, tolerance, truncation, use_local_preconditioner, and usePanel.
Referenced by Options().
◆ show()
void paso::Options::show |
( |
| ) |
const |
◆ showDiagnostics()
void paso::Options::showDiagnostics |
( |
| ) |
const |
prints diagnostic data
References coarsening_matrix_time, coarsening_selection_time, converged, net_time, num_inner_iter, num_iter, num_level, preconditioner_size, residual_norm, set_up_time, time, and time_step_backtracking_used.
Referenced by Options().
◆ updateEscriptDiagnostics()
void paso::Options::updateEscriptDiagnostics |
( |
boost::python::object & |
options | ) |
const |
updates SolverBuddy diagnostics from this
References coarse_level_sparsity, converged, net_time, num_coarse_unknowns, num_inner_iter, num_iter, num_level, residual_norm, SET, set_up_time, time, and time_step_backtracking_used.
Referenced by Options(), paso::TransportProblem::setToSolution(), and paso::SystemMatrix::setToSolution().
◆ absolute_tolerance
double paso::Options::absolute_tolerance |
◆ accept_failed_convergence
bool paso::Options::accept_failed_convergence |
◆ adapt_inner_tolerance
bool paso::Options::adapt_inner_tolerance |
◆ coarse_level_sparsity
double paso::Options::coarse_level_sparsity |
◆ coarse_matrix_refinements
dim_t paso::Options::coarse_matrix_refinements |
◆ coarsening_matrix_time
double paso::Options::coarsening_matrix_time |
◆ coarsening_method
index_t paso::Options::coarsening_method |
◆ coarsening_selection_time
double paso::Options::coarsening_selection_time |
◆ coarsening_threshold
double paso::Options::coarsening_threshold |
◆ converged
bool paso::Options::converged |
◆ cycle_type
int paso::Options::cycle_type |
◆ diagonal_dominance_threshold
double paso::Options::diagonal_dominance_threshold |
◆ drop_storage
double paso::Options::drop_storage |
◆ drop_tolerance
double paso::Options::drop_tolerance |
◆ inner_iter_max
dim_t paso::Options::inner_iter_max |
◆ inner_tolerance
double paso::Options::inner_tolerance |
◆ interpolation_method
int paso::Options::interpolation_method |
◆ iter_max
dim_t paso::Options::iter_max |
◆ level_max
int paso::Options::level_max |
◆ method
int paso::Options::method |
◆ min_coarse_matrix_size
dim_t paso::Options::min_coarse_matrix_size |
◆ min_coarse_sparsity
double paso::Options::min_coarse_sparsity |
◆ net_time
double paso::Options::net_time |
◆ num_coarse_unknowns
dim_t paso::Options::num_coarse_unknowns |
◆ num_inner_iter
dim_t paso::Options::num_inner_iter |
◆ num_iter
dim_t paso::Options::num_iter |
◆ num_level
dim_t paso::Options::num_level |
◆ ode_solver
int paso::Options::ode_solver |
◆ package
int paso::Options::package |
◆ post_sweeps
int paso::Options::post_sweeps |
◆ pre_sweeps
int paso::Options::pre_sweeps |
◆ preconditioner
int paso::Options::preconditioner |
◆ preconditioner_size
double paso::Options::preconditioner_size |
◆ refinements
dim_t paso::Options::refinements |
◆ relaxation_factor
double paso::Options::relaxation_factor |
◆ reordering
bool paso::Options::reordering |
◆ residual_norm
double paso::Options::residual_norm |
◆ restart
index_t paso::Options::restart |
◆ set_up_time
double paso::Options::set_up_time |
◆ smoother
int paso::Options::smoother |
◆ sweeps
int paso::Options::sweeps |
◆ symmetric
bool paso::Options::symmetric |
◆ time
double paso::Options::time |
◆ time_step_backtracking_used
bool paso::Options::time_step_backtracking_used |
◆ tolerance
double paso::Options::tolerance |
◆ truncation
index_t paso::Options::truncation |
◆ use_local_preconditioner
bool paso::Options::use_local_preconditioner |
◆ usePanel
bool paso::Options::usePanel |
◆ verbose
bool paso::Options::verbose |
Referenced by paso::FCT_Solver::initialize(), paso::Preconditioner_alloc(), paso::Preconditioner_AMG_alloc(), paso::Preconditioner_AMG_Root_alloc(), paso::Preconditioner_BoomerAMG_alloc(), paso::Preconditioner_LocalAMG_alloc(), paso::TransportProblem::solve(), paso::SystemMatrix::solve(), paso::Solver(), paso::Solver_NewtonGMRES(), paso::FCT_Solver::updateLCN(), and paso::FCT_Solver::updateNL().
The documentation for this struct was generated from the following files: