Foam::ensightOutput Namespace Reference

A collection of functions for writing ensight file content. More...

Namespaces
	Detail
	Implementation details and output backends that would not normally be called directly by a user.

Functions
template<class Type >
bool	writeAreaField (ensightFile &os, const GeometricField< Type, faPatchField, areaMesh > &fld, const ensightFaMesh &ensMesh)
	Write finite-area field component-wise. More...
template<class Type >
bool	writeVolField (ensightFile &os, const GeometricField< Type, fvPatchField, volMesh > &vf, const ensightMesh &ensMesh)
	Write volume field component-wise. More...
template<class Type >
bool	writeVolField (ensightFile &os, const GeometricField< Type, fvPatchField, volMesh > &vf, const ensightMesh &ensMesh, const bool nodeValues)
	Write volume field component-wise, optionally forcing interpolation. More...
template<class Type >
bool	writePointField (ensightFile &os, const GeometricField< Type, pointPatchField, pointMesh > &pf, const ensightMesh &ensMesh)
	Write point field component-wise. More...
void	writeFaceList (ensightGeoFile &os, const UList< face > &faces)
	Write list of faces. More...
void	writeFaceList (ensightGeoFile &os, const UIndirectList< face > &faces)
	Write list of faces. More...
void	writeCellShapes (ensightGeoFile &os, const UList< cellShape > &shapes)
	Write cell connectivity via cell shapes. More...
void	writePolysPoints (ensightGeoFile &os, const cellUList &meshCells, const labelUList &addr, const faceUList &meshFaces, const labelUList &faceOwner)
	Write the point ids per poly element. More...
void	writePolysPoints (ensightGeoFile &os, const polyMesh &mesh, const labelUList &addr, const labelList &pointMap)
	Write the point ids per poly element, with point renumbering. More...
void	writeFaceConnectivity (ensightGeoFile &os, const ensightFaces::elemType etype, const label nTotal, const UIndirectList< face > &faces, bool parallel)
void	writeFaceConnectivity (ensightGeoFile &os, const ensightFaces::elemType etype, const label nTotal, const faceUList &faces, bool parallel)
	Write the regular face connectivity for specified type. More...
void	writeFaceConnectivity (ensightGeoFile &os, const ensightFaces &part, const faceUList &faces, bool parallel)
	Write the face connectivity for the part. More...
void	writeFaceConnectivityPresorted (ensightGeoFile &os, const ensightFaces &part, const faceUList &faces, bool parallel)
	Write the presorted face connectivity for the part. More...
template<class Type >
bool	writeField (ensightFile &os, const Field< Type > &fld, const ensightCells &part, bool parallel)
template<class Type >
bool	writeField (ensightFile &os, const Field< Type > &fld, const ensightFaces &part, bool parallel)
bool	writeCloudPositions (const fvMesh &mesh, const word &cloudName, bool exists, autoPtr< ensightFile > &output)
	Write cloud positions. More...
template<class Type >
bool	writeCloudField (const IOField< Type > &field, ensightFile &os)
	Write cloud field, returning true if the field is non-empty. More...
template<class Type >
bool	writeCloudField (const IOobject &io, bool exists, autoPtr< ensightFile > &output)

Detailed Description

A collection of functions for writing ensight file content.

Source files

• ensightOutput.H
• ensightOutput.C
• ensightOutputTemplates.C

Function Documentation

writeAreaField()

bool writeAreaField	(	ensightFile &	os,
		const GeometricField< Type, faPatchField, areaMesh > &	fld,
		const ensightFaMesh &	ensMesh
	)

Write finite-area field component-wise.

Definition at line 36 of file ensightOutputAreaFieldTemplates.C.

References ensightFaMesh::areaPart(), fld, os(), and Foam::ensightOutput::Detail::writeFaceLocalField().

Here is the call graph for this function:

writeVolField() [1/2]

bool writeVolField	(	ensightFile &	os,
		const GeometricField< Type, fvPatchField, volMesh > &	vf,
		const ensightMesh &	ensMesh
	)

Write volume field component-wise.

Definition at line 42 of file ensightOutputVolFieldTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), ensightMesh::boundaryParts(), ensightMesh::cellZoneParts(), ensightFaces::decrFaceIds(), faceId(), ensightFaces::faceIds(), ensightMesh::faceZoneParts(), forAll, forAllConstIters(), Foam::linearInterpolate(), Foam::max(), mesh, polyPatch::offset(), os(), patchId(), ensightFaces::size(), polyBoundaryMesh::start(), Foam::HashTableOps::values(), Foam::ensightOutput::Detail::writeFaceSubField(), writeField(), and Foam::Zero.

Here is the call graph for this function:

writeVolField() [2/2]

bool writeVolField	(	ensightFile &	os,
		const GeometricField< Type, fvPatchField, volMesh > &	vf,
		const ensightMesh &	ensMesh,
		const bool	nodeValues
	)

Write volume field component-wise, optionally forcing interpolation.

Definition at line 330 of file ensightOutputVolFieldTemplates.C.

References Foam::fac::interpolate(), Foam::New(), os(), and tmp< T >::ref().

Here is the call graph for this function:

writePointField()

bool writePointField	(	ensightFile &	os,
		const GeometricField< Type, pointPatchField, pointMesh > &	pf,
		const ensightMesh &	ensMesh
	)

Write point field component-wise.

Definition at line 201 of file ensightOutputVolFieldTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), ensightMesh::boundaryParts(), ensightMesh::cellZoneParts(), coordinates(), ensightMesh::faceZoneParts(), ensightPart::index(), GeometricField< Type, PatchField, GeoMesh >::internalField(), mesh, ensightMesh::mesh(), PrimitivePatch< FaceList, PointField >::meshPointMap(), os(), patchId(), ensightFaces::uniqueMeshPoints(), ensightCells::uniqueMeshPoints(), and Foam::ensightOutput::Detail::writeFieldComponents().

Here is the call graph for this function:

writeFaceList() [1/2]

void writeFaceList	(	ensightGeoFile &	os,
		const UList< face > &	faces
	)

Write list of faces.

Definition at line 137 of file ensightOutput.C.

References f(), and os().

Referenced by writeFaceConnectivity().

Here is the call graph for this function:

Here is the caller graph for this function:

writeFaceList() [2/2]

void writeFaceList	(	ensightGeoFile &	os,
		const UIndirectList< face > &	faces
	)

Write list of faces.

Definition at line 155 of file ensightOutput.C.

References f(), and os().

Here is the call graph for this function:

writeCellShapes()

void writeCellShapes	(	ensightGeoFile &	os,
		const UList< cellShape > &	shapes
	)

Write cell connectivity via cell shapes.

Definition at line 173 of file ensightOutput.C.

References os().

Here is the call graph for this function:

writePolysPoints() [1/2]

void writePolysPoints	(	ensightGeoFile &	os,
		const cellUList &	meshCells,
		const labelUList &	addr,
		const faceUList &	meshFaces,
		const labelUList &	faceOwner
	)

Write the point ids per poly element.

Points have been already renumbered

Parameters

addr	Cell ids to write

Definition at line 238 of file ensightOutput.C.

References cellId, f(), faceId(), os(), and UList< T >::size().

Here is the call graph for this function:

writePolysPoints() [2/2]

void writePolysPoints	(	ensightGeoFile &	os,
		const polyMesh &	mesh,
		const labelUList &	addr,
		const labelList &	pointMap
	)

Write the point ids per poly element, with point renumbering.

Parameters

addr	Cell ids to write
pointMap	Point map to use

Definition at line 195 of file ensightOutput.C.

References cellId, f(), faceId(), mesh, and os().

Here is the call graph for this function:

writeFaceConnectivity() [1/3]

void writeFaceConnectivity	(	ensightGeoFile &	os,
		const ensightFaces::elemType	etype,
		const label	nTotal,
		const UIndirectList< face > &	faces,
		bool	parallel
	)

Write the regular face connectivity for specified type and and specified faces

Parameters

parallel

Collective write?

Definition at line 369 of file ensightOutput.C.

References Foam::ensightOutput::Detail::getFaceSizes(), Foam::glTF::key(), os(), and writeFaceList().

Referenced by ensightOutputSurface::write(), writeFaceConnectivity(), and writeFaceConnectivityPresorted().

Here is the call graph for this function:

Here is the caller graph for this function:

writeFaceConnectivity() [2/3]

void writeFaceConnectivity	(	ensightGeoFile &	os,
		const ensightFaces::elemType	etype,
		const label	nTotal,
		const faceUList &	faces,
		bool	parallel
	)

Write the regular face connectivity for specified type.

Parameters

parallel

Collective write?

Definition at line 278 of file ensightOutput.C.

References Foam::ensightOutput::Detail::getFaceSizes(), Foam::glTF::key(), os(), and writeFaceList().

Here is the call graph for this function:

writeFaceConnectivity() [3/3]

void writeFaceConnectivity	(	ensightGeoFile &	os,
		const ensightFaces &	part,
		const faceUList &	faces,
		bool	parallel
	)

Write the face connectivity for the part.

Parameters

parallel

Collective write?

Definition at line 462 of file ensightOutput.C.

References ensightFaces::faceIds(), os(), ensightFaces::total(), and writeFaceConnectivity().

Here is the call graph for this function:

writeFaceConnectivityPresorted()

void writeFaceConnectivityPresorted	(	ensightGeoFile &	os,
		const ensightFaces &	part,
		const faceUList &	faces,
		bool	parallel
	)

Write the presorted face connectivity for the part.

This is a special case when the list of faces is already in ensight sorted order

Parameters

parallel

Collective write?

Definition at line 486 of file ensightOutput.C.

References os(), ensightFaces::range(), ensightFaces::total(), and writeFaceConnectivity().

Referenced by ensightFaces::write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeField() [1/2]

bool writeField	(	ensightFile &	os,
		const Field< Type > &	fld,
		const ensightCells &	part,
		bool	parallel
	)

Write a field of cell values as an indirect list, using the cell ids from ensightCells

Parameters

parallel

Collective write?

Definition at line 313 of file ensightOutputTemplates.C.

References ensightCells::cellIds(), fld, ensightPart::index(), Foam::glTF::key(), os(), reduce(), ensightCells::size(), ensightCells::total(), and Foam::ensightOutput::Detail::writeFieldComponents().

Referenced by rotorDiskSource::read(), exprResult::writeDict(), ensightOutputSurface::writeFaceData(), and writeVolField().

Here is the call graph for this function:

Here is the caller graph for this function:

writeField() [2/2]

bool writeField	(	ensightFile &	os,
		const Field< Type > &	fld,
		const ensightFaces &	part,
		bool	parallel
	)

Write a field of faces values as an indirect list, using the face ids from ensightFaces

Parameters

parallel

Collective write?

Definition at line 363 of file ensightOutputTemplates.C.

References ensightFaces::faceIds(), fld, ensightPart::index(), Foam::glTF::key(), os(), reduce(), ensightFaces::size(), ensightFaces::total(), and Foam::ensightOutput::Detail::writeFieldComponents().

Here is the call graph for this function:

writeCloudPositions()

bool writeCloudPositions	(	const fvMesh &	mesh,
		const word &	cloudName,
		bool	exists,
		autoPtr< ensightFile > &	output
	)

Write cloud positions.

Definition at line 79 of file ensightOutputCloud.C.

References cloudName(), Foam::exists(), globalIndex::localSize(), globalIndex::maxSize(), mesh, os(), Foam::output(), p, Foam::blockMeshTools::read(), DynamicList< T, SizeMin >::reserve(), autoPtr< T >::reset(), DynamicList< T, SizeMin >::resize_nocopy(), Foam::returnReduce(), globalIndex::subProcs(), Foam::vtk::write(), Foam::writeMeasured_ascii(), and Foam::writeMeasured_binary().

Referenced by if().

Here is the call graph for this function:

Here is the caller graph for this function:

writeCloudField() [1/2]

bool writeCloudField	(	const IOField< Type > &	field,
		ensightFile &	os
	)

Write cloud field, returning true if the field is non-empty.

Definition at line 71 of file ensightOutputCloudTemplates.C.

References Foam::BitOps::count(), field(), globalIndex::localSize(), globalIndex::maxNonLocalSize(), os(), Foam::blockMeshTools::read(), globalIndex::reset(), DynamicList< T, SizeMin >::resize_nocopy(), Foam::returnReduce(), globalIndex::subProcs(), Foam::vtk::write(), and Foam::ensightOutput::Detail::writeCloudFieldContent().

Referenced by writeCloudField().

Here is the call graph for this function:

Here is the caller graph for this function:

writeCloudField() [2/2]

bool writeCloudField	(	const IOobject &	io,
		bool	exists,
		autoPtr< ensightFile > &	output
	)

Read cloud field from IOobject (if exists == true) and write, always returning true.

Definition at line 152 of file ensightOutputCloudTemplates.C.

References Foam::exists(), field(), Foam::output(), IOobject::readOpt(), and writeCloudField().

Here is the call graph for this function: