All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
surfaceFieldValueI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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 "surfaceFieldValue.H"
27 #include "Time.H"
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
33 {
34  return regionType_;
35 }
36 
37 
38 inline const Foam::labelList&
40 {
41  return faceId_;
42 }
43 
44 
45 inline const Foam::labelList&
47 {
48  return facePatchId_;
49 }
50 
51 
52 inline const Foam::labelList&
54 {
55  return faceSign_;
56 }
57 
58 
59 inline Foam::fileName
61 {
62  return baseFileDir()/name()/"surface"/obr_.time().timeName();
63 }
64 
65 
66 // ************************************************************************* //
labelList faceSign_
List of +1/-1 representing face flip map.
A class for handling file names.
Definition: fileName.H:79
const labelList & faceSign() const
Return the list of +1/-1 representing face flip map.
const word & name() const
Return the name of this functionObject.
fileName outputDir() const
Return the output directory.
static word timeName(const scalar, const int precision=precision_)
Return time name of given scalar time.
Definition: Time.C:636
const regionTypes & regionType() const
Return the region type.
labelList facePatchId_
Local list of patch ID per face.
const labelList & facePatch() const
Return the local list of patch ID per face.
const Time & time() const
Return time.
const labelList & faceId() const
Return the local list of face IDs.
fileName baseFileDir() const
Return the base directory for output.
Definition: writeFile.C:49
const objectRegistry & obr_
Reference to the region objectRegistry.