Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Parameters::Lagrangian::InsertionInfo< dim > Class Template Reference

#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

Detailed Description

template<int dim>
class Parameters::Lagrangian::InsertionInfo< dim >

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.

Template Parameters
dimNumber of spatial dimensions.

Definition at line 420 of file parameters_lagrangian.h.

Member Enumeration Documentation

◆ InsertionMethod

template<int dim>
enum class Parameters::Lagrangian::InsertionInfo::InsertionMethod
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.

Member Function Documentation

◆ declare_parameters()

◆ parse_parameters()

Member Data Documentation

◆ clear_box_point_1

template<int dim>
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.

◆ clear_box_point_2

template<int dim>
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.

◆ direction_sequence

template<int dim>
std::vector<unsigned int> Parameters::Lagrangian::InsertionInfo< dim >::direction_sequence
Initial value:
=
(dim == 2) ? std::vector<unsigned int>{0, 1} :
std::vector<unsigned int>{0, 1, 2}

Direction sequence for particle insertion (1st, 2nd, 3rd).

Definition at line 479 of file parameters_lagrangian.h.

◆ distance_threshold

template<int dim>
double Parameters::Lagrangian::InsertionInfo< dim >::distance_threshold = 1.

Minimum distance threshold between inserted particles.

Definition at line 500 of file parameters_lagrangian.h.

◆ initial_omega

template<int dim>
Tensor<1, 3> Parameters::Lagrangian::InsertionInfo< dim >::initial_omega

Initial angular velocity of inserted particles.

Definition at line 493 of file parameters_lagrangian.h.

◆ initial_temperature_function

template<int dim>
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.

◆ initial_vel

template<int dim>
Tensor<1, 3> Parameters::Lagrangian::InsertionInfo< dim >::initial_vel

Initial translational velocity of inserted particles.

Definition at line 490 of file parameters_lagrangian.h.

◆ inserted_this_step

template<int dim>
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.

◆ insertion_acceptance_fct

template<int dim>
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.

◆ insertion_box_point_1

template<int dim>
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.

◆ insertion_box_point_2

template<int dim>
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.

◆ insertion_frequency

template<int dim>
int Parameters::Lagrangian::InsertionInfo< dim >::insertion_frequency = 0

Frequency of insertion (in time steps).

Definition at line 445 of file parameters_lagrangian.h.

◆ insertion_maximum_offset

template<int dim>
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.

◆ insertion_method

Method used to insert particles

◆ insertion_plane_normal_vector

template<int dim>
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.

◆ insertion_plane_point

template<int dim>
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.

◆ list_d

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_d {-1.0}

Diameter for list insertion.

Definition at line 475 of file parameters_lagrangian.h.

◆ list_of_input_files

template<int dim>
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.

◆ list_T

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_T {0.}

Temperature for list insertion.

Definition at line 476 of file parameters_lagrangian.h.

◆ list_vx

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vx {0.}

x-velocity for list insertion.

Definition at line 469 of file parameters_lagrangian.h.

◆ list_vy

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vy {0.}

y-velocity for list insertion.

Definition at line 470 of file parameters_lagrangian.h.

◆ list_vz

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_vz {0.}

z-velocity for list insertion.

Definition at line 471 of file parameters_lagrangian.h.

◆ list_wx

template<int dim>
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.

◆ list_wy

template<int dim>
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.

◆ list_wz

template<int dim>
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.

◆ list_x

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_x {0.}

x-position for list insertion.

Definition at line 466 of file parameters_lagrangian.h.

◆ list_y

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_y {0.}

y-position for list insertion.

Definition at line 467 of file parameters_lagrangian.h.

◆ list_z

template<int dim>
std::vector<double> Parameters::Lagrangian::InsertionInfo< dim >::list_z {0.}

z-position for list insertion.

Definition at line 468 of file parameters_lagrangian.h.

◆ removing_particles_in_region

template<int dim>
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.

◆ seed_for_insertion

template<int dim>
int Parameters::Lagrangian::InsertionInfo< dim >::seed_for_insertion = 1

Random seed for particle insertion.

Definition at line 506 of file parameters_lagrangian.h.


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