An Ostream is an abstract base class for all output systems (streams, files, token lists, etc). More...
Public Member Functions | |
Ostream (const Ostream &)=default | |
Copy construct. More... | |
virtual | ~Ostream ()=default |
Destructor. More... | |
Ostream (IOstreamOption streamOpt=IOstreamOption()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct with format (uncompressed) More... | |
virtual bool | write (const token &tok)=0 |
Write token to stream or otherwise handle it. More... | |
virtual Ostream & | write (const char c)=0 |
Write character. More... | |
virtual Ostream & | writeQuoted (const char *str, std::streamsize len, const bool quoted=true)=0 |
Write character/string content, with/without surrounding quotes. More... | |
virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
Write string content, with/without surrounding quotes. More... | |
virtual Ostream & | write (const char *str)=0 |
Write character string. More... | |
virtual Ostream & | write (const word &str)=0 |
Write word (unquoted) More... | |
virtual Ostream & | write (const std::string &str)=0 |
Write string content (usually quoted) More... | |
virtual Ostream & | write (const keyType &kw) |
Write keyType. More... | |
virtual Ostream & | write (const int32_t val)=0 |
Write int32_t. More... | |
virtual Ostream & | write (const int64_t val)=0 |
Write int64_t. More... | |
virtual Ostream & | write (const float val)=0 |
Write float. More... | |
virtual Ostream & | write (const double val)=0 |
Write double. More... | |
virtual Ostream & | write (const char *data, std::streamsize count)=0 |
Write binary block. More... | |
virtual Ostream & | writeRaw (const char *data, std::streamsize count)=0 |
Low-level raw binary output. More... | |
virtual bool | beginRawWrite (std::streamsize count)=0 |
Emit begin marker for low-level raw binary output. More... | |
virtual bool | endRawWrite ()=0 |
Emit end marker for low-level raw binary output. More... | |
virtual void | indent ()=0 |
Add indentation characters. More... | |
unsigned short | indentSize () const noexcept |
Return indent size (spaces per level) More... | |
unsigned short | indentSize (unsigned short val) noexcept |
Change indent size (spaces per level), return old value. More... | |
unsigned short | indentLevel () const noexcept |
Return the indent level. More... | |
unsigned short | indentLevel (unsigned short val) noexcept |
Change the indent level, return old value. More... | |
void | incrIndent () noexcept |
Increment the indent level. More... | |
void | decrIndent () |
Decrement the indent level. More... | |
virtual Ostream & | writeKeyword (const keyType &kw) |
Write the keyword followed by an appropriate indentation. More... | |
virtual Ostream & | beginBlock (const keyType &kw) |
Write begin block group with the given name. More... | |
virtual Ostream & | beginBlock () |
Write begin block group without a name. More... | |
virtual Ostream & | endBlock () |
Write end block group. More... | |
virtual Ostream & | endEntry () |
Write end entry (';') followed by newline. More... | |
template<class T > | |
Ostream & | writeEntry (const keyType &key, const T &value) |
Write a keyword/value entry. More... | |
template<class T > | |
Ostream & | writeEntryIfDifferent (const word &key, const T &value1, const T &value2) |
Write a keyword/value entry only when the two values differ. More... | |
virtual void | flush ()=0 |
Flush stream. More... | |
virtual void | endl ()=0 |
Add newline and flush stream. More... | |
virtual char | fill () const =0 |
Get padding character. More... | |
virtual char | fill (const char fillch)=0 |
Set padding character for formatted field up to field width. More... | |
virtual int | width () const =0 |
Get width of output field. More... | |
virtual int | width (const int w)=0 |
Set width of output field (and return old width) More... | |
virtual int | precision () const =0 |
Get precision of output field. More... | |
virtual int | precision (const int p)=0 |
Set precision of output field (and return old precision) More... | |
Ostream & | operator() () const |
Return a non-const reference to const Ostream. More... | |
unsigned short & | indentLevel () noexcept |
Access to indent level. More... | |
unsigned short & | indentSize () noexcept |
Access to indent size. More... | |
Public Member Functions inherited from IOstream | |
IOstream (const IOstream &)=default | |
Copy construct. More... | |
virtual | ~IOstream ()=default |
Destructor. More... | |
IOstream (IOstreamOption streamOpt=IOstreamOption()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct with format, version (compression) More... | |
virtual const fileName & | name () const |
The name of the stream. More... | |
fileName | relativeName () const |
Return the name of the stream relative to the current case. More... | |
virtual bool | check (const char *operation) const |
Check IOstream status for given operation. More... | |
bool | fatalCheck (const char *operation) const |
Check IOstream status for given operation. More... | |
bool | opened () const noexcept |
True if stream has been opened. More... | |
bool | closed () const noexcept |
True if stream is closed. More... | |
bool | good () const noexcept |
True if next operation might succeed. More... | |
bool | eof () const noexcept |
True if end of input seen. More... | |
bool | fail () const noexcept |
True if next operation will fail. More... | |
bool | bad () const noexcept |
True if stream is corrupted. More... | |
operator bool () const noexcept | |
Return true if the stream has not failed. More... | |
bool | operator! () const noexcept |
Return true if the stream has failed. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes associated with the stream. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes associated with the stream. More... | |
void | setLabelByteSize (unsigned nbytes) noexcept |
Set the sizeof (label) in bytes associated with the stream. More... | |
void | setScalarByteSize (unsigned nbytes) noexcept |
Set the sizeof (scalar) in bytes associated with the stream. More... | |
template<class T = label> | |
std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const noexcept |
Check if the label byte-size associated with the stream is the same as the given type. More... | |
template<class T = scalar> | |
std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const noexcept |
Check if the scalar byte-size associated with the stream is the same as the given type. More... | |
label | lineNumber () const noexcept |
Const access to the current stream line number. More... | |
label & | lineNumber () noexcept |
Non-const access to the current stream line number. More... | |
label | lineNumber (const label num) noexcept |
Set the stream line number. More... | |
void | setEof () noexcept |
Set stream state as reached 'eof'. More... | |
void | setFail () noexcept |
Set stream state as 'failed'. More... | |
void | setBad () noexcept |
Set stream state to be 'bad'. More... | |
virtual std::ios_base::fmtflags | flags () const =0 |
Return current stream flags. More... | |
virtual std::ios_base::fmtflags | flags (std::ios_base::fmtflags)=0 |
Set stream flags, return old stream flags. More... | |
std::ios_base::fmtflags | setf (std::ios_base::fmtflags f) |
Set stream flag(s), return old stream flags. More... | |
std::ios_base::fmtflags | setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask) |
Set stream flag(s) with mask, return old stream flags. More... | |
void | unsetf (std::ios_base::fmtflags f) |
Unset flags of stream. More... | |
virtual void | print (Ostream &os) const |
Print stream description to Ostream. More... | |
void | print (Ostream &os, const int streamState) const |
Print information about the stream state bits. More... | |
InfoProxy< IOstream > | info () const noexcept |
Return info proxy, used to print IOstream information to a stream. More... | |
Public Member Functions inherited from IOstreamOption | |
constexpr | IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More... | |
constexpr | IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept |
Construct from components (format, compression, version) More... | |
constexpr | IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
Construct from components (format, version, compression) More... | |
IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept | |
Copy construct with change of format. More... | |
streamFormat | format () const noexcept |
Get the current stream format. More... | |
streamFormat | format (const streamFormat fmt) noexcept |
Set the stream format. More... | |
streamFormat | format (const word &formatName) |
Set the stream format from string value. More... | |
compressionType | compression () const noexcept |
Get the stream compression. More... | |
compressionType | compression (const compressionType comp) noexcept |
Set the stream compression. More... | |
compressionType | compression (const word &compName) |
Set the stream compression from string value. More... | |
versionNumber | version () const noexcept |
Get the stream version. More... | |
versionNumber | version (const versionNumber ver) noexcept |
Set the stream version. More... | |
versionNumber | version (const token &tok) |
Set the stream version from token. More... | |
Protected Attributes | |
unsigned short | indentSize_ = 4 |
Number of spaces per indent level. More... | |
unsigned short | indentLevel_ = 0 |
Current indent level. More... | |
Protected Attributes inherited from IOstream | |
std::ios_base::iostate | ioState_ |
Mirror of internal stream io state. More... | |
streamAccess | openClosed_ |
The stream open/closed state. More... | |
unsigned char | sizeofLabel_ |
The sizeof (label), possibly read from the header. More... | |
unsigned char | sizeofScalar_ |
The sizeof (scalar), possibly read from the header. More... | |
label | lineNumber_ |
The file line. More... | |
Static Protected Attributes | |
static constexpr const unsigned short | entryIndentation_ = 16 |
Indentation of the entry from the start of the keyword. More... | |
Static Protected Attributes inherited from IOstream | |
static fileName | staticName_ |
Name for any generic stream - normally treat as readonly. More... | |
Additional Inherited Members | |
Public Types inherited from IOstream | |
enum | streamAccess : char { CLOSED = 0, OPENED } |
Enumeration for stream open/closed state. More... | |
Public Types inherited from IOstreamOption | |
enum | streamFormat : char { ASCII = 0, BINARY } |
Data format (ascii | binary) More... | |
enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
enum | appendType : char { NO_APPEND = 0, APPEND_APP, APPEND_ATE, NON_APPEND = NO_APPEND, APPEND = APPEND_APP } |
File appending (NO_APPEND | APPEND_APP | APPEND_ATE) More... | |
enum | atomicType : char { NON_ATOMIC = 0, ATOMIC } |
Atomic operations (output) More... | |
enum | floatFormat : unsigned { general = unsigned(0), fixed = unsigned(std::ios_base::fixed), scientific = unsigned(std::ios_base::scientific) } |
Float formats (eg, time directory name formats) More... | |
Static Public Member Functions inherited from IOstream | |
static unsigned int | defaultPrecision () noexcept |
Return the default precision. More... | |
static unsigned int | defaultPrecision (unsigned int prec) noexcept |
Reset the default precision. More... | |
static unsigned int | minPrecision (unsigned int prec) noexcept |
Set the minimum default precision. More... | |
Static Public Member Functions inherited from IOstreamOption | |
static floatFormat | floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general) |
Lookup floatFormat enum corresponding to the string (general | fixed | scientific). More... | |
static floatFormat | floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general) |
getOrDefault floatFormat from dictionary, warn only on bad enumeration. More... | |
static streamFormat | formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII) |
Lookup streamFormat enum corresponding to the string (ascii | binary). More... | |
static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
getOrDefault streamFormat from dictionary, warn only on bad enumeration. More... | |
static compressionType | compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED) |
The compression enum corresponding to the string. More... | |
static compressionType | compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED) |
getOrDefault compressionType from dictionary, warn only on bad enumeration. More... | |
Static Public Attributes inherited from IOstream | |
static unsigned int | precision_ |
Default precision. More... | |
Static Public Attributes inherited from IOstreamOption | |
static const Enum< floatFormat > | floatFormatNames |
Names for float formats (general, fixed, scientific) More... | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | currentVersion |
The current version number (2.0) More... | |
Protected Member Functions inherited from IOstream | |
void | setOpened () noexcept |
Set stream opened. More... | |
void | setClosed () noexcept |
Set stream closed. More... | |
void | setState (std::ios_base::iostate state) noexcept |
Set stream state. More... | |
void | setGood () noexcept |
Set stream state to be good. More... | |
An Ostream is an abstract base class for all output systems (streams, files, token lists, etc).
|
virtualdefault |
Destructor.
|
inlineexplicit |
|
inlineexplicit |
|
pure virtual |
Write token to stream or otherwise handle it.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
Referenced by snappyLayerDriver::addLayers(), snappyLayerDriver::addLayersSinglePass(), interRegionHeatTransferModel::addSup(), hexRef8::consistentSlowRefinement2(), distanceSurface::createGeometry(), snappySnapDriver::doSnap(), if(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), Foam::MapLagrangianFields(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), Foam::operator<<(), faFieldReconstructor::reconstructAreaFields(), faFieldReconstructor::reconstructEdgeFields(), lagrangianReconstructor::reconstructFieldFields(), lagrangianReconstructor::reconstructFields(), fvFieldReconstructor::reconstructInternalFields(), pointFieldReconstructor::reconstructPointFields(), fvFieldReconstructor::reconstructSurfaceFields(), fvFieldReconstructor::reconstructVolumeFields(), refinementIterator::setRefinement(), hexRef8::setRefinement(), snappySnapDriver::smoothDisplacement(), XiReactionRate::write(), writeCellVolumes::write(), SHA1::write(), writeCellCentres::write(), scene::write(), momentumError::write(), derivedFields::write(), ensightMesh::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), PopeIndex::write(), CelikNuIndex::write(), ObukhovLength::write(), CelikEtaIndex::write(), electricPotential::write(), extractEulerianParticles::write(), sixDoFRigidBodyMotion::write(), cyclicPolyPatch::write(), forces::write(), cyclicAMIPolyPatch::write(), mappedPatchBase::write(), ensightWriter::writeCollated(), OSstream::writeRaw(), vtkWriter::writeTemplate(), and meshRefinement::zonify().
|
pure virtual |
Write character.
Implemented in ensightFile, UOPstreamBase, OSstream, OBJstream, OTstream, and prefixOSstream.
|
pure virtual |
Write character/string content, with/without surrounding quotes.
Implemented in UOPstreamBase, OSstream, OBJstream, OTstream, and prefixOSstream.
Referenced by JSONformatter::write(), JSONformatter::writeDict(), JSONformatter::writeEntry(), and JSONformatter::writeKeyword().
|
virtual |
|
pure virtual |
Write character string.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, OBJstream, and prefixOSstream.
Write word (unquoted)
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, OBJstream, and prefixOSstream.
|
pure virtual |
Write string content (usually quoted)
Implemented in ensightFile, UOPstreamBase, OSstream, OSHA1stream, OTstream, OBJstream, and prefixOSstream.
|
virtual |
Write keyType.
A plain word is written unquoted. A regular expression is written as a quoted string.
Definition at line 54 of file Ostream.C.
References keyType::isPattern().
|
pure virtual |
Write int32_t.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
pure virtual |
Write int64_t.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
pure virtual |
Write float.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
pure virtual |
Write double.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
pure virtual |
Write binary block.
Implemented in ensightFile, UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
pure virtual |
Low-level raw binary output.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Emit begin marker for low-level raw binary output.
The count indicates the number of bytes for subsequent writeRaw calls.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Emit end marker for low-level raw binary output.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Add indentation characters.
Implemented in UOPstreamBase, OSstream, OTstream, and prefixOSstream.
|
inlinenoexcept |
Return indent size (spaces per level)
Definition at line 233 of file Ostream.H.
References Ostream::indentSize_.
|
inlinenoexcept |
Change indent size (spaces per level), return old value.
Definition at line 241 of file Ostream.H.
References Ostream::indentSize_.
|
inlinenoexcept |
Return the indent level.
Definition at line 251 of file Ostream.H.
References Ostream::indentLevel_.
|
inlinenoexcept |
Change the indent level, return old value.
Definition at line 259 of file Ostream.H.
References Ostream::indentLevel_.
|
inlinenoexcept |
Increment the indent level.
Definition at line 269 of file Ostream.H.
References Ostream::indentLevel_.
Referenced by Foam::incrIndent().
void decrIndent | ( | ) |
Decrement the indent level.
Definition at line 30 of file Ostream.C.
References Ostream::indentLevel_.
Referenced by Foam::decrIndent().
|
virtual |
Write the keyword followed by an appropriate indentation.
Reimplemented in ensightFile, and ensightGeoFile.
Definition at line 60 of file Ostream.C.
References Foam::indent(), keyType::isPattern(), token::SPACE, and Foam::vtk::write().
Referenced by zoneIdentifier::write(), patchIdentifier::write(), primitiveEntry::write(), ensightCells::writeBox(), ensightFaces::writeDict(), ensightCells::writeDict(), and Ostream::writeEntry().
|
virtual |
Write begin block group with the given name.
Increments indentation, adds newline.
Definition at line 90 of file Ostream.C.
References Foam::beginBlock(), Foam::indent(), keyType::isPattern(), and Foam::vtk::write().
Referenced by Foam::beginBlock(), Foam::operator<<(), Foam::printDOT(), surfacePatch::write(), specie::write(), surfZone::write(), WLFTransport< Thermo >::write(), profilingInformation::write(), rhoConst< Specie >::write(), sutherlandTransport< Thermo >::write(), icoTabulated< Specie >::write(), hConstThermo< EquationOfState >::write(), linear< Type >::write(), perfectFluid< Specie >::write(), eConstThermo< EquationOfState >::write(), janafThermo< EquationOfState >::write(), icoPolynomial< Specie, PolySize >::write(), rPolynomial< Specie >::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), sixDoFRigidBodyMotion::write(), dictionary::write(), mapDistributePolyMesh::writeCellMapEntries(), LookupField< Type >::writeData(), profiling::writeData(), MRFZone::writeData(), MappedFile< Type >::writeData(), setUpdater::writeDict(), perfectInterface::writeDict(), colourTable::writeDict(), layerAdditionRemoval::writeDict(), cellZone::writeDict(), pointZone::writeDict(), attachDetach::writeDict(), PDRblock::gridControl::writeDict(), ensightFaces::writeDict(), ensightCells::writeDict(), plane::writeDict(), engineValve::writeDict(), faceZone::writeDict(), slidingInterface::writeDict(), mapDistribute::writeEntries(), mapDistributeBase::writeEntries(), profilingSysInfo::writeEntry(), cpuInfo::writeEntry(), memInfo::writeEntry(), faBoundaryMesh::writeEntry(), polyBoundaryMesh::writeEntry(), coordinateSystem::writeEntry(), dictionary::writeEntry(), mapDistributePolyMesh::writeFaceMapEntries(), Foam::writeFuncsImpl(), decomposedBlockData::writeHeader(), IOobject::writeHeader(), mapDistributePolyMesh::writePatchMapEntries(), and mapDistributePolyMesh::writePointMapEntries().
|
virtual |
Write begin block group without a name.
Increments indentation, adds newline.
Definition at line 99 of file Ostream.C.
References token::BEGIN_BLOCK, Foam::incrIndent(), Foam::indent(), and Foam::vtk::write().
|
virtual |
Write end block group.
Decrements indentation, adds newline.
Definition at line 108 of file Ostream.C.
References Foam::decrIndent(), token::END_BLOCK, Foam::indent(), and Foam::vtk::write().
Referenced by Foam::endBlock(), Foam::operator<<(), Foam::printDOT(), surfacePatch::write(), specie::write(), surfZone::write(), WLFTransport< Thermo >::write(), profilingInformation::write(), rhoConst< Specie >::write(), sutherlandTransport< Thermo >::write(), icoTabulated< Specie >::write(), hConstThermo< EquationOfState >::write(), linear< Type >::write(), perfectFluid< Specie >::write(), eConstThermo< EquationOfState >::write(), janafThermo< EquationOfState >::write(), icoPolynomial< Specie, PolySize >::write(), rPolynomial< Specie >::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), sixDoFRigidBodyMotion::write(), dictionary::write(), mapDistributePolyMesh::writeCellMapEntries(), profiling::writeData(), MRFZone::writeData(), setUpdater::writeDict(), perfectInterface::writeDict(), colourTable::writeDict(), layerAdditionRemoval::writeDict(), cellZone::writeDict(), pointZone::writeDict(), attachDetach::writeDict(), PDRblock::gridControl::writeDict(), ensightFaces::writeDict(), ensightCells::writeDict(), plane::writeDict(), engineValve::writeDict(), faceZone::writeDict(), slidingInterface::writeDict(), mapDistribute::writeEntries(), mapDistributeBase::writeEntries(), profilingSysInfo::writeEntry(), cpuInfo::writeEntry(), memInfo::writeEntry(), faBoundaryMesh::writeEntry(), polyBoundaryMesh::writeEntry(), coordinateSystem::writeEntry(), dictionary::writeEntry(), mapDistributePolyMesh::writeFaceMapEntries(), Foam::writeFuncsImpl(), decomposedBlockData::writeHeader(), IOobject::writeHeader(), mapDistributePolyMesh::writePatchMapEntries(), and mapDistributePolyMesh::writePointMapEntries().
|
virtual |
Write end entry (';') followed by newline.
Definition at line 117 of file Ostream.C.
References token::END_STATEMENT, and Foam::vtk::write().
Referenced by Foam::endEntry(), Foam::operator<<(), zoneIdentifier::write(), patchIdentifier::write(), primitiveEntry::write(), PDRblock::gridControl::writeDict(), engineValve::writeDict(), faBoundaryMeshEntries::writeEntry(), polyBoundaryMeshEntries::writeEntry(), Ostream::writeEntry(), faBoundaryMesh::writeEntry(), polyBoundaryMesh::writeEntry(), and Foam::writeMaps().
Write a keyword/value entry.
The following two are functionally equivalent:
Definition at line 321 of file Ostream.H.
References Ostream::endEntry(), Foam::glTF::key(), and Ostream::writeKeyword().
Referenced by Foam::operator<<(), thirdBodyEfficiencies::write(), SRIFallOffFunction::write(), TroeFallOffFunction::write(), adjointWallVelocityLowReFvPatchVectorField::write(), adjointOutletPressureFvPatchScalarField::write(), waveDisplacementPointPatchVectorField::write(), coupleGroupIdentifier::write(), boundaryPatch::write(), csvTableReader< Type >::write(), adjointFarFieldVelocityFvPatchVectorField::write(), adjointRotatingWallVelocityFvPatchVectorField::write(), surfacePatch::write(), specie::write(), adjointInletVelocityFvPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), adjointWallVelocityFvPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), adjointOutletVelocityFvPatchVectorField::write(), JohnsonJacksonParticleSlipFvPatchVectorField::write(), waveAlphaFvPatchScalarField::write(), waveVelocityFvPatchVectorField::write(), adjointFarFieldPressureFvPatchScalarField::write(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::write(), JohnsonJacksonParticleThetaFvPatchScalarField::write(), adjointOutletVelocityFluxFvPatchVectorField::write(), surfZone::write(), WLFTransport< Thermo >::write(), profilingInformation::write(), sixDoFRigidBodyMotionState::write(), rhoConst< Specie >::write(), sutherlandTransport< Thermo >::write(), genericPolyPatch::write(), copiedFixedValueFvPatchScalarField::write(), fixedShearStressFvPatchVectorField::write(), acousticWaveTransmissiveFvPatchField< Type >::write(), variableHeightFlowRateInletVelocityFvPatchVectorField::write(), icoTabulated< Specie >::write(), mappedFlowRateFvPatchVectorField::write(), hConstThermo< EquationOfState >::write(), rotatingPressureInletOutletVelocityFvPatchVectorField::write(), linear< Type >::write(), perfectFluid< Specie >::write(), variableHeightFlowRateFvPatchScalarField::write(), surfZoneIdentifier::write(), outletPhaseMeanVelocityFvPatchVectorField::write(), matchedFlowRateOutletVelocityFvPatchVectorField::write(), eConstThermo< EquationOfState >::write(), faceAreaWeightAMI::write(), turbulentIntensityKineticEnergyInletFvPatchScalarField::write(), geometricSurfacePatch::write(), zoneIdentifier::write(), lumpedPointDisplacementPointPatchVectorField::write(), turbulentMixingLengthFrequencyInletFvPatchScalarField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), lumpedMassWallTemperatureFvPatchScalarField::write(), swirlInletVelocityFvPatchVectorField::write(), cylindricalInletVelocityFvPatchVectorField::write(), rotatingWallVelocityFvPatchVectorField::write(), surfaceDisplacementPointPatchVectorField::write(), outletMappedUniformInletHeatAdditionFvPatchField::write(), patchIdentifier::write(), pressureNormalInletOutletVelocityFvPatchVectorField::write(), janafThermo< EquationOfState >::write(), fixedMultiPhaseHeatFluxFvPatchScalarField::write(), swirlFlowRateInletVelocityFvPatchVectorField::write(), icoPolynomial< Specie, PolySize >::write(), SRFFreestreamVelocityFvPatchVectorField::write(), rPolynomial< Specie >::write(), totalTemperatureFvPatchScalarField::write(), waveTransmissiveFvPatchField< Type >::write(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::write(), SRFVelocityFvPatchVectorField::write(), flowRateInletVelocityFvPatchVectorField::write(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::write(), inletOutletTotalTemperatureFvPatchScalarField::write(), advectiveFvPatchField< Type >::write(), uniformTotalPressureFvPatchScalarField::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), uniformDensityHydrostaticPressureFvPatchScalarField::write(), thermalBaffle1DFvPatchScalarField< solidType >::write(), fanPressureFvPatchScalarField::write(), supersonicFreestreamFvPatchVectorField::write(), timeVaryingMassSorptionFvPatchScalarField::write(), outletMachNumberPressureFvPatchScalarField::write(), syringePressureFvPatchScalarField::write(), activeBaffleVelocityFvPatchVectorField::write(), porousBafflePressureFvPatchField::write(), phaseHydrostaticPressureFvPatchScalarField::write(), activePressureForceBaffleVelocityFvPatchVectorField::write(), pressurePIDControlInletVelocityFvPatchVectorField::write(), swirlFanVelocityFvPatchField::write(), oldCyclicPolyPatch::write(), plenumPressureFvPatchScalarField::write(), enthalpySorptionFvPatchScalarField::write(), processorFaPatch::write(), externalWallHeatFluxTemperatureFvPatchScalarField::write(), waveMakerPointPatchVectorField::write(), faPatch::write(), speciesSorptionFvPatchScalarField::write(), cyclicACMIPolyPatch::write(), processorPolyPatch::write(), coupledPolyPatch::write(), processorCyclicPolyPatch::write(), sixDoFRigidBodyMotion::write(), humidityTemperatureCoupledMixedFvPatchScalarField::write(), totalPressureFvPatchScalarField::write(), polyPatch::write(), cyclicPolyPatch::write(), electrostaticDepositionFvPatchScalarField::write(), turbulentDFSEMInletFvPatchVectorField::write(), fvsPatchField< Type >::write(), cyclicAMIPolyPatch::write(), mappedPatchBase::write(), AMIInterpolation::write(), mapDistributePolyMesh::writeCellMapEntries(), RASTurbulenceModel::writeData(), dynamicTopODesignVariables::writeData(), simple::writeData(), adjointSimple::writeData(), MRFZone::writeData(), updateMethod::writeData(), nullSpace::writeData(), MMA::writeData(), lumpedPointMovement::writeData(), setUpdater::writeDict(), perfectInterface::writeDict(), colourTable::writeDict(), layerAdditionRemoval::writeDict(), cellZone::writeDict(), pointZone::writeDict(), attachDetach::writeDict(), lumpedPointState::writeDict(), ensightFaces::writeDict(), ensightCells::writeDict(), plane::writeDict(), engineValve::writeDict(), faceZone::writeDict(), slidingInterface::writeDict(), cpuInfo::writeEntries(), lookupBase::writeEntries(), memInfo::writeEntries(), wallFunctionBlenders::writeEntries(), mapDistribute::writeEntries(), mapDistributeBase::writeEntries(), orientedType::writeEntry(), coordinateSystem::writeEntry(), Ostream::writeEntryIfDifferent(), Foam::writeEntryIfPresent(), mapDistributePolyMesh::writeFaceMapEntries(), genericPatchFieldBase::writeGeneric(), nutUTabulatedWallFunctionFvPatchScalarField::writeLocalEntries(), Foam::writeMaps(), mapDistributePolyMesh::writePatchMapEntries(), and mapDistributePolyMesh::writePointMapEntries().
Write a keyword/value entry only when the two values differ.
key | the name of the entry |
value1 | the reference value |
value2 | the value to write if it differs from value1 |
Definition at line 336 of file Ostream.H.
References Foam::glTF::key(), and Ostream::writeEntry().
Referenced by specie::write(), inclinedFilmNusseltHeightFvPatchScalarField::write(), inclinedFilmNusseltInletVelocityFvPatchVectorField::write(), nearestFaceAMI::write(), interstitialInletVelocityFvPatchVectorField::write(), semiPermeableBaffleVelocityFvPatchVectorField::write(), profilingInformation::write(), mappedVelocityFluxFixedValueFvPatchField::write(), freestreamPressureFvPatchScalarField::write(), mappedFlowRateFvPatchVectorField::write(), hConstThermo< EquationOfState >::write(), variableHeightFlowRateFvPatchScalarField::write(), filmPyrolysisTemperatureCoupledFvPatchScalarField::write(), filmPyrolysisVelocityCoupledFvPatchVectorField::write(), matchedFlowRateOutletVelocityFvPatchVectorField::write(), fixedPressureCompressibleDensityFvPatchScalarField::write(), pressureInletVelocityFvPatchVectorField::write(), eConstThermo< EquationOfState >::write(), turbulentIntensityKineticEnergyInletFvPatchScalarField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), semiPermeableBaffleMassFractionFvPatchScalarField::write(), surfaceDisplacementPointPatchVectorField::write(), outletMappedUniformInletHeatAdditionFvPatchField::write(), pressureInletOutletParSlipVelocityFvPatchVectorField::write(), cyclicPeriodicAMIPolyPatch::write(), swirlFlowRateInletVelocityFvPatchVectorField::write(), flowRateOutletVelocityFvPatchVectorField::write(), waveSurfacePressureFvPatchScalarField::write(), pressureInletOutletVelocityFvPatchVectorField::write(), prghTotalHydrostaticPressureFvPatchScalarField::write(), totalTemperatureFvPatchScalarField::write(), waveTransmissiveFvPatchField< Type >::write(), flowRateInletVelocityFvPatchVectorField::write(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::write(), inletOutletTotalTemperatureFvPatchScalarField::write(), pressureDirectedInletVelocityFvPatchVectorField::write(), pressureDirectedInletOutletVelocityFvPatchVectorField::write(), prghPressureFvPatchScalarField::write(), advectiveFvPatchField< Type >::write(), pressurePermeableAlphaInletOutletVelocityFvPatchVectorField::write(), uniformTotalPressureFvPatchScalarField::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), filmHeightInletVelocityFvPatchVectorField::write(), prghTotalPressureFvPatchScalarField::write(), prghPermeableAlphaTotalPressureFvPatchScalarField::write(), supersonicFreestreamFvPatchVectorField::write(), timeVaryingMassSorptionFvPatchScalarField::write(), outletMachNumberPressureFvPatchScalarField::write(), syringePressureFvPatchScalarField::write(), activeBaffleVelocityFvPatchVectorField::write(), phaseHydrostaticPressureFvPatchScalarField::write(), porousBafflePressureFvPatchField::write(), advancingFrontAMI::write(), activePressureForceBaffleVelocityFvPatchVectorField::write(), pressurePIDControlInletVelocityFvPatchVectorField::write(), swirlFanVelocityFvPatchField::write(), plenumPressureFvPatchScalarField::write(), enthalpySorptionFvPatchScalarField::write(), speciesSorptionFvPatchScalarField::write(), processorCyclicPolyPatch::write(), humidityTemperatureCoupledMixedFvPatchScalarField::write(), totalPressureFvPatchScalarField::write(), electrostaticDepositionFvPatchScalarField::write(), turbulentDFSEMInletFvPatchVectorField::write(), cyclicAMIPolyPatch::write(), mappedPatchBase::write(), cpuInfo::writeEntries(), wallFunctionCoefficients::writeEntries(), nutWallFunctionFvPatchScalarField::writeLocalEntries(), nutUBlendedWallFunctionFvPatchScalarField::writeLocalEntries(), atmNutUWallFunctionFvPatchScalarField::writeLocalEntries(), atmAlphatkWallFunctionFvPatchScalarField::writeLocalEntries(), atmNutkWallFunctionFvPatchScalarField::writeLocalEntries(), nutUSpaldingWallFunctionFvPatchScalarField::writeLocalEntries(), omegaWallFunctionFvPatchScalarField::writeLocalEntries(), epsilonWallFunctionFvPatchScalarField::writeLocalEntries(), and atmNutWallFunctionFvPatchScalarField::writeLocalEntries().
|
pure virtual |
Flush stream.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Add newline and flush stream.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Get padding character.
Implemented in UOPstreamBase, OSstream, and OTstream.
Referenced by Foam::setfill().
|
pure virtual |
Set padding character for formatted field up to field width.
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Get width of output field.
Implemented in UOPstreamBase, OSstream, and OTstream.
Referenced by Foam::setw().
|
pure virtual |
Set width of output field (and return old width)
Implemented in UOPstreamBase, OSstream, and OTstream.
|
pure virtual |
Get precision of output field.
Implemented in UOPstreamBase, OSstream, and OTstream.
Referenced by Foam::setprecision().
|
pure virtual |
Set precision of output field (and return old precision)
Implemented in UOPstreamBase, OSstream, and OTstream.
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
staticprotected |
|
protected |
Number of spaces per indent level.
Definition at line 72 of file Ostream.H.
Referenced by Ostream::indentSize().
|
protected |
Current indent level.
Definition at line 77 of file Ostream.H.
Referenced by Ostream::decrIndent(), Ostream::incrIndent(), and Ostream::indentLevel().