![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <simulation_control.h>
Public Member Functions | |
| SimulationControlRayTracing (const Parameters::SimulationControl ¶m, Particles::ParticleHandler< 3 > &input_photon_handler) | |
| virtual bool | integrate () override |
| bool | is_at_end () override |
| bool | is_adaptive_time_stepping () const override |
| void | print_progression (const ConditionalOStream &pcout) override |
| Public Member Functions inherited from SimulationControl | |
| SimulationControl (const Parameters::SimulationControl ¶m) | |
| 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) |
Public Attributes | |
| Particles::ParticleHandler< 3 > & | photon_handler |
Simulation control for ray tracing simulations.
This class manages ray tracing simulations where photons are traced through a computational domain. The simulation terminates when all photons have exited the triangulation or been absorbed.
Ray tracing simulations do not use time stepping in the traditional sense; instead, iterations represent photon propagation steps until all photons have completed their trajectories.
Definition at line 1251 of file simulation_control.h.
| SimulationControlRayTracing::SimulationControlRayTracing | ( | const Parameters::SimulationControl & | param, |
| Particles::ParticleHandler< 3 > & | input_photon_handler ) |
Construct a ray tracing simulation control object.
| [in] | param | Structure of the parameters for the simulation control |
| [in] | input_photon_handler | The particle handler containing the photons to be traced |
Definition at line 680 of file simulation_control.cc.
References photon_handler, and SimulationControl::SimulationControl().
|
overridevirtual |
Proceed with the simulation until the end condition is reached.
Advances the ray tracing simulation by incrementing the iteration number.
Implements SimulationControl.
Definition at line 688 of file simulation_control.cc.
References is_at_end(), and SimulationControl::iteration_number.
|
inlineoverridevirtual |
Indicate if the simulation uses adaptive time stepping.
Implements SimulationControl.
Definition at line 1289 of file simulation_control.h.
|
overridevirtual |
End the simulation when there are no longer any photons in the triangulation.
Implements SimulationControl.
Definition at line 700 of file simulation_control.cc.
References photon_handler.
|
overridevirtual |
Print the current progress status of the ray tracing simulation.
| [in] | pcout | Parallel conditional output stream used to print the information |
Implements SimulationControl.
Definition at line 706 of file simulation_control.cc.
References SimulationControl::iteration_number, and photon_handler.
| Particles::ParticleHandler<3>& SimulationControlRayTracing::photon_handler |
Reference to the photon handler used during the ray-tracing simulation.
This handler manages the photons being traced through the domain.
Definition at line 1308 of file simulation_control.h.