File size: 4,803 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::ensightFile
Description
Ensight output with specialised write() for strings, integers and floats.
Correctly handles binary write as well.
\*---------------------------------------------------------------------------*/
#ifndef ensightFile_H
#define ensightFile_H
#include "OFstream.H"
#include "IOstream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ensightFile Declaration
\*---------------------------------------------------------------------------*/
class ensightFile
:
public OFstream
{
// Private Data
//- Allow undef in results
static bool allowUndef_;
//- Value to represent undef in results
static scalar undefValue_;
//- The '*' mask appropriate for subDir
static string mask_;
//- The printf format for zero-padded subdirectory numbers
static string dirFmt_;
public:
// Constructors
//- Construct from filePath
ensightFile
(
const fileName& filePath,
IOstream::streamFormat format=IOstream::BINARY
);
//- Disallow default bitwise copy construction
ensightFile(const ensightFile&) = delete;
//- Destructor
~ensightFile();
// Access
//- Return setting for whether 'undef' values are allowed in results
static bool allowUndef();
//- The '*' mask appropriate for subDir
static string mask();
//- Consistent zero-padded numbers for subdirectories
static string subDir(const label);
//- Set width of subDir and mask. Default width is 8 digits.
// Max width is 31 digits.
static void subDirWidth(const label);
//- Return current width of subDir and mask.
static label subDirWidth();
// Edit
static bool allowUndef(bool);
//- Assign the value to represent undef in the results
// Returns the previous value
// NB: do not use values larger than floatScalarvGreat
static scalar undefValue(const scalar);
// Output
//- Inherit write from Ostream
using Ostream::write;
//- Binary write
virtual Ostream& write(const char* buf, std::streamsize count);
//- Write element keyword with trailing newline, optionally with undef
virtual Ostream& writeKeyword(const string& key);
//- Write "C Binary" for binary files (eg, geometry/measured)
Ostream& writeBinaryHeader();
//- Write undef value
Ostream& writeUndef();
//- Write C-string as "%80s" or as binary
Ostream& write(const char* value);
//- Write string as "%80s" or as binary
Ostream& write(const string& value);
//- Write integer as "%10d" or as binary
Ostream& write(const label value);
//- Write integer with specified width or as binary
Ostream& write(const label value, const label fieldWidth);
//- Write float as "%12.5e" or as binary
Ostream& write(const scalar value);
//- Add carriage return to ascii stream
void newline();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const ensightFile&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|