Provide a means of writing AVL/FIRE FLMA format. More...

Inheritance diagram for FLMAsurfaceFormat< Face >:

Collaboration diagram for FLMAsurfaceFormat< Face >:

Public Member Functions
	FLMAsurfaceFormat ()=default
	Default construct. More...

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

virtual void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Write surface mesh as flma file. More...

Public Member Functions inherited from MeshedSurface< Face >
	ClassName ("MeshedSurface")
	Declare type-name (with debug switch) More...

	MeshedSurface ()
	Default construct, an empty surface. More...

	MeshedSurface (const MeshedSurface &surf)
	Copy construct. More...

	MeshedSurface (const UnsortedMeshedSurface< Face > &surf)
	Copy construct from an UnsortedMeshedSurface. More...

	MeshedSurface (MeshedSurface &&surf)
	Move construct. More...

	MeshedSurface (UnsortedMeshedSurface< Face > &&surf)
	Move construct from an UnsortedMeshedSurface. More...

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)
	Copy construct from components (points, faces, zones). More...

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)
	Move construct from components (points, faces). More...

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Copy construct from components (points, faces). More...

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Move construct from components (points, faces). More...

	MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)
	Construct from a boundary mesh with local points/faces. More...

	MeshedSurface (const surfMesh &mesh)
	Construct from a surfMesh. More...

	MeshedSurface (const fileName &name)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (const fileName &name, const word &fileType)
	Construct from file name and given file type. More...

	MeshedSurface (Istream &is)
	Construct from Istream. More...

	MeshedSurface (const Time &runTime)
	Construct from database (as surfMesh) with default name. More...

	MeshedSurface (const Time &runTime, const word &surfName)
	Construct from database (as surfMesh) with given surface name. More...

	MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Read construct using IO to find the file location. More...

	declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))

virtual	~MeshedSurface ()
	Destructor. More...

	declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options))

label	size () const
	The surface size is the number of faces. More...

const List< Face > &	surfFaces () const
	Return const access to the faces. More...

const labelList &	faceIds () const
	Return const access to faces ids. More...

const surfZoneList &	surfZones () const
	Const access to the surface zones. More...

const vectorField &	Sf () const
	Face area vectors (normals) More...

const scalarField &	magSf () const
	Face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

virtual void	clear ()
	Clear all storage. More...

virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)
	Add surface zones. More...

bool	addZonesToFaces ()
	Propagate zone information on face regions. More...

virtual void	removeZones ()
	Remove surface zones. More...

virtual void	movePoints (const pointField &newPoints)
	Move points. More...

virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

virtual void	cleanup (const bool verbose)
	Remove invalid faces. More...

virtual void	compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))
	Remove unused points and renumber faces in local visit order. More...

virtual bool	stitchFaces (const scalar tol=SMALL, const bool verbose=false)

virtual bool	checkFaces (const bool verbose=false)

virtual label	nTriangles () const
	Count number of triangles. More...

virtual label	nTriangles (labelList &faceMap) const
	Count number of triangles, returning a face map of original ids. More...

virtual label	triangulate ()
	Triangulate in-place, returning the number of triangles added. More...

virtual label	triangulate (labelList &faceMap)
	Triangulate in-place, returning the number of triangles added. More...

template<class BoolListType >
void	subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
	Create mappings for a sub-surface. More...

MeshedSurface	subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const UList< bool > &include) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const bitSet &include) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const
	Return a new surface subsetted on the selected zone names. More...

void	swap (MeshedSurface< Face > &surf)
	Swap contents. More...

void	transfer (pointField &pointLst, List< Face > &faceLst)
	Transfer the components. More...

void	transfer (MeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument. More...

void	transfer (UnsortedMeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument. More...

autoPtr< MeshedSurface< Face > >	releaseGeom ()
	Release (clear) geometry and return for reuse. More...

void	swapFaces (List< Face > &faces)
	Swap the stored faces. Use with caution. More...

void	swapPoints (pointField &points)
	Swap the stored points. More...

bool	read (const fileName &name, const word &fileType)
	Read from file. Chooses reader based on explicit extension. More...

virtual bool	read (const fileName &name)
	Read from file. Chooses reader based on detected extension. More...

void	writeStats (Ostream &os) const

virtual void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Generic write routine for given format type. More...

void	write (const Time &runTime, const word &surfName=word::null) const
	Write to database. More...

void	operator= (const MeshedSurface< Face > &surf)
	Copy assignment. More...

void	operator= (MeshedSurface< Face > &&surf)
	Move assignment. More...

	operator MeshedSurfaceProxy< Face > () const
	Conversion operator to MeshedSurfaceProxy. More...

template<class Face>
	MeshedSurface (const MeshedSurface< Face > &surf)

template<class Face>
	MeshedSurface (MeshedSurface< Face > &&surf)

template<>
bool	addZonesToFaces ()
	Specialization for labelledTri. More...

template<>
bool	addZonesToFaces ()

Static Public Member Functions
static void	write (const fileName &filename, const MeshedSurfaceProxy< Face > &surf, IOstreamOption=IOstreamOption(), const dictionary &=dictionary::null)
	Write surface mesh components by proxy. More...

Static Public Member Functions inherited from MeshedSurface< Face >
static wordHashSet	readTypes ()
	Known readable file-types, without friends or proxies. More...

static wordHashSet	writeTypes ()
	Known writable file-types, without friends or proxies. More...

static bool	canReadType (const word &fileType, bool verbose=false)
	Can we read this file format? Also checks friend types. More...

static bool	canWriteType (const word &fileType, bool verbose=false)
	Can we write this file format? Also checks proxy types. More...

static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format? More...

static autoPtr< MeshedSurface >	New (const fileName &name, const word &fileType, bool mandatory=true)
	Read construct from filename with given file type. More...

static autoPtr< MeshedSurface >	New (const fileName &name)
	Read construct from filename (file type implicit from extension) More...

static void	write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on its extension. More...

static void	write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on the given extension. More...

Static Public Member Functions inherited from FIRECore
static fileName	fireFileName (const fileName &baseName, const enum fileExt3d)
	Resolve base file-name for the given file-type. More...

static label	getFireLabel (ISstream &)
	Get an integer (ascii or binary) More...

static point	getFirePoint (ISstream &)
	Get an point x/y/z (ascii or binary) More...

static std::string	getFireString (ISstream &)
	Extract a string (ascii or binary) More...

static void	putFireLabel (OSstream &, const label)
	Write an integer (ascii or binary) More...

static void	putFireLabels (OSstream &, const labelUList &)
	Write multiple integers (ascii or binary) More...

static void	putFireLabels (OSstream &, const label count, const label start)
	Write an on-the-fly list of integers (ascii or binary) More...

static void	putFirePoint (OSstream &, const point &)
	Write a point x/y/z (ascii or binary) More...

static void	putFireString (OSstream &, const std::string &)
	Write a string (ascii or binary) More...

Static Protected Member Functions
static void	write (OSstream &os, const MeshedSurfaceProxy< Face > &surf)
	Write surface mesh components by proxy. More...

static void	write (IOstreamOption::compressionType comp, const fileName &filename, const MeshedSurfaceProxy< Face > &surf)
	Write surface mesh components by proxy with/without compression. More...

Static Protected Member Functions inherited from FIRECore
static label	readPoints (ISstream &, pointField &)
	Read points. More...

Additional Inherited Members
Public Types inherited from MeshedSurface< Face >
typedef Face	face_type
	The face type (same as the underlying PrimitivePatch) More...

typedef point	point_type
	The point type (same as the underlying PrimitivePatch) More...

Public Types inherited from FIRECore
enum	selectionType { cellSelection = 2, faceSelection = 3 }
	Selection Types. More...

enum	shapeType { fireLine = 1, fireTri = 2, fireQuad = 3, fireTet = 4, fireHex = 5, firePyr = 6, firePrism = 8 }
	Shape-Type for FIRE (FLMA) files. More...

enum	fileExt3d { POLY_ASCII, POLY_BINARY, POLY_ASCII_Z, POLY_BINARY_Z }
	Enumeration defining the file extensions for 3D types. More...

typedef int32_t	fireInt_t
	Integer type (binary format) More...

typedef double	fireReal_t
	Float type (binary format) More...

Protected Member Functions inherited from MeshedSurface< Face >
void	transcribe (MeshedSurface< face > &surf)
	Transfer points/zones from 'face' to other other shapes. More...

void	checkZones (const bool verbose=true)
	Sanity check/resizing on zones. More...

pointField &	storedPoints ()
	Non-const access to global points. More...

List< Face > &	storedFaces ()
	Non-const access to the faces. More...

labelList &	storedFaceIds ()
	Non-const access to face ids. More...

surfZoneList &	storedZones ()
	Non-const access to the zones. More...

void	sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted)
	Sort faces by zones and store sorted faces. More...

virtual void	remapFaces (const labelUList &faceMapNewToOld)
	Set new zones from faceMap. More...

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

Protected Member Functions inherited from FIRECore
	FIRECore ()=default
	Construct null. More...

Static Protected Attributes inherited from FIRECore
static const Enum< fileExt3d >	file3dExtensions

Detailed Description

template<class Face>
class Foam::fileFormats::FLMAsurfaceFormat< Face >

Provide a means of writing AVL/FIRE FLMA format.

Output stream options:

ASCII only
compression : ignored

Output dictionary options: ignored

Note: The internal logic is still a bit odd (2020-02) since compressed files must have a .flmaz ending. To be revisited in the future.

Source files

Definition at line 66 of file FLMAsurfaceFormat.H.

Constructor & Destructor Documentation

◆ FLMAsurfaceFormat()

FLMAsurfaceFormat ( )

default

Default construct.

◆ ~FLMAsurfaceFormat()

virtual ~FLMAsurfaceFormat ( )

virtualdefault

Destructor.

Member Function Documentation

◆ write() [1/4]

void write	(	OSstream &	os,
		const MeshedSurfaceProxy< Face > &	surf
	)

staticprotected

Write surface mesh components by proxy.

Definition at line 156 of file FLMAsurfaceFormat.C.

References Foam::endl(), Foam::exit(), f(), Foam::faceMap(), MeshedSurfaceProxy< Face >::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, zoneIdentifier::name(), Foam::nl, os(), MeshedSurfaceProxy< Face >::points(), UList< T >::size(), MeshedSurfaceProxy< Face >::surfFaces(), MeshedSurfaceProxy< Face >::surfZones(), and MeshedSurfaceProxy< Face >::useFaceMap().

Referenced by FLMAsurfaceFormat< Face >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/4]

void write	(	IOstreamOption::compressionType	comp,
		const fileName &	filename,
		const MeshedSurfaceProxy< Face > &	surf
	)

staticprotected

Write surface mesh components by proxy with/without compression.

Definition at line 300 of file FLMAsurfaceFormat.C.

References autoPtr< T >::clear(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, autoPtr< T >::good(), Foam::mv(), Foam::nl, and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [3/4]

void write	(	const fileName &	filename,
		const MeshedSurfaceProxy< Face > &	surf,
		IOstreamOption	= `IOstreamOption()`,
		const dictionary &	= `dictionary::null`
	)

static

Write surface mesh components by proxy.

Definition at line 339 of file FLMAsurfaceFormat.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ write() [4/4]

virtual void write	(	const fileName &	name,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const dictionary &	options = `dictionary::null`
	)		const

inlinevirtual

Write surface mesh as flma file.

Reimplemented from MeshedSurface< Face >.

Reimplemented in FLMAZsurfaceFormat< Face >.

Definition at line 125 of file FLMAsurfaceFormat.H.

References Foam::name(), and FLMAsurfaceFormat< Face >::write().

Here is the call graph for this function:

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

src/surfMesh/surfaceFormats/fire/FLMAsurfaceFormat.H
src/surfMesh/surfaceFormats/fire/FLMAsurfaceFormat.C

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

template<class Face> class Foam::fileFormats::FLMAsurfaceFormat< Face >

Constructor & Destructor Documentation

◆ FLMAsurfaceFormat()

◆ ~FLMAsurfaceFormat()

Member Function Documentation

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

template<class Face>
class Foam::fileFormats::FLMAsurfaceFormat< Face >