 |
deal.II version GIT relicensing-6842-g793a97d2aa 2026-10-02 14:00:01+00:00
|
Loading...
Searching...
No Matches
|
deal.II version GIT relicensing-6842-g793a97d2aa 2026-10-02 14:00:01+00:00
|
#include <deal.II/sundials/arkode_stepper.h>
Additional parameters for the LSRKStepperSTS class.
Definition at line 1378 of file arkode_stepper.h.
Public Member Functions | |
| AdditionalData (const std::string &method_name="", const unsigned int dom_eig_frequency=numbers::invalid_unsigned_int, const unsigned int max_num_stages=0, const unsigned int dom_eig_estimator_max_iters=0, const double dom_eig_estimator_rel_tol=0, const unsigned int dom_eig_estimator_num_warmups=numbers::invalid_unsigned_int) | |
| void | add_parameters (ParameterHandler &prm) |
Public Attributes | |
| std::string | method_name |
| unsigned int | dom_eig_frequency |
| unsigned int | max_num_stages |
| unsigned int | dom_eig_estimator_max_iters |
| double | dom_eig_estimator_rel_tol |
| unsigned int | dom_eig_estimator_num_warmups |
|
inline |
Constructor with a complete set of default values.
| method_name | Name of the STS method to use. If empty, SUNDIALS selects the default (RKC-2). Must be a name recognised by LSRKStepSetSTSMethodByName (e.g., "ARKODE_LSRK_RKC_2", "ARKODE_LSRK_RKL_2"). |
| dom_eig_frequency | Number of successful time steps after which the dominant eigenvalue estimate is recomputed. A value of 0 means the dominant eigenvalue will not change throughout the simulation. A negative value (the default, -1) leaves this option unset, so SUNDIALS uses its built-in default of 25. Forwarded to LSRKStepSetDomEigFrequency. |
| max_num_stages | Maximum number of stages allowed within a single time step. A value of 0 means no limit is imposed (SUNDIALS default of 200). Forwarded to LSRKStepSetMaxNumStages. |
| dom_eig_estimator_max_iters | Maximum number of power iterations performed by the built-in dominant-eigenvalue estimator. Only used when dominant_eigenvalue_function() is not provided (so that the default SUNDomEigEstimator is created). A zero value (the default) leaves this option unset, so SUNDIALS uses its built-in default. Forwarded to SUNDomEigEstimator_Power. |
| dom_eig_estimator_rel_tol | Relative convergence tolerance of the power iteration used by the built-in dominant-eigenvalue estimator. Only used when dominant_eigenvalue_function() is not provided. A negative value (the default, -1) leaves this option unset, so SUNDIALS uses its built-in default. Forwarded to SUNDomEigEstimator_Power. |
| dom_eig_estimator_num_warmups | Number of preprocessing warmup iterations performed once when the built-in dominant-eigenvalue estimator is first initialized. Only used when dominant_eigenvalue_function() is not provided. A negative value (the default, -1) leaves this option unset, so SUNDIALS uses its built-in default. Forwarded to LSRKStepSetNumDomEigEstInitPreprocessIters. |
Definition at line 1416 of file arkode_stepper.h.
| void SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::add_parameters | ( | ParameterHandler & | prm | ) |
Add all AdditionalData() parameters to the given ParameterHandler object. When the parameters are parsed from a file, the internal parameters are automatically updated.
Definition at line 1616 of file arkode_stepper.h.
| std::string SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::method_name |
Name of the STS method. If empty, SUNDIALS selects the default (Runge-Kutta-Chebyshev of order 2).
Definition at line 1444 of file arkode_stepper.h.
| unsigned int SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::dom_eig_frequency |
Number of successful time steps after which the dominant eigenvalue estimate is recomputed. A value of 0 means the dominant eigenvalue will not change throughout the simulation. The default value (numbers::invalid_unsigned_int) leaves this option unset so that SUNDIALS uses its built-in default of 25. Forwarded to LSRKStepSetDomEigFrequency.
Definition at line 1454 of file arkode_stepper.h.
| unsigned int SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::max_num_stages |
Maximum number of stages allowed per time step. 0 means no limit (SUNDIALS default of 200). Forwarded to LSRKStepSetMaxNumStages.
Definition at line 1460 of file arkode_stepper.h.
| unsigned int SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::dom_eig_estimator_max_iters |
Maximum number of power iterations performed by the built-in dominant-eigenvalue estimator. Only used when dominant_eigenvalue_function() is not provided, in which case a default SUNDomEigEstimator (power iteration) is created and attached. Forwarded to SUNDomEigEstimator_Power.
Definition at line 1469 of file arkode_stepper.h.
| double SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::dom_eig_estimator_rel_tol |
Relative convergence tolerance of the power iteration used by the built-in dominant-eigenvalue estimator. Only used when dominant_eigenvalue_function() is not provided. Any non-positive value (default 0) lets SUNDIALS to use its default tolerance (default 0.005). Forwarded to SUNDomEigEstimator_Power.
Definition at line 1478 of file arkode_stepper.h.
| unsigned int SUNDIALS::LSRKStepperSTS< VectorType >::AdditionalData::dom_eig_estimator_num_warmups |
Number of preprocessing warmup iterations performed once when the built-in dominant-eigenvalue estimator is first initialized. Only used when dominant_eigenvalue_function() is not provided. The default value (numbers::invalid_unsigned_int) leaves this option unset so that SUNDIALS uses its built-in default of 100. Forwarded to LSRKStepSetNumDomEigEstInitPreprocessIters.
Definition at line 1488 of file arkode_stepper.h.
1.9.8