starcdWriter Class Reference

A surfaceWriter for STARCD files. More...

Inheritance diagram for starcdWriter:
[legend]
Collaboration diagram for starcdWriter:
[legend]

Public Member Functions

 TypeNameNoDebug ("starcd")
 Declare type-name, virtual type (without debug switch) More...
 
 starcdWriter ()
 Default construct. More...
 
 starcdWriter (const dictionary &options)
 Construct with some output options. More...
 
 starcdWriter (const meshedSurf &surf, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())
 Construct from components. More...
 
 starcdWriter (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())
 Construct from components. More...
 
virtual ~starcdWriter ()=default
 Destructor. More...
 
virtual bool separateGeometry () const
 True if the surface format supports geometry in a separate file. More...
 
virtual fileName write ()
 Write surface geometry to file. More...
 
 declareSurfaceWriterWriteMethod (label)
 
 declareSurfaceWriterWriteMethod (scalar)
 
 declareSurfaceWriterWriteMethod (vector)
 
 declareSurfaceWriterWriteMethod (sphericalTensor)
 
 declareSurfaceWriterWriteMethod (symmTensor)
 
 declareSurfaceWriterWriteMethod (tensor)
 
template<class Type >
Foam::fileName writeTemplate (const word &fieldName, const Field< Type > &localValues)
 
- Public Member Functions inherited from surfaceWriter
 TypeName ("surfaceWriter")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(),())
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, wordDict,(const dictionary &writeOpts),(writeOpts))
 
 surfaceWriter ()
 Construct null. More...
 
 surfaceWriter (const dictionary &options)
 Construct null with specified options. More...
 
 surfaceWriter (const meshedSurf &surf, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())
 Construct from components. More...
 
 surfaceWriter (const pointField &points, const faceList &faces, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())
 Construct from components. More...
 
virtual ~surfaceWriter ()
 Destructor. Calls close() More...
 
virtual bool enabled () const
 
virtual bool needsUpdate () const
 Does the writer need an update (eg, lagging behind surface changes) More...
 
virtual bool wroteData () const
 Geometry or fields written since the last open? More...
 
virtual bool expire ()
 
virtual void clear ()
 
virtual void setSurface (const meshedSurf &surf, bool parallel)
 
virtual void setSurface (const pointField &points, const faceList &faces, bool parallel)
 
virtual void setSurface (const meshedSurf &surf)
 
virtual void setSurface (const pointField &points, const faceList &faces)
 
bool hasSurface () const
 Writer is associated with a surface. More...
 
bool empty () const
 The surface to write is empty if the global number of faces is zero. More...
 
label size () const
 The global number of faces for the associated surface. More...
 
label nFields () const
 The number of expected output fields. More...
 
label & nFields ()
 The number of expected output fields. More...
 
bool isPointData () const
 Are the field data to be treated as point data? More...
 
boolisPointData ()
 Set handling of field data to face/point data. More...
 
bool useTimeDir () const
 Should a time directory be spliced into the output path? More...
 
booluseTimeDir ()
 Change handling of spliced output path. More...
 
bool verbose () const
 Get output verbosity. More...
 
boolverbose ()
 Set output verbosity. More...
 
scalar mergeDim () const
 The current value of the point merge dimension (metre) More...
 
scalar & mergeDim ()
 The current value of the point merge dimension (metre) More...
 
bool hasTime () const
 True if there is a known time. More...
 
const wordtimeName () const
 The current time value/name. More...
 
scalar timeValue () const
 The current time value/name. More...
 
void setTime (const instant &inst)
 Set the current time. More...
 
void setTime (scalar timeValue)
 Set current time from timeValue, auto generating the name. More...
 
void setTime (scalar timeValue, const word &timeName)
 Set current time from timeValue and timeName. More...
 
void unsetTime ()
 Clear the current time. More...
 
virtual void beginTime (const Time &t)
 Begin a time-step. More...
 
virtual void beginTime (const instant &inst)
 Begin a time-step. More...
 
virtual void endTime ()
 End a time-step. More...
 
virtual void open (const fileName &outputPath)
 Open for output on specified path, using existing surface. More...
 
virtual void open (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel)
 Open from components. More...
 
virtual void open (const meshedSurf &surf, const fileName &outputPath, bool parallel)
 Open from components. More...
 
virtual void open (const pointField &points, const faceList &faces, const fileName &outputPath)
 Open from components, with the current parallel/serial treatment. More...
 
virtual void open (const meshedSurf &surf, const fileName &outputPath)
 Open from components, with the current parallel/serial treatment. More...
 
virtual void close ()
 Finish output, performing any necessary cleanup. More...
 
virtual fileName write (const word &fieldName, const Field< label > &values)=0
 
virtual fileName write (const word &fieldName, const Field< scalar > &values)=0
 
virtual fileName write (const word &fieldName, const Field< vector > &values)=0
 
virtual fileName write (const word &fieldName, const Field< sphericalTensor > &values)=0
 
virtual fileName write (const word &fieldName, const Field< symmTensor > &values)=0
 
virtual fileName write (const word &fieldName, const Field< tensor > &values)=0
 
virtual InfoProxy< surfaceWriterinfo () const
 Return info proxy. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mergeFieldTemplate (const Field< Type > &fld) const
 

Additional Inherited Members

- Static Public Member Functions inherited from surfaceWriter
static bool supportedType (const word &writeType)
 True if New is likely to succeed for this writeType. More...
 
static autoPtr< surfaceWriterNew (const word &writeType)
 Return a reference to the selected surfaceWriter. More...
 
static autoPtr< surfaceWriterNew (const word &writeType, const dictionary &writeOptions)
 Return a reference to the selected surfaceWriter. More...
 
- Static Public Attributes inherited from surfaceWriter
static scalar defaultMergeDim = 1e-8
 The default merge dimension (1e-8) More...
 
- Protected Member Functions inherited from surfaceWriter
bool checkOpen () const
 Verify that the outputPath_ has been set or FatalError. More...
 
virtual bool merge () const
 
const meshedSurfsurface () const
 
template<class Type >
tmp< Field< Type > > mergeFieldTemplate (const Field< Type > &fld) const
 Gather (merge) fields with renumbering and shrinking for point data. More...
 
tmp< Field< label > > mergeField (const Field< label > &fld) const
 
tmp< Field< scalar > > mergeField (const Field< scalar > &fld) const
 
tmp< Field< vector > > mergeField (const Field< vector > &fld) const
 
tmp< Field< sphericalTensor > > mergeField (const Field< sphericalTensor > &fld) const
 
tmp< Field< symmTensor > > mergeField (const Field< symmTensor > &fld) const
 
tmp< Field< tensor > > mergeField (const Field< tensor > &fld) const
 
template<class Type >
fileName writeTemplate (const word &fieldName, const Field< Type > &localValues)
 Dummy templated write operation. More...
 
- Protected Attributes inherited from surfaceWriter
std::reference_wrapper< const meshedSurfsurf_
 Reference to a surface. More...
 
meshedSurfRef surfComp_
 Reference to raw surface components. More...
 
bool useComponents_
 Use raw surface components instead of surface reference. More...
 
bool upToDate_
 The topology/surface is up-to-date? More...
 
bool wroteGeom_
 Track if geometry has been written since the last open. More...
 
bool parallel_
 Writing in parallel (via master) More...
 
bool useTimeDir_
 Insert additional time sub-directory in the output path. More...
 
bool isPointData_
 Is point vs cell data. More...
 
bool verbose_
 Additional output verbosity. More...
 
label nFields_
 The number of fields. More...
 
scalar mergeDim_
 Dimension for merging. More...
 
mergedSurf merged_
 Merging information and the resulting merged surface (parallel) More...
 
instant currTime_
 The current time value/name. More...
 
fileName outputPath_
 The full output directory and file (surface) name. More...
 
- Static Protected Attributes inherited from surfaceWriter
static const meshedSurf::emptySurface emptySurface_
 Placeholder. More...
 

Detailed Description

A surfaceWriter for STARCD files.

The formatOptions for starcd:

Property Description Required Default
compression Use file compression no false

The geometry is written via the MeshedSurfaceProxy, the fields are written in a trivial ASCII format with ID and VALUE as so-called user data. These .usr files can be read into proSTAR with these types of commands. For element data:

        getuser FILENAME.usr cell scalar free
        getuser FILENAME.usr cell vector free

and for vertex data:

        getuser FILENAME.usr vertex scalar free
        getuser FILENAME.usr vertex vector free


Output file locations

The rootdir normally corresponds to something like postProcessing/<name>

\subheading Geometry

    rootdir
    `-- timeName
        `-- surfaceName.{cel,vrt,inp}

\subheading Fields

    rootdir
    `-- timeName
        |-- <field0>_surfaceName.{usr}
        `-- <field1>_surfaceName.{usr}
Source files

Definition at line 103 of file starcdSurfaceWriter.H.

Constructor & Destructor Documentation

◆ starcdWriter() [1/4]

Default construct.

Definition at line 68 of file starcdSurfaceWriter.C.

◆ starcdWriter() [2/4]

starcdWriter ( const dictionary options)
explicit

Construct with some output options.

Definition at line 76 of file starcdSurfaceWriter.C.

◆ starcdWriter() [3/4]

starcdWriter ( const meshedSurf surf,
const fileName outputPath,
bool  parallel = Pstream::parRun(),
const dictionary options = dictionary() 
)

Construct from components.

Definition at line 90 of file starcdSurfaceWriter.C.

◆ starcdWriter() [4/4]

starcdWriter ( const pointField points,
const faceList faces,
const fileName outputPath,
bool  parallel = Pstream::parRun(),
const dictionary options = dictionary() 
)

Construct from components.

Definition at line 104 of file starcdSurfaceWriter.C.

References points.

◆ ~starcdWriter()

virtual ~starcdWriter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "starcd"  )

Declare type-name, virtual type (without debug switch)

◆ separateGeometry()

virtual bool separateGeometry ( ) const
inlinevirtual

True if the surface format supports geometry in a separate file.

False if geometry and field must be in a single file

Reimplemented from surfaceWriter.

Definition at line 166 of file starcdSurfaceWriter.H.

◆ write()

Foam::fileName write ( )
virtual

Write surface geometry to file.

Implements surfaceWriter.

Definition at line 120 of file starcdSurfaceWriter.C.

References Foam::endl(), fileName::ext(), meshedSurf::faceIds(), meshedSurf::faces(), Foam::Info, Foam::isDir(), UPstream::master(), Foam::mkDir(), UList< T >::null(), fileName::path(), meshedSurf::points(), timeName, and Foam::vtk::write().

Here is the call graph for this function:

◆ declareSurfaceWriterWriteMethod() [1/6]

declareSurfaceWriterWriteMethod ( label  )

◆ declareSurfaceWriterWriteMethod() [2/6]

declareSurfaceWriterWriteMethod ( scalar  )

◆ declareSurfaceWriterWriteMethod() [3/6]

declareSurfaceWriterWriteMethod ( vector  )

◆ declareSurfaceWriterWriteMethod() [4/6]

declareSurfaceWriterWriteMethod ( sphericalTensor  )

◆ declareSurfaceWriterWriteMethod() [5/6]

declareSurfaceWriterWriteMethod ( symmTensor  )

◆ declareSurfaceWriterWriteMethod() [6/6]

declareSurfaceWriterWriteMethod ( tensor  )

◆ writeTemplate()

Foam::fileName writeTemplate ( const word fieldName,
const Field< Type > &  localValues 
)

Definition at line 172 of file starcdSurfaceWriter.C.

References Foam::endl(), fileName::ext(), Foam::Info, Foam::isDir(), UPstream::master(), Foam::mkDir(), fileName::path(), timeName, Foam::HashTableOps::values(), Foam::vtk::write(), and Foam::writeData().

Here is the call graph for this function:

The documentation for this class was generated from the following files: