generatedCellZoneI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2021-2025 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "polyMesh.H"
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 inline bool Foam::generatedCellZone::all() const
31 {
32  return all_;
33 }
34 
35 
37 {
38  static word allName_("all");
39 
40  if (all_)
41  {
42  return allName_;
43  }
44  else
45  {
46  return cellZone_.cZone().name();
47  }
48 }
49 
50 
52 {
53  if (all_)
54  {
55  return mesh_.cellZones().all();
56  }
57  else
58  {
59  return cellZone_.cZone();
60  }
61 }
62 
63 
65 {
66  if (all_)
67  {
68  return mesh_.nCells();
69  }
70  else
71  {
72  return cellZone_.cZone().size();
73  }
74 }
75 
76 
78 {
79  if (all_)
80  {
81  return i;
82  }
83  else
84  {
85  return cellZone_.cZone()[i];
86  }
87 }
88 
89 
90 // ************************************************************************* //
Named list of cell indices representing a sub-set of the mesh.
Definition: cellZone.H:61
const cellZone & zone() const
Return const access to the cell set.
label celli(const label i) const
Return the cell index corresponding to the cell set index.
bool all() const
Return true if the set comprises all the cells.
label nCells() const
Return the number of cells in the set.
const word & name() const
Return const access to the name of cellZone.
A class for handling words, derived from string.
Definition: word.H:62
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59