Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\/ 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 specialized write() for strings, integers and floats.
Correctly handles binary write as well.
\*---------------------------------------------------------------------------*/
#ifndef ensightFile_H
#define ensightFile_H
#include "OFstream.H"
#include "IOstream.H"
#include "ensightFileName.H"
#include "ensightVarName.H"
#include "UList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ensightFile Declaration
\*---------------------------------------------------------------------------*/
class ensightFile
:
public OFstream
{
//- Allow undef in results
//- Value to represent undef in results
//- The '*' mask appropriate for subDir
static string mask_;
//- The printf format for zero-padded subdirectory numbers
static string dirFmt_;
Mark Olesen
committed
// Private Member Functions
//- Initialize by setting the ASCII output formatting
void initialize();
//- No copy construct
ensightFile(const ensightFile&) = delete;
//- No copy assignment
void operator=(const ensightFile&) = delete;
//- Return a null ensightFile
inline static const ensightFile& null()
{
return NullObjectRef<ensightFile>();
}
//- Construct from pathName.
// The entire pathName is checked for valid ensight naming.
explicit ensightFile
(
const fileName& pathname,
IOstream::streamFormat format=IOstream::BINARY
);
//- Construct from path and name.
// Only the name portion is checked for valid ensight naming.
ensightFile
(
const fileName& path,
const fileName& name,
IOstream::streamFormat format=IOstream::BINARY
);
//- Destructor
//- Return setting for whether 'undef' values are allowed in results
static bool allowUndef();
//- The '*' mask appropriate for subDir
//- 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();
//- Enable/disable use of \c undef keyword and value
static bool allowUndef(bool enabled);
//- 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 value);
//- Inherit write from Ostream
using Ostream::write;
virtual Ostream& write(const char* buf, std::streamsize count);
//- Write element keyword with trailing newline, optionally with undef
virtual Ostream& writeKeyword(const keyType& key);
//- Write "C Binary" for binary files (eg, geometry/measured)
Ostream& writeBinaryHeader();
//- Write undef value
//- Write C-string as "%79s" or as binary (max 80 chars)
Ostream& write(const char*);
//- Write string as "%79s" or as binary (max 80 chars)
Ostream& write(const string&);
//- Write integer as "%10d" or as binary
Ostream& write(const label);
//- Write integer with specified width or as binary
Ostream& write(const label, const label fieldWidth);
//- Write float as "%12.5e" or as binary
Ostream& write(const scalar);
//- Add carriage return to ascii stream
void newline();
// Convenience Output Methods
//- Begin a part (0-based index internally).
void beginPart(const label index);
//- Begin a "particle coordinates" block (measured data)
void beginParticleCoordinates(const label nparticles);
//- Write a list of integers as float values
void writeList(const UList<label>& field);
//- Write a list of floats as "%12.5e" or as binary
// With carriage return after each value (ascii stream)
void writeList(const UList<scalar>& field);
//- Write an indirect list of scalars as "%12.5e" or as binary
// With carriage return after each value (ascii stream)
void writeList(const UList<scalar>& field, const labelUList& addr);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //