regionModel1DI.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-2015 OpenFOAM Foundation
9  Copyright (C) 2020 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 #include "regionModel1D.H"
30 
31 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32 
33 inline const Foam::labelListList&
35 {
36  return boundaryFaceFaces_;
37 }
38 
39 
40 inline const Foam::labelListList&
42 {
43  return boundaryFaceCells_;
44 }
45 
46 
47 inline const Foam::labelList&
49 {
50  return boundaryFaceOppositeFace_;
51 }
52 
53 
54 inline const Foam::surfaceScalarField&
56 {
57  if (!nMagSfPtr_)
58  {
60  << "Face normal areas not available" << abort(FatalError);
61  }
62 
63  return *nMagSfPtr_;
64 }
65 
66 
68 {
69  return nLayers_;
70 }
71 
72 
73 // ************************************************************************* //
Foam::regionModels::regionModel1D::boundaryFaceOppositeFace
const labelList & boundaryFaceOppositeFace() const
Return the global boundary face IDs oppositte coupled patch.
Definition: regionModel1DI.H:48
Foam::regionModels::regionModel1D::nLayers
label nLayers() const
Return the number of layers in the region.
Definition: regionModel1DI.H:67
Foam::regionModels::regionModel1D::boundaryFaceFaces_
labelListList boundaryFaceFaces_
Global face IDs.
Definition: regionModel1D.H:80
Foam::regionModels::regionModel1D::boundaryFaceCells
const labelListList & boundaryFaceCells() const
Return the global cell IDs.
Definition: regionModel1DI.H:41
regionModel1D.H
Foam::regionModels::regionModel1D::nMagSf
const surfaceScalarField & nMagSf() const
Return the face area magnitudes / [m2].
Definition: regionModel1DI.H:55
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::regionModels::regionModel1D::boundaryFaceFaces
const labelListList & boundaryFaceFaces() const
Return the global face IDs.
Definition: regionModel1DI.H:34
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::List< labelList >
Foam::GeometricField< scalar, fvsPatchField, surfaceMesh >