Core routines used when reading/writing AVL/FIRE files. More...

Inheritance diagram for FIRECore:

Collaboration diagram for FIRECore:

Public Types
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
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
	FIRECore ()=default
	Construct null. More...

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

Static Protected Attributes
static const Enum< fileExt3d >	file3dExtensions

Detailed Description

Core routines used when reading/writing AVL/FIRE files.

Source files

Definition at line 60 of file FIRECore.H.

Member Typedef Documentation

◆ fireInt_t

typedef int32_t fireInt_t

Integer type (binary format)

Definition at line 96 of file FIRECore.H.

◆ fireReal_t

typedef double fireReal_t

Float type (binary format)

Definition at line 99 of file FIRECore.H.

Member Enumeration Documentation

◆ selectionType

enum selectionType

Selection Types.

Enumerator
cellSelection
faceSelection

Definition at line 67 of file FIRECore.H.

◆ shapeType

enum shapeType

Shape-Type for FIRE (FLMA) files.

Enumerator
fireLine
fireTri
fireQuad
fireTet
fireHex
firePyr
firePrism

Definition at line 74 of file FIRECore.H.

◆ fileExt3d

enum fileExt3d

Enumeration defining the file extensions for 3D types.

Enumerator
POLY_ASCII
POLY_BINARY
POLY_ASCII_Z
POLY_BINARY_Z

Definition at line 86 of file FIRECore.H.

Constructor & Destructor Documentation

◆ FIRECore()

FIRECore ( )

protecteddefault

Construct null.

Member Function Documentation

◆ readPoints()

Foam::label readPoints	(	ISstream &	is,
		pointField &	points
	)

staticprotected

Read points.

This is the first thing to do when reading FPMA,FPMB,FLMA files. Return the number of points read.

The file format is as follows:

NUMBER_OF_VERTICES
x0 y0 z0 x1 y1 z1 ... xN-1 yN-1 zN-1

Definition at line 48 of file FIRECore.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, n, ISstream::name(), and points.

Here is the call graph for this function:

◆ fireFileName()

Foam::fileName fireFileName	(	const fileName &	baseName,
		const enum fileExt3d	ext
	)

static

Resolve base file-name for the given file-type.

Definition at line 79 of file FIRECore.C.

Referenced by FIREMeshWriter::write().

Here is the caller graph for this function:

◆ getFireLabel()

Foam::label getFireLabel ( ISstream & is )

static

Get an integer (ascii or binary)

Definition at line 88 of file FIRECore.C.

References IOstreamOption::BINARY, IOstreamOption::format(), Foam::readLabel(), and ISstream::stdStream().

Referenced by FIREMeshReader::readFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirePoint()

Foam::point getFirePoint ( ISstream & is )

static

Get an point x/y/z (ascii or binary)

Definition at line 109 of file FIRECore.C.

References IOstreamOption::BINARY, IOstreamOption::format(), ISstream::stdStream(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ getFireString()

std::string getFireString ( ISstream & is )

static

Extract a string (ascii or binary)

Definition at line 138 of file FIRECore.C.

References IOstreamOption::BINARY, IOstreamOption::format(), ISstream::getLine(), Foam::pos(), s, and ISstream::stdStream().

Here is the call graph for this function:

◆ putFireLabel()

void putFireLabel	(	OSstream &	os,
		const label	value
	)

static

Write an integer (ascii or binary)

Definition at line 202 of file FIRECore.C.

References IOstreamOption::BINARY, and os().

Here is the call graph for this function:

◆ putFireLabels() [1/2]

void putFireLabels	(	OSstream &	os,
		const labelUList &	lst
	)

static

Write multiple integers (ascii or binary)

Definition at line 225 of file FIRECore.C.

References IOstreamOption::BINARY, forAll, os(), and UList< T >::size().

Here is the call graph for this function:

◆ putFireLabels() [2/2]

void putFireLabels	(	OSstream &	os,
		const label	count,
		const label	start
	)

static

Write an on-the-fly list of integers (ascii or binary)

Definition at line 264 of file FIRECore.C.

References IOstreamOption::BINARY, Foam::BitOps::count(), and os().

Here is the call graph for this function:

◆ putFirePoint()

void putFirePoint	(	OSstream &	os,
		const point &	value
	)

static

Write a point x/y/z (ascii or binary)

Definition at line 305 of file FIRECore.C.

References IOstreamOption::BINARY, os(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ putFireString()

void putFireString	(	OSstream &	os,
		const std::string &	value
	)

static

Write a string (ascii or binary)

Definition at line 334 of file FIRECore.C.

References IOstreamOption::BINARY, and os().

Here is the call graph for this function:

Member Data Documentation

◆ file3dExtensions

const Foam::Enum< Foam::fileFormats::FIRECore::fileExt3d > file3dExtensions

staticprotected

Definition at line 106 of file FIRECore.H.

Referenced by FIREMeshReader::readGeometry(), and FIREMeshWriter::write().

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

src/fileFormats/fire/FIRECore.H
src/fileFormats/fire/FIRECore.C

Public Types

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ fireInt_t

◆ fireReal_t

Member Enumeration Documentation

◆ selectionType

◆ shapeType

◆ fileExt3d

Constructor & Destructor Documentation

◆ FIRECore()

Member Function Documentation

◆ readPoints()

◆ fireFileName()

◆ getFireLabel()

◆ getFirePoint()

◆ getFireString()

◆ putFireLabel()

◆ putFireLabels() [1/2]

◆ putFireLabels() [2/2]

◆ putFirePoint()

◆ putFireString()

Member Data Documentation

◆ file3dExtensions