Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::SimulationControl Struct Reference

#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)

Public Attributes

enum Parameters::SimulationControl::TimeSteppingMethod method = TimeSteppingMethod::steady
double dt = 1.
double time_end = 1.
unsigned int iteration_end = 10
bool time_step_independent_of_end_time = true
bool time_step_adaptation_required = false
bool adapt_with_cfl = false
double maxCFL = 1.
double max_dt = 1e6
bool adapt_with_capillary_time_step_ratio = false
double max_capillary_time_step_ratio = 1.0
double stop_tolerance = 1e-10
double adaptative_time_step_scaling = 1.1
double startup_timestep_scaling = 0.4
bool override_time_step_on_restart = false
unsigned int number_mesh_adaptation = 0
std::string output_folder = "./"
std::string output_name = "out"
enum Parameters::SimulationControl::EndControl end_control = EndControl::time
enum Parameters::SimulationControl::OutputControl output_control = OutputControl::iteration
enum Parameters::SimulationControl::BDFStartupMethods bdf_startup_method = BDFStartupMethods::multiple_step_bdf
unsigned int output_iteration_frequency = 1
double output_time_frequency = -1
std::vector< double > output_times_vector {-1.}
std::vector< double > output_time_interval
bool output_boundaries = false
unsigned int log_frequency = 1
unsigned int log_precision = 6
unsigned int subdivision = 1
unsigned int group_files = 1

Detailed Description

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.

Member Enumeration Documentation

◆ BDFStartupMethods

enum class Parameters::SimulationControl::BDFStartupMethods : std::uint8_t
strong
Enumerator
initial_solution 
multiple_step_bdf 

Definition at line 201 of file parameters.h.

◆ EndControl

enum class Parameters::SimulationControl::EndControl : std::uint8_t
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).

Remarks
By default, this is set to 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.

◆ OutputControl

enum class Parameters::SimulationControl::OutputControl : std::uint8_t
strong
Enumerator
iteration 
time 

Definition at line 195 of file parameters.h.

◆ TimeSteppingMethod

enum class Parameters::SimulationControl::TimeSteppingMethod : std::uint8_t
strong
Enumerator
steady 
steady_bdf 
bdf1 
bdf2 
bdf3 
sdirk22 
sdirk33 
sdirk45 

Definition at line 89 of file parameters.h.

Member Function Documentation

◆ declare_parameters()

◆ parse_parameters()

Member Data Documentation

◆ adapt_with_capillary_time_step_ratio

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

Remarks
By default, this is set to false.

Definition at line 146 of file parameters.h.

◆ adapt_with_cfl

bool Parameters::SimulationControl::adapt_with_cfl = false

Boolean indicating if the CFL condition should be controlling the simulation time step.

Remarks
By default, this is set to false.

Definition at line 132 of file parameters.h.

◆ adaptative_time_step_scaling

double Parameters::SimulationControl::adaptative_time_step_scaling = 1.1

Definition at line 163 of file parameters.h.

◆ bdf_startup_method

enum Parameters::SimulationControl::BDFStartupMethods Parameters::SimulationControl::bdf_startup_method = BDFStartupMethods::multiple_step_bdf

◆ dt

double Parameters::SimulationControl::dt = 1.

Definition at line 102 of file parameters.h.

◆ end_control

enum Parameters::SimulationControl::EndControl Parameters::SimulationControl::end_control = EndControl::time

◆ group_files

unsigned int Parameters::SimulationControl::group_files = 1

Number of vtu files written at an output step.

Definition at line 234 of file parameters.h.

◆ iteration_end

unsigned int Parameters::SimulationControl::iteration_end = 10

Definition at line 108 of file parameters.h.

◆ log_frequency

unsigned int Parameters::SimulationControl::log_frequency = 1

Frequency of the log output to the terminal.

Definition at line 225 of file parameters.h.

◆ log_precision

unsigned int Parameters::SimulationControl::log_precision = 6

Display precision of the log output to the terminal.

Definition at line 228 of file parameters.h.

◆ max_capillary_time_step_ratio

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.

Remarks
By default, this is set to 1.

Definition at line 157 of file parameters.h.

◆ max_dt

double Parameters::SimulationControl::max_dt = 1e6

Definition at line 138 of file parameters.h.

◆ maxCFL

double Parameters::SimulationControl::maxCFL = 1.

Definition at line 135 of file parameters.h.

◆ method

◆ number_mesh_adaptation

unsigned int Parameters::SimulationControl::number_mesh_adaptation = 0

Definition at line 172 of file parameters.h.

◆ output_boundaries

bool Parameters::SimulationControl::output_boundaries = false

Enable output of the boundaries in a separate VTU file.

Definition at line 222 of file parameters.h.

◆ output_control

enum Parameters::SimulationControl::OutputControl Parameters::SimulationControl::output_control = OutputControl::iteration

◆ output_folder

std::string Parameters::SimulationControl::output_folder = "./"

Definition at line 175 of file parameters.h.

◆ output_iteration_frequency

unsigned int Parameters::SimulationControl::output_iteration_frequency = 1

Frequency of the output (for iteration output control).

Definition at line 208 of file parameters.h.

◆ output_name

std::string Parameters::SimulationControl::output_name = "out"

Definition at line 178 of file parameters.h.

◆ output_time_frequency

double Parameters::SimulationControl::output_time_frequency = -1

Time frequency of the output (for time output control).

Definition at line 211 of file parameters.h.

◆ output_time_interval

std::vector<double> Parameters::SimulationControl::output_time_interval
Initial value:
{
0.,
std::numeric_limits<double>::max()}

Time window for file output (for both iteration and time output control).

Definition at line 217 of file parameters.h.

◆ output_times_vector

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.

◆ override_time_step_on_restart

bool Parameters::SimulationControl::override_time_step_on_restart = false

Definition at line 169 of file parameters.h.

◆ startup_timestep_scaling

double Parameters::SimulationControl::startup_timestep_scaling = 0.4

Definition at line 166 of file parameters.h.

◆ stop_tolerance

double Parameters::SimulationControl::stop_tolerance = 1e-10

Definition at line 160 of file parameters.h.

◆ subdivision

unsigned int Parameters::SimulationControl::subdivision = 1

Subdivisions of the results in the output.

Definition at line 231 of file parameters.h.

◆ time_end

double Parameters::SimulationControl::time_end = 1.

Definition at line 105 of file parameters.h.

◆ time_step_adaptation_required

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.

Remarks
By default, this is set to 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.

◆ time_step_independent_of_end_time

bool Parameters::SimulationControl::time_step_independent_of_end_time = true

Definition at line 112 of file parameters.h.


The documentation for this struct was generated from the following files: