Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
cls_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_cls_boundary_conditions_h
5#define lethe_cls_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 CLS. periodic_neighbor is not a user
22 /// choice: it is assigned to the boundary matching a periodic boundary.
30
31 /// Boundary condition types of the CLS which can be selected in the
32 /// parameter file
33 inline const std::vector<CLSBoundaryType> cls_boundary_types = {
37
38 /**
39 * @brief This class manages the boundary conditions for CLS solver
40 * It introduces the boundary functions and declares the boundary conditions
41 * coherently.
42 */
43 template <int dim>
44 class CLSBoundaryConditions : public BoundaryConditions<CLSBoundaryType>
45 {
46 public:
47 std::map<types::boundary_id,
48 std::shared_ptr<Functions::ParsedFunction<dim>>>
50
51 /**
52 * @brief Declare the default parameters for one CLS boundary condition.
53 *
54 * @param[in, out] prm The parameter handler object.
55 * @param[in] default_boundary_id The default mesh boundary id.
56 */
57 void
58 declare_default_entry(ParameterHandler &prm,
59 types::boundary_id default_boundary_id);
60
61 /**
62 * @brief Declare the CLS boundary condition parameters.
63 *
64 * @param[in, out] prm The parameter handler object.
65 * @param[in] number_of_boundary_conditions The number of boundary
66 * conditions to declare.
67 */
68 void
69 declare_parameters(ParameterHandler &prm,
71
72 /**
73 * @brief Parse the information for one CLS boundary condition.
74 *
75 * @param[in] prm The parameter handler object.
76 */
77 void
78 parse_boundary(ParameterHandler &prm);
79
80 /**
81 * @brief Parse the CLS boundary condition parameters.
82 *
83 * @param[in] prm The parameter handler object.
84 */
85 void
86 parse_parameters(ParameterHandler &prm);
87 };
88} // namespace BoundaryConditions
89
90#endif
This class manages the boundary conditions for CLS solver It introduces the boundary functions and de...
void declare_default_entry(ParameterHandler &prm, types::boundary_id default_boundary_id)
Declare the default parameters for one CLS boundary condition.
void parse_parameters(ParameterHandler &prm)
Parse the CLS boundary condition parameters.
void declare_parameters(ParameterHandler &prm, unsigned int number_of_boundary_conditions)
Declare the CLS boundary condition parameters.
std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > phase_indicator
void parse_boundary(ParameterHandler &prm)
Parse the information for one CLS boundary condition.
const std::vector< CLSBoundaryType > cls_boundary_types