Debian Codegraph @

include/deal.II/grid/cell_status.h

raw
1 // ------------------------------------------------------------------------
2 //
3 // SPDX-License-Identifier: LGPL-2.1-or-later
4 // Copyright (C) 2023 - 2024 by the deal.II authors
5 //
6 // This file is part of the deal.II library.
7 //
8 // Part of the source code is dual licensed under Apache-2.0 WITH
9 // LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10 // governing the source code and code contributions can be found in
11 // LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12 //
13 // ------------------------------------------------------------------------
14
15 #ifndef dealii_cell_status_h
16 #define dealii_cell_status_h
17
18 #include <deal.II/base/config.h>
19
20 DEAL_II_NAMESPACE_OPEN
21
22 /**
23 * The elements of this `enum` are used to inform functions how a specific cell
24 * is going to change. This is used in the course of transferring data from one
25 * mesh to a refined or coarsened version of the mesh, for example. Note that
26 * this may me different than the refine_flag() and coarsen_flag() set on a
27 * cell, for example in parallel calculations, because of refinement constraints
28 * that an individual machine does not see.
29 */
30 enum class CellStatus : unsigned int
31 {
32 /**
33 * The cell will not be refined or coarsened and might or might not move
34 * to a different processor.
35 */
36 cell_will_persist,
37 /**
38 * The cell will be or was refined.
39 */
40 cell_will_be_refined,
41 /**
42 * The children of this cell will be or were coarsened into this cell.
43 */
44 children_will_be_coarsened,
45 /**
46 * Invalid status. Will not occur for the user.
47 */
48 cell_invalid,
49
50 /**
51 * @deprecated Use CellStatus::cell_will_persist instead
52 */
53 CELL_PERSIST DEAL_II_DEPRECATED = cell_will_persist,
54
55 /**
56 * @deprecated Use CellStatus::cell_will_be_refined instead
57 */
58 CELL_REFINE DEAL_II_DEPRECATED = cell_will_be_refined,
59
60 /**
61 * @deprecated Use CellStatus::cell_will_be_coarsened instead
62 */
63 CELL_COARSEN DEAL_II_DEPRECATED = children_will_be_coarsened,
64
65 /**
66 * @deprecated Use CellStatus::cell_invalid instead
67 */
68 CELL_INVALID DEAL_II_DEPRECATED = cell_invalid,
69 };
70
71 DEAL_II_NAMESPACE_CLOSE
72
73 #endif