![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <parameters_lagrangian.h>
Public Types | |
| enum class | InsertionMethod { file , list , plane , volume , packed } |
Public Member Functions | |
| void | parse_parameters (ParameterHandler &prm) |
Static Public Member Functions | |
| static void | declare_parameters (ParameterHandler &prm) |
Public Attributes | |
| enum Parameters::Lagrangian::InsertionInfo::InsertionMethod | insertion_method = InsertionMethod::volume |
| unsigned int | inserted_this_step = 0 |
| int | insertion_frequency = 0 |
| bool | removing_particles_in_region = false |
| Point< 3 > | clear_box_point_1 |
| Point< 3 > | clear_box_point_2 {1., 1., 1.} |
| std::vector< std::string > | list_of_input_files {"particles.input"} |
| Tensor< 1, 3 > | insertion_plane_normal_vector {{1., 0., 0.}} |
| Point< 3 > | insertion_plane_point |
| std::vector< double > | list_x {0.} |
| std::vector< double > | list_y {0.} |
| std::vector< double > | list_z {0.} |
| std::vector< double > | list_vx {0.} |
| std::vector< double > | list_vy {0.} |
| std::vector< double > | list_vz {0.} |
| std::vector< double > | list_wx {0.} |
| std::vector< double > | list_wy {0.} |
| std::vector< double > | list_wz {0.} |
| std::vector< double > | list_d {-1.0} |
| std::vector< double > | list_T {0.} |
| std::vector< unsigned int > | direction_sequence |
| Point< 3 > | insertion_box_point_1 |
| Point< 3 > | insertion_box_point_2 {1., 1., 1.} |
| Tensor< 1, 3 > | initial_vel |
| Tensor< 1, 3 > | initial_omega |
| std::shared_ptr< Function< dim > > | initial_temperature_function |
| double | distance_threshold = 1. |
| double | insertion_maximum_offset = 1. |
| int | seed_for_insertion = 1 |
| std::shared_ptr< Function< dim > > | insertion_acceptance_fct |
Parameters controlling particle insertion in DEM simulations.
This class stores the insertion method, geometry, initial conditions, and scheduling parameters used to introduce particles into the domain. Four insertion methods are supported: file, list, plane, and volume.
| dim | Number of spatial dimensions. |
Definition at line 420 of file parameters_lagrangian.h.
|
strong |
Method used to insert particles.
| Enumerator | |
|---|---|
| file | Insertion from a file listing particles. |
| list | Insertion from a list in the prm file. |
| plane | Insertion from a plane defined by a point and a normal. |
| volume | Insertion within a volume defined by a box. |
| packed | Insertion using the packed method. |
Definition at line 426 of file parameters_lagrangian.h.
|
static |
Declare the parameters in the parameter handler.
| [in,out] | prm | The parameter handler object. |
Definition at line 589 of file parameters_lagrangian.cc.
References clear_box_point_1, clear_box_point_2, declare_enum_entry(), direction_sequence, distance_threshold, initial_omega, initial_vel, inserted_this_step, insertion_box_point_1, insertion_box_point_2, insertion_frequency, insertion_maximum_offset, insertion_method, insertion_plane_normal_vector, insertion_plane_point, list_d, list_of_input_files, list_T, list_vx, list_vy, list_vz, list_wx, list_wy, list_wz, list_x, list_y, list_z, removing_particles_in_region, and seed_for_insertion.
| void Parameters::Lagrangian::InsertionInfo< dim >::parse_parameters | ( | ParameterHandler & | prm | ) |
Parse the parameters from the parameter handler.
| [in] | prm | The parameter handler object. |
Definition at line 788 of file parameters_lagrangian.cc.
References clear_box_point_1, clear_box_point_2, convert_string_to_vector(), direction_sequence, distance_threshold, initial_omega, initial_temperature_function, initial_vel, inserted_this_step, insertion_acceptance_fct, insertion_box_point_1, insertion_box_point_2, insertion_frequency, insertion_maximum_offset, insertion_method, insertion_plane_normal_vector, insertion_plane_point, list_d, list_of_input_files, list_T, list_vx, list_vy, list_vz, list_wx, list_wy, list_wz, list_x, list_y, list_z, removing_particles_in_region, seed_for_insertion, string_to_enum(), and value_string_to_tensor().
| Point<3> Parameters::Lagrangian::InsertionInfo< dim >::clear_box_point_1 |
First corner of the particle removal box.
Definition at line 451 of file parameters_lagrangian.h.
| Point<3> Parameters::Lagrangian::InsertionInfo< dim >::clear_box_point_2 {1., 1., 1.} |
Second corner of the particle removal box.
Definition at line 454 of file parameters_lagrangian.h.
| std::vector<unsigned int> Parameters::Lagrangian::InsertionInfo< dim >::direction_sequence |
Direction sequence for particle insertion (1st, 2nd, 3rd).
Definition at line 479 of file parameters_lagrangian.h.
| double Parameters::Lagrangian::InsertionInfo< dim >::distance_threshold = 1. |
Minimum distance threshold between inserted particles.
Definition at line 500 of file parameters_lagrangian.h.
| Tensor<1, 3> Parameters::Lagrangian::InsertionInfo< dim >::initial_omega |
Initial angular velocity of inserted particles.
Definition at line 493 of file parameters_lagrangian.h.
| std::shared_ptr<Function<dim> > Parameters::Lagrangian::InsertionInfo< dim >::initial_temperature_function |
Function returning the initial temperature of a particle based on time or its position.
Definition at line 497 of file parameters_lagrangian.h.
| Tensor<1, 3> Parameters::Lagrangian::InsertionInfo< dim >::initial_vel |
Initial translational velocity of inserted particles.
Definition at line 490 of file parameters_lagrangian.h.
| unsigned int Parameters::Lagrangian::InsertionInfo< dim >::inserted_this_step = 0 |
Number of particles inserted at each insertion step.
Definition at line 442 of file parameters_lagrangian.h.
| std::shared_ptr<Function<dim> > Parameters::Lagrangian::InsertionInfo< dim >::insertion_acceptance_fct |
Function used to accept or reject point in the insertion box when using the volume insertion.
Definition at line 510 of file parameters_lagrangian.h.
| Point<3> Parameters::Lagrangian::InsertionInfo< dim >::insertion_box_point_1 |
First corner of the insertion box (volume method).
Definition at line 484 of file parameters_lagrangian.h.
| Point<3> Parameters::Lagrangian::InsertionInfo< dim >::insertion_box_point_2 {1., 1., 1.} |
Second corner of the insertion box (volume method).
Definition at line 487 of file parameters_lagrangian.h.
| int Parameters::Lagrangian::InsertionInfo< dim >::insertion_frequency = 0 |
Frequency of insertion (in time steps).
Definition at line 445 of file parameters_lagrangian.h.
| double Parameters::Lagrangian::InsertionInfo< dim >::insertion_maximum_offset = 1. |
Maximum random offset applied to insertion positions.
Definition at line 503 of file parameters_lagrangian.h.
| enum Parameters::Lagrangian::InsertionInfo::InsertionMethod Parameters::Lagrangian::InsertionInfo< dim >::insertion_method = InsertionMethod::volume |
Method used to insert particles
| Tensor<1, 3> Parameters::Lagrangian::InsertionInfo< dim >::insertion_plane_normal_vector {{1., 0., 0.}} |
Normal vector of the insertion plane (plane method).
Definition at line 460 of file parameters_lagrangian.h.
| Point<3> Parameters::Lagrangian::InsertionInfo< dim >::insertion_plane_point |
Point on the insertion plane (plane method).
Definition at line 463 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_d {-1.0} |
Diameter for list insertion.
Definition at line 475 of file parameters_lagrangian.h.
| std::vector<std::string> Parameters::Lagrangian::InsertionInfo< dim >::list_of_input_files {"particles.input"} |
List of input files for the file insertion method.
Definition at line 457 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_T {0.} |
Temperature for list insertion.
Definition at line 476 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vx {0.} |
x-velocity for list insertion.
Definition at line 469 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vy {0.} |
y-velocity for list insertion.
Definition at line 470 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vz {0.} |
z-velocity for list insertion.
Definition at line 471 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_wx {0.} |
x-angular velocity for list insertion.
Definition at line 472 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_wy {0.} |
y-angular velocity for list insertion.
Definition at line 473 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_wz {0.} |
z-angular velocity for list insertion.
Definition at line 474 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_x {0.} |
x-position for list insertion.
Definition at line 466 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_y {0.} |
y-position for list insertion.
Definition at line 467 of file parameters_lagrangian.h.
| std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_z {0.} |
z-position for list insertion.
Definition at line 468 of file parameters_lagrangian.h.
| bool Parameters::Lagrangian::InsertionInfo< dim >::removing_particles_in_region = false |
Enable removal of particles in a specified region.
Definition at line 448 of file parameters_lagrangian.h.
| int Parameters::Lagrangian::InsertionInfo< dim >::seed_for_insertion = 1 |
Random seed for particle insertion.
Definition at line 506 of file parameters_lagrangian.h.