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