raySearchEngineI.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) 2023-2024 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 
29 {
30  return mesh_;
31 }
32 
33 
35 {
36  if (!mapPtr_)
37  {
39  << "mapDistribute has not been set"
40  << abort(FatalError);
41  }
42 
43  return mapPtr_;
44 }
45 
46 
47 const Foam::labelList&
49 {
50  return compactToGlobal_;
51 }
52 
53 
56 {
57  return globalNumbering_;
58 }
59 
60 
62 {
63  return patchIDs_;
64 }
65 
66 
68 {
69  return patchAreas_;
70 }
71 
72 
74 {
75  if (nCoarseFace_ == -1) return nFace_;
76  return nCoarseFace_;
77 }
78 
79 
82 {
83  return allCf_;
84 }
85 
86 
89 {
90  return allSf_;
91 }
92 
93 
96 {
97  return allAgg_;
98 }
99 
100 
101 // ************************************************************************* //
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
const mapDistribute & map() const
Parallel map.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:608
const fvMesh & mesh_
Reference to the mesh.
const fvMesh & mesh() const noexcept
Reference to the mesh.
Calculates a unique integer (label so might not have enough room - 2G max) for processor + local inde...
Definition: globalIndex.H:61
const List< pointField > & allCf() const noexcept
List of all face centres per processor.
const List< vectorField > & allSf() const noexcept
List of all face areas per processor.
errorManip< error > abort(error &err)
Definition: errorManip.H:139
const List< labelField > & allAgg() const noexcept
List of all face agglomeration index per processor.
const direction noexcept
Definition: Scalar.H:258
const labelList & patchIDs() const noexcept
List of participating patch IDs.
const labelList & compactToGlobal() const noexcept
Compact to global addressing.
const globalIndex & globalNumbering() const noexcept
Global numbering.
label nParticipatingFaces() const
Number of participating faces.
Class containing processor-to-processor mapping information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const scalarList & patchAreas() const noexcept
Patch areas.