Base class for writing coordSet(s) and tracks with fields. More...
#include <coordSetWriter.H>


Public Member Functions | |
| TypeName ("coordSetWriter") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, coordSetWriter, word,(),()) | |
| declareRunTimeSelectionTable (autoPtr, coordSetWriter, wordDict,(const dictionary &writeOptions),(writeOptions)) | |
| coordSetWriter () | |
| Default construct. | |
| coordSetWriter (const dictionary &options) | |
| Default construct with specified options. | |
| virtual | ~coordSetWriter () |
| Destructor. Calls close(). | |
| virtual bool | buffering () const |
| True if the format uses internal buffering (eg, column output). | |
| virtual bool | buffering (const bool on) |
| Turn internal buffering on/off (only if supported by the writer). | |
| virtual bool | enabled () const |
| The writer is enabled. If the writer is not enabled, it may be possible for the caller to skip various preparatory operations. | |
| virtual bool | needsUpdate () const |
| Does the writer need an update (eg, lagging behind other changes). | |
| virtual bool | wroteData () const |
| Geometry or fields written since the last open? | |
| virtual bool | expire () |
| Mark that content changed and the writer will need an update, and set nFields = 0. | |
| virtual void | clear () |
| Close any open output, remove coordSet associations and expire the writer. | |
| virtual void | setCoordinates (const coordSet *coords) |
| Set coordinates, can also be nullptr. | |
| virtual void | setCoordinates (const coordSet &coords) |
| Set coordinates. | |
| virtual void | setTracks (const UPtrList< coordSet > &tracks) |
| Set track coordinates. | |
| virtual void | setTrackTimes (const UList< scalarField > ×) |
| Set track times. | |
| label | numPoints () const |
| The number of associated points (local processor). | |
| label | numTracks () const |
| The number of coordinate tracks. | |
| bool | hasCoords () const |
| Writer is associated with content. | |
| bool | empty () const |
| Writer is not associated with content. | |
| bool | is_open () const noexcept |
| Test if outputPath has been set. | |
| label | nFields () const noexcept |
| The number of expected output fields. | |
| label | nFields (const label n) noexcept |
| Set the number of expected output fields. | |
| bool | useTracks () const noexcept |
| Prefer tracks to points during single set writing. | |
| bool | useTracks (const bool on) noexcept |
| Enable/disable tracks preference. | |
| bool | useTimeDir () const noexcept |
| Should a time directory be spliced into the output path? | |
| bool | useTimeDir (const bool on) noexcept |
| Enable/disable use of spliced output path. | |
| bool | verbose () const noexcept |
| Get output verbosity. | |
| bool | verbose (bool on) noexcept |
| Enable/disable verbose output. | |
| bool | hasTime () const |
| True if there is a known time. | |
| const word & | timeName () const |
| The current time value/name. | |
| scalar | timeValue () const |
| The current time value/name. | |
| void | setTime (const instant &inst) |
| Set the current time. | |
| void | setTime (scalar timeValue) |
| Set current time from timeValue, auto generating the name. | |
| void | setTime (scalar timeValue, const word &timeName) |
| Set current time from timeValue and timeName. | |
| void | unsetTime () |
| Clear the current time. | |
| virtual void | beginTime (const Time &t) |
| Begin a time-step. | |
| virtual void | beginTime (const instant &inst) |
| Begin a time-step. | |
| virtual void | endTime () |
| End a time-step. | |
| virtual fileName | path () const =0 |
| Expected (characteristic) output file name - information only. Return empty when is_open() is false. | |
| virtual void | open (const fileName &outputPath) |
| Write separate geometry to file. | |
| virtual void | open (const coordSet &coords, const fileName &outputPath) |
| Open from components. | |
| virtual void | open (const UPtrList< coordSet > &tracks, const fileName &outputPath) |
| Open from components. | |
| virtual void | close (bool force=false) |
| Finish output, performing any necessary cleanup. | |
| virtual InfoProxy< coordSetWriter > | info () const |
| Return info proxy, used to print information to a stream. | |
| virtual fileName | write (const word &fieldName, const Field< label > &field)=0 |
| Write field of label (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< label > > &fieldValues)=0 |
| Write track fields of label (point data). | |
| virtual fileName | write (const word &fieldName, const Field< scalar > &field)=0 |
| Write field of scalar (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< scalar > > &fieldValues)=0 |
| Write track fields of scalar (point data). | |
| virtual fileName | write (const word &fieldName, const Field< vector > &field)=0 |
| Write field of vector (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< vector > > &fieldValues)=0 |
| Write track fields of vector (point data). | |
| virtual fileName | write (const word &fieldName, const Field< sphericalTensor > &field)=0 |
| Write field of sphericalTensor (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< sphericalTensor > > &fieldValues)=0 |
| Write track fields of sphericalTensor (point data). | |
| virtual fileName | write (const word &fieldName, const Field< symmTensor > &field)=0 |
| Write field of symmTensor (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< symmTensor > > &fieldValues)=0 |
| Write track fields of symmTensor (point data). | |
| virtual fileName | write (const word &fieldName, const Field< tensor > &field)=0 |
| Write field of tensor (point data). | |
| virtual fileName | write (const word &fieldName, const List< Field< tensor > > &fieldValues)=0 |
| Write track fields of tensor (point data). | |
| template<class Type> | |
| Foam::tmp< Foam::Field< Type > > | adjustFieldTemplate (const word &fieldName, const tmp< Field< Type > > &tfield) const |
| template<class Type> | |
| Foam::UPtrList< const Foam::Field< Type > > | repackageFields (const Field< Type > &field) |
| template<class Type> | |
| Foam::UPtrList< const Foam::Field< Type > > | repackageFields (const UList< Field< Type > > &fieldValues) |
Static Public Member Functions | |
| static dictionary | formatOptions (const dictionary &dict, const word &formatName, const word &entryName="formatOptions") |
| Same as fileFormats::getFormatOptions. | |
| static dictionary | formatOptions (const dictionary &dict, const dictionary &setDict, const word &formatName, const word &entryName="formatOptions") |
| Same as fileFormats::getFormatOptions. | |
| static bool | supportedType (const word &writeType) |
| True if New is likely to succeed for this writeType. | |
| static autoPtr< coordSetWriter > | New (const word &writeFormat) |
| Return a reference to the selected writer. | |
| static autoPtr< coordSetWriter > | New (const word &writeFormat, const dictionary &writeOptions) |
| Return a reference to the selected writer. | |
| static word | suffix (const word &fldName, const word &fileExt=word::null) |
| Name suffix based on fieldName (underscore separator). | |
| static word | suffix (const wordList &fieldNames, const word &fileExt=word::null) |
| Name suffix based on fieldNames (underscore separator). | |
Protected Member Functions | |
| void | appendField (const word &fieldName, const Field< label > &vals) |
| void | appendField (const word &fieldName, const Field< scalar > &vals) |
| void | appendField (const word &fieldName, const Field< vector > &vals) |
| void | appendField (const word &fieldName, const Field< sphericalTensor > &vals) |
| void | appendField (const word &fieldName, const Field< symmTensor > &vals) |
| void | appendField (const word &fieldName, const Field< tensor > &vals) |
| void | clearBuffers () |
| Clear out buffering. | |
| label | nDataColumns () const |
| The number of buffer data columns, after splitting into components. | |
| virtual bool | writeBuffered () |
| Write buffered data. | |
| void | writeBufferContents (Ostream &os, const coordSet &coords, const char *sep) const |
| Write buffered data. | |
| void | getBufferLine (DynamicList< scalar > &buf, const coordSet &coords, const label pointi) const |
| Get buffered data line (components). | |
| fileName | getExpectedPath (const word &fileExt=word::null) const |
| Get expected (characteristic) output file name - information only. | |
| fileName | getFieldPrefixedPath (const word &fieldName, const word &fileExt=word::null) const |
| Get field-prefixed output file name. | |
| void | checkOpen () const |
| Verify that the outputPath_ has been set or FatalError. | |
| virtual bool | merge () const |
| Perform any merging if not already upToDate (parallel) or simply mark as being up-to-date. | |
| template<class Type> | |
| tmp< Field< Type > > | adjustFieldTemplate (const word &fieldName, const tmp< Field< Type > > &tfield) const |
| template<class Type> | |
| fileName | writeTemplate (const word &fieldName, const Field< Type > &values) |
| Dummy templated write operation. | |
| template<class Type> | |
| fileName | writeTemplate (const word &fieldName, const List< Field< Type > > &fieldValues) |
| Dummy templated write operation. Multiple tracks. | |
| coordSetWriter (const coordSetWriter &)=delete | |
| No copy construct. | |
| void | operator= (const coordSetWriter &)=delete |
| No copy assignment. | |
Static Protected Member Functions | |
| static void | writeLine (Ostream &, const UList< word > &, const char *sep) |
| Write line contents (eg, buffered). | |
| static void | writeLine (Ostream &, const UList< scalar > &, const char *sep) |
| Write line contents (eg, buffered). | |
| template<class Type> | |
| static UPtrList< const Field< Type > > | repackageFields (const Field< Type > &field) |
| Repackage field into a UPtrList. | |
| template<class Type> | |
| static UPtrList< const Field< Type > > | repackageFields (const UList< Field< Type > > &fieldValues) |
| Repackage multiple fields into a UPtrList. | |
| template<class Type> | |
| static void | writeTable (Ostream &os, const coordSet &coords, const UList< Type > &values, const char *sep) |
| Write coordinates and values. | |
Protected Attributes | |
| UPtrList< const coordSet > | coords_ |
| Reference to coordinate set(s). | |
| List< scalarField > | trackTimes_ |
| Track times (eg, streamlines), one per coords_ entry. | |
| bool | upToDate_ |
| The content is up-to-date? | |
| bool | wroteGeom_ |
| Track if geometry has been written since the last open. | |
| bool | buffering_ |
| Writer with buffering output. | |
| bool | useTracks_ |
| Prefer tracks to points during single set writing. | |
| bool | useTimeDir_ |
| Insert additional time sub-directory in the output path. | |
| bool | verbose_ |
| Additional output verbosity. | |
| label | nFields_ |
| The number of fields. | |
| instant | currTime_ |
| The current time value/name. | |
| fileName | outputPath_ |
| The full output directory and file (coords) name. | |
| scalar | geometryScale_ |
| Output geometry scaling after rotate/translate. | |
| point | geometryCentre_ |
| The centre of rotation (untranslate, translate). | |
| coordSystem::cartesian | geometryTransform_ |
| Local coordinate system transformation. | |
| dictionary | fieldLevel_ |
| Field level to remove (on output). | |
| dictionary | fieldScale_ |
| Field scaling (on output). | |
| DynamicList< word > | labelNames_ |
| PtrDynList< Field< label > > | labelFields_ |
| DynamicList< word > | scalarNames_ |
| PtrDynList< Field< scalar > > | scalarFields_ |
| DynamicList< word > | vectorNames_ |
| PtrDynList< Field< vector > > | vectorFields_ |
| DynamicList< word > | sphericalTensorNames_ |
| PtrDynList< Field< sphericalTensor > > | sphericalTensorFields_ |
| DynamicList< word > | symmTensorNames_ |
| PtrDynList< Field< symmTensor > > | symmTensorFields_ |
| DynamicList< word > | tensorNames_ |
| PtrDynList< Field< tensor > > | tensorFields_ |
Friends | |
| Ostream & | operator<< (Ostream &os, const InfoProxy< coordSetWriter > &iproxy) |
| Output info proxy. | |
Base class for writing coordSet(s) and tracks with fields.
Example:
coordSet coords(...);
// Construct writer of xmgr type
autoPtr<coordSetWriter> writer(coordSetWriter::New("vtk"));
writer.open(coords, path/name);
writer.write("density", rho);
writer.write("velocity", U);
Definition at line 82 of file coordSetWriter.H.
|
protecteddelete |
No copy construct.
References coordSetWriter().
Referenced by abaqusWriter::abaqusWriter(), abaqusWriter::abaqusWriter(), coordSetWriter(), coordSetWriter(), csvWriter::csvWriter(), csvWriter::csvWriter(), declareRunTimeSelectionTable(), declareRunTimeSelectionTable(), ensightWriter::ensightWriter(), ensightWriter::ensightWriter(), gltfWriter::gltfWriter(), gltfWriter::gltfWriter(), gnuplotWriter::gnuplotWriter(), gnuplotWriter::gnuplotWriter(), info(), nastranWriter::nastranWriter(), nastranWriter::nastranWriter(), nullWriter::nullWriter(), operator=(), rawWriter::rawWriter(), rawWriter::rawWriter(), xmgraceWriter::xmgraceWriter(), and xmgraceWriter::xmgraceWriter().


| coordSetWriter | ( | ) |
Default construct.
Definition at line 100 of file coordSetWriter.C.
References buffering_, coords_, currTime_, fieldLevel_, fieldScale_, geometryCentre_, geometryScale_, geometryTransform_, nFields_, outputPath_, trackTimes_, upToDate_, useTimeDir_, useTracks_, verbose_, wroteGeom_, and Foam::Zero.
|
explicit |
Default construct with specified options.
Definition at line 122 of file coordSetWriter.C.
References coordSetWriter(), fieldLevel_, fieldScale_, dictionary::findDict(), geometryCentre_, geometryScale_, geometryTransform_, IOobjectOption::LAZY_READ, keyType::LITERAL, dictionary::readIfPresent(), dictionary::subOrEmptyDict(), verbose_, and Foam::Zero.

|
virtual |
Destructor. Calls close().
Definition at line 153 of file coordSetWriter.C.
References close().

Definition at line 190 of file coordSetWriter.H.
Referenced by csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), and rawWriter::writeTemplate().

Definition at line 191 of file coordSetWriter.H.
Definition at line 192 of file coordSetWriter.H.
|
inlineprotected |
Definition at line 193 of file coordSetWriter.H.
|
inlineprotected |
Definition at line 194 of file coordSetWriter.H.
Definition at line 195 of file coordSetWriter.H.
References word::null, and os().

Write line contents (eg, buffered).
Definition at line 25 of file coordSetWriterBuffers.C.
References forAll, Foam::nl, and os().
Referenced by writeBufferContents(), and csvWriter::writeBuffered().


Write line contents (eg, buffered).
Definition at line 44 of file coordSetWriterBuffers.C.
References forAll, Foam::nl, and os().

|
protected |
Clear out buffering.
Definition at line 63 of file coordSetWriterBuffers.C.
References doLocalCode.
Referenced by clear(), close(), endTime(), setCoordinates(), setTracks(), csvWriter::writeBuffered(), gnuplotWriter::writeBuffered(), and rawWriter::writeBuffered().

|
protected |
The number of buffer data columns, after splitting into components.
Definition at line 82 of file coordSetWriterBuffers.C.
References doLocalCode.
Referenced by close(), endTime(), writeBufferContents(), and csvWriter::writeBuffered().

|
protectedvirtual |
Write buffered data.
Reimplemented in csvWriter, gnuplotWriter, and rawWriter.
Definition at line 149 of file coordSetWriterBuffers.C.
Referenced by close(), and endTime().

|
protected |
Write buffered data.
Definition at line 155 of file coordSetWriterBuffers.C.
References getBufferLine(), nDataColumns(), os(), UList< T >::size(), and writeLine().
Referenced by csvWriter::writeBuffered(), and rawWriter::writeBuffered().


|
protected |
Get buffered data line (components).
Definition at line 102 of file coordSetWriterBuffers.C.
References DynamicList< T, SizeMin >::append(), DynamicList< T, SizeMin >::clear(), doLocalCode, coordSet::hasVectorAxis(), p, coordSet::scalarCoord(), and coordSet::vectorCoord().
Referenced by writeBufferContents().


|
protected |
Get expected (characteristic) output file name - information only.
Definition at line 388 of file coordSetWriter.C.
References empty(), fileName::ext(), outputPath_, timeName, and useTimeDir().
Referenced by getFieldPrefixedPath(), abaqusWriter::path(), csvWriter::path(), gltfWriter::path(), gnuplotWriter::path(), nastranWriter::path(), rawWriter::path(), and xmgraceWriter::path().


|
protected |
Get field-prefixed output file name.
Eg, dir/U_name.raw
Definition at line 414 of file coordSetWriter.C.
References empty(), fileName::ext(), getExpectedPath(), outputPath_, timeName, and useTimeDir().
Referenced by csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), rawWriter::writeTemplate(), and xmgraceWriter::writeTemplate().


|
protected |
Verify that the outputPath_ has been set or FatalError.
Definition at line 446 of file coordSetWriter.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, is_open(), Foam::nl, and Foam::type().
Referenced by ensightWriter::writeCollated(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), csvWriter::writeTemplate(), csvWriter::writeTemplate(), ensightWriter::writeTemplate(), ensightWriter::writeTemplate(), gltfWriter::writeTemplate(), gltfWriter::writeTemplate(), gnuplotWriter::writeTemplate(), gnuplotWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), xmgraceWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().


|
protectedvirtual |
Perform any merging if not already upToDate (parallel) or simply mark as being up-to-date.
Definition at line 457 of file coordSetWriter.C.
References upToDate_, and wroteGeom_.
Referenced by ensightWriter::writeCollated(), and ensightWriter::writeUncollated().

|
staticprotected |
Repackage field into a UPtrList.
References field().
Referenced by csvWriter::writeTemplate(), csvWriter::writeTemplate(), ensightWriter::writeTemplate(), ensightWriter::writeTemplate(), gltfWriter::writeTemplate(), gltfWriter::writeTemplate(), gnuplotWriter::writeTemplate(), gnuplotWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), and xmgraceWriter::writeTemplate().


|
staticprotected |
Write coordinates and values.
Definition at line 157 of file coordSetWriterTemplates.C.
References Foam::component(), forAll, coordSet::hasVectorAxis(), Foam::nl, os(), p, coordSet::scalarCoord(), and coordSet::vectorCoord().
Referenced by csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), and xmgraceWriter::writeTemplate().


|
inlineprotected |
Dummy templated write operation.
if (!wroteGeom_) { return this->write(); }
| fieldName | Name of field |
| values | Local field values to write |
Definition at line 327 of file coordSetWriter.H.
References fileName::null.
|
inlineprotected |
Dummy templated write operation. Multiple tracks.
Definition at line 344 of file coordSetWriter.H.
References fileName::null.
|
protecteddelete |
| TypeName | ( | "coordSetWriter" | ) |
Runtime type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| coordSetWriter | , | ||
| word | , | ||
| () | , | ||
| () | ) |
| declareRunTimeSelectionTable | ( | autoPtr | , |
| coordSetWriter | , | ||
| wordDict | , | ||
| (const dictionary &writeOptions) | , | ||
| (writeOptions) | ) |
|
static |
Same as fileFormats::getFormatOptions.
Definition at line 75 of file coordSetWriter.C.
References dict, and Foam::fileFormats::getFormatOptions().
Referenced by ParticleZoneInfo< CloudType >::ParticleZoneInfo().


|
static |
Same as fileFormats::getFormatOptions.
Definition at line 86 of file coordSetWriter.C.
References dict, and Foam::fileFormats::getFormatOptions().

|
static |
True if New is likely to succeed for this writeType.
Definition at line 26 of file coordSetWriterNew.C.
|
static |
Return a reference to the selected writer.
Definition at line 36 of file coordSetWriterNew.C.
References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.
Referenced by ParticleZoneInfo< CloudType >::ParticleZoneInfo(), particleDistribution::read(), regionSizeDistribution::read(), and streamLineBase::read().


|
static |
Return a reference to the selected writer.
Select with extra write option
Definition at line 57 of file coordSetWriterNew.C.
References Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

|
static |
Name suffix based on fieldName (underscore separator).
Definition at line 38 of file coordSetWriter.C.
References word::ext().

|
static |
Name suffix based on fieldNames (underscore separator).
Definition at line 55 of file coordSetWriter.C.
References word::ext().

|
virtual |
True if the format uses internal buffering (eg, column output).
Reimplemented in nullWriter.
Definition at line 177 of file coordSetWriterBuffers.C.
References buffering_.
|
virtual |
Turn internal buffering on/off (only if supported by the writer).
Reimplemented in csvWriter, gnuplotWriter, rawWriter, and xmgraceWriter.
Definition at line 184 of file coordSetWriterBuffers.C.
References buffering_.
|
inlinevirtual |
The writer is enabled. If the writer is not enabled, it may be possible for the caller to skip various preparatory operations.
This method is primarily useful for the null writer
Reimplemented in nullWriter.
Definition at line 502 of file coordSetWriter.H.
|
virtual |
Does the writer need an update (eg, lagging behind other changes).
Reimplemented in nullWriter.
Definition at line 349 of file coordSetWriter.C.
References upToDate_.
|
virtual |
Geometry or fields written since the last open?
Reimplemented in nullWriter.
Definition at line 355 of file coordSetWriter.C.
References wroteGeom_.
|
virtual |
Mark that content changed and the writer will need an update, and set nFields = 0.
May also free up unneeded data. Return false if it was previously already expired.
Definition at line 361 of file coordSetWriter.C.
References coords_, trackTimes_, upToDate_, and wroteGeom_.
Referenced by clear(), setCoordinates(), and setTracks().

|
virtual |
Close any open output, remove coordSet associations and expire the writer.
Definition at line 265 of file coordSetWriter.C.
References clearBuffers(), close(), coords_, expire(), and trackTimes_.

|
virtual |
Set coordinates, can also be nullptr.
Reimplemented in nullWriter.
Definition at line 275 of file coordSetWriter.C.
References clearBuffers(), coords_, expire(), and trackTimes_.
Referenced by open(), and setCoordinates().


|
virtual |
Set coordinates.
Reimplemented in nullWriter.
Definition at line 293 of file coordSetWriter.C.
References setCoordinates().

Set track coordinates.
Reimplemented in nullWriter.
Definition at line 299 of file coordSetWriter.C.
References clearBuffers(), coords_, expire(), forAll, UPtrList< T >::get(), UPtrList< T >::size(), trackTimes_, and useTracks_.
Referenced by open().


|
virtual |
Set track times.
Definition at line 316 of file coordSetWriter.C.
References coords_, UList< T >::size(), and trackTimes_.

| Foam::label numPoints | ( | ) | const |
The number of associated points (local processor).
Definition at line 329 of file coordSetWriter.C.
| Foam::label numTracks | ( | ) | const |
The number of coordinate tracks.
Definition at line 343 of file coordSetWriter.C.
References coords_.
| bool hasCoords | ( | ) | const |
Writer is associated with content.
Definition at line 377 of file coordSetWriter.C.
References coords_.
| bool empty | ( | ) | const |
Writer is not associated with content.
Definition at line 383 of file coordSetWriter.C.
References coords_.
Referenced by getExpectedPath(), getFieldPrefixedPath(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().

|
inlinenoexcept |
Test if outputPath has been set.
Definition at line 23 of file coordSetWriterI.H.
References Foam::noexcept, and outputPath_.
Referenced by checkOpen().

|
inlinenoexcept |
The number of expected output fields.
Currently only used by the legacy VTK format.
Definition at line 29 of file coordSetWriterI.H.
References nFields_, and Foam::noexcept.
|
inlinenoexcept |
Set the number of expected output fields.
Currently only used by the legacy VTK format.
Definition at line 35 of file coordSetWriterI.H.
|
inlinenoexcept |
Prefer tracks to points during single set writing.
Definition at line 43 of file coordSetWriterI.H.
References Foam::noexcept, and useTracks_.
|
inlinenoexcept |
Enable/disable tracks preference.
Definition at line 49 of file coordSetWriterI.H.
References useTracks_.
|
inlinenoexcept |
Should a time directory be spliced into the output path?
Definition at line 57 of file coordSetWriterI.H.
References Foam::noexcept, and useTimeDir_.
Referenced by abaqusWriter::abaqusWriter(), abaqusWriter::abaqusWriter(), getExpectedPath(), getFieldPrefixedPath(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().

|
inlinenoexcept |
Enable/disable use of spliced output path.
Definition at line 63 of file coordSetWriterI.H.
References useTimeDir_.
|
inlinenoexcept |
Get output verbosity.
Definition at line 71 of file coordSetWriterI.H.
References Foam::noexcept, and verbose_.
|
inlinenoexcept |
Enable/disable verbose output.
Definition at line 77 of file coordSetWriterI.H.
References verbose_.
|
inline |
True if there is a known time.
Definition at line 85 of file coordSetWriterI.H.
References currTime_.
|
inline |
The current time value/name.
Definition at line 91 of file coordSetWriterI.H.
References currTime_.
Referenced by setTime().

|
inline |
The current time value/name.
Definition at line 97 of file coordSetWriterI.H.
References currTime_.
Referenced by setTime(), setTime(), ensightWriter::writeCollated(), ensightWriter::writeCollated(), nastranWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().

| void setTime | ( | const instant & | inst | ) |
| void setTime | ( | scalar | timeValue | ) |
Set current time from timeValue, auto generating the name.
Definition at line 167 of file coordSetWriter.C.
References currTime_, and timeValue().

| void setTime | ( | scalar | timeValue, |
| const word & | timeName ) |
Set current time from timeValue and timeName.
Definition at line 173 of file coordSetWriter.C.
References currTime_, timeName(), and timeValue().

| void unsetTime | ( | ) |
Clear the current time.
Definition at line 180 of file coordSetWriter.C.
References currTime_.
Referenced by endTime().

|
virtual |
Begin a time-step.
Reimplemented in gltfWriter, vtkWriter, and xmgraceWriter.
Definition at line 187 of file coordSetWriter.C.
References setTime(), Time::timeName(), and dimensioned< Type >::value().
Referenced by gltfWriter::beginTime(), gltfWriter::beginTime(), xmgraceWriter::beginTime(), and xmgraceWriter::beginTime().


|
virtual |
Begin a time-step.
Reimplemented in gltfWriter, vtkWriter, and xmgraceWriter.
Definition at line 193 of file coordSetWriter.C.
References setTime().

|
virtual |
End a time-step.
Reimplemented in gltfWriter, vtkWriter, and xmgraceWriter.
Definition at line 199 of file coordSetWriter.C.
References clearBuffers(), nDataColumns(), unsetTime(), and writeBuffered().
Referenced by gltfWriter::endTime(), and xmgraceWriter::endTime().


|
pure virtual |
Expected (characteristic) output file name - information only. Return empty when is_open() is false.
Implemented in abaqusWriter, csvWriter, ensightWriter, gltfWriter, gnuplotWriter, nastranWriter, nullWriter, rawWriter, vtkWriter, and xmgraceWriter.
References close(), open(), and path().
Referenced by path().


|
virtual |
Write separate geometry to file.
/ TBD: virtual fileName write() = 0;
Open for output on specified path, using existing content
Reimplemented in nullWriter.
Definition at line 214 of file coordSetWriter.C.
References outputPath_, and wroteGeom_.
Referenced by abaqusWriter::abaqusWriter(), abaqusWriter::abaqusWriter(), csvWriter::csvWriter(), csvWriter::csvWriter(), ensightWriter::ensightWriter(), ensightWriter::ensightWriter(), gltfWriter::gltfWriter(), gltfWriter::gltfWriter(), gnuplotWriter::gnuplotWriter(), gnuplotWriter::gnuplotWriter(), nastranWriter::nastranWriter(), nastranWriter::nastranWriter(), open(), open(), path(), rawWriter::rawWriter(), rawWriter::rawWriter(), xmgraceWriter::xmgraceWriter(), and xmgraceWriter::xmgraceWriter().

Open from components.
Definition at line 221 of file coordSetWriter.C.
References close(), open(), and setCoordinates().

Open from components.
Definition at line 233 of file coordSetWriter.C.
References close(), open(), and setTracks().

|
virtual |
Finish output, performing any necessary cleanup.
Optional force disassociation with any coordSet(s)
Reimplemented in ensightWriter, gltfWriter, vtkWriter, and xmgraceWriter.
Definition at line 245 of file coordSetWriter.C.
References clearBuffers(), coords_, Foam::Info, nDataColumns(), Foam::nl, outputPath_, trackTimes_, verbose_, writeBuffered(), and wroteGeom_.
Referenced by clear(), ensightWriter::close(), gltfWriter::close(), xmgraceWriter::close(), open(), open(), path(), abaqusWriter::~abaqusWriter(), ~coordSetWriter(), csvWriter::~csvWriter(), gnuplotWriter::~gnuplotWriter(), nastranWriter::~nastranWriter(), and rawWriter::~rawWriter().


|
inlinevirtual |
Return info proxy, used to print information to a stream.
Definition at line 744 of file coordSetWriter.H.
References coordSetWriter(), and info().
Referenced by info().


|
pure virtual |
Write track fields of label (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
|
pure virtual |
Write track fields of scalar (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
|
pure virtual |
Write track fields of vector (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
|
pure virtual |
Write field of sphericalTensor (point data).
|
pure virtual |
Write track fields of sphericalTensor (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
|
pure virtual |
Write field of symmTensor (point data).
|
pure virtual |
Write track fields of symmTensor (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
|
pure virtual |
Write track fields of tensor (point data).
| fieldName | Name of field |
| fieldValues | Per-track values |
| Foam::tmp< Foam::Field< Type > > adjustFieldTemplate | ( | const word & | fieldName, |
| const tmp< Field< Type > > & | tfield ) const |
Definition at line 26 of file coordSetWriterTemplates.C.
References Foam::equal(), fieldLevel_, fieldScale_, geometryTransform_, Foam::Info, Foam::is_rotational_vectorspace_v, Foam::is_vectorspace_v, tmp< T >::ref(), keyType::REGEX, tmp< T >::reset(), Foam::transform(), and verbose_.

| Foam::UPtrList< const Foam::Field< Type > > repackageFields | ( | const Field< Type > & | field | ) |
Definition at line 133 of file coordSetWriterTemplates.C.
References field(), and UPtrList< T >::set().

| Foam::UPtrList< const Foam::Field< Type > > repackageFields | ( | const UList< Field< Type > > & | fieldValues | ) |
Definition at line 144 of file coordSetWriterTemplates.C.
References forAll, and UPtrList< T >::set().

|
friend |
Output info proxy.
References os().
Reference to coordinate set(s).
Definition at line 91 of file coordSetWriter.H.
Referenced by clear(), close(), coordSetWriter(), empty(), expire(), hasCoords(), numPoints(), numTracks(), setCoordinates(), setTracks(), setTrackTimes(), csvWriter::writeBuffered(), gnuplotWriter::writeBuffered(), rawWriter::writeBuffered(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), csvWriter::writeTemplate(), csvWriter::writeTemplate(), csvWriter::writeTemplate(), ensightWriter::writeTemplate(), ensightWriter::writeTemplate(), gltfWriter::writeTemplate(), gltfWriter::writeTemplate(), gltfWriter::writeTemplate(), gnuplotWriter::writeTemplate(), gnuplotWriter::writeTemplate(), gnuplotWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), xmgraceWriter::writeTemplate(), xmgraceWriter::writeTemplate(), and gltfWriter::writeTemplate_animate().
|
protected |
Track times (eg, streamlines), one per coords_ entry.
Definition at line 96 of file coordSetWriter.H.
Referenced by clear(), close(), coordSetWriter(), expire(), setCoordinates(), setTracks(), setTrackTimes(), gltfWriter::writeTemplate(), and gltfWriter::writeTemplate_animate().
|
mutableprotected |
The content is up-to-date?
Definition at line 101 of file coordSetWriter.H.
Referenced by coordSetWriter(), expire(), merge(), needsUpdate(), ensightWriter::writeCollated(), and ensightWriter::writeCollated().
|
mutableprotected |
Track if geometry has been written since the last open.
Definition at line 106 of file coordSetWriter.H.
Referenced by close(), coordSetWriter(), expire(), merge(), open(), ensightWriter::writeCollated(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), vtkWriter::writeTemplate(), xmgraceWriter::writeTemplate(), ensightWriter::writeUncollated(), ensightWriter::writeUncollated(), and wroteData().
|
mutableprotected |
Writer with buffering output.
//- Writing in parallel (via master) bool parallel_;
Definition at line 114 of file coordSetWriter.H.
Referenced by buffering(), buffering(), csvWriter::buffering(), gnuplotWriter::buffering(), rawWriter::buffering(), xmgraceWriter::buffering(), coordSetWriter(), csvWriter::csvWriter(), csvWriter::csvWriter(), gnuplotWriter::gnuplotWriter(), gnuplotWriter::gnuplotWriter(), rawWriter::rawWriter(), rawWriter::rawWriter(), csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), xmgraceWriter::xmgraceWriter(), and xmgraceWriter::xmgraceWriter().
|
protected |
Prefer tracks to points during single set writing.
Definition at line 119 of file coordSetWriter.H.
Referenced by coordSetWriter(), setTracks(), useTracks(), useTracks(), abaqusWriter::writeTemplate(), csvWriter::writeTemplate(), csvWriter::writeTemplate(), ensightWriter::writeTemplate(), gnuplotWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), xmgraceWriter::writeTemplate(), and xmgraceWriter::writeTemplate().
|
protected |
Insert additional time sub-directory in the output path.
Definition at line 124 of file coordSetWriter.H.
Referenced by coordSetWriter(), useTimeDir(), and useTimeDir().
|
protected |
Additional output verbosity.
Definition at line 129 of file coordSetWriter.H.
Referenced by adjustFieldTemplate(), close(), coordSetWriter(), coordSetWriter(), verbose(), verbose(), ensightWriter::writeCollated(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), abaqusWriter::writeTemplate(), csvWriter::writeTemplate(), gnuplotWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), rawWriter::writeTemplate(), vtkWriter::writeTemplate(), xmgraceWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().
|
protected |
The number of fields.
Definition at line 134 of file coordSetWriter.H.
Referenced by coordSetWriter(), nFields(), nFields(), and vtkWriter::writeTemplate().
|
protected |
The current time value/name.
Definition at line 139 of file coordSetWriter.H.
Referenced by coordSetWriter(), hasTime(), setTime(), setTime(), setTime(), timeName(), timeValue(), unsetTime(), ensightWriter::writeCollated(), ensightWriter::writeCollated(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().
|
protected |
The full output directory and file (coords) name.
Definition at line 144 of file coordSetWriter.H.
Referenced by close(), coordSetWriter(), getExpectedPath(), getFieldPrefixedPath(), is_open(), open(), ensightWriter::path(), ensightWriter::writeCollated(), ensightWriter::writeCollated(), abaqusWriter::writeTemplate(), nastranWriter::writeTemplate(), rawWriter::writeTemplate(), ensightWriter::writeUncollated(), and ensightWriter::writeUncollated().
|
protected |
Output geometry scaling after rotate/translate.
Definition at line 149 of file coordSetWriter.H.
Referenced by coordSetWriter(), and coordSetWriter().
|
protected |
The centre of rotation (untranslate, translate).
Definition at line 154 of file coordSetWriter.H.
Referenced by coordSetWriter(), and coordSetWriter().
|
protected |
Local coordinate system transformation.
Definition at line 159 of file coordSetWriter.H.
Referenced by adjustFieldTemplate(), coordSetWriter(), and coordSetWriter().
|
protected |
Field level to remove (on output).
Definition at line 164 of file coordSetWriter.H.
Referenced by adjustFieldTemplate(), coordSetWriter(), and coordSetWriter().
|
protected |
Field scaling (on output).
Definition at line 169 of file coordSetWriter.H.
Referenced by adjustFieldTemplate(), coordSetWriter(), and coordSetWriter().
|
protected |
Definition at line 190 of file coordSetWriter.H.
Referenced by csvWriter::writeBuffered().
|
protected |
Definition at line 190 of file coordSetWriter.H.
|
protected |
Definition at line 191 of file coordSetWriter.H.
Referenced by csvWriter::writeBuffered().
|
protected |
Definition at line 191 of file coordSetWriter.H.
|
protected |
Definition at line 192 of file coordSetWriter.H.
|
protected |
Definition at line 192 of file coordSetWriter.H.
|
protected |
Definition at line 193 of file coordSetWriter.H.
|
protected |
Definition at line 193 of file coordSetWriter.H.
|
protected |
Definition at line 194 of file coordSetWriter.H.
|
protected |
Definition at line 194 of file coordSetWriter.H.
|
protected |
Definition at line 195 of file coordSetWriter.H.
|
protected |
Definition at line 195 of file coordSetWriter.H.