An implementation of ensightPart to hold mesh faces. More...

Inheritance diagram for ensightPartFaces:

Collaboration diagram for ensightPartFaces:

Public Member Functions
	TypeName ("ensightFaces")
	Runtime type information. More...

	ensightPartFaces (label partIndex, const string &description, const pointField &points, const faceList &faces, const bool contiguousPoints=false)
	Construct part with 0-based index, description, points and faces. More...

	ensightPartFaces (label partIndex, const polyMesh &mesh, const polyPatch &patch, const string &partName="")

	ensightPartFaces (label partIndex, const polyPatch &patch, const string &partName="")

virtual	~ensightPartFaces ()=default
	Destructor. More...

virtual label	index () const
	Part index (0-based) More...

virtual label	size () const
	Number of elements in this part. More...

label	patchIndex () const
	Return the patch index, -1 when not in use. More...

virtual void	writeSummary (Ostream &os) const
	Write summary information about the object. More...

virtual void	dumpInfo (Ostream &os) const
	Print various types of debugging information. More...

virtual void	write (ensightGeoFile &os) const
	Write geometry. More...

virtual void	write (ensightGeoFile &os, const pointField &points) const
	Helper: write geometry given the pointField. More...

Public Member Functions inherited from ensightFaces
	ensightFaces ()
	Construct null, with part index 0. More...

	ensightFaces (const label partIndex)
	Construct null, with specified part index. More...

	ensightFaces (const ensightFaces &obj)
	Copy constructor. Needed for lists etc. More...

	~ensightFaces ()=default
	Destructor. More...

label	index () const
	The index in a list. More...

label &	index ()
	The index in a list, non-const access. More...

label	size () const
	The processor local size of all elements. More...

label	size (const enum elemType) const
	The processor local size of the specified element type. More...

label	total () const
	The global number of all element types. More...

label	total (const enum elemType) const
	The global number of the specified element type. More...

const FixedList< label, 3 > &	totals () const
	The global numbers per element type. More...

FixedList< label, 3 >	sizes () const
	The processor local sizes per element type. More...

label	offset (const enum elemType what) const
	Processor local starting offset of element type. More...

const labelUList	faceIds (const enum elemType) const
	Return the (local) face ids of the specified element type. More...

const labelUList &	faceIds () const
	Return the processor local face ids of all elements. More...

const boolList &	flipMap () const
	Return the processor local flip-map of all elements. More...

void	classify (const faceList &faces)
	Classify the face types, set element list. More...

void	classify (const faceList &faces, const labelUList &addressing, const boolList &flipMap=boolList(), const bitSet &exclude=bitSet())
	Classify the face types, set element list. More...

void	clear ()
	Set addressable sizes to zero, free up addressing memory. More...

void	reduce ()
	Sum element counts across all processes. More...

void	sort ()
	Sort element lists numerically. More...

label	operator[] (const label i) const
	Return element from linear-list. More...

Public Member Functions inherited from ensightPart
	TypeName ("ensightPart")
	Runtime type information. More...

	ensightPart (const string &description)
	Construct with description. More...

virtual	~ensightPart ()=default
	Destructor. More...

const string &	name () const
	Return the part name or description. More...

void	rename (string value)
	Change the part name or description. More...

void	FOAM_DEPRECATED_FOR (2019-12, "rename() method") name(string value)
	Deprecated(2019-12) - use rename() method. More...

Additional Inherited Members
Public Types inherited from ensightFaces
enum	elemType { TRIA3, QUAD4, NSIDED }
	Addressable ensight element types. More...

Static Public Member Functions inherited from ensightFaces
static const char *	key (const enum elemType)
	Return the ensight element name for the specified type. More...

Static Public Attributes inherited from ensightFaces
static constexpr int	nTypes = 3
	Number of element types (3) More...

static const char *	elemNames [3]
	The ensight element type names. More...

Detailed Description

An implementation of ensightPart to hold mesh faces.

Source files

Definition at line 53 of file ensightPartFaces.H.

Constructor & Destructor Documentation

◆ ensightPartFaces() [1/3]

ensightPartFaces	(	label	partIndex,
		const string &	description,
		const pointField &	points,
		const faceList &	faces,
		const bool	contiguousPoints = `false`
	)

Construct part with 0-based index, description, points and faces.

Can skip local point renumbering when points are contiguous

Definition at line 92 of file ensightPartFaces.C.

◆ ensightPartFaces() [2/3]

ensightPartFaces	(	label	partIndex,
		const polyMesh &	mesh,
		const polyPatch &	patch,
		const string &	partName = `""`
	)

Construct from polyMesh and polyPatch Part receives the name of the patch unless otherwise specified.

Definition at line 114 of file ensightPartFaces.C.

References Foam::foamVersion::patch.

◆ ensightPartFaces() [3/3]

ensightPartFaces	(	label	partIndex,
		const polyPatch &	patch,
		const string &	partName = `""`
	)

Construct from polyPatch Part receives the name of the patch unless otherwise specified.

Definition at line 140 of file ensightPartFaces.C.

◆ ~ensightPartFaces()

virtual ~ensightPartFaces ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ensightFaces" )

Runtime type information.

◆ index()

virtual label index ( ) const

inlinevirtual

Part index (0-based)

Implements ensightPart.

Definition at line 157 of file ensightPartFaces.H.

References ensightFaces::index().

Here is the call graph for this function:

◆ size()

virtual label size ( ) const

inlinevirtual

Number of elements in this part.

Reimplemented from ensightPart.

Definition at line 164 of file ensightPartFaces.H.

References ensightFaces::size().

Here is the call graph for this function:

◆ patchIndex()

label patchIndex ( ) const

inline

Return the patch index, -1 when not in use.

Definition at line 171 of file ensightPartFaces.H.

Referenced by Foam::ensightOutput::Serial::writeVolField().

Here is the caller graph for this function:

◆ writeSummary()

void writeSummary ( Ostream & os ) const

virtual

Write summary information about the object.

Implements ensightPart.

Definition at line 266 of file ensightPartFaces.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), Foam::type(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ dumpInfo()

void dumpInfo ( Ostream & os ) const

virtual

Print various types of debugging information.

Implements ensightPart.

Definition at line 279 of file ensightPartFaces.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::endEntry(), ensightFaces::key(), Foam::name(), ensightFaces::nTypes, Foam::type(), Ostream::writeEntry(), Ostream::writeKeyword(), and UList< T >::writeList().

Here is the call graph for this function:

◆ write() [1/2]

void write ( ensightGeoFile & os ) const

virtual

Write geometry.

Implements ensightPart.

Definition at line 260 of file ensightPartFaces.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ write() [2/2]

void write	(	ensightGeoFile &	os,
		const pointField &	points
	)		const

virtual

Helper: write geometry given the pointField.

Implements ensightPart.

Definition at line 218 of file ensightPartFaces.C.

References ensightGeoFile::beginCoordinates(), ensightGeoFile::beginPart(), Foam::component(), forAll, ensightFaces::key(), ensightPart::localPoints::list, Foam::name(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, ensightFile::newline(), ensightPart::localPoints::nPoints, ensightFaces::nTypes, points, and ensightFile::write().

Here is the call graph for this function:

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

src/fileFormats/ensight/part/ensightPartFaces.H
src/fileFormats/ensight/part/ensightPartFaces.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ensightPartFaces() [1/3]

◆ ensightPartFaces() [2/3]

◆ ensightPartFaces() [3/3]

◆ ~ensightPartFaces()

Member Function Documentation

◆ TypeName()

◆ index()

◆ size()

◆ patchIndex()

◆ writeSummary()

◆ dumpInfo()

◆ write() [1/2]

◆ write() [2/2]