![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters.h>
Public Types | |
| enum class | SolverType : std::int8_t { gmres , bicgstab , direct } |
| enum class | PreconditionerType : std::int8_t { ilu , amg , lsmg , gcmg , none } |
| enum class | MultigridCoarseningSequenceType : std::int8_t { h , p , hp , ph } |
| enum class | MultigridSmootherPreconditionerType : std::int8_t { inverse_diagonal , additive_schwarz_method , chebyshev } |
| enum class | CoarseGridSolverType : std::int8_t { gmres , amg , ilu , direct } |
Public Member Functions | |
| void | parse_parameters (ParameterHandler &prm, const std::string &physics_name) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler &prm, const std::string &physics_name) |
LinearSolver - Parameters that control the solution of the linear system of equations that arise from the finite element problem for each of the physics available in Lethe.
Definition at line 1789 of file parameters.h.
|
strong |
Type of coarse grid solver.
| Enumerator | |
|---|---|
| gmres | |
| amg | |
| ilu | |
| direct | |
Definition at line 1945 of file parameters.h.
|
strong |
|
strong |
Type of preconditioner for the MG smoother.
| Enumerator | |
|---|---|
| inverse_diagonal | |
| additive_schwarz_method | |
| chebyshev | |
Definition at line 1914 of file parameters.h.
|
strong |
Type of preconditioner.
| Enumerator | |
|---|---|
| ilu | Incomplete LU Factorization. |
| amg | Algebraic Multigrid. |
| lsmg | Local-Smoothing Geometric Multigrid. |
| gcmg | Global-Coarsening Multigrid. |
| none | No preconditioner. |
Definition at line 1827 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| gmres | |
| bicgstab | |
| direct | |
Definition at line 1792 of file parameters.h.
|
static |
Declare the parameters.
| [in,out] | prm | ParameterHandler object. |
| [in] | physics_name | Name of the current physics |
Definition at line 3424 of file parameters.cc.
References amg_aggregation_threshold, amg_n_cycles, amg_precond_ilu_atol, amg_precond_ilu_fill, amg_precond_ilu_rtol, amg_smoother_overlap, amg_smoother_sweeps, amg_w_cycles, declare_enum_entry(), Parameters::deprecated_verbosity_names(), eig_estimation_cg_n_iterations, eig_estimation_smoothing_range, eig_estimation_verbose, enable_hessians_jacobian, enable_hessians_residual, force_linear_solver_continuation, ilu_precond_atol, ilu_precond_fill, ilu_precond_rtol, max_iterations, max_krylov_vectors, mg_amg_use_default_parameters, mg_coarse_grid_solver, mg_coarsening_type, mg_enable_hessians_jacobian, mg_gmres_max_iterations, mg_gmres_max_krylov_vectors, mg_gmres_preconditioner, mg_gmres_reduce, mg_gmres_tolerance, mg_int_level, mg_level_min_cells, mg_min_level, mg_p_coarsening_type, mg_p_min_coarsening_degree, mg_smoother_chebyshev_degree, mg_smoother_chebyshev_eig_cg_n_iterations, mg_smoother_chebyshev_smoothing_range, mg_smoother_eig_estimation, mg_smoother_iterations, mg_smoother_preconditioner_type, mg_smoother_relaxation, mg_use_fe_q_iso_q1, mg_verbosity, minimum_residual, preconditioner, Parameters::quiet_or_verbose(), relative_residual, rescale_residual_by_volume, solver, and verbosity.
| void Parameters::LinearSolver::parse_parameters | ( | ParameterHandler & | prm, |
| const std::string & | physics_name ) |
Parse the parameters.
| [in] | prm | ParameterHandler object. |
| [in] | physics_name | Name of the current physics |
Definition at line 3729 of file parameters.cc.
References amg_aggregation_threshold, amg_n_cycles, amg_precond_ilu_atol, amg_precond_ilu_fill, amg_precond_ilu_rtol, amg_smoother_overlap, amg_smoother_sweeps, amg_w_cycles, Parameters::deprecated_verbosity_names(), eig_estimation_cg_n_iterations, eig_estimation_smoothing_range, eig_estimation_verbose, enable_hessians_jacobian, enable_hessians_residual, force_linear_solver_continuation, h, hp, ilu_precond_atol, ilu_precond_fill, ilu_precond_rtol, lsmg, max_iterations, max_krylov_vectors, mg_amg_use_default_parameters, mg_coarse_grid_solver, mg_coarsening_type, mg_enable_hessians_jacobian, mg_gmres_max_iterations, mg_gmres_max_krylov_vectors, mg_gmres_preconditioner, mg_gmres_reduce, mg_gmres_tolerance, mg_int_level, mg_level_min_cells, mg_min_level, mg_p_coarsening_type, mg_p_min_coarsening_degree, mg_smoother_chebyshev_degree, mg_smoother_chebyshev_eig_cg_n_iterations, mg_smoother_chebyshev_smoothing_range, mg_smoother_eig_estimation, mg_smoother_iterations, mg_smoother_preconditioner_type, mg_smoother_relaxation, mg_use_fe_q_iso_q1, mg_verbosity, minimum_residual, preconditioner, relative_residual, rescale_residual_by_volume, solver, string_to_enum(), and verbosity.
| double Parameters::LinearSolver::amg_aggregation_threshold = 1e-14 |
AMG aggregation threshold.
Definition at line 1859 of file parameters.h.
| unsigned int Parameters::LinearSolver::amg_n_cycles = 1 |
AMG number of cycles.
Definition at line 1862 of file parameters.h.
| double Parameters::LinearSolver::amg_precond_ilu_atol = 1e-12 |
ILU absolute tolerance for smoother.
Definition at line 1853 of file parameters.h.
| unsigned int Parameters::LinearSolver::amg_precond_ilu_fill = 0 |
ILU fill for smoother.
AMG parameters either as linear solver preconditioner or as preconditioner of a coarse-grid solver for LSMG or GCMG
Definition at line 1850 of file parameters.h.
| double Parameters::LinearSolver::amg_precond_ilu_rtol = 1.00 |
ILU relative tolerance for smoother.
Definition at line 1856 of file parameters.h.
| unsigned int Parameters::LinearSolver::amg_smoother_overlap = 1 |
AMG Smoother overlap.
Definition at line 1871 of file parameters.h.
| unsigned int Parameters::LinearSolver::amg_smoother_sweeps = 2 |
AMG Smoother sweeps.
Definition at line 1868 of file parameters.h.
| bool Parameters::LinearSolver::amg_w_cycles = false |
AMG W_cycle.
Definition at line 1865 of file parameters.h.
| int Parameters::LinearSolver::eig_estimation_cg_n_iterations = 10 |
MG number of cg iterations to find eigenvalue.
Definition at line 1939 of file parameters.h.
| double Parameters::LinearSolver::eig_estimation_smoothing_range = 10 |
MG smoothing range to set range between eigenvalues.
Definition at line 1936 of file parameters.h.
| Verbosity Parameters::LinearSolver::eig_estimation_verbose = Verbosity::verbose |
MG print max, min, eigenvalues.
Definition at line 1942 of file parameters.h.
| bool Parameters::LinearSolver::enable_hessians_jacobian = true |
Enable hessians in jacobian.
Definition at line 1821 of file parameters.h.
| bool Parameters::LinearSolver::enable_hessians_residual = true |
Enable hessians in residual.
Definition at line 1824 of file parameters.h.
| bool Parameters::LinearSolver::force_linear_solver_continuation = false |
Block linear solver to throw error.
Definition at line 1874 of file parameters.h.
| double Parameters::LinearSolver::ilu_precond_atol = 1e-12 |
ILU absolute tolerance.
Definition at line 1841 of file parameters.h.
| unsigned int Parameters::LinearSolver::ilu_precond_fill = 0 |
ILU fill.
Definition at line 1838 of file parameters.h.
| double Parameters::LinearSolver::ilu_precond_rtol = 1.00 |
ILU relative tolerance.
Definition at line 1844 of file parameters.h.
| int Parameters::LinearSolver::max_iterations = 1000 |
Maximum number of iterations.
Definition at line 1815 of file parameters.h.
| int Parameters::LinearSolver::max_krylov_vectors = 100 |
Maximum number of krylov vectors.
Definition at line 1818 of file parameters.h.
| bool Parameters::LinearSolver::mg_amg_use_default_parameters = false |
MG use default parameters for AMG.
Definition at line 1973 of file parameters.h.
| CoarseGridSolverType Parameters::LinearSolver::mg_coarse_grid_solver = CoarseGridSolverType::direct |
Definition at line 1952 of file parameters.h.
| MultigridCoarseningSequenceType Parameters::LinearSolver::mg_coarsening_type |
Definition at line 1896 of file parameters.h.
| bool Parameters::LinearSolver::mg_enable_hessians_jacobian = true |
MG enable hessians in jacobian.
Definition at line 1886 of file parameters.h.
| int Parameters::LinearSolver::mg_gmres_max_iterations = 2000 |
MG coarse-grid solver maximum number of iterations.
Definition at line 1958 of file parameters.h.
| int Parameters::LinearSolver::mg_gmres_max_krylov_vectors = 30 |
MG coarse-grid solver maximum number of krylov vectors.
Definition at line 1967 of file parameters.h.
| PreconditionerType Parameters::LinearSolver::mg_gmres_preconditioner = PreconditionerType::amg |
MG coarse-grid solver preconditioner.
Definition at line 1970 of file parameters.h.
| double Parameters::LinearSolver::mg_gmres_reduce = 1e-4 |
MG coarse-grid solver reduce.
Definition at line 1964 of file parameters.h.
| double Parameters::LinearSolver::mg_gmres_tolerance = 1e-14 |
MG coarse-grid solver tolerance.
Definition at line 1961 of file parameters.h.
| int Parameters::LinearSolver::mg_int_level = -1 |
MG intermediate level.
Definition at line 1883 of file parameters.h.
| int Parameters::LinearSolver::mg_level_min_cells = -1 |
MG minimum number of cells per level.
Definition at line 1880 of file parameters.h.
| int Parameters::LinearSolver::mg_min_level = -1 |
MG min level.
Definition at line 1877 of file parameters.h.
| MGTransferGlobalCoarseningTools::PolynomialCoarseningSequenceType Parameters::LinearSolver::mg_p_coarsening_type |
Type of p coarsening sequence.
Definition at line 1901 of file parameters.h.
| unsigned int Parameters::LinearSolver::mg_p_min_coarsening_degree = 1 |
Minimum polynomial degree for p coarsening sequence.
Definition at line 1905 of file parameters.h.
| unsigned int Parameters::LinearSolver::mg_smoother_chebyshev_degree = 3 |
Chebyshev smoother polynomial degree.
Definition at line 1924 of file parameters.h.
| unsigned int Parameters::LinearSolver::mg_smoother_chebyshev_eig_cg_n_iterations = 10 |
Chebyshev smoother eigenvalue-estimation CG/Lanczos iterations.
Definition at line 1930 of file parameters.h.
| double Parameters::LinearSolver::mg_smoother_chebyshev_smoothing_range = 15 |
Chebyshev smoother smoothing range (lambda_max / lambda_min).
Definition at line 1927 of file parameters.h.
| bool Parameters::LinearSolver::mg_smoother_eig_estimation = true |
MG eigenvalue estimation for smoother relaxation parameter.
Definition at line 1933 of file parameters.h.
| int Parameters::LinearSolver::mg_smoother_iterations = 10 |
MG smoother number of iterations.
Definition at line 1908 of file parameters.h.
| MultigridSmootherPreconditionerType Parameters::LinearSolver::mg_smoother_preconditioner_type |
Definition at line 1920 of file parameters.h.
| double Parameters::LinearSolver::mg_smoother_relaxation = 0.5 |
MG smoother relaxation parameter.
Definition at line 1911 of file parameters.h.
| bool Parameters::LinearSolver::mg_use_fe_q_iso_q1 = false |
MG use FE_Q_iso_Q1 elements for coarse grid.
Definition at line 1955 of file parameters.h.
| Verbosity Parameters::LinearSolver::mg_verbosity = Verbosity::verbose |
MG information about levels.
Definition at line 1976 of file parameters.h.
| double Parameters::LinearSolver::minimum_residual = 1e-12 |
Minimum residual of the iterative solver.
Definition at line 1812 of file parameters.h.
| PreconditionerType Parameters::LinearSolver::preconditioner = PreconditionerType::ilu |
Definition at line 1835 of file parameters.h.
| double Parameters::LinearSolver::relative_residual = 1e-3 |
Relative residuals of the iterative solver.
Definition at line 1809 of file parameters.h.
| bool Parameters::LinearSolver::rescale_residual_by_volume = false |
Flag to rescale linear and non-linear residuals by the sqrt of the triangulation volume
Definition at line 1806 of file parameters.h.
| SolverType Parameters::LinearSolver::solver = SolverType::gmres |
Definition at line 1799 of file parameters.h.
| Verbosity Parameters::LinearSolver::verbosity = Verbosity::verbose |
Verbosity of linear solver.
Definition at line 1802 of file parameters.h.