BSpline Finite Element Exterior Calculus
Loading...
Searching...
No Matches
m_mform_solver::solverinitoptions Interface Reference
Inheritance diagram for m_mform_solver::solverinitoptions:
m_mform_solver::solversolveoptions m_mform_eigensolver::eigeninitoptions

Public Member Functions

procedure init_from_traits (this, traits)
 
type(solverinitoptions) function make_solver_options (ksp_type, pc_type, hypre_type, rtol, atol, max_iter, verbosity, verbosity_flag)
 Create a SolverInitOptions object from the provided arguments.
 
- Public Member Functions inherited from m_mform_solver::solversolveoptions
procedure apply_default_solve_options (options, default_max_iter, default_verbosity)
 
type(solversolveoptions) function make_solver_solve_options (rtol, atol, max_iter, verbosity, verbosity_flag)
 Create a SolverSolveOptions object from the provided arguments.
 

Public Attributes

character(len=80) ksp_type = ''
 KSP type for the PETSc solver (e.g., 'cg', 'gmres', 'minres', etc.)
 
character(len=80) pc_type = ''
 PC type for the PETSc preconditioner (e.g., 'jacobi', 'ilu', 'hypre', etc.)
 
character(len=80) hypre_type = ''
 HYPRE preconditioner type (e.g., 'boomeramg', 'ams', 'ilu', etc.)
 
character(len=80) ilu_level = ''
 ILU level for the HYPRE ILU preconditioner (e.g., '0', '1', '2', '3', or 'ilut')
 
- Public Attributes inherited from m_mform_solver::solversolveoptions
real(wp) rtol = -1._wp
 Relative tolerance for the solver.
 
real(wp) atol = -1._wp
 Absolute tolerance for the solver.
 
integer max_iter = -1
 Maximum number of iterations for the solver.
 
integer verbosity = -1
 Verbosity level for the solver (default: VERBOSITY_WARN_ON_FAILURE)
 

Member Function/Subroutine Documentation

◆ make_solver_options()

type(solverinitoptions) function m_mform_solver::solverinitoptions::make_solver_options ( character(*), intent(in), optional ksp_type,
character(*), intent(in), optional pc_type,
character(*), intent(in), optional hypre_type,
real(wp), intent(in), optional rtol,
real(wp), intent(in), optional atol,
integer, intent(in), optional max_iter,
character(*), intent(in), optional verbosity,
integer, intent(in), optional verbosity_flag )

Create a SolverInitOptions object from the provided arguments.

Parameters
[in]ksp_type_(optional)_ The type of the KSP solver to be used (default is 'gmres' for non-symmetric matrices, 'cg' for symmetric positive definite matrices, and 'minres' for symmetric indefinite matrices)
[in]pc_type_(optional)_ The type of the preconditioner to be used (default is 'hypre' for parallel problems, 'ilu' for serial problems, and 'hypre' for any curl-curl problems)
[in]hypre_type_(optional)_ The type of the Hypre preconditioner to be used (default is 'boomeramg' for parallel problems, 'ams' for curl-curl problems; note that 'pc_type' is set to 'hypre' if 'hypre_type' is present and 'pc_type' is not). For ILU the following options are supported: 'ilu' (for ILUT), 'ilu(0)', 'ilu(1)', 'ilu(2)', 'ilu(3)' (for ILUK).
[in]rtol_(optional)_ The relative tolerance for the solver (default is 1.e-10, or the value set in the init() method)
[in]atol_(optional)_ The absolute tolerance for the solver (default is 1.e-20, or the value set in the init() method)
[in]max_iter_(optional)_ The maximum number of iterations for the solver (default is the value set in the init() method)
[in]verbosity_(optional)_ The verbosity level for the solver (default is the value set in the init() method)
[in]verbosity_flag_(optional)_ The verbosity flag for the solver (default is the value set in the init() method)

The documentation for this interface was generated from the following file: