faMeshI.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) 2016-2017 Wikki Ltd
9  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
31 inline const Foam::polyMesh& Foam::faMesh::mesh() const
32 {
33  return
35 }
36 
37 
38 inline const Foam::faBoundaryMesh& Foam::faMesh::boundary() const noexcept
39 {
40  return boundary_;
41 }
42 
43 
44 inline Foam::label Foam::faMesh::comm() const noexcept
45 {
46  return comm_;
47 }
48 
49 
50 inline Foam::label& Foam::faMesh::comm() noexcept
51 {
52  return comm_;
53 }
54 
55 
56 inline Foam::label Foam::faMesh::nPoints() const noexcept
57 {
58  return nPoints_;
59 }
60 
61 
62 inline Foam::label Foam::faMesh::nEdges() const noexcept
63 {
64  return nEdges_;
65 }
66 
67 
68 inline Foam::label Foam::faMesh::nInternalEdges() const noexcept
69 {
70  return nInternalEdges_;
71 }
72 
73 
74 inline Foam::label Foam::faMesh::nBoundaryEdges() const noexcept
75 {
76  return nEdges_ - nInternalEdges_;
77 }
78 
79 
80 inline Foam::label Foam::faMesh::nFaces() const noexcept
81 {
82  return nFaces_;
83 }
84 
85 
87 {
88  return patch().localPoints();
89 }
90 
91 
92 inline const Foam::edgeList& Foam::faMesh::edges() const noexcept
93 {
94  return edges_;
95 }
96 
97 
98 inline const Foam::faceList& Foam::faMesh::faces() const
99 {
100  return patch().localFaces();
101 }
102 
103 
104 inline const Foam::labelList& Foam::faMesh::edgeOwner() const noexcept
105 {
106  return edgeOwner_;
107 }
108 
109 
110 inline const Foam::labelList& Foam::faMesh::edgeNeighbour() const noexcept
111 {
112  return edgeNeighbour_;
113 }
114 
115 
116 inline const Foam::labelList& Foam::faMesh::faceLabels() const noexcept
117 {
118  return faceLabels_;
119 }
120 
121 
123 {
124  if (!patchPtr_)
125  {
126  initPatch();
127  }
128  return *patchPtr_;
129 }
130 
131 
133 {
134  if (!patchPtr_)
135  {
136  initPatch();
137  }
138  return *patchPtr_;
139 }
140 
141 
142 inline const Foam::List<Foam::labelPair>&
144 {
145  if (!bndConnectPtr_)
146  {
147  calcBoundaryConnections();
148  }
149  return *bndConnectPtr_;
150 }
151 
152 
153 // ************************************************************************* //
Foam::faMesh::faces
const faceList & faces() const
Return local patch faces.
Definition: faMeshI.H:98
Foam::faMesh::faceLabels
const labelList & faceLabels() const noexcept
Return the underlying polyMesh face labels.
Definition: faMeshI.H:116
Foam::faMesh::edgeOwner
const labelList & edgeOwner() const noexcept
Edge owner addressing.
Definition: faMeshI.H:104
Foam::faMesh::boundaryConnections
const List< labelPair > & boundaryConnections() const
Definition: faMeshI.H:143
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::faMesh::nFaces
label nFaces() const noexcept
Number of patch faces.
Definition: faMeshI.H:80
Foam::faBoundaryMesh
Finite area boundary mesh.
Definition: faBoundaryMesh.H:65
Foam::faMesh::edges
const edgeList & edges() const noexcept
Return local patch edges with reordered boundary.
Definition: faMeshI.H:92
Foam::Field< vector >
Foam::MeshObject::mesh
const Mesh & mesh() const
Definition: MeshObject.H:122
Foam::faMesh::nEdges
label nEdges() const noexcept
Number of local mesh edges.
Definition: faMeshI.H:62
Foam::faMesh::nInternalEdges
label nInternalEdges() const noexcept
Number of internal faces.
Definition: faMeshI.H:68
Foam::faMesh::nBoundaryEdges
label nBoundaryEdges() const noexcept
Number of boundary edges (== nEdges - nInternalEdges)
Definition: faMeshI.H:74
Foam::faMesh::nPoints
label nPoints() const noexcept
Number of local mesh points.
Definition: faMeshI.H:56
Foam::faMesh::mesh
const polyMesh & mesh() const
Return access to polyMesh.
Definition: faMeshI.H:31
Foam::faMesh::boundary
const faBoundaryMesh & boundary() const noexcept
Return constant reference to boundary mesh.
Definition: faMeshI.H:38
Foam::faMesh::points
const pointField & points() const
Return local patch points.
Definition: faMeshI.H:86
Foam::faMesh::edgeNeighbour
const labelList & edgeNeighbour() const noexcept
Edge neighbour addressing.
Definition: faMeshI.H:110
Foam::faMesh::comm
label comm() const noexcept
Return communicator used for parallel communication.
Definition: faMeshI.H:44
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::List< edge >
Foam::faMesh::patch
const uindirectPrimitivePatch & patch() const
Return constant reference to primitive patch.
Definition: faMeshI.H:122
Foam::PrimitivePatch
A list of faces which address into the list of points.
Definition: PrimitivePatch.H:79