rawSurfaceWriter Class Reference

A surfaceWriter for raw output. More...

Inheritance diagram for rawSurfaceWriter:
Collaboration diagram for rawSurfaceWriter:

Public Member Functions

 TypeName ("raw")
 Runtime type information. More...
 
 rawSurfaceWriter (const IOstream::streamFormat writeFormat)
 Construct given write format. More...
 
 rawSurfaceWriter (const dictionary &optDict)
 Construct with output options. More...
 
virtual ~rawSurfaceWriter ()
 Destructor. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const
 Write single surface geometry to file. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< scalar > &values, const bool isNodeValues) const
 Write scalarField for a single surface to file. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< vector > &values, const bool isNodeValues) const
 Write vectorField for a single surface to file. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< sphericalTensor > &values, const bool isNodeValues) const
 Write sphericalTensorField for a single surface to file. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< symmTensor > &values, const bool isNodeValues) const
 Write symmTensorField for a single surface to file. More...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< tensor > &values, const bool isNodeValues) const
 Write tensorField for a single surface to file. More...
 
template<>
void writeHeader (Ostream &os, const word &fieldName, const Field< scalar > &values)
 
template<>
void writeHeader (Ostream &os, const word &fieldName, const Field< vector > &values)
 
template<>
void writeHeader (Ostream &os, const word &fieldName, const Field< sphericalTensor > &values)
 
template<>
void writeHeader (Ostream &os, const word &fieldName, const Field< symmTensor > &values)
 
template<>
void writeHeader (Ostream &os, const word &fieldName, const Field< tensor > &values)
 
template<>
void writeData (Ostream &os, const scalar &v)
 
template<>
void writeData (Ostream &os, const vector &v)
 
template<>
void writeData (Ostream &os, const sphericalTensor &v)
 
template<>
void writeData (Ostream &os, const symmTensor &v)
 
template<>
void writeData (Ostream &os, const tensor &v)
 
- Public Member Functions inherited from surfaceWriter
 TypeName ("surfaceWriter")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(const IOstream::streamFormat writeFormat),(writeFormat))
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, wordDict,(const dictionary &optDict),(optDict))
 
 surfaceWriter (const IOstream::streamFormat writeFormat)
 Construct given write format. More...
 
 surfaceWriter (const dictionary &optDict)
 Construct with output options. More...
 
virtual ~surfaceWriter ()
 Destructor. More...
 
virtual bool separateGeometry ()
 True if the surface format supports geometry in a separate file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from surfaceWriter
static autoPtr< surfaceWriterNew (const word &writeType, const IOstream::streamFormat writeFormat)
 Return a reference to the selected surfaceWriter. More...
 
static autoPtr< surfaceWriterNew (const word &writeType, const dictionary &optDict)
 Return a reference to the selected surfaceWriter. More...
 
- Protected Attributes inherited from surfaceWriter
IOstream::streamFormat writeFormat_
 Write format. More...
 

Detailed Description

A surfaceWriter for raw output.

Source files

Definition at line 49 of file rawSurfaceWriter.H.

Constructor & Destructor Documentation

◆ rawSurfaceWriter() [1/2]

rawSurfaceWriter ( const IOstream::streamFormat  writeFormat)

Construct given write format.

Definition at line 277 of file rawSurfaceWriter.C.

Referenced by rawSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ rawSurfaceWriter() [2/2]

rawSurfaceWriter ( const dictionary optDict)

Construct with output options.

Definition at line 286 of file rawSurfaceWriter.C.

References IOstream::compressionEnum(), dictionary::found(), and dictionary::lookup().

Here is the call graph for this function:

◆ ~rawSurfaceWriter()

~rawSurfaceWriter ( )
virtual

Destructor.

Definition at line 301 of file rawSurfaceWriter.C.

References rawSurfaceWriter::write().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "raw"  )

Runtime type information.

◆ write() [1/6]

void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces 
) const
virtual

Write single surface geometry to file.

Implements surfaceWriter.

Definition at line 308 of file rawSurfaceWriter.C.

References IOstream::ASCII, IOstream::currentVersion, Foam::defineSurfaceWriterWriteFields(), Foam::endl(), forAll, Foam::Info, Foam::isDir(), Foam::mkDir(), OFstream::name(), Foam::nl, and List< T >::size().

Referenced by rawSurfaceWriter::~rawSurfaceWriter().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write() [2/6]

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< scalar > &  values,
const bool  isNodeValues 
) const
virtual

Write scalarField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implements surfaceWriter.

◆ write() [3/6]

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< vector > &  values,
const bool  isNodeValues 
) const
virtual

Write vectorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implements surfaceWriter.

◆ write() [4/6]

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< sphericalTensor > &  values,
const bool  isNodeValues 
) const
virtual

Write sphericalTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implements surfaceWriter.

◆ write() [5/6]

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< symmTensor > &  values,
const bool  isNodeValues 
) const
virtual

Write symmTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implements surfaceWriter.

◆ write() [6/6]

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< tensor > &  values,
const bool  isNodeValues 
) const
virtual

Write tensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implements surfaceWriter.

◆ writeHeader() [1/5]

void writeHeader ( Ostream os,
const word fieldName,
const Field< scalar > &  values 
)

Definition at line 71 of file rawSurfaceWriter.C.

References Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ writeHeader() [2/5]

void writeHeader ( Ostream os,
const word fieldName,
const Field< vector > &  values 
)

Definition at line 84 of file rawSurfaceWriter.C.

References Foam::endl(), Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ writeHeader() [3/5]

void writeHeader ( Ostream os,
const word fieldName,
const Field< sphericalTensor > &  values 
)

Definition at line 101 of file rawSurfaceWriter.C.

References Foam::nl, and List< Type >::size().

Here is the call graph for this function:

◆ writeHeader() [4/5]

void writeHeader ( Ostream os,
const word fieldName,
const Field< symmTensor > &  values 
)

Definition at line 115 of file rawSurfaceWriter.C.

References Foam::endl(), Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ writeHeader() [5/5]

void writeHeader ( Ostream os,
const word fieldName,
const Field< tensor > &  values 
)

Definition at line 133 of file rawSurfaceWriter.C.

References Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ writeData() [1/5]

void writeData ( Ostream os,
const scalar &  v 
)
inline

Definition at line 151 of file rawSurfaceWriter.C.

References Foam::nl.

◆ writeData() [2/5]

void writeData ( Ostream os,
const vector v 
)
inline

Definition at line 162 of file rawSurfaceWriter.C.

References Foam::nl.

◆ writeData() [3/5]

void writeData ( Ostream os,
const sphericalTensor v 
)
inline

Definition at line 173 of file rawSurfaceWriter.C.

References Foam::nl.

◆ writeData() [4/5]

void writeData ( Ostream os,
const symmTensor v 
)
inline

Definition at line 184 of file rawSurfaceWriter.C.

References Foam::nl.

◆ writeData() [5/5]

void writeData ( Ostream os,
const tensor v 
)
inline

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