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 -------------------------------------------------------------------------------
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 #include "regionModel1D.H"
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
32 inline const Foam::labelListList&
34 {
35  return boundaryFaceFaces_;
36 }
37 
38 
39 inline const Foam::labelListList&
41 {
42  return boundaryFaceCells_;
43 }
44 
45 
46 inline const Foam::labelList&
48 {
49  return boundaryFaceOppositeFace_;
50 }
51 
52 
53 inline const Foam::surfaceScalarField&
55 {
56  if (!nMagSfPtr_.valid())
57  {
59  << "Face normal areas not available" << abort(FatalError);
60  }
61 
62  return *nMagSfPtr_;
63 }
64 
65 
67 {
68  return nLayers_;
69 }
70 
71 
72 // ************************************************************************* //
Foam::regionModels::regionModel1D::boundaryFaceOppositeFace
const labelList & boundaryFaceOppositeFace() const
Return the global boundary face IDs oppositte coupled patch.
Definition: regionModel1DI.H:47
Foam::regionModels::regionModel1D::nLayers
label nLayers() const
Return the number of layers in the region.
Definition: regionModel1DI.H:66
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:40
regionModel1D.H
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:62
Foam::regionModels::regionModel1D::nMagSf
const surfaceScalarField & nMagSf() const
Return the face area magnitudes / [m2].
Definition: regionModel1DI.H:54
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:137
Foam::regionModels::regionModel1D::boundaryFaceFaces
const labelListList & boundaryFaceFaces() const
Return the global face IDs.
Definition: regionModel1DI.H:33
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:355
Foam::List< labelList >
Foam::GeometricField< scalar, fvsPatchField, surfaceMesh >