foamSurfaceWriter Class Reference

A surfaceWriter for native OpenFOAM format with support for writing ASCII or binary. More...

Inheritance diagram for foamSurfaceWriter:

Collaboration diagram for foamSurfaceWriter:

Public Member Functions
	TypeName ("foam")
	Runtime type information. More...
virtual	~foamSurfaceWriter ()
	Destructor. More...
virtual void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const
	Write fields for a single surface to file. More...
	surfaceWriter (const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Inherit constructors. More...
	surfaceWriter (const dictionary &dict)
	Inherit constructors. More...
virtual void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const=0
	Inherit base class templated write. More...
virtual void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const wordList &fieldNames, const bool writePointValues #define FieldTypeValuesConstArg(Type, nullArg)) const
	Inherit base class templated write. More...
void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const
	Inherit base class templated write. More...
template<class ... Args>
void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const bool writePointValues, const Args &... args) const
	Inherit base class templated write. More...
Public Member Functions inherited from surfaceWriter
	TypeName ("surfaceWriter")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression),(writeFormat, writeCompression))
	declareRunTimeSelectionTable (autoPtr, surfaceWriter, dict,(const dictionary &dict),(dict))
	surfaceWriter (const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Construct given write options. More...
	surfaceWriter (const dictionary &dict)
	Construct from dictionary. More...
virtual	~surfaceWriter ()
	Destructor. More...
void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces) const
	Write the surface geometry only. More...
template<class ... Args>
void	write (const fileName &outputDir, const fileName &surfaceName, const pointField &points, const faceList &faces, const bool writePointValues, const Args &... args) const
	Write fields for a single surface to file. For use in code where. More...

Additional Inherited Members
Static Public Member Functions inherited from surfaceWriter
static autoPtr< surfaceWriter >	New (const word &writeType, const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Select given write options. More...
static autoPtr< surfaceWriter >	New (const word &writeType, const dictionary &dict)
	Select given a dictionary. More...
Protected Attributes inherited from surfaceWriter
IOstream::streamFormat	writeFormat_
	Write format. More...
IOstream::compressionType	writeCompression_
	Write compression. More...

Detailed Description

A surfaceWriter for native OpenFOAM format with support for writing ASCII or binary.

Source files

• foamSurfaceWriter.H
• foamSurfaceWriter.C

Definition at line 49 of file foamSurfaceWriter.H.

Constructor & Destructor Documentation

~foamSurfaceWriter()

~foamSurfaceWriter ( )

virtual

Destructor.

Definition at line 43 of file foamSurfaceWriter.C.

Member Function Documentation

TypeName()

TypeName

(

"foam"

)

Runtime type information.

write() [1/5]

void write ( const fileName &  outputDir, const fileName &  surfaceName, const pointField &  points, const faceList &  faces, const wordList &  fieldNames, const bool writePointValues #define   FieldTypeValuesConstArgType, nullArg  ) const

virtual

Write fields for a single surface to file.

Implements surfaceWriter.

Definition at line 49 of file foamSurfaceWriter.C.

References IOstream::currentVersion, Foam::endl(), fieldNames, Foam::file, Foam::FOR_ALL_FIELD_TYPES(), forAll, Foam::Info, Foam::isDir(), Foam::mkDir(), points, List< T >::size(), WriteFieldType, and Foam::Zero.

Here is the call graph for this function:

surfaceWriter() [1/2]

surfaceWriter

Inherit constructors.

Definition at line 119 of file surfaceWriter.C.

surfaceWriter() [2/2]

surfaceWriter

Inherit constructors.

Definition at line 126 of file surfaceWriter.C.

write() [2/5]

virtual void write

Inherit base class templated write.

write() [3/5]

virtual void write

inline

Inherit base class templated write.

Definition at line 151 of file surfaceWriter.H.

write() [4/5]

void write

inline

Inherit base class templated write.

Definition at line 182 of file surfaceWriter.H.

write() [5/5]

void write ( class ...  Args )

inline

Inherit base class templated write.

Definition at line 223 of file surfaceWriter.H.

---

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

• src/sampling/sampledSurface/writers/foam/foamSurfaceWriter.H
• src/sampling/sampledSurface/writers/foam/foamSurfaceWriter.C