Base class for surface writers. More...

Inheritance diagram for surfaceWriter:

[legend]

Public Member Functions
	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 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...

Static Public Member Functions
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

Base class for surface writers.

Source files

Definition at line 54 of file surfaceWriter.H.

Constructor & Destructor Documentation

◆ surfaceWriter()

surfaceWriter ( )

Construct null.

Definition at line 104 of file surfaceWriter.C.

◆ ~surfaceWriter()

~surfaceWriter ( )

virtual

Destructor.

Definition at line 110 of file surfaceWriter.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceWriter" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		surfaceWriter	,
		word	,
		()	,
		()
	)

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [1/2]

Foam::autoPtr< Foam::surfaceWriter > New ( const word & writeType )

static

Return a reference to the selected surfaceWriter.

Definition at line 55 of file surfaceWriter.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and MeshedSurfaceProxy::writeTypes().

Referenced by faceSource::initialise(), main(), surfaceWriter::New(), sampledSurfaces::read(), and immersedBoundaryFvPatchField< Type >::write().

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 &	writeOptions
	)

static

Return a reference to the selected surfaceWriter.

Select with extra write option

Definition at line 86 of file surfaceWriter.C.

References surfaceWriter::New().

Here is the call graph for this function:

◆ 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 in nastranSurfaceWriter, ensightSurfaceWriter, starcdSurfaceWriter, foamFileSurfaceWriter, and proxySurfaceWriter.

Definition at line 112 of file surfaceWriter.H.

◆ write() [1/6]

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

inlinevirtual

Write single surface geometry to file.

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, starcdSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and proxySurfaceWriter.

Definition at line 119 of file surfaceWriter.H.

References fileName::null.

◆ 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

inlinevirtual

Write scalarField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, starcdSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and dxSurfaceWriter.

Definition at line 133 of file surfaceWriter.H.

References fileName::null.

◆ 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

inlinevirtual

Write vectorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, starcdSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and dxSurfaceWriter.

Definition at line 150 of file surfaceWriter.H.

References fileName::null.

◆ 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

inlinevirtual

Write sphericalTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, starcdSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and dxSurfaceWriter.

Definition at line 167 of file surfaceWriter.H.

References fileName::null.

◆ 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

inlinevirtual

Write symmTensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and dxSurfaceWriter.

Definition at line 184 of file surfaceWriter.H.

References fileName::null.

◆ 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

inlinevirtual

Write tensorField for a single surface to file.

One value per face or vertex (isNodeValues = true)

Reimplemented in nastranSurfaceWriter, ensightSurfaceWriter, boundaryDataSurfaceWriter, rawSurfaceWriter, foamFileSurfaceWriter, vtkSurfaceWriter, and dxSurfaceWriter.

Definition at line 201 of file surfaceWriter.H.

References fileName::null.

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

src/sampling/sampledSurface/writers/surfaceWriter.H
src/sampling/sampledSurface/writers/surfaceWriter.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ surfaceWriter()

◆ ~surfaceWriter()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ separateGeometry()

◆ write() [1/6]

◆ write() [2/6]

◆ write() [3/6]

◆ write() [4/6]

◆ write() [5/6]

◆ write() [6/6]