GpuThesis::FireParameters Class Reference

#include <FireParameters.h>

Inheritance diagram for GpuThesis::FireParameters:

GpuThesis::Fire3dSimulator List of all members.

Public Member Functions

float getBurningRate () const
void setBurningRate (float burningRate)
float getOutputHeat () const
void setOutputHeat (float outputHeat)
float getStoichiometricMixture () const
void setStoichiometricMixture (float stoichiometricMixture)
float getThreshold () const
void setThreshold (float threshold)
float getExhaustDissipation () const
void setExhaustDissipation (float exhaustDissipation)
float getTemperatureDissipation () const
void setTemperatureDissipation (float temperatureDissipation)
float getFuelDissipation () const
void setFuelDissipation (float fuelDissipation)
float getExhaustDiffusion () const
void setExhaustDiffusion (float exhaustDiffusion)
float getTemperatureDiffusion () const
void setTemperatureDiffusion (float temperatureDiffusion)
float getFuelDiffusion () const
void setFuelDiffusion (float fuelDiffusion)
float getGravity () const
void setGravity (float gravity)
float getBuoyancy () const
void setBuoyancy (float buoyancy)
float getVorticityWeight () const
void setVorticityWeight (float vorticityWeight)
float getViscosity () const
void setViscosity (float viscosity)
float getVorticity () const
void setVorticity (float vorticity)
unsigned int getJacobiSteps () const
void setJacobiSteps (unsigned int jacobiSteps)
float getFireColorScale () const
void setFireColorScale (float fireColorScale)
float getSmokeTemperatureScale () const
void setSmokeTemperatureScale (float smokeTemperatureScale)
float getSmokeDensity () const
void setSmokeDensity (float smokeDensity)
Math::Vector3d getSmokeColor () const
void setSmokeColor (Math::Vector3d smokeColor)
float getSmokeVisibilityThreshold () const
void setSmokeVisibilityThreshold (float smokeVisibilityThreshold)
bool getCompute2dColors () const
void setCompute2dColors (bool compute2dColors)
float getMassExpansion () const
void setMassExpansion (float massExpansion)
Math::Vector3d getGlobalWind () const
void setGlobalWind (Math::Vector3d globalWind)
Math::Vector3d getGlobalWindAmplitude () const
void setGlobalWindAmplitude (Math::Vector3d globalWindAmplitude)
Math::Vector3d getGlobalWindAngle () const
void setGlobalWindAngle (Math::Vector3d globalWindAngle)
bool getGlobalWindDynamic () const
void setGlobalWindDynamic (bool globalWindDynamic)

Detailed Description

Contains all the parameters governing the fire simulation.


Member Function Documentation

float GpuThesis::FireParameters::getBuoyancy  )  const
 

Buoyancy controls the force which makes air rise due to heat.

Returns:
the buoyancy.

float GpuThesis::FireParameters::getBurningRate  )  const
 

Burning rate governs how fast fuel can be combusted.

Returns:
the burning rate.

bool GpuThesis::FireParameters::getCompute2dColors  )  const
 

Compute 2d colors controls whether to compute the color field using the approach from the 2d gpu fire.

Returns:
whether to compute 2d colors.

float GpuThesis::FireParameters::getExhaustDiffusion  )  const
 

Exhaust diffusion is the rate at which exhaust diffuses.

Returns:
the exhaust diffusion.

float GpuThesis::FireParameters::getExhaustDissipation  )  const
 

Exhaust dissipation is the rate at which exhaust dissipates.

Returns:
the exhaust dissipation.

float GpuThesis::FireParameters::getFireColorScale  )  const
 

The fire color scale controls the brightness of the color field.

Returns:
the fire color scale.

float GpuThesis::FireParameters::getFuelDiffusion  )  const
 

Fuel diffusion is the rate at which fuel diffuses.

Returns:
the fuel diffusion.

float GpuThesis::FireParameters::getFuelDissipation  )  const
 

Fuel dissipation is the rate at which fuel dissipates.

Returns:
the fuel dissipation.

Math::Vector3d GpuThesis::FireParameters::getGlobalWind  )  const
 

The static global wind of the fire simulation (the wind at the boundaries).

Returns:
the static global wind.

Math::Vector3d GpuThesis::FireParameters::getGlobalWindAmplitude  )  const
 

The amplitude parameters of the dynamic global wind. The x, y, and z components control the min, max, and frequency of the amplitude.

Returns:
the dynamic global wind amplitude parameters.

Math::Vector3d GpuThesis::FireParameters::getGlobalWindAngle  )  const
 

The angle parameters of the dynamic global wind. The x, y, and z components control the min, max, and frequency of the angle.

Returns:
the dynamic global wind angle parameters.

bool GpuThesis::FireParameters::getGlobalWindDynamic  )  const
 

Global wind dynamic controls whether to have static or dynamic global wind. Static global wind is constant, whereas dynamic global wind is governed by angle and amplitude parameters.

See also:
getGlobalWind

getGlobalWindAmplitude

getGlobalWindAngle

Returns:
whether to use dynamic global wind.

float GpuThesis::FireParameters::getGravity  )  const
 

Gravity controls the force with which fuel and exhaust are pulled down.

Returns:
the gravity.

unsigned int GpuThesis::FireParameters::getJacobiSteps  )  const
 

Jacobi steps controls how many steps are used in the diffusion and projection solvers. The more Jacobi steps the more accurate diffusion and projection.

Returns:
the number of jacobi steps.

float GpuThesis::FireParameters::getMassExpansion  )  const
 

Mass expansion controls how fuel gas expands when being converted to exhaust gas.

Returns:
the mass expansion.

float GpuThesis::FireParameters::getOutputHeat  )  const
 

Output heat governs how much heat is created in the combustion reaction.

Returns:
the output heat.

Math::Vector3d GpuThesis::FireParameters::getSmokeColor  )  const
 

The color of the smoke.

Returns:
the smoke's color as a Vector3d.

float GpuThesis::FireParameters::getSmokeDensity  )  const
 

The smoke density controls how dense the smoke appears.

Returns:
the smoke density.

float GpuThesis::FireParameters::getSmokeTemperatureScale  )  const
 

The smoke temperature scale controls how cool the exhaust gas must be to be treated as smoke.

Returns:
the smoke temperature scale.

float GpuThesis::FireParameters::getSmokeVisibilityThreshold  )  const
 

The smoke visibility threshold controls the amount of exhaust gas below which smoke particles are respawned.

Returns:
the smoke visibility threshold.

float GpuThesis::FireParameters::getStoichiometricMixture  )  const
 

Stoichiometric mixture governs how much oxygen is involved in the combustion reaction. Higher stoichiometric mixture causes more exhaust gas to be produced by one unit of fuel.

Returns:
the stoichiometric mixture.

float GpuThesis::FireParameters::getTemperatureDiffusion  )  const
 

Temperature diffusion is the rate at which temperature diffuses.

Returns:
the temperature diffusion.

float GpuThesis::FireParameters::getTemperatureDissipation  )  const
 

Temperature dissipation is the rate at which temperature dissipates.

Returns:
the temperature dissipation.

float GpuThesis::FireParameters::getThreshold  )  const
 

Threshold is the lowest temperature at which the combustion reaction takes place.

Returns:
the temperature threshold.

float GpuThesis::FireParameters::getViscosity  )  const
 

Viscosity controls the "thickness" of the air.

Returns:
the viscosity.

float GpuThesis::FireParameters::getVorticity  )  const
 

Vorticity controls the rate at which vortices in the velocity field are enhanced.

Returns:
the vorticity.

float GpuThesis::FireParameters::getVorticityWeight  )  const
 

The vorticity weight controls how the vorticity is increased outside the flame.

Returns:
the vorticity weight.

void GpuThesis::FireParameters::setBuoyancy float  buoyancy  ) 
 

Set the buoyancy.

See also:
getBuoyancy
Parameters:
buoyancy the new buoyancy.

void GpuThesis::FireParameters::setBurningRate float  burningRate  ) 
 

Set the burning rate.

See also:
getBurningRate
Parameters:
burningRate the new burning rate.

void GpuThesis::FireParameters::setCompute2dColors bool  compute2dColors  ) 
 

Set whether to compute 2d colors.

See also:
getCompute2dColors
Parameters:
compute2dColors whether to compute 2d colors.

void GpuThesis::FireParameters::setExhaustDiffusion float  exhaustDiffusion  ) 
 

Set the exhaust diffusion.

See also:
getExhaustDiffusion
Parameters:
exhaustDiffusion the exhaust diffusion.

void GpuThesis::FireParameters::setExhaustDissipation float  exhaustDissipation  ) 
 

Set the exhaust dissipation.

See also:
getExhaustDissipation
Parameters:
exhaustDissipation the exhaust dissipation.

void GpuThesis::FireParameters::setFireColorScale float  fireColorScale  ) 
 

Set the fire color scale.

See also:
getFireColorScale
Parameters:
fireColorScale the new fire color scale.

void GpuThesis::FireParameters::setFuelDiffusion float  fuelDiffusion  ) 
 

Set the fuel diffusion.

See also:
getFuelDiffusion
Parameters:
fuelDiffusion the fuel diffusion.

void GpuThesis::FireParameters::setFuelDissipation float  fuelDissipation  ) 
 

Set the fuel dissipation.

See also:
getFuelDissipation
Parameters:
fuelDissipation the fuel dissipation.

void GpuThesis::FireParameters::setGlobalWind Math::Vector3d  globalWind  ) 
 

Set the static global wind.

See also:
getGlobalWind
Parameters:
globalWind the new static global wind.

void GpuThesis::FireParameters::setGlobalWindAmplitude Math::Vector3d  globalWindAmplitude  ) 
 

Set the dynamic global wind amplitude parameters.

See also:
getGlobalWindAmplitude
Parameters:
globalWindAmplitude the new dynamic global wind amplitude parameters.

void GpuThesis::FireParameters::setGlobalWindAngle Math::Vector3d  globalWindAngle  ) 
 

Set the dynamic global wind angle parameters.

See also:
getGlobalWindAngle
Parameters:
globalWindAngle the new dynamic global wind angle parameters.

void GpuThesis::FireParameters::setGlobalWindDynamic bool  globalWindDynamic  ) 
 

Set whether to use dynamic global wind.

See also:
getGlobalWindDynamic
Parameters:
globalWindDynamic whether to use dynamic global wind.

void GpuThesis::FireParameters::setGravity float  gravity  ) 
 

Set the gravity.

See also:
getGravity
Parameters:
gravity the new gravity.

void GpuThesis::FireParameters::setJacobiSteps unsigned int  jacobiSteps  ) 
 

Set the number of jacobi steps.

See also:
getJacobiSteps
Parameters:
jacobiSteps the new number of jacobi steps.

void GpuThesis::FireParameters::setMassExpansion float  massExpansion  ) 
 

Set the mass expansion.

See also:
getMassExpansion
Parameters:
massExpansion the new mass expansion.

void GpuThesis::FireParameters::setOutputHeat float  outputHeat  ) 
 

Set the output heat.

See also:
getOutputHeat
Parameters:
outputHeat the new output heat.

void GpuThesis::FireParameters::setSmokeColor Math::Vector3d  smokeColor  ) 
 

Set the smoke color.

See also:
getSmokeColor
Parameters:
smokeColor the new smoke color.

void GpuThesis::FireParameters::setSmokeDensity float  smokeDensity  ) 
 

Set the smoke density.

See also:
getSmokeDensity
Parameters:
smokeDensity the new smoke density.

void GpuThesis::FireParameters::setSmokeTemperatureScale float  smokeTemperatureScale  ) 
 

Set the smoke temperature scale.

See also:
getSmokeTemperatureScale
Parameters:
smokeTemperatureScale the new smoke temperature scale.

void GpuThesis::FireParameters::setSmokeVisibilityThreshold float  smokeVisibilityThreshold  ) 
 

Set the smoke visibility threshold.

See also:
getSmokeVisibilityThreshold
Parameters:
smokeVisibilityThreshold the new smoke visibility threshold.

void GpuThesis::FireParameters::setStoichiometricMixture float  stoichiometricMixture  ) 
 

Set the stoichiometric mixture.

See also:
getStoichiometricMixture
Parameters:
stoichiometricMixture the new stoichiometricMixture.

void GpuThesis::FireParameters::setTemperatureDiffusion float  temperatureDiffusion  ) 
 

Set the temperature diffusion.

See also:
getTemperatureDiffusion
Parameters:
temperatureDiffusion the temperature diffusion.

void GpuThesis::FireParameters::setTemperatureDissipation float  temperatureDissipation  ) 
 

Set the temperature dissipation.

See also:
getTemperatureDissipation
Parameters:
temperatureDissipation the temperature dissipation.

void GpuThesis::FireParameters::setThreshold float  threshold  ) 
 

Set the threshold.

See also:
getThreshold
Parameters:
threshold the new threshold.

void GpuThesis::FireParameters::setViscosity float  viscosity  ) 
 

Set the viscosity.

See also:
getViscosity
Parameters:
viscosity the new viscosity.

void GpuThesis::FireParameters::setVorticity float  vorticity  ) 
 

Set the vorticity.

See also:
getVorticity
Parameters:
vorticity the vorticity.

void GpuThesis::FireParameters::setVorticityWeight float  vorticityWeight  ) 
 

Set the vorticity weight.

See also:
getVorticityWeight
Parameters:
vorticityWeight the new vorticity weight.


The documentation for this class was generated from the following files:
Generated on Fri Jun 16 08:42:50 2006 for GPU Thesis by  doxygen 1.4.6-NO