![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters.h>
Public Types | |
| enum class | TimeSteppingMethod : std::uint8_t { steady , steady_bdf , bdf1 , bdf2 , bdf3 , sdirk22 , sdirk33 , sdirk45 } |
| enum class | EndControl : std::uint8_t { iteration , time } |
| enum class | OutputControl : std::uint8_t { iteration , time } |
| enum class | BDFStartupMethods : std::uint8_t { initial_solution , multiple_step_bdf } |
Public Member Functions | |
| void | parse_parameters (ParameterHandler &prm) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler &prm) |
SimulationControl - Defines the parameter that control the flow of the simulation as well as the frequency of the output of the solutions.
Definition at line 86 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| initial_solution | |
| multiple_step_bdf | |
Definition at line 201 of file parameters.h.
|
strong |
Criterion used to end a transient simulation: either a maximum time (SimulationControl::time_end) or a maximum number of transient iterations (SimulationControl::iteration_end).
EndControl::time. The default value matters since this structure is also filled programmatically (e.g. in unit tests) instead of being parsed from a parameter file. | Enumerator | |
|---|---|
| iteration | |
| time | |
Definition at line 189 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| iteration | |
| time | |
Definition at line 195 of file parameters.h.
|
strong |
| Enumerator | |
|---|---|
| steady | |
| steady_bdf | |
| bdf1 | |
| bdf2 | |
| bdf3 | |
| sdirk22 | |
| sdirk33 | |
| sdirk45 | |
Definition at line 89 of file parameters.h.
|
static |
Declare the simulation control parameters.
| [in,out] | prm | The parameter handler object. |
Definition at line 158 of file parameters.cc.
References adapt_with_capillary_time_step_ratio, adapt_with_cfl, adaptative_time_step_scaling, bdf_startup_method, declare_enum_entry(), dt, end_control, group_files, iteration_end, log_frequency, log_precision, max_capillary_time_step_ratio, max_dt, maxCFL, method, number_mesh_adaptation, output_boundaries, output_control, output_folder, output_iteration_frequency, output_name, output_time_frequency, output_time_interval, output_times_vector, override_time_step_on_restart, startup_timestep_scaling, stop_tolerance, subdivision, time_end, and time_step_independent_of_end_time.
| void SimulationControl::parse_parameters | ( | ParameterHandler & | prm | ) |
Parse the simulation control parameters.
| [in] | prm | The parameter handler object. |
Definition at line 342 of file parameters.cc.
References adapt_with_capillary_time_step_ratio, adapt_with_cfl, adaptative_time_step_scaling, bdf_startup_method, convert_string_to_vector(), dt, end_control, group_files, iteration_end, log_frequency, log_precision, max_capillary_time_step_ratio, max_dt, maxCFL, method, number_mesh_adaptation, output_boundaries, output_control, output_folder, output_iteration_frequency, output_name, output_time_frequency, output_time_interval, output_times_vector, override_time_step_on_restart, startup_timestep_scaling, stop_tolerance, string_to_enum(), subdivision, time_end, time_step_adaptation_required, and time_step_independent_of_end_time.
| bool Parameters::SimulationControl::adapt_with_capillary_time_step_ratio = false |
Boolean indicating if the capillary time-step ratio should be controlling the simulation time step
false. Definition at line 146 of file parameters.h.
| bool Parameters::SimulationControl::adapt_with_cfl = false |
Boolean indicating if the CFL condition should be controlling the simulation time step.
false. Definition at line 132 of file parameters.h.
| double Parameters::SimulationControl::adaptative_time_step_scaling = 1.1 |
Definition at line 163 of file parameters.h.
| enum Parameters::SimulationControl::BDFStartupMethods Parameters::SimulationControl::bdf_startup_method = BDFStartupMethods::multiple_step_bdf |
| double Parameters::SimulationControl::dt = 1. |
Definition at line 102 of file parameters.h.
| enum Parameters::SimulationControl::EndControl Parameters::SimulationControl::end_control = EndControl::time |
| unsigned int Parameters::SimulationControl::group_files = 1 |
Number of vtu files written at an output step.
Definition at line 234 of file parameters.h.
| unsigned int Parameters::SimulationControl::iteration_end = 10 |
Definition at line 108 of file parameters.h.
| unsigned int Parameters::SimulationControl::log_frequency = 1 |
Frequency of the log output to the terminal.
Definition at line 225 of file parameters.h.
| unsigned int Parameters::SimulationControl::log_precision = 6 |
Display precision of the log output to the terminal.
Definition at line 228 of file parameters.h.
| double Parameters::SimulationControl::max_capillary_time_step_ratio = 1.0 |
The capillary time-step ratio (CTR) corresponds to the imposed value for the ratio between the current time step and the capillary time-step constraint (Δt/Δt_σ) to be maximally respected when SimulationControl::adapt_with_capillary_time_step_ratio is set to true.
Definition at line 157 of file parameters.h.
| double Parameters::SimulationControl::max_dt = 1e6 |
Definition at line 138 of file parameters.h.
| double Parameters::SimulationControl::maxCFL = 1. |
Definition at line 135 of file parameters.h.
| enum Parameters::SimulationControl::TimeSteppingMethod Parameters::SimulationControl::method = TimeSteppingMethod::steady |
| unsigned int Parameters::SimulationControl::number_mesh_adaptation = 0 |
Definition at line 172 of file parameters.h.
| bool Parameters::SimulationControl::output_boundaries = false |
Enable output of the boundaries in a separate VTU file.
Definition at line 222 of file parameters.h.
| enum Parameters::SimulationControl::OutputControl Parameters::SimulationControl::output_control = OutputControl::iteration |
| std::string Parameters::SimulationControl::output_folder = "./" |
Definition at line 175 of file parameters.h.
| unsigned int Parameters::SimulationControl::output_iteration_frequency = 1 |
Frequency of the output (for iteration output control).
Definition at line 208 of file parameters.h.
| std::string Parameters::SimulationControl::output_name = "out" |
Definition at line 178 of file parameters.h.
| double Parameters::SimulationControl::output_time_frequency = -1 |
Time frequency of the output (for time output control).
Definition at line 211 of file parameters.h.
| std::vector<double> Parameters::SimulationControl::output_time_interval |
Time window for file output (for both iteration and time output control).
Definition at line 217 of file parameters.h.
| std::vector<double> Parameters::SimulationControl::output_times_vector {-1.} |
Output at specific times (for time output control).
Definition at line 214 of file parameters.h.
| bool Parameters::SimulationControl::override_time_step_on_restart = false |
Definition at line 169 of file parameters.h.
| double Parameters::SimulationControl::startup_timestep_scaling = 0.4 |
Definition at line 166 of file parameters.h.
| double Parameters::SimulationControl::stop_tolerance = 1e-10 |
Definition at line 160 of file parameters.h.
| unsigned int Parameters::SimulationControl::subdivision = 1 |
Subdivisions of the results in the output.
Definition at line 231 of file parameters.h.
| double Parameters::SimulationControl::time_end = 1. |
Definition at line 105 of file parameters.h.
| bool Parameters::SimulationControl::time_step_adaptation_required = false |
Boolean indicating if adaptive time-stepping is enabled. To enable it, enable either SimulationControl::adapt_with_cfl or SimulationControl::adapt_with_capillary_time_step_ratio.
false since both SimulationControl::adapt_with_cfl and SimulationControl::adapt_with_capillary_time_step_ratio are set to false by default. Definition at line 124 of file parameters.h.
| bool Parameters::SimulationControl::time_step_independent_of_end_time = true |
Definition at line 112 of file parameters.h.