Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
SimulationControlSteady Class Reference

#include <simulation_control.h>

Inheritance diagram for SimulationControlSteady:
[legend]

Public Member Functions

 SimulationControlSteady (const Parameters::SimulationControl &param)
virtual void print_progression (const ConditionalOStream &pcout) override
bool is_adaptive_time_stepping () const override
virtual bool integrate () override
virtual bool is_at_end () override
Public Member Functions inherited from SimulationControl
 SimulationControl (const Parameters::SimulationControl &param)
virtual ~SimulationControl ()=default
void add_time_step (double p_timestep)
bool is_at_start () const
bool is_steady () const
bool is_bdf () const
bool is_sdirk () const
virtual double calculate_time_step ()
bool is_refinement_step (const Parameters::MeshAdaptation &mesh_adaptation)
bool output_enabled () const
virtual bool is_output_iteration ()
bool get_output_boundaries () const
virtual bool is_verbose_iteration ()
virtual bool is_first_assembly ()
void update_assembly_method ()
void set_CFL (const double p_CFL)
void set_capillary_time_step_constraint (const double p_capillary_time_step_constraint)
void set_current_time_step (const double new_time_step)
void limit_initial_time_step_with_capillary_time_step_constraint ()
void set_current_capillary_time_step_ratio ()
void provide_residual (const double new_residual)
double get_time_step () const
unsigned int get_iteration_number () const
std::string get_output_name () const
std::string get_output_path () const
unsigned int get_group_files () const
unsigned int get_log_precision () const
double get_current_time () const
double get_previous_time () const
void set_stage_time (const double c_i)
void end_stages ()
std::vector< double > get_time_steps_vector () const
double get_CFL () const
double get_current_capillary_time_step_ratio () const
unsigned int get_number_subdivision () const
unsigned int get_log_frequency () const
Parameters::SimulationControl::TimeSteppingMethod get_assembly_method () const
void set_assembly_method (const Parameters::SimulationControl::TimeSteppingMethod a_method)
unsigned int get_number_of_previous_solution_in_assembly () const
std::vector< double > get_simulation_times () const
Vector< double > const & get_bdf_coefficients ()
virtual void save (const std::string &prefix)
virtual void read (const std::string &prefix)
std::vector< double > get_checkpointed_simulation_control_info (const std::string &prefix)

Additional Inherited Members

Static Public Member Functions inherited from SimulationControl
static unsigned int get_number_of_stages (const Parameters::SimulationControl::TimeSteppingMethod &method)
Protected Member Functions inherited from SimulationControl
void update_bdf_coefficients ()
Protected Attributes inherited from SimulationControl
Parameters::SimulationControl::TimeSteppingMethod method
Parameters::SimulationControl::TimeSteppingMethod assembly_method
double current_time
double previous_time
double time_step
double initial_time_step
double end_time
bool time_step_independent_of_end_time
std::vector< double > time_step_vector
unsigned int iteration_number
unsigned int end_iteration
unsigned int number_mesh_adapt
double CFL
double max_CFL
double capillary_time_step_constraint
double max_capillary_time_step_ratio
double current_capillary_time_step_ratio
bool adapt_with_capillary_time_step_ratio
double residual
double stop_tolerance
unsigned int output_iteration_frequency
unsigned int log_frequency
unsigned int log_precision
unsigned int subdivision
unsigned int group_files
std::string output_name
std::string output_path
bool output_boundaries
bool first_assembly
Parameters::SimulationControl::BDFStartupMethods bdf_start_method
double startup_timestep_scaling
Vector< double > bdf_coefs
Static Protected Attributes inherited from SimulationControl
static constexpr unsigned int n_previous_time_steps = 4

Detailed Description

Simulation control for steady-state simulations.

This class handles steady-state simulations where time integration is not required. The simulation progresses through iterations until the specified number of mesh adaptations is reached or the maximum number of iterations is completed.

Note
Steady-state simulations do not use adaptive time stepping.

Definition at line 1151 of file simulation_control.h.

Constructor & Destructor Documentation

◆ SimulationControlSteady()

SimulationControlSteady::SimulationControlSteady ( const Parameters::SimulationControl & param)

Construct a steady-state simulation control object.

Parameters
[in]paramStructure of the parameters for the simulation control

Definition at line 602 of file simulation_control.cc.

References SimulationControl::SimulationControl().

Member Function Documentation

◆ integrate()

bool SimulationControlSteady::integrate ( )
overridevirtual

Proceed with the simulation until the end condition is reached.

Advances the simulation by incrementing the iteration number.

Returns
true if the simulation should continue, false otherwise

Implements SimulationControl.

Definition at line 608 of file simulation_control.cc.

References SimulationControl::current_time, is_at_end(), SimulationControl::iteration_number, and SimulationControl::previous_time.

◆ is_adaptive_time_stepping()

bool SimulationControlSteady::is_adaptive_time_stepping ( ) const
inlineoverridevirtual

Indicate if the simulation uses adaptive time stepping.

Returns
false (steady-state simulations do not use adaptive time stepping)

Implements SimulationControl.

Definition at line 1176 of file simulation_control.h.

◆ is_at_end()

bool SimulationControlSteady::is_at_end ( )
overridevirtual

End the simulation when the number of mesh adaptations is reached.

Returns
true if the required number of mesh adaptations has been completed, false otherwise

Implements SimulationControl.

Definition at line 642 of file simulation_control.cc.

References SimulationControl::iteration_number, and SimulationControl::number_mesh_adapt.

◆ print_progression()

void SimulationControlSteady::print_progression ( const ConditionalOStream & pcout)
overridevirtual

Print the current progress status of the steady-state simulation.

Parameters
[in]pcoutParallel conditional output stream used to print the information

Implements SimulationControl.

Definition at line 625 of file simulation_control.cc.

References announce_string(), SimulationControl::is_verbose_iteration(), SimulationControl::iteration_number, and SimulationControl::number_mesh_adapt.


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