mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
05427217a0
- parallel list output for foamVtkOutput - simplified '.series' file output - beginDataArray() method instead of openDataArray() + closeTag() since this seems to be the most common use anyhow. With an optional argument for leaving the tag open, this works the same as openDataArray() which may be deprecated in the future. - begin/end methods for CellData, PointData, FieldData (commonly used) - templating parameters for file headers, content version, legacy fields. This improves coding robustness and convenience of use. - use formatter and higher-level methods for legacy output - attribute quoting character now part of the formatter itself instead of as an argument for xmlAttr(). Toggle with quoting() method. - pair-wise processing of xml attributes, which also allows them to be passed as optional entries when creating an xml tag. - xmlComment with multiple arguments
166 lines
4.8 KiB
C++
166 lines
4.8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016-2017 OpenCFD Ltd.
|
|
\\/ 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::vtk::outputOptions
|
|
|
|
Description
|
|
Encapsulated combinations of output format options.
|
|
This is primarily useful when defining the output type based on some
|
|
command-line arguments or dictionary contents.
|
|
However, it can also be a useful alternative to using the underlying
|
|
enumeration directly, since this class provides additional methods
|
|
not possible with an enum.
|
|
|
|
SourceFiles
|
|
foamVtkOutputOptions.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef foamVtkOutputOptions_H
|
|
#define foamVtkOutputOptions_H
|
|
|
|
#include "foamVtkOutput.H"
|
|
#include "string.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace vtk
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class outputOptions Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class outputOptions
|
|
{
|
|
// Private Member Data
|
|
|
|
//- The output style tuning
|
|
enum styleType
|
|
{
|
|
NONE = 0x00, //!< Normal
|
|
HEADER = 0x01 //!< Emit xml header
|
|
};
|
|
|
|
//- The output format type
|
|
formatType fmtType_;
|
|
|
|
//- ASCII write precision
|
|
mutable unsigned precision_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct null - XML insitu ASCII format with default precision
|
|
inline outputOptions();
|
|
|
|
//- Construct with specified format.
|
|
// This constructor should remain non-explicit.
|
|
inline outputOptions(enum formatType fmtType);
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Return new formatter based on the selected output options
|
|
inline autoPtr<formatter> newFormatter(std::ostream& os) const;
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- The output format type
|
|
inline formatType fmt() const;
|
|
|
|
//- The file extension (legacy or xml) for the given content-type
|
|
inline word ext(vtk::fileTag contentType) const;
|
|
|
|
//- True if writer uses legacy file format
|
|
inline bool legacy() const;
|
|
|
|
//- True if writer uses XML file format (non-legacy)
|
|
inline bool xml() const;
|
|
|
|
//- True if output format uses an append mode
|
|
inline bool append() const;
|
|
|
|
//- True if output format does not use an append mode
|
|
inline bool insitu() const;
|
|
|
|
//- True if output format is ASCII
|
|
inline bool ascii() const;
|
|
|
|
//- Return the ASCII write precision
|
|
inline unsigned precision() const;
|
|
|
|
|
|
// Edit
|
|
|
|
//- Toggle ASCII mode on/off.
|
|
// In XML append mode, this switches between base64 and raw binary.
|
|
// In XML inline mode, this switches between ASCII and base64.
|
|
// In legacy mode, this switches between ASCII and binary.
|
|
// \return outputOptions for chaining
|
|
outputOptions& ascii(bool on);
|
|
|
|
//- Toggle append mode on/off.
|
|
// \return outputOptions for chaining
|
|
outputOptions& append(bool on);
|
|
|
|
//- Toggle legacy mode on/off.
|
|
// \return outputOptions for chaining
|
|
outputOptions& legacy(bool on);
|
|
|
|
//- Set the write precision to be used for new ASCII formatters
|
|
// \return outputOptions for chaining
|
|
outputOptions& precision(unsigned prec);
|
|
|
|
|
|
// Other
|
|
|
|
//- A text description about the output option selected
|
|
string description() const;
|
|
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace vtk
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "foamVtkOutputOptionsI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|