Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
periodic_boundary.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_periodic_boundary_h
5#define lethe_periodic_boundary_h
6
7#include <deal.II/base/types.h>
8
9#include <map>
10
11namespace Parameters
12{
13 /**
14 * @brief A periodic boundary pair, keyed elsewhere by its principal boundary id.
15 */
17 {
18 /// Neighbor periodic boundary id of the pair.
19 dealii::types::boundary_id neighbor_id;
20
21 /// Direction of periodicity (0, 1 or 2) of the pair.
22 unsigned int direction;
23 };
24
25 /**
26 * @brief The periodic boundary pairs of a simulation, keyed by the principal
27 * (first) boundary id of each pair.
28 *
29 * CFD and DEM simulations declare their boundary conditions through different
30 * parameter classes (BoundaryConditions::BoundaryConditions<BoundaryType> and
31 * Parameters::Lagrangian::BCDEM respectively), but both describe periodicity
32 * with this container, so that a single routine,
33 * setup_periodic_boundary_conditions(), sets up the periodicity of the
34 * triangulation for either solver.
35 */
37 std::map<dealii::types::boundary_id, PeriodicBoundary>;
38} // namespace Parameters
39
40#endif
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.
A periodic boundary pair, keyed elsewhere by its principal boundary id.
unsigned int direction
Direction of periodicity (0, 1 or 2) of the pair.
dealii::types::boundary_id neighbor_id
Neighbor periodic boundary id of the pair.