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

#include <simulation_control.h>

Inheritance diagram for SimulationControlRayTracing:
[legend]

Public Member Functions

 SimulationControlRayTracing (const Parameters::SimulationControl &param, 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 &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)

Public Attributes

Particles::ParticleHandler< 3 > & photon_handler

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 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.

Constructor & Destructor Documentation

◆ SimulationControlRayTracing()

SimulationControlRayTracing::SimulationControlRayTracing ( const Parameters::SimulationControl & param,
Particles::ParticleHandler< 3 > & input_photon_handler )

Construct a ray tracing simulation control object.

Parameters
[in]paramStructure of the parameters for the simulation control
[in]input_photon_handlerThe particle handler containing the photons to be traced

Definition at line 680 of file simulation_control.cc.

References photon_handler, and SimulationControl::SimulationControl().

Member Function Documentation

◆ integrate()

bool SimulationControlRayTracing::integrate ( )
overridevirtual

Proceed with the simulation until the end condition is reached.

Advances the ray tracing simulation by incrementing the iteration number.

Returns
true if the simulation should continue, false otherwise

Implements SimulationControl.

Definition at line 688 of file simulation_control.cc.

References is_at_end(), and SimulationControl::iteration_number.

◆ is_adaptive_time_stepping()

bool SimulationControlRayTracing::is_adaptive_time_stepping ( ) const
inlineoverridevirtual

Indicate if the simulation uses adaptive time stepping.

Returns
false (ray tracing simulations do not use adaptive time stepping)

Implements SimulationControl.

Definition at line 1289 of file simulation_control.h.

◆ is_at_end()

bool SimulationControlRayTracing::is_at_end ( )
overridevirtual

End the simulation when there are no longer any photons in the triangulation.

Returns
true if all photons have exited or been absorbed, false otherwise

Implements SimulationControl.

Definition at line 700 of file simulation_control.cc.

References photon_handler.

◆ print_progression()

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

Print the current progress status of the ray tracing simulation.

Parameters
[in]pcoutParallel 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.

Member Data Documentation

◆ 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.


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