BoundingBox Class Reference

This class is keeps the information of the boundaries of a fluid/boundary object. More...

#include <initializer.h>

Public Member Functions
	BoundingBox (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	Constructor. More...
double	getXmin ()
	Getter function of the minimum value in x-coordinate of the bounding box. More...
double	getXmax ()
	Getter function of the maximum value in x-coordinate of the bounding box. More...
double	getYmin ()
	Getter function of the minimum value in y-coordinate of the bounding box. More...
double	getYmax ()
	Getter function of the maximum value in y-coordinate of the bounding box. More...
double	getZmin ()
	Getter function of the minimum value in z-coordinate of the bounding box. More...
double	getZmax ()
	Getter function of the maximum value in z-coordinate of the bounding box. More...
size_t	getStartIndex ()
	Getter function of the start index in the particle arrays of the fluid/boundary object inside this bounding box. More...
size_t	getNumber ()
	Getter function of the number of particles of the fluid/boundary object inside this bounding box. More...
void	setXmin (double xmin)
	Setter function of the minimum value in x-coordinate of the bounding box. More...
void	setXmax (double xmax)
	Setter function of the maximum value in x-coordinate of the bounding box. More...
void	setYmin (double ymin)
	Setter function of the minimum value in y-coordinate of the bounding box. More...
void	setYmax (double ymax)
	Setter function of the maximum value in y-coordinate of the bounding box. More...
void	setZmin (double zmin)
	Setter function of the minimum value in z-coordinate of the bounding box. More...
void	setZmax (double zmax)
	Setter function of the maximum value in z-coordinate of the bounding box. More...
void	setStartIndex (size_t index)
	Setter function of the start index in the particle arrays of the fluid/boundary object inside this bounding box. More...
void	setNumber (size_t num)
	Setter function of the number of particles of the fluid/boundary object inside this bounding box. More...

Detailed Description

This class is keeps the information of the boundaries of a fluid/boundary object.

The bounding box can be updated by the setter member methods

Author

Chen, Hsin-Chiang (morri.nosp@m.sche.nosp@m.n2008.nosp@m.@gma.nosp@m.il.co.nosp@m.m)

Version

1.0

Date

2014/06/09

Created on: 2014/06/01

Constructor & Destructor Documentation

BoundingBox::BoundingBox ( double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax  )

inline

Constructor.

Initializes the bounding box using the parameters in the argument list

Parameters

[in]	xmin	The minimum value in the x-coordinate
[in]	xmax	The maximum value in the x-coordinate
[in]	ymin	The minimum value in the y-coordinate
[in]	ymax	The maximum value in the y-coordinate
[in]	zmin	The minimum value in the z-coordinate
[in]	zmax	The maximum value in the z-coordinate

Member Function Documentation

size_t BoundingBox::getNumber ( )

inline

Getter function of the number of particles of the fluid/boundary object inside this bounding box.

Parameters

None

Returns

The number of particles of the fluid/boundary object inside this bounding box

size_t BoundingBox::getStartIndex ( )

inline

Getter function of the start index in the particle arrays of the fluid/boundary object inside this bounding box.

Parameters

None

Returns

The start index in the particle arrays of the fluid/boundary object inside this bounding box

Note

The particle arrays refer to the major arrays like the x, y, z-coordinates of the ParticleData class

double BoundingBox::getXmax ( )

inline

Getter function of the maximum value in x-coordinate of the bounding box.

Parameters

None

Returns

The maximum value in x-coordinate of the bounding box

double BoundingBox::getXmin ( )

inline

Getter function of the minimum value in x-coordinate of the bounding box.

Parameters

None

Returns

The minimum value in x-coordinate of the bounding box

double BoundingBox::getYmax ( )

inline

Getter function of the maximum value in y-coordinate of the bounding box.

Parameters

None

Returns

The maximum value in y-coordinate of the bounding box

double BoundingBox::getYmin ( )

inline

Getter function of the minimum value in y-coordinate of the bounding box.

Parameters

None

Returns

The minimum value in y-coordinate of the bounding box

double BoundingBox::getZmax ( )

inline

Getter function of the maximum value in z-coordinate of the bounding box.

Parameters

None

Returns

The maximum value in z-coordinate of the bounding box

double BoundingBox::getZmin ( )

inline

Getter function of the minimum value in z-coordinate of the bounding box.

Parameters

None

Returns

The minimum value in z-coordinate of the bounding box

void BoundingBox::setNumber ( size_t  num )

inline

Setter function of the number of particles of the fluid/boundary object inside this bounding box.

Parameters

The	number of particles of the fluid/boundary object inside this bounding box

Returns

None

void BoundingBox::setStartIndex ( size_t  index )

inline

Setter function of the start index in the particle arrays of the fluid/boundary object inside this bounding box.

Parameters

The	start index in the particle arrays of the fluid/boundary object inside this bounding box

Returns

None

Note

The particle arrays refer to the major arrays like the x, y, z-coordinates of the ParticleData class

void BoundingBox::setXmax ( double  xmax )

inline

Setter function of the maximum value in x-coordinate of the bounding box.

Parameters

xmax	The maximum value in x-coordinate of the bounding box

Returns

None

void BoundingBox::setXmin ( double  xmin )

inline

Setter function of the minimum value in x-coordinate of the bounding box.

Parameters

xmin	The minimum value in x-coordinate of the bounding box

Returns

None

void BoundingBox::setYmax ( double  ymax )

inline

Setter function of the maximum value in y-coordinate of the bounding box.

Parameters

ymax	The maximum value in y-coordinate of the bounding box

Returns

None

void BoundingBox::setYmin ( double  ymin )

inline

Setter function of the minimum value in y-coordinate of the bounding box.

Parameters

ymin	The minimum value in y-coordinate of the bounding box

Returns

None

void BoundingBox::setZmax ( double  zmax )

inline

Setter function of the maximum value in z-coordinate of the bounding box.

Parameters

zmax	The maximum value in z-coordinate of the bounding box

Returns

None

void BoundingBox::setZmin ( double  zmin )

inline

Setter function of the minimum value in z-coordinate of the bounding box.

Parameters

zmin	The minimum value in z-coordinate of the bounding box

Returns

None

---

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

• initializer.h