fvMeshSubsetI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2018-2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 inline const Foam::fvMesh& Foam::fvMeshSubset::baseMesh() const noexcept
31 {
32  return baseMesh_;
33 }
34 
35 
36 inline const Foam::fvMesh& Foam::fvMeshSubset::mesh() const noexcept
37 {
38  return fvMeshSubsetPtr_ ? *fvMeshSubsetPtr_ : baseMesh_;
39 }
40 
41 
42 inline bool Foam::fvMeshSubset::hasSubMesh() const noexcept
43 {
44  return bool(fvMeshSubsetPtr_);
45 }
46 
47 
49 {
50  checkCellSubset();
51 
52  return *fvMeshSubsetPtr_;
53 }
54 
55 
57 {
58  checkCellSubset();
59 
60  return *fvMeshSubsetPtr_;
61 }
62 
63 
65 {
66  checkCellSubset();
67 
68  return pointMap_;
69 }
70 
71 
73 {
74  checkCellSubset();
75 
76  return faceMap_;
77 }
78 
79 
81 {
82  if (!faceFlipMapPtr_)
83  {
84  calcFaceFlipMap();
85  }
86 
87  return *faceFlipMapPtr_;
88 }
89 
90 
92 {
93  checkCellSubset();
94 
95  return cellMap_;
96 }
97 
98 
100 {
101  checkCellSubset();
102 
103  return patchMap_;
104 }
105 
106 
107 // ************************************************************************* //
Foam::fvMeshSubset::cellMap
const labelList & cellMap() const
Return cell map.
Definition: fvMeshSubsetI.H:91
Foam::fvMeshSubset::pointMap
const labelList & pointMap() const
Return point map.
Definition: fvMeshSubsetI.H:64
Foam::fvMeshSubset::faceFlipMap
const labelList & faceFlipMap() const
Return face map with sign to encode flipped faces.
Definition: fvMeshSubsetI.H:80
Foam::fvMeshSubset::subMesh
const fvMesh & subMesh() const
Return reference to subset mesh.
Definition: fvMeshSubsetI.H:48
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam::fvMeshSubset::baseMesh
const fvMesh & baseMesh() const noexcept
Original mesh.
Definition: fvMeshSubsetI.H:30
Foam::fvMeshSubset::hasSubMesh
bool hasSubMesh() const noexcept
Have subMesh?
Definition: fvMeshSubsetI.H:42
Foam::List< label >
bool
bool
Definition: EEqn.H:20
Foam::fvMeshSubset::faceMap
const labelList & faceMap() const
Return face map.
Definition: fvMeshSubsetI.H:72
Foam::fvMeshSubset::patchMap
const labelList & patchMap() const
Return patch map.
Definition: fvMeshSubsetI.H:99
Foam::fvMeshSubset::mesh
const fvMesh & mesh() const noexcept
Return baseMesh or subMesh, depending on the current state.
Definition: fvMeshSubsetI.H:36