Public Member Functions | Private Member Functions
foamFileSurfaceWriter Class Reference

A surfaceWriter for foamFiles. More...

Inheritance diagram for foamFileSurfaceWriter:
Inheritance graph
[legend]
Collaboration diagram for foamFileSurfaceWriter:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("foamFile")
 Runtime type information. More...
 
 foamFileSurfaceWriter ()
 Construct null. More...
 
virtual ~foamFileSurfaceWriter ()
 Destructor. More...
 
virtual bool separateGeometry () const
 True if the surface format supports geometry in a separate file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const bool verbose=false) const
 Write single surface geometry to file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< scalar > &values, const bool isNodeValues, const bool verbose=false) const
 Write scalarField for a single surface to file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< vector > &values, const bool isNodeValues, const bool verbose=false) const
 Write vectorField for a single surface to file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< sphericalTensor > &values, const bool isNodeValues, const bool verbose=false) const
 Write sphericalTensorField for a single surface to file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< symmTensor > &values, const bool isNodeValues, const bool verbose=false) const
 Write symmTensorField for a single surface to file. More...
 
virtual fileName write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< tensor > &values, const bool isNodeValues, const bool verbose=false) const
 Write tensorField for a single surface to file. More...
 
template<class Type >
Foam::fileName writeTemplate (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< Type > &values, const bool isNodeValues, const bool verbose) const
 
- Public Member Functions inherited from surfaceWriter
 TypeName ("surfaceWriter")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(),())
 
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, wordDict,(const dictionary &optDict),(optDict))
 
 surfaceWriter ()
 Construct null. More...
 
virtual ~surfaceWriter ()
 Destructor. More...
 

Private Member Functions

template<class Type >
fileName writeTemplate (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const word &fieldName, const Field< Type > &values, const bool isNodeValues, const bool verbose) const
 Templated write operation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from surfaceWriter
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...
 

Detailed Description

A surfaceWriter for foamFiles.

Source files

Definition at line 48 of file foamFileSurfaceWriter.H.

Constructor & Destructor Documentation

◆ foamFileSurfaceWriter()

Construct null.

Definition at line 39 of file foamFileSurfaceWriter.C.

◆ ~foamFileSurfaceWriter()

~foamFileSurfaceWriter ( )
virtual

Destructor.

Definition at line 47 of file foamFileSurfaceWriter.C.

Member Function Documentation

◆ writeTemplate() [1/2]

fileName writeTemplate ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< Type > &  values,
const bool  isNodeValues,
const bool  verbose 
) const
private

Templated write operation.

◆ TypeName()

TypeName ( "foamFile"  )

Runtime type information.

◆ 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 89 of file foamFileSurfaceWriter.H.

◆ write() [1/6]

Foam::fileName write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const bool  verbose = false 
) const
virtual

Write single surface geometry to file.

Reimplemented from surfaceWriter.

Definition at line 54 of file foamFileSurfaceWriter.C.

References Foam::endl(), forAll, Foam::Info, Foam::isDir(), Foam::mkDir(), points, List::size(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ write() [2/6]

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

Write scalarField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented from surfaceWriter.

◆ write() [3/6]

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

Write vectorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented from surfaceWriter.

◆ write() [4/6]

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

Write sphericalTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented from surfaceWriter.

◆ write() [5/6]

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

Write symmTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented from surfaceWriter.

◆ write() [6/6]

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

Write tensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented from surfaceWriter.

◆ writeTemplate() [2/2]

Foam::fileName writeTemplate ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const word fieldName,
const Field< Type > &  values,
const bool  isNodeValues,
const bool  verbose 
) const

Definition at line 33 of file foamFileSurfaceWriterTemplates.C.

References Foam::endl(), Foam::Info, Foam::isDir(), and Foam::mkDir().

Here is the call graph for this function:

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