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

#include <simulation_control.h>

Inheritance diagram for SimulationControlAdjointSteady:
[legend]

Public Member Functions

 SimulationControlAdjointSteady (const Parameters::SimulationControl &param)
virtual void print_progression (const ConditionalOStream &pcout) override
virtual bool is_at_end () override
Public Member Functions inherited from SimulationControlTransient
 SimulationControlTransient (const Parameters::SimulationControl &param)
bool is_adaptive_time_stepping () const override
virtual bool integrate () override
virtual bool is_output_iteration () override
void read (const std::string &prefix) 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
bool is_refinement_step (const Parameters::MeshAdaptation &mesh_adaptation)
bool output_enabled () const
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)
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 SimulationControlTransient
virtual double calculate_time_step () override
Protected Member Functions inherited from SimulationControl
void update_bdf_coefficients ()
Protected Attributes inherited from SimulationControlTransient
bool time_step_adaptation_required
bool adapt_with_cfl
double adaptative_time_step_scaling
double max_dt
double output_time_frequency
std::vector< double > output_times_vector
bool override_time_step_on_restart
std::vector< double > output_time_interval
Parameters::SimulationControl::EndControl end_control
Parameters::SimulationControl::OutputControl output_control
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 SimulationControlTransient
static constexpr double output_time_tolerance = 1e-6
Static Protected Attributes inherited from SimulationControl
static constexpr unsigned int n_previous_time_steps = 4

Detailed Description

Simulation control for adjoint steady-state simulations.

This class manages adjoint simulations that use a pseudo-transient approach to converge to a steady state. The simulation terminates when the residual reaches a specified tolerance (stop_tolerance).

The class inherits from SimulationControlTransient to leverage time-stepping mechanisms, but applies them in the context of an adjoint problem where time is a pseudo-parameter for convergence.

Definition at line 1211 of file simulation_control.h.

Constructor & Destructor Documentation

◆ SimulationControlAdjointSteady()

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

Construct an adjoint steady-state simulation control object.

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

Definition at line 647 of file simulation_control.cc.

References SimulationControlTransient::SimulationControlTransient().

Member Function Documentation

◆ is_at_end()

bool SimulationControlAdjointSteady::is_at_end ( )
overridevirtual

End the simulation when the desired residual tolerance is reached.

Returns
true if the residual has reached the stop_tolerance, false otherwise

Reimplemented from SimulationControlTransient.

Definition at line 675 of file simulation_control.cc.

References SimulationControl::residual, and SimulationControl::stop_tolerance.

◆ print_progression()

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

Print the current progress status of the adjoint simulation.

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

Reimplemented from SimulationControlTransient.

Definition at line 653 of file simulation_control.cc.

References announce_string(), SimulationControl::current_time, SimulationControl::get_CFL(), SimulationControl::is_verbose_iteration(), SimulationControl::iteration_number, SimulationControl::log_precision, and SimulationControl::time_step.


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