Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
tracer_boundary_conditions.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_tracer_boundary_conditions_h
5#define lethe_tracer_boundary_conditions_h
6
8#include <core/utilities.h>
9
10#include <deal.II/base/parameter_handler.h>
11#include <deal.II/base/parsed_function.h>
12
13#include <map>
14#include <memory>
15#include <vector>
16
17using namespace dealii;
18
19namespace BoundaryConditions
20{
21 /// Boundary condition types of the tracer. periodic_neighbor is not a user
22 /// choice: it is assigned to the boundary matching a periodic boundary.
31
32 /// Boundary condition types of the tracer which can be selected in the
33 /// parameter file
39
40 /**
41 * @brief This class manages the boundary conditions for Tracer solver
42 * It introduces the boundary functions and declares the boundary conditions
43 * coherently.
44 */
45 template <int dim>
46 class TracerBoundaryConditions : public BoundaryConditions<TracerBoundaryType>
47 {
48 public:
49 std::map<types::boundary_id,
50 std::shared_ptr<Functions::ParsedFunction<dim>>>
52
53 /**
54 * @brief Declare the default parameters for one tracer boundary condition.
55 *
56 * @param[in, out] prm The parameter handler object.
57 * @param[in] default_boundary_id The default mesh boundary id.
58 */
59 void
60 declare_default_entry(ParameterHandler &prm,
61 types::boundary_id default_boundary_id);
62
63 /**
64 * @brief Declare the tracer boundary condition parameters.
65 *
66 * @param[in, out] prm The parameter handler object.
67 * @param[in] number_of_boundary_conditions The number of boundary
68 * conditions to declare.
69 */
70 void
71 declare_parameters(ParameterHandler &prm,
73
74 /**
75 * @brief Parse the information for one tracer boundary condition.
76 *
77 * @param[in] prm The parameter handler object.
78 */
79 void
80 parse_boundary(ParameterHandler &prm);
81
82 /**
83 * @brief Parse the tracer boundary condition parameters.
84 *
85 * @param[in] prm The parameter handler object.
86 */
87 void
88 parse_parameters(ParameterHandler &prm);
89 };
90} // namespace BoundaryConditions
91
92#endif
This class manages the boundary conditions for Tracer solver It introduces the boundary functions and...
void declare_parameters(ParameterHandler &prm, unsigned int number_of_boundary_conditions)
Declare the tracer boundary condition parameters.
void parse_parameters(ParameterHandler &prm)
Parse the tracer boundary condition parameters.
void declare_default_entry(ParameterHandler &prm, types::boundary_id default_boundary_id)
Declare the default parameters for one tracer boundary condition.
void parse_boundary(ParameterHandler &prm)
Parse the information for one tracer boundary condition.
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > tracer
const std::vector< TracerBoundaryType > tracer_boundary_types