surfaceWriterI.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) 2019-2020 OpenCFD Ltd.
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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 inline Foam::label Foam::surfaceWriter::nFields() const
31 {
32  return nFields_;
33 }
34 
35 
36 inline Foam::label& Foam::surfaceWriter::nFields()
37 {
38  return nFields_;
39 }
40 
41 
43 {
44  return isPointData_;
45 }
46 
47 
49 {
50  return isPointData_;
51 }
52 
53 
55 {
56  return useTimeDir_;
57 }
58 
59 
60 inline bool Foam::surfaceWriter::useTimeDir(const bool on)
61 {
62  bool old(useTimeDir_);
63  useTimeDir_ = on;
64  return old;
65 }
66 
67 
69 {
70  return useTimeDir_;
71 }
72 
73 
74 inline bool Foam::surfaceWriter::verbose() const
75 {
76  return verbose_;
77 }
78 
79 
80 inline bool Foam::surfaceWriter::verbose(const bool on)
81 {
82  bool old(verbose_);
83  verbose_ = on;
84  return old;
85 }
86 
87 
89 {
90  return verbose_;
91 }
92 
93 
94 inline Foam::scalar Foam::surfaceWriter::mergeDim() const
95 {
96  return mergeDim_;
97 }
98 
99 
100 inline Foam::scalar& Foam::surfaceWriter::mergeDim()
101 {
102  return mergeDim_;
103 }
104 
105 
106 inline bool Foam::surfaceWriter::hasTime() const
107 {
108  return currTime_.name().size();
109 }
110 
111 
113 {
114  return currTime_.name();
115 }
116 
117 
118 inline Foam::scalar Foam::surfaceWriter::timeValue() const
119 {
120  return currTime_.name().empty() ? 0 : currTime_.value();
121 }
122 
123 
124 // ************************************************************************* //
Foam::surfaceWriter::timeValue
scalar timeValue() const
The current time value/name.
Definition: surfaceWriterI.H:118
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::surfaceWriter::mergeDim
scalar mergeDim() const
The current value of the point merge dimension (metre)
Definition: surfaceWriterI.H:94
Foam::surfaceWriter::useTimeDir
bool useTimeDir() const
Should a time directory be spliced into the output path?
Definition: surfaceWriterI.H:54
Foam::surfaceWriter::hasTime
bool hasTime() const
True if there is a known time.
Definition: surfaceWriterI.H:106
Foam::surfaceWriter::timeName
const word & timeName() const
The current time value/name.
Definition: surfaceWriterI.H:112
Foam::surfaceWriter::isPointData
bool isPointData() const
Are the field data to be treated as point data?
Definition: surfaceWriterI.H:42
Foam::surfaceWriter::verbose
bool verbose() const
Get output verbosity.
Definition: surfaceWriterI.H:74
Foam::surfaceWriter::nFields_
label nFields_
The number of fields.
Definition: surfaceWriter.H:151
Foam::surfaceWriter::nFields
label nFields() const
The number of expected output fields.
Definition: surfaceWriterI.H:30