starcdSurfaceWriter Class Reference

A surfaceWriter for STARCD files. More...

Inheritance diagram for starcdSurfaceWriter:

Collaboration diagram for starcdSurfaceWriter:

Public Member Functions
	TypeName ("starcd")
	Runtime type information. More...
	starcdSurfaceWriter ()
	Construct null. More...
virtual	~starcdSurfaceWriter ()
	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...
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<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...
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...

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...

Static Private Member Functions
template<class Type >
static void	writeData (Ostream &, const Type &)

Additional Inherited Members
Static Public Member Functions inherited from surfaceWriter
static autoPtr< surfaceWriter >	New (const word &writeType)
	Return a reference to the selected surfaceWriter. More...
static autoPtr< surfaceWriter >	New (const word &writeType, const dictionary &writeOptions)
	Return a reference to the selected surfaceWriter. More...

Detailed Description

A surfaceWriter for STARCD files.

The geometry is written via the MeshedSurfaceProxy, the fields are written in a trivial ASCII format with ID and VALUE as so-called user data. These .usr files can be read into proSTAR with these types of commands. For element data:

    getuser FILENAME.usr cell scalar free
    getuser FILENAME.usr cell vector free

and for vertex data:

    getuser FILENAME.usr vertex scalar free
    getuser FILENAME.usr vertex vector free

Note

Only scalar and vector fields are supported directly. A sphericalTensor is written as a scalar. Other field types are not written.

Source files

• starcdSurfaceWriter.H
• starcdSurfaceWriter.C

Definition at line 67 of file starcdSurfaceWriter.H.

Constructor & Destructor Documentation

starcdSurfaceWriter()

starcdSurfaceWriter

(

)

Construct null.

Definition at line 79 of file starcdSurfaceWriter.C.

~starcdSurfaceWriter()

~starcdSurfaceWriter ( )

virtual

Destructor.

Definition at line 87 of file starcdSurfaceWriter.C.

Member Function Documentation

writeData() [1/4]

void writeData ( Ostream &  os, const Type &  v  )

inlinestaticprivate

Definition at line 33 of file starcdSurfaceWriterTemplates.C.

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

(

"starcd"

)

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 112 of file starcdSurfaceWriter.H.

write() [1/4]

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 94 of file starcdSurfaceWriter.C.

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

Here is the call graph for this function:

write() [2/4]

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/4]

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/4]

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.

writeData() [2/4]

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

inline

Definition at line 44 of file starcdSurfaceWriter.C.

References Foam::nl.

writeData() [3/4]

void writeData ( Ostream &  os, const vector &  v  )

inline

Definition at line 55 of file starcdSurfaceWriter.C.

References Foam::nl.

writeData() [4/4]

void writeData ( Ostream &  os, const sphericalTensor &  v  )

inline

Definition at line 66 of file starcdSurfaceWriter.C.

References Foam::nl.

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 42 of file starcdSurfaceWriterTemplates.C.

References Foam::endl(), forAll, Foam::Info, Foam::isDir(), Foam::mkDir(), OFstream::name(), and writeData().

Here is the call graph for this function:

---

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

• src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.H
• src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriter.C
• src/sampling/sampledSurface/writers/starcd/starcdSurfaceWriterTemplates.C