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-2023 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 
31 inline
34 {
35  return selectionType_;
36 }
37 
38 
39 inline const Foam::word&
41 {
42  return selectionName_;
43 }
44 
45 
46 inline const Foam::labelList&
48 {
49  return faceId_;
50 }
51 
52 
53 inline const Foam::labelList&
55 {
56  return facePatchId_;
57 }
58 
59 
60 inline const Foam::labelList&
62 {
63  return faceSign_;
64 }
65 
66 
67 inline Foam::fileName
69 {
70  return baseFileDir()/name()/"surface"/time_.name();
71 }
72 
73 
74 // ************************************************************************* //
A class for handling file names.
Definition: fileName.H:82
const labelList & faceSign() const
Return the list of +1/-1 representing face flip map.
const selectionTypes & selectionType() const
Return the selection type.
fileName outputDir() const
Return the output directory.
const labelList & faceId() const
Return the local list of face IDs.
const word & selectionName() const
Return the selection name.
const labelList & facePatch() const
Return the local list of patch ID per face.
A class for handling words, derived from string.
Definition: word.H:62
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47