---

WindAzimuth.c File Reference

#include "WindAzimuth.h"

Go to the source code of this file.

Functions
int	GetWindAzimuthFIXEDFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz)
	Returns a wind azimuth to be used for given {month, day, hour} of simulation. More...
int	GetWindAzimuthRANDUFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz)
	Returns a wind azimuth to be used for given {month, day, hour} of simulation. More...
int	GetWindAzimuthSPATIALFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz)
	Returns a wind azimuth to be used for given {month, day, hour} of simulation. More...

---

Detailed Description

Author(s):

Marco Morais

Date:

2000-2001

HFire (Highly Optmized Tolerance Fire Spread Model) Library Copyright (C) 2001 Marco Morais

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Definition in file WindAzimuth.c.

---

Function Documentation

int GetWindAzimuthFIXEDFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz )

Returns a wind azimuth to be used for given {month, day, hour} of simulation. For FIXED implementations the value of keyword WIND_AZIMUTH_FIXED_FILE is used to load a DblTwoDArray of month, day, hour wind azimuth values. The supplied arguments are used to index the table and retrieve the recorded azimuth. Static variables are used to ensure that the table is initialized only once and that repeat table indexes are avoided. See also: Check the config file documentation Parameters: proptbl   HashTable of simulation properties month   1 based month to retrieve azimuth for day   1 based day in month to retrieve azimuth for hour   value of 0-23 corresponding to hour on given month and day to retrieve azimuth for row   cell row index to retrieve azimuth for (spatial only) col   cell col index to retrieve azimuth for (spatial only) waz   double corresponding to value of wind azimuth in the range 0-360 Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 27 of file WindAzimuth.c.

int GetWindAzimuthRANDHFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz )

Definition at line 111 of file WindAzimuth.c.

int GetWindAzimuthRANDUFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz )

Returns a wind azimuth to be used for given {month, day, hour} of simulation. For RANDU implementations a uniform random number in therange 0-360 is drawn and returned as the wind azimuth. Static variables are used to ensure that the same wind azimuth is retrieved for every call to this function during the same {month, day, hour}. See also: Check the config file documentation Parameters: proptbl   HashTable of simulation properties month   1 based month to retrieve azimuth for day   1 based day in month to retrieve azimuth for hour   value of 0-23 corresponding to hour on given month and day to retrieve azimuth for row   cell row index to retrieve azimuth for (spatial only) col   cell col index to retrieve azimuth for (spatial only) waz   double corresponding to value of wind azimuth in the range 0-360 Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 83 of file WindAzimuth.c.

int GetWindAzimuthSPATIALFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * waz )

Returns a wind azimuth to be used for given {month, day, hour} of simulation. Using this option each cell in the simulation domain is assigned a unique wind azimuth based upon index into a raster of wind azimuths See also: Check the config file documentation Parameters: proptbl   HashTable of simulation properties month   1 based month to retrieve azimuth for day   1 based day in month to retrieve azimuth for hour   value of 0-23 corresponding to hour on given month and day to retrieve azimuth for row   cell row index to retrieve azimuth for (spatial only) col   cell col index to retrieve azimuth for (spatial only) waz   double corresponding to value of wind azimuth in the range 0-360 Return values: ERR_SUCCESS   (0) if operation successful, an error code otherwise Note: Best use of this facility is as follows: int error_status = SomeFunctionXXX(); if ( error_status ) // something bad happened Definition at line 165 of file WindAzimuth.c.

---