Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
boundary_conditions.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2019-2026 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_boundary_conditions_h
5#define lethe_boundary_conditions_h
6
8
9#include <deal.II/base/types.h>
10
11#include <map>
12#include <type_traits>
13
14using namespace dealii;
15
17{
18 /**
19 * @brief This class is the base class for all boundary conditions. It stores
20 * the general information that all boundary condition share.
21 * In Lethe, boundary conditions are identified with an id, a type and, in the
22 * special case of periodic boundary condition, a periodic matching id
23 * (periodic_id) and a periodic direction (0, 1 or 2).
24 *
25 * @tparam BoundaryType Enumeration of the boundary condition types of the
26 * physics (e.g. FluidDynamicsBoundaryType).
27 */
28 template <typename BoundaryType>
29 requires std::is_enum_v<BoundaryType>
31 {
32 public:
33 /// Map containing the boundary id and the boundary type
34 std::map<types::boundary_id, BoundaryType> type;
35
36 /// Number of boundary conditions
38
39 /// indicator for transient BCs
41
42 /// Periodic boundary pairs, keyed by the principal periodic boundary id
44 };
45
46} // namespace BoundaryConditions
47
48#endif
Parameters::PeriodicBoundaries periodic_boundaries
Periodic boundary pairs, keyed by the principal periodic boundary id.
std::map< types::boundary_id, BoundaryType > type
Map containing the boundary id and the boundary type.
unsigned int number_of_boundary_conditions
Number of boundary conditions.
bool time_dependent
indicator for transient BCs
std::map< dealii::types::boundary_id, PeriodicBoundary > PeriodicBoundaries
The periodic boundary pairs of a simulation, keyed by the principal (first) boundary id of each pair.