OpenFOAM: API Guide
v2112
The open source CFD toolbox
faceToCellStencil.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) 2011-2013 OpenFOAM Foundation
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
Class
27
Foam::faceToCellStencil
28
29
Description
30
baseclass for extended cell centred addressing. Contains per cell a
31
list of neighbouring faces in global addressing.
32
33
SourceFiles
34
faceToCellStencil.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef faceToCellStencil_H
39
#define faceToCellStencil_H
40
41
#include "
globalIndex.H
"
42
#include "
boolList.H
"
43
#include "
HashSet.H
"
44
#include "
indirectPrimitivePatch.H
"
45
46
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47
48
namespace
Foam
49
{
50
51
class
polyMesh;
52
53
/*---------------------------------------------------------------------------*\
54
Class faceToCellStencil Declaration
55
\*---------------------------------------------------------------------------*/
56
57
class
faceToCellStencil
58
:
59
public
labelListList
60
{
61
// Private data
62
63
const
polyMesh
& mesh_;
64
65
//- Global numbering for faces
66
const
globalIndex
globalNumbering_;
67
68
public
:
69
70
// Constructors
71
72
//- Construct from mesh
73
explicit
faceToCellStencil
(
const
polyMesh
&);
74
75
76
// Member Functions
77
78
const
polyMesh
&
mesh
()
const
79
{
80
return
mesh_;
81
}
82
83
//- Global numbering for faces
84
const
globalIndex
&
globalNumbering
()
const
85
{
86
return
globalNumbering_;
87
}
88
89
};
90
91
92
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93
94
}
// End namespace Foam
95
96
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97
98
#endif
99
100
// ************************************************************************* //
Foam::faceToCellStencil::mesh
const polyMesh & mesh() const
Definition:
faceToCellStencil.H:77
boolList.H
globalIndex.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition:
polyMesh.H:77
Foam::faceToCellStencil::globalNumbering
const globalIndex & globalNumbering() const
Global numbering for faces.
Definition:
faceToCellStencil.H:83
indirectPrimitivePatch.H
HashSet.H
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::globalIndex
Calculates a unique integer (label so might not have enough room - 2G max) for processor + local inde...
Definition:
globalIndex.H:68
Foam::faceToCellStencil
baseclass for extended cell centred addressing. Contains per cell a list of neighbouring faces in glo...
Definition:
faceToCellStencil.H:56
Foam::List< labelList >
Foam::faceToCellStencil::faceToCellStencil
faceToCellStencil(const polyMesh &)
Construct from mesh.
Definition:
faceToCellStencil.C:35
src
finiteVolume
fvMesh
extendedStencil
faceToCell
globalIndexStencils
faceToCellStencil.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.