FlowGeometry Class Reference

class for handling the geometry == rectangular grids organized in vertices and cells More...

#include <FlowGeometry.h>

List of all members.

Public Member Functions
	~FlowGeometry ()
	deletes the allocated geometry storage
bool	getInterpolationAt (vec3 pos, int *vtxID, float *coef)
	Returns true if inside. Stores the vertex indices and interpolation weights for the given position in the arrays.
bool	readFromFile (char *header, FILE *fp, bool bigEndian)
	reads the geometry grids data from a file
int	getDimX ()
	returns the number of vertices in X dimension
int	getDimY ()
	returns the number of vertices in Y dimension
int	getDimZ ()
	returns the number of vertices in Z dimension, is always 1
float	getMinX ()
	returns the minimum in the X dimension
float	getMaxX ()
	returns the maximum in the X dimension
float	getMinY ()
	returns the minimum in the Y dimension
float	getMaxY ()
	returns the maximum in the Y dimension
vec3	getPos (int vtxID)
	returns the position of the vertex
float	getPosX (int vtxID)
	returns the x position of the vertex
float	getPosY (int vtxID)
	returns the y position of the vertex
int	getRightNeigh (int vtxID)
	returns the vertex ID of the neighbor on its right
int	getTopNeigh (int vtxID)
	returns the vertex ID of the neighbor on its top
int	getLeftNeigh (int vtxID)
	returns the vertex ID of the neighbor on its left
int	getBottomNeigh (int vtxID)
	returns the vertex ID of the neighbor on its bottom
vec3	normalizeCoords (vec3 pos)
	compression of coordinates in each dimension separately, returns values scaled to <0,1>
vec3	unNormalizeCoords (vec3 pos)
	inverts the compression. From values of <0,1> it restores the real geometrical coordinates
Friends
class	FlowData

---

Detailed Description

class for handling the geometry == rectangular grids organized in vertices and cells

---

Constructor & Destructor Documentation

FlowGeometry::~FlowGeometry

(

)

deletes the allocated geometry storage

---

Member Function Documentation

int FlowGeometry::getBottomNeigh

(

int

vtxID

)

returns the vertex ID of the neighbor on its bottom

int FlowGeometry::getDimX

(

)

[inline]

returns the number of vertices in X dimension

int FlowGeometry::getDimY

(

)

[inline]

returns the number of vertices in Y dimension

int FlowGeometry::getDimZ

(

)

[inline]

returns the number of vertices in Z dimension, is always 1

bool FlowGeometry::getInterpolationAt	(	vec3	pos,
		int *	vtxID,
		float *	coef
	)

Returns true if inside. Stores the vertex indices and interpolation weights for the given position in the arrays.

Stores the indexes and weights of vertices surrounding the given position. This information can be used later on for interpolation of channel values.

Parameters:

pos	geometrical position for the lookup
vtxID	list of surrounding vertices (given by vertex ID)
coef	list of surrounding vertex weights (sum == 1.0)

Returns:

true if the given position is inside of the geometrical boundaries

int FlowGeometry::getLeftNeigh

(

int

vtxID

)

returns the vertex ID of the neighbor on its left

float FlowGeometry::getMaxX

(

)

[inline]

returns the maximum in the X dimension

float FlowGeometry::getMaxY

(

)

[inline]

returns the maximum in the Y dimension

float FlowGeometry::getMinX

(

)

[inline]

returns the minimum in the X dimension

float FlowGeometry::getMinY

(

)

[inline]

returns the minimum in the Y dimension

vec3 FlowGeometry::getPos

(

int

vtxID

)

[inline]

returns the position of the vertex

float FlowGeometry::getPosX

(

int

vtxID

)

[inline]

returns the x position of the vertex

float FlowGeometry::getPosY

(

int

vtxID

)

[inline]

returns the y position of the vertex

int FlowGeometry::getRightNeigh

(

int

vtxID

)

returns the vertex ID of the neighbor on its right

int FlowGeometry::getTopNeigh

(

int

vtxID

)

returns the vertex ID of the neighbor on its top

vec3 FlowGeometry::normalizeCoords

(

vec3

pos

)

compression of coordinates in each dimension separately, returns values scaled to <0,1>

bool FlowGeometry::readFromFile	(	char *	header,
		FILE *	fp,
		bool	bigEndian
	)

reads the geometry grids data from a file

vec3 FlowGeometry::unNormalizeCoords

(

vec3

pos

)

inverts the compression. From values of <0,1> it restores the real geometrical coordinates

---

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

• FlowGeometry.h
• FlowGeometry.cpp