ensightCaseI.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) 2016-2022 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29
31{
32 return *options_;
33}
34
35
37{
38 return options_->format();
39}
40
41
43{
44 return ensightDir_;
45}
46
47
49{
50 return options_->mask();
51}
52
53
54inline Foam::word Foam::ensightCase::padded(const label i) const
55{
56 return options_->padded(i);
57}
58
59
61{
62 return options_->nodeValues();
63}
64
65
67{
68 return options_->separateCloud();
69}
70
71
72// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
73
75{
76 return *os_;
77}
78
79
80// ************************************************************************* //
streamFormat
Data format (ascii | binary)
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Configuration options for the ensightCase.
Definition: ensightCase.H:381
const word & mask() const
The output '*' mask.
Definition: ensightCaseI.H:48
const fileName & path() const noexcept
The nominal path to the case file.
Definition: ensightCaseI.H:42
word padded(const label i) const
Consistent zero-padded integer value.
Definition: ensightCaseI.H:54
bool nodeValues() const
Force use of values per node instead of per element.
Definition: ensightCaseI.H:60
Ostream & operator()() const
Output stream (master only).
Definition: ensightCaseI.H:74
bool separateCloud() const
Write clouds into their own directory instead in "data" directory.
Definition: ensightCaseI.H:66
const ensightCase::options & option() const
Reference to the case options.
Definition: ensightCaseI.H:30
IOstreamOption::streamFormat format() const
The output file format (ascii/binary)
Definition: ensightCaseI.H:36
A class for handling file names.
Definition: fileName.H:76
A class for handling words, derived from Foam::string.
Definition: word.H:68
const direction noexcept
Definition: Scalar.H:223