src/conversion/ensight/file/ensightFile.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "ensightFile.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 bool Foam::ensightFile::allowUndef_ = false;
  32
  33 Foam::scalar Foam::ensightFile::undefValue_ = Foam::floatScalarVGREAT;
  34
  35 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  36
  37 Foam::ensightFile::ensightFile
  38 (
  39     const fileName& pathname,
  40     IOstream::streamFormat format
  41 )
  42 :
  43     OFstream(pathname, format)
  44 {
  45     // ascii formatting specs
  46     setf
  47     (
  48         ios_base::scientific,
  49         ios_base::floatfield
  50     );
  51     precision(5);
  52 }
  53
  54
  55 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  56
  57 Foam::ensightFile::~ensightFile()
  58 {}
  59
  60
  61 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  62
  63 bool Foam::ensightFile::allowUndef()
  64 {
  65     return allowUndef_;
  66 }
  67
  68
  69 bool Foam::ensightFile::allowUndef(bool value)
  70 {
  71     bool old = allowUndef_;
  72     allowUndef_ = value;
  73     return old;
  74 }
  75
  76
  77 Foam::scalar Foam::ensightFile::undefValue(const scalar& value)
  78 {
  79     // enable its use too
  80     allowUndef_ = true;
  81
  82     scalar old = undefValue_;
  83     undefValue_ = value;
  84     return old;
  85 }
  86
  87
  88 Foam::Ostream& Foam::ensightFile::write
  89 (
  90     const char* buf,
  91     std::streamsize count
  92 )
  93 {
  94     stream().write(buf, count);
  95     return *this;
  96 }
  97
  98
  99 Foam::Ostream& Foam::ensightFile::write(const string& value)
 100 {
 101     char buf[80];
 102
 103     for (string::size_type i = 0; i < 80; ++i)
 104     {
 105         buf[i] = 0;
 106     }
 107
 108     string::size_type n = value.size();
 109     if (n >= 80)
 110     {
 111         n = 79;
 112     }
 113
 114     for (string::size_type i = 0; i < n; ++i)
 115     {
 116         buf[i] = value[i];
 117     }
 118
 119     if (format() == IOstream::BINARY)
 120     {
 121         write
 122         (
 123             reinterpret_cast<char const *>(buf),
 124             sizeof(buf)
 125         );
 126     }
 127     else
 128     {
 129         stream() << buf;
 130     }
 131
 132     return *this;
 133 }
 134
 135
 136 Foam::Ostream& Foam::ensightFile::write(const label& value)
 137 {
 138     if (format() == IOstream::BINARY)
 139     {
 140         unsigned int ivalue(value);
 141
 142         write
 143         (
 144             reinterpret_cast<char const *>(&ivalue),
 145             sizeof(ivalue)
 146         );
 147     }
 148     else
 149     {
 150         stream().width(10);
 151         stream() << value;
 152     }
 153
 154     return *this;
 155 }
 156
 157
 158 Foam::Ostream& Foam::ensightFile::write
 159 (
 160     const label& value,
 161     const label fieldWidth
 162 )
 163 {
 164     if (format() == IOstream::BINARY)
 165     {
 166         unsigned int ivalue(value);
 167
 168         write
 169         (
 170             reinterpret_cast<char const *>(&ivalue),
 171             sizeof(ivalue)
 172         );
 173     }
 174     else
 175     {
 176         stream().width(fieldWidth);
 177         stream() << value;
 178     }
 179
 180     return *this;
 181 }
 182
 183
 184 Foam::Ostream& Foam::ensightFile::write(const scalar& value)
 185 {
 186     if (format() == IOstream::BINARY)
 187     {
 188         float fvalue(value);
 189
 190         write
 191         (
 192             reinterpret_cast<char const *>(&fvalue),
 193             sizeof(fvalue)
 194         );
 195     }
 196     else
 197     {
 198         stream().width(12);
 199         stream() << value;
 200     }
 201
 202     return *this;
 203 }
 204
 205
 206 void Foam::ensightFile::newline()
 207 {
 208     if (format() == IOstream::ASCII)
 209     {
 210         stream() << nl;
 211     }
 212 }
 213
 214
 215 Foam::Ostream& Foam::ensightFile::writeUndef()
 216 {
 217     write(undefValue_);
 218     return *this;
 219 }
 220
 221
 222 Foam::Ostream& Foam::ensightFile::writeKeyword(const string& key)
 223 {
 224     if (allowUndef_)
 225     {
 226         write(key + " undef");
 227         newline();
 228         write(undefValue_);
 229         newline();
 230     }
 231     else
 232     {
 233         write(key);
 234         newline();
 235     }
 236     return *this;
 237 }
 238
 239
 240 Foam::Ostream& Foam::ensightFile::writeBinaryHeader()
 241 {
 242     if (format() == IOstream::BINARY)
 243     {
 244         write("C Binary");
 245     }
 246
 247     return *this;
 248 }
 249
 250
 251 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
 252
 253 Foam::string Foam::ensightFile::mask()
 254 {
 255     char buf[16] = "********";
 256     return buf;
 257 }
 258
 259
 260 Foam::string Foam::ensightFile::subDir(const label n)
 261 {
 262     char buf[16];
 263
 264     sprintf(buf, "%08d", n);
 265     return buf;
 266 }
 267
 268
 269 // ************************************************************************* //