Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
ray_tracing_solver_parameters.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2020-2026 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_ray_tracing_solver_parameters_h
5#define lethe_ray_tracing_solver_parameters_h
6
7#include <core/manifolds.h>
8#include <core/parameters.h>
11
12/**
13 * @brief Handles all the parameters declared in the parameter handler file.
14 */
15template <int dim>
17{
18public:
27
28 /**
29 * @brief Declare all the parameters of a ray tracing simulation.
30 *
31 * @param[in,out] prm The parameter handler object.
32 * @param[in] size_of_subsections The maximum size of the variable-size
33 * subsections of the parameter file, as returned by
34 * Parameters::get_size_of_subsections.
35 */
36 void
37 declare(ParameterHandler &prm,
38 const Parameters::SizeOfSubsections size_of_subsections)
39 {
40 prm.declare_entry("dimension",
41 "0",
42 Patterns::Integer(),
43 "Dimension of the problem");
44
45 prm.declare_entry("print parameters",
46 "none",
47 Patterns::Selection("none|only changed|all"),
48 "Print all the parameters, or only"
49 "the changed parameters or none");
50
51 prm.declare_entry(
52 "comment message",
53 "",
54 Patterns::Anything(),
55 "Print a comment at the beginning of the console output.");
56
58 manifolds_parameters.declare_parameters(prm, size_of_subsections.manifolds);
65 }
66
67 /**
68 * @brief Handles the parsing of all the parameters in the parameter handler file.
69 *
70 * @param[in] prm The parameter handler object.
71 */
72 void
73 parse(ParameterHandler &prm)
74 {
75 mesh.parse_parameters(prm);
76 manifolds_parameters.parse_parameters(prm);
77 test.parse_parameters(prm);
78 timer.parse_parameters(prm);
79 simulation_control.parse_parameters(prm);
80 particle_insertion_info.parse_parameters(prm);
81 ray_tracing_info.parse_parameters(prm);
82 model_parameters.parse_parameters(prm);
83 }
84};
85
86#endif
Parameters controlling particle insertion in DEM simulations.
static void declare_parameters(ParameterHandler &prm)
Declare the parameters in the parameter handler.
Numerical model parameters for DEM simulations.
static void declare_parameters(ParameterHandler &prm)
Declare the parameters in the parameter handler.
Manifolds - This class manages attaching manifolds to faces when a manual attachment is required (for...
Definition manifolds.h:25
Mesh - Parameters that control mesh reading and mesh generation.
static void declare_parameters(ParameterHandler &prm)
Declare the parameters.
Handles all the parameters declared in the parameter handler file.
void declare(ParameterHandler &prm, const Parameters::SizeOfSubsections size_of_subsections)
Declare all the parameters of a ray tracing simulation.
void parse(ParameterHandler &prm)
Handles the parsing of all the parameters in the parameter handler file.
Parameters::SimulationControl simulation_control
Parameters::Lagrangian::ParticleRayTracing< dim > ray_tracing_info
Parameters::Lagrangian::InsertionInfo< dim > particle_insertion_info
Parameters::Lagrangian::ModelParameters< dim > model_parameters
Parameter structures for Lagrangian (DEM) particle simulations.
Simulation control classes for managing time-stepping and iteration control in Lethe.
Defines parameters used to construct particle ray tracing class.
static void declare_parameters(ParameterHandler &prm)
Declare the parameters in the parameter handler.
SimulationControl - Defines the parameter that control the flow of the simulation as well as the freq...
Definition parameters.h:87
static void declare_parameters(ParameterHandler &prm)
Declare the simulation control parameters.
Testing - Some solvers have a specific testing mode that can be enabled to output more variables to t...
static void declare_parameters(ParameterHandler &prm)
Declare the parameters.
Timer - Defines the parameters that control the timing of the simulation. Lethe supports advanced tim...
static void declare_parameters(ParameterHandler &prm)
Declare the parameters.