FIREMeshWriter Class Reference

Writes polyMesh in AVL/FIRE polyhedra format (fpma, fpmb) More...

Inheritance diagram for FIREMeshWriter:

Collaboration diagram for FIREMeshWriter:

Public Member Functions
	FIREMeshWriter (const polyMesh &, const scalar scaleFactor=1.0)
	Prepare for writing, optionally with scaling. More...
virtual	~FIREMeshWriter ()=default
	Destructor. More...
virtual bool	write (const fileName &meshName=fileName::null) const
	Write volume mesh. More...
Public Member Functions inherited from meshWriter
	meshWriter (const polyMesh &, const scalar scaling=1.0)
	Create a writer object with given output scaling. More...
virtual	~meshWriter ()
	Destructor. More...

Static Public Attributes
static bool	binary = false
	Write binary (default ascii) More...
static bool	compress = false
	Write with compression (default false) More...
static bool	prefixBoundary = true
	Prefix patches with 'BND_' before writing (default true) More...
Static Public Attributes inherited from meshWriter
static string	defaultMeshName = "meshExport"
	Specify a default mesh name. More...

Additional Inherited Members
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...
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...
Protected Member Functions inherited from FIRECore
	FIRECore ()=default
	Construct null. More...
Static Protected Member Functions inherited from FIRECore
static label	readPoints (ISstream &, pointField &)
	Read points. More...
Protected Attributes inherited from meshWriter
const polyMesh &	mesh_
	Mesh reference. More...
scalar	scaleFactor_
	Scaling factor for points (eg, [m] -> [mm]) More...
boundaryRegion	boundaryRegion_
	boundaryRegion persistent data saved as a dictionary More...
cellTable	cellTable_
	cellTable persistent data saved as a dictionary More...
labelList	cellTableId_
	cellTable IDs for each cell More...
Static Protected Attributes inherited from FIRECore
static const Enum< fileExt3d >	file3dExtensions

Detailed Description

Writes polyMesh in AVL/FIRE polyhedra format (fpma, fpmb)

It is also possible to write compressed formats (fpmaz, fpmbz)

Note

The fpma, fpmb formats are relatively poorly documented, but are manageable to read and write. It is, however, not recommended to import them directly into AVL/FIRE (the GUI) since it is generally not robust enough. Instead use their file-convertor to reconvert them into their native format.

In the AVL/FIRE polyhedra format, the faces normals point inwards, whereas the OpenFOAM face normals always point outwards.

Source files

• FIREMeshWriter.H
• FIREMeshWriter.C

Definition at line 62 of file FIREMeshWriter.H.

Constructor & Destructor Documentation

FIREMeshWriter()

FIREMeshWriter	(	const polyMesh &	mesh,
		const scalar	scaleFactor = 1.0
	)

Prepare for writing, optionally with scaling.

Treats a zero or negative scale factor as unity scaling.

Definition at line 238 of file FIREMeshWriter.C.

~FIREMeshWriter()

virtual ~FIREMeshWriter ( )

virtualdefault

Destructor.

Member Function Documentation

write()

bool write ( const fileName &  meshName = fileName::null ) const

virtual

Write volume mesh.

Implements meshWriter.

Definition at line 249 of file FIREMeshWriter.C.

References IOstreamOption::ASCII, IOstreamOption::BINARY, autoPtr< T >::clear(), IOstreamOption::COMPRESSED, IOstreamOption::compression(), TimePaths::constant(), meshWriter::defaultMeshName, Foam::endl(), fileName::ext(), FIRECore::file3dExtensions, FIRECore::fireFileName(), IOstreamOption::format(), found, autoPtr< T >::good(), Foam::Info, Foam::mv(), FIRECore::POLY_ASCII, FIRECore::POLY_BINARY, fileName::remove_ext(), objectRegistry::time(), Time::timeName(), IOstreamOption::UNCOMPRESSED, and writeGeometry().

Here is the call graph for this function:

Member Data Documentation

binary

bool binary = false

static

Write binary (default ascii)

Definition at line 96 of file FIREMeshWriter.H.

compress

bool compress = false

static

Write with compression (default false)

Definition at line 101 of file FIREMeshWriter.H.

prefixBoundary

bool prefixBoundary = true

static

Prefix patches with 'BND_' before writing (default true)

Definition at line 106 of file FIREMeshWriter.H.

---

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

• src/conversion/fire/FIREMeshWriter.H
• src/conversion/fire/FIREMeshWriter.C