![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters_lagrangian.h>
Public Member Functions | |
| void | parse_parameters (ParameterHandler &prm) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler &prm) |
Public Attributes | |
| Point< 3 > | starting_point |
| std::vector< Tensor< 1, 3 > > | insertion_directions_units_vector |
| std::vector< unsigned int > | n_photons_each_directions {1, 1, 1} |
| std::vector< double > | step_between_photons_each_directions {1., 1., 1.} |
| Tensor< 1, 3 > | ref_displacement_tensor_unit {{0., 0., 1.}} |
| double | max_insertion_offset = 0. |
| unsigned int | prn_seed_photon_insertion = 0 |
| double | max_angular_offset = 0. |
| unsigned int | prn_seed_photon_displacement = 1 |
Defines parameters used to construct particle ray tracing class.
Definition at line 1046 of file parameters_lagrangian.h.
|
static |
Declare the parameters in the parameter handler.
| [in,out] | prm | The parameter handler object. |
Definition at line 1921 of file parameters_lagrangian.cc.
References insertion_directions_units_vector, max_angular_offset, max_insertion_offset, n_photons_each_directions, prn_seed_photon_displacement, prn_seed_photon_insertion, ref_displacement_tensor_unit, starting_point, and step_between_photons_each_directions.
| void Parameters::Lagrangian::ParticleRayTracing< dim >::parse_parameters | ( | ParameterHandler & | prm | ) |
Parse the parameters from the parameter handler.
| [in] | prm | The parameter handler object. |
Definition at line 2022 of file parameters_lagrangian.cc.
References insertion_directions_units_vector, max_angular_offset, max_insertion_offset, n_photons_each_directions, point_nd_to_3d(), prn_seed_photon_displacement, prn_seed_photon_insertion, ref_displacement_tensor_unit, starting_point, step_between_photons_each_directions, tensor_nd_to_3d(), and value_string_to_tensor().
| std::vector<Tensor<1, 3> > Parameters::Lagrangian::ParticleRayTracing< dim >::insertion_directions_units_vector |
Unit direction vectors along which photons are inserted relative to the starting point.
Definition at line 1053 of file parameters_lagrangian.h.
| double Parameters::Lagrangian::ParticleRayTracing< dim >::max_angular_offset = 0. |
Maximum angular offset applied to the photon displacement direction.
Definition at line 1075 of file parameters_lagrangian.h.
| double Parameters::Lagrangian::ParticleRayTracing< dim >::max_insertion_offset = 0. |
Maximum random offset applied to the photon insertion position.
Definition at line 1069 of file parameters_lagrangian.h.
| std::vector<unsigned int> Parameters::Lagrangian::ParticleRayTracing< dim >::n_photons_each_directions {1, 1, 1} |
Number of photons to insert along each direction.
Definition at line 1059 of file parameters_lagrangian.h.
| unsigned int Parameters::Lagrangian::ParticleRayTracing< dim >::prn_seed_photon_displacement = 1 |
Random seed for photon displacement angular offset.
Definition at line 1078 of file parameters_lagrangian.h.
| unsigned int Parameters::Lagrangian::ParticleRayTracing< dim >::prn_seed_photon_insertion = 0 |
Random seed for photon insertion position offset.
Definition at line 1072 of file parameters_lagrangian.h.
| Tensor<1, 3> Parameters::Lagrangian::ParticleRayTracing< dim >::ref_displacement_tensor_unit {{0., 0., 1.}} |
Reference unit tensor defining the photon displacement direction.
Definition at line 1066 of file parameters_lagrangian.h.
| Point<3> Parameters::Lagrangian::ParticleRayTracing< dim >::starting_point |
Location of the first photon to be inserted.
Definition at line 1049 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::ParticleRayTracing< dim >::step_between_photons_each_directions {1., 1., 1.} |
Spacing between consecutive photons along each direction (at zero offset).
Definition at line 1063 of file parameters_lagrangian.h.