FreeFOAM The Cross-Platform CFD Toolkit
surfaceWriter< Type > Class Template Reference

#include <sampling/surfaceWriter.H>


Detailed Description

template<class Type>
class Foam::surfaceWriter< Type >

Source files

Definition at line 62 of file surfaceWriter.H.

+ Inheritance diagram for surfaceWriter< Type >:

List of all members.

Public Member Functions

 TypeName ("surfaceWriter")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(),())
 surfaceWriter ()
 Construct null.
virtual ~surfaceWriter ()
virtual bool separateFiles ()
 Return true if the surface format supports separate files.
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const bool verbose=false) const
 Writes single surface geometry to file.
virtual void write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const fileName &fieldName, const Field< Type > &values, const bool verbose=false) const =0
 Writes single surface to file. Either one value per vertex or.

Static Public Member Functions

static autoPtr< surfaceWriterNew (const word &writeFormat)
 Return a reference to the selected surfaceWriter.

Friends

class surfaceWriter
 friendship between writer data types

Constructor & Destructor Documentation

Construct null.

~surfaceWriter ( )
virtual

Definition at line 100 of file surfaceWriter.C.


Member Function Documentation

TypeName ( "surfaceWriter< Type >"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
surfaceWriter< Type >  ,
word  ,
()  ,
()   
)
Foam::autoPtr< Foam::surfaceWriter< Type > > New ( const word writeFormat)
static

Return a reference to the selected surfaceWriter.

Definition at line 39 of file surfaceWriter.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and Foam::nl.

Referenced by sampledSurfaces::read().

virtual bool separateFiles ( )
inlinevirtual

Return true if the surface format supports separate files.

Reimplemented in proxySurfaceWriter< Type >, and foamFileSurfaceWriter< Type >.

Definition at line 104 of file surfaceWriter.H.

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

Writes single surface geometry to file.

Reimplemented in rawSurfaceWriter< Type >, proxySurfaceWriter< Type >, vtkSurfaceWriter< Type >, and foamFileSurfaceWriter< Type >.

Definition at line 112 of file surfaceWriter.H.

virtual void write ( const fileName outputDir,
const fileName surfaceName,
const pointField points,
const faceList faces,
const fileName fieldName,
const Field< Type > &  values,
const bool  verbose = false 
) const
pure virtual

Writes single surface to file. Either one value per vertex or.

one value per face (detected by values.size()==faces.size())

Implemented in rawSurfaceWriter< Type >, proxySurfaceWriter< Type >, vtkSurfaceWriter< Type >, foamFileSurfaceWriter< Type >, dxSurfaceWriter< Type >, and nullSurfaceWriter< Type >.


Friends And Related Function Documentation

surfaceWriter
friend

friendship between writer data types

Definition at line 65 of file surfaceWriter.H.


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