Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
set_insertion_method.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2026 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_set_insertion_method_h
5#define lethe_set_insertion_method_h
6
8
10#include <dem/insertion_list.h>
12#include <dem/insertion_plane.h>
14
15/**
16 * @brief Set up the particle insertion method for the simulation.
17 * Creates and configures the appropriate insertion object based on the
18 * simulation parameters (e.g., volume insertion, plane insertion, etc.).
19 *
20 * @param size_distribution_object_container Contains all distribution for each
21 * particle type.
22 * @param triangulation Triangulation to access the cells in which the
23 * particles will be inserted.
24 * @param dem_parameters DEM parameters declared in the .prm file.
25 * @param maximum_particle_diameter Maximum particle diameter based on values
26 * defined in the parameter handler.
27 *
28 * @return Shared pointer to the configured insertion object
29 */
30template <int dim, typename PropertiesIndex>
31std::shared_ptr<Insertion<dim, PropertiesIndex>>
32set_insertion_type(std::vector<std::shared_ptr<Distribution>>
33 &size_distribution_object_container,
34 parallel::distributed::Triangulation<dim> &triangulation,
35 DEMSolverParameters<dim> &dem_parameters,
36 const double &maximum_particle_diameter)
37{
38 using namespace Parameters::Lagrangian;
39 typename InsertionInfo<dim>::InsertionMethod insertion_method =
40 dem_parameters.insertion_info.insertion_method;
41
42 switch (insertion_method)
43 {
45 return std::make_shared<InsertionFile<dim, PropertiesIndex>>(
46 size_distribution_object_container, triangulation, dem_parameters);
48 return std::make_shared<InsertionList<dim, PropertiesIndex>>(
49 size_distribution_object_container, triangulation, dem_parameters);
51 return std::make_shared<InsertionPlane<dim, PropertiesIndex>>(
52 size_distribution_object_container, triangulation, dem_parameters);
54 return std::make_shared<InsertionVolume<dim, PropertiesIndex>>(
55 size_distribution_object_container,
56 triangulation,
57 dem_parameters,
58 maximum_particle_diameter);
60 {
61 if constexpr (std::is_same_v<PropertiesIndex,
63 {
64 return std::make_shared<InsertionPacked<dim, PropertiesIndex>>(
65 size_distribution_object_container,
66 triangulation,
67 dem_parameters);
68 }
69 else
70 {
71 AssertThrow(false,
72 ExcMessage("InsertionPacked is not valid for "
73 "the current solver type. It only works "
74 "for the standard DEM solver."));
75 }
76 }
77 default:
78 AssertThrow(false, ExcMessage("Invalid insertion method."));
79 }
80}
81#endif
Handles all the parameters declared in the parameter handler file.
Parameters::Lagrangian::InsertionInfo< dim > insertion_info
Parameters controlling particle insertion in DEM simulations.
InsertionMethod
Method used to insert particles.
PropertiesIndex
Particle property indices for pure DEM simulations.
Parameter structures for Lagrangian (DEM) particle simulations.
std::shared_ptr< Insertion< dim, PropertiesIndex > > set_insertion_type(std::vector< std::shared_ptr< Distribution > > &size_distribution_object_container, parallel::distributed::Triangulation< dim > &triangulation, DEMSolverParameters< dim > &dem_parameters, const double &maximum_particle_diameter)
Set up the particle insertion method for the simulation. Creates and configures the appropriate inser...