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

#include <FIRECore.H>

Inheritance diagram for FIRECore:

[legend]

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).
typedef double	fireReal_t
	Float type (binary format).

Static Public Member Functions
static fileName	fireFileName (const fileName &baseName, const enum fileExt3d)
	Resolve base file-name for the given file-type.
static label	getFireLabel (ISstream &)
	Get an integer (ascii or binary).
static point	getFirePoint (ISstream &)
	Get an point x/y/z (ascii or binary).
static std::string	getFireString (ISstream &)
	Extract a string (ascii or binary).
static void	putFireLabel (OSstream &, const label)
	Write an integer (ascii or binary).
static void	putFireLabels (OSstream &, const labelUList &)
	Write multiple integers (ascii or binary).
static void	putFireLabels (OSstream &, const label count, const label start)
	Write an on-the-fly list of integers (ascii or binary).
static void	putFirePoint (OSstream &, const point &)
	Write a point x/y/z (ascii or binary).
static void	putFireString (OSstream &, const std::string &)
	Write a string (ascii or binary).

Protected Member Functions
	FIRECore ()=default
	Construct null.

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

Static Protected Attributes
static const Enum< fileExt3d >	file3dExtensions

Detailed Description

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

Source files

Definition at line 55 of file FIRECore.H.

Member Typedef Documentation

◆ fireInt_t

typedef int32_t fireInt_t

Integer type (binary format).

Definition at line 99 of file FIRECore.H.

◆ fireReal_t

typedef double fireReal_t

Float type (binary format).

Definition at line 104 of file FIRECore.H.

Member Enumeration Documentation

◆ selectionType

enum selectionType

Selection Types.

Enumerator
cellSelection
faceSelection

Definition at line 64 of file FIRECore.H.

◆ shapeType

enum shapeType

Shape-Type for FIRE (FLMA) files.

Enumerator
fireLine
fireTri
fireQuad
fireTet
fireHex
firePyr
firePrism

Definition at line 73 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 87 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 40 of file FIRECore.C.

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

Referenced by FIREMeshReader::readPoints().

Here is the call graph for this function:

Here is the caller 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 71 of file FIRECore.C.

References file3dExtensions.

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 81 of file FIRECore.C.

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

Referenced by FIREMeshReader::readCells(), FIREMeshReader::readFaces(), readPoints(), and FIREMeshReader::readSelections().

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 103 of file FIRECore.C.

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

Referenced by readPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFireString()

std::string getFireString ( ISstream & is )

static

Extract a string (ascii or binary).

Definition at line 133 of file FIRECore.C.

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

Referenced by FIREMeshReader::readSelections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putFireLabel()

void putFireLabel	(	OSstream &	os,
		const label	value )

static

Write an integer (ascii or binary).

Definition at line 198 of file FIRECore.C.

References IOstreamOption::BINARY, and os().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putFireLabels() [1/2]

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

static

Write multiple integers (ascii or binary).

Definition at line 223 of file FIRECore.C.

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

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

Here is the call graph for this function:

Here is the caller 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, 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 307 of file FIRECore.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putFireString()

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

static

Write a string (ascii or binary).

Definition at line 338 of file FIRECore.C.

References IOstreamOption::BINARY, and os().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ file3dExtensions

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

staticprotected

Definition at line 111 of file FIRECore.H.

Referenced by fireFileName(), 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