surfaceWriter Class Referenceabstract

Base class for surface writers. More...

Inheritance diagram for surfaceWriter:

Public Member Functions

 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...
 
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const =0
 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 =0
 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 =0
 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 =0
 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 =0
 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 =0
 Write tensorField for a single surface to file. More...
 

Static Public Member Functions

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

IOstream::streamFormat writeFormat_
 Write format. More...
 

Detailed Description

Base class for surface writers.

Source files

Definition at line 54 of file surfaceWriter.H.

Constructor & Destructor Documentation

◆ surfaceWriter() [1/2]

surfaceWriter ( const IOstream::streamFormat  writeFormat)

Construct given write format.

Definition at line 111 of file surfaceWriter.C.

◆ surfaceWriter() [2/2]

surfaceWriter ( const dictionary optDict)

Construct with output options.

Definition at line 117 of file surfaceWriter.C.

References IOstream::formatEnum(), dictionary::found(), dictionary::lookup(), and surfaceWriter::writeFormat_.

Here is the call graph for this function:

◆ ~surfaceWriter()

~surfaceWriter ( )
virtual

Destructor.

Definition at line 133 of file surfaceWriter.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceWriter"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
surfaceWriter  ,
word  ,
(const IOstream::streamFormat writeFormat)  ,
(writeFormat)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
surfaceWriter  ,
wordDict  ,
(const dictionary &optDict)  ,
(optDict)   
)

◆ New() [1/2]

Foam::autoPtr< Foam::surfaceWriter > New ( const word writeType,
const IOstream::streamFormat  writeFormat 
)
static

Return a reference to the selected surfaceWriter.

Definition at line 45 of file surfaceWriter.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, format(), Foam::nl, and MeshedSurfaceProxy< Face >::writeTypes().

Referenced by surfaceFieldValue::initialise(), surfaceWriter::New(), and sampledSurfaces::read().

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

◆ New() [2/2]

Foam::autoPtr< Foam::surfaceWriter > New ( const word writeType,
const dictionary optDict 
)
static

Return a reference to the selected surfaceWriter.

Select with extra write option

Definition at line 80 of file surfaceWriter.C.

References IOstream::ASCII, IOstream::formatEnum(), dictionary::found(), dictionary::lookup(), and surfaceWriter::New().

Here is the call graph for this function:

◆ separateGeometry()

virtual bool separateGeometry ( )
inlinevirtual

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

False if geometry and field must be in a single file

Reimplemented in nastranSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, and proxySurfaceWriter.

Definition at line 130 of file surfaceWriter.H.

◆ write() [1/6]

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

◆ 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
pure virtual

Write scalarField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implemented in nastranSurfaceWriter, rawSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, vtkSurfaceWriter, proxySurfaceWriter, and noSurfaceWriter.

◆ 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
pure virtual

Write vectorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implemented in nastranSurfaceWriter, rawSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, vtkSurfaceWriter, proxySurfaceWriter, and noSurfaceWriter.

◆ 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
pure virtual

Write sphericalTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implemented in nastranSurfaceWriter, rawSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, vtkSurfaceWriter, proxySurfaceWriter, and noSurfaceWriter.

◆ 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
pure virtual

Write symmTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implemented in nastranSurfaceWriter, rawSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, vtkSurfaceWriter, proxySurfaceWriter, and noSurfaceWriter.

◆ 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
pure virtual

Write tensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Implemented in nastranSurfaceWriter, rawSurfaceWriter, starcdSurfaceWriter, ensightSurfaceWriter, foamSurfaceWriter, vtkSurfaceWriter, proxySurfaceWriter, and noSurfaceWriter.

Member Data Documentation

◆ writeFormat_

IOstream::streamFormat writeFormat_
protected

Write format.

Definition at line 62 of file surfaceWriter.H.

Referenced by surfaceWriter::surfaceWriter(), and ensightSurfaceWriter::write().


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