A surfaceWriter for OpenFOAM surfaces. More...

Inheritance diagram for foamWriter:

Collaboration diagram for foamWriter:

Public Member Functions
	TypeNameNoDebug ("foam")

	foamWriter ()

	foamWriter (const dictionary &options)

	foamWriter (const meshedSurf &surf, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

	foamWriter (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

virtual	~foamWriter ()=default

virtual bool	separateGeometry () const

virtual fileName	write ()

	declareSurfaceWriterWriteMethod (label)

	declareSurfaceWriterWriteMethod (scalar)

	declareSurfaceWriterWriteMethod (vector)

	declareSurfaceWriterWriteMethod (sphericalTensor)

	declareSurfaceWriterWriteMethod (symmTensor)

	declareSurfaceWriterWriteMethod (tensor)

template<class Type >
Foam::fileName	writeTemplate (const word &fieldName, const Field< Type > &localValues)

Public Member Functions inherited from surfaceWriter
	TypeName ("surfaceWriter")

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

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

	surfaceWriter ()

	surfaceWriter (const dictionary &options)

	surfaceWriter (const meshedSurf &surf, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

	surfaceWriter (const pointField &points, const faceList &faces, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

virtual	~surfaceWriter ()

virtual bool	enabled () const

virtual bool	usesFaceIds () const

virtual bool	needsUpdate () const

virtual bool	wroteData () const

virtual bool	expire ()

virtual void	clear ()

virtual void	setSurface (const meshedSurf &surf, bool parallel)

virtual void	setSurface (const pointField &points, const faceList &faces, bool parallel)

virtual void	setSurface (const meshedSurf &surf)

virtual void	setSurface (const pointField &points, const faceList &faces)

bool	hasSurface () const

bool	empty () const

label	size () const

label	nFields () const

label	nFields (const label n)

bool	isPointData () const

bool	isPointData (const bool on)

bool	useTimeDir () const

bool	useTimeDir (const bool on)

bool	verbose () const

bool	verbose (const bool on)

scalar	mergeDim () const

scalar	mergeDim (const scalar dist)

bool	hasTime () const

const word &	timeName () const

scalar	timeValue () const

void	setTime (const instant &inst)

void	setTime (scalar timeValue)

void	setTime (scalar timeValue, const word &timeName)

void	unsetTime ()

virtual void	beginTime (const Time &t)

virtual void	beginTime (const instant &inst)

virtual void	endTime ()

virtual void	open (const fileName &outputPath)

virtual void	open (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel)

virtual void	open (const meshedSurf &surf, const fileName &outputPath, bool parallel)

virtual void	open (const pointField &points, const faceList &faces, const fileName &outputPath)

virtual void	open (const meshedSurf &surf, const fileName &outputPath)

virtual void	close ()

virtual fileName	write (const word &fieldName, const Field< label > &values)=0
	Write field of label (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< scalar > &values)=0
	Write field of scalar (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< vector > &values)=0
	Write field of vector (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< sphericalTensor > &values)=0
	Write field of sphericalTensor (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< symmTensor > &values)=0
	Write field of symmTensor (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< tensor > &values)=0
	Write field of tensor (per face or vertex) More...

virtual InfoProxy< surfaceWriter >	info () const

template<class Type >
Foam::tmp< Foam::Field< Type > >	mergeFieldTemplate (const Field< Type > &fld) const

Additional Inherited Members
Static Public Member Functions inherited from surfaceWriter
static bool	supportedType (const word &writeType)

static autoPtr< surfaceWriter >	New (const word &writeType)

static autoPtr< surfaceWriter >	New (const word &writeType, const dictionary &writeOptions)

Static Public Attributes inherited from surfaceWriter
static scalar	defaultMergeDim = 1e-8

Protected Member Functions inherited from surfaceWriter
bool	checkOpen () const

virtual bool	merge () const

const meshedSurf &	surface () const

template<class Type >
tmp< Field< Type > >	mergeFieldTemplate (const Field< Type > &fld) const

tmp< Field< label > >	mergeField (const Field< label > &fld) const

tmp< Field< scalar > >	mergeField (const Field< scalar > &fld) const

tmp< Field< vector > >	mergeField (const Field< vector > &fld) const

tmp< Field< sphericalTensor > >	mergeField (const Field< sphericalTensor > &fld) const

tmp< Field< symmTensor > >	mergeField (const Field< symmTensor > &fld) const

tmp< Field< tensor > >	mergeField (const Field< tensor > &fld) const

template<class Type >
fileName	writeTemplate (const word &fieldName, const Field< Type > &localValues)

Protected Attributes inherited from surfaceWriter
std::reference_wrapper< const meshedSurf >	surf_

meshedSurfRef	surfComp_

bool	useComponents_

bool	upToDate_

bool	wroteGeom_

bool	parallel_

bool	useTimeDir_

bool	isPointData_

bool	verbose_

label	nFields_

scalar	mergeDim_

mergedSurf	merged_

instant	currTime_

fileName	outputPath_

Static Protected Attributes inherited from surfaceWriter
static const meshedSurf::emptySurface	emptySurface_

Detailed Description

A surfaceWriter for OpenFOAM surfaces.

formatOptions
{
    foam
    {
        format      ascii;
        compression true;

        fieldScale
        {
           "p.*"   0.01;  // [Pa] -> [mbar]
        }
    }
}

Format options:

Property	Description	Required	Default
`format`	ascii/binary	no	ascii
`compression`	output file compression	no	false
`fieldScale`	output field scaling (dictionary)	no	empty

file locations

The rootdir normally corresponds to something like postProcessing/<name>

Geometry

    rootdir
    `-- timeName
        `-- surfaceName
            |-- "points"
            |-- "faceCentres"
            `-- "faces"

Fields

    rootdir
    `-- timeName
        `-- surfaceName
            |-- scalarField
            |   |-- field
            |   `-- field
            |-- vectorField
                |-- field
                `-- field

Source files

Definition at line 121 of file foamSurfaceWriter.H.

Constructor & Destructor Documentation

◆ foamWriter() [1/4]

foamWriter ( )

Definition at line 43 of file foamSurfaceWriter.C.

◆ foamWriter() [2/4]

foamWriter ( const dictionary & options )

explicit

Definition at line 52 of file foamSurfaceWriter.C.

◆ foamWriter() [3/4]

foamWriter	(	const meshedSurf &	surf,
		const fileName &	outputPath,
		bool	parallel = `Pstream::parRun()`,
		const dictionary &	options = `dictionary()`
	)

Definition at line 67 of file foamSurfaceWriter.C.

◆ foamWriter() [4/4]

foamWriter	(	const pointField &	points,
		const faceList &	faces,
		const fileName &	outputPath,
		bool	parallel = `Pstream::parRun()`,
		const dictionary &	options = `dictionary()`
	)

Definition at line 81 of file foamSurfaceWriter.C.

References points.

◆ ~foamWriter()

virtual ~foamWriter ( )

virtualdefault

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "foam" )

◆ separateGeometry()

virtual bool separateGeometry ( ) const

inlinevirtual

Reimplemented from surfaceWriter.

Definition at line 186 of file foamSurfaceWriter.H.

◆ write()

Foam::fileName write ( )

virtual

Implements surfaceWriter.

Definition at line 97 of file foamSurfaceWriter.C.

References Foam::endl(), meshedSurf::faces(), forAll, Foam::Info, Foam::isDir(), UPstream::master(), Foam::mkDir(), fileName::path(), points, meshedSurf::points(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ declareSurfaceWriterWriteMethod() [1/6]

declareSurfaceWriterWriteMethod ( label )

◆ declareSurfaceWriterWriteMethod() [2/6]

declareSurfaceWriterWriteMethod ( scalar )

◆ declareSurfaceWriterWriteMethod() [3/6]

declareSurfaceWriterWriteMethod ( vector )

◆ declareSurfaceWriterWriteMethod() [4/6]

declareSurfaceWriterWriteMethod ( sphericalTensor )

◆ declareSurfaceWriterWriteMethod() [5/6]

declareSurfaceWriterWriteMethod ( symmTensor )

◆ declareSurfaceWriterWriteMethod() [6/6]

declareSurfaceWriterWriteMethod ( tensor )

◆ writeTemplate()

Foam::fileName writeTemplate	(	const word &	fieldName,
		const Field< Type > &	localValues
	)

Definition at line 157 of file foamSurfaceWriter.C.

References Foam::endl(), Foam::equal(), Foam::Info, Foam::isDir(), UPstream::master(), Foam::mkDir(), fileName::path(), timeName, FieldBase::typeName, and Foam::vtk::write().