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 | Copyright (C) 2011-2015 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "regionModel1D.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 inline const Foam::labelListList&
32 {
33  return boundaryFaceFaces_;
34 }
35 
36 
37 inline const Foam::labelListList&
39 {
40  return boundaryFaceCells_;
41 }
42 
43 
44 inline const Foam::labelList&
46 {
47  return boundaryFaceOppositeFace_;
48 }
49 
50 
51 inline const Foam::surfaceScalarField&
53 {
54  if (!nMagSfPtr_.valid())
55  {
57  << "Face normal areas not available" << abort(FatalError);
58  }
59 
60  return nMagSfPtr_();
61 }
62 
63 
65 {
66  return nLayers_;
67 }
68 
69 
70 // ************************************************************************* //
Foam::regionModels::regionModel1D::boundaryFaceOppositeFace
const labelList & boundaryFaceOppositeFace() const
Return the global boundary face IDs oppossite coupled patch.
Definition: regionModel1DI.H:45
Foam::regionModels::regionModel1D::nLayers
label nLayers() const
Return the number of layers in the region.
Definition: regionModel1DI.H:64
Foam::regionModels::regionModel1D::boundaryFaceFaces_
labelListList boundaryFaceFaces_
Global face IDs.
Definition: regionModel1D.H:81
Foam::regionModels::regionModel1D::boundaryFaceCells
const labelListList & boundaryFaceCells() const
Return the global cell IDs.
Definition: regionModel1DI.H:38
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:59
Foam::regionModels::regionModel1D::nMagSf
const surfaceScalarField & nMagSf() const
Return the face area magnitudes / [m2].
Definition: regionModel1DI.H:52
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:131
Foam::regionModels::regionModel1D::boundaryFaceFaces
const labelListList & boundaryFaceFaces() const
Return the global face IDs.
Definition: regionModel1DI.H:31
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::GeometricField
Generic GeometricField class.
Definition: surfaceFieldsFwd.H:52