---

SantaAna.c File Reference

#include "SantaAna.h"

Go to the source code of this file.

Functions
	IsSantaAnaNowFromProps (ChHashTable * proptbl, int year, int month, int day)
	Tests whether a Santa Ana event occurs during this day in the simulation. More...
int	GetSantaAnaEnvFromProps (ChHashTable * proptbl, int month, int day, int hour, double * waz, double fbedhgtm, double * wspmps, double * d1hfm, double * d10hfm, double * d100hfm)
	The procedure employed to mimic Santa Ana conditions during the simulation is similar to that used for simulations incorporating wind speed, wind direction, and dead fuel moisture using the RANDOM_HISTORICAL option. 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 SantaAna.c.

---

Function Documentation

int GetSantaAnaEnvFromProps ( ChHashTable * proptbl, int month, int day, int hour, double * waz, double fbedhgtm, double * wspmps, double * d1hfm, double * d10hfm, double * d100hfm )

The procedure employed to mimic Santa Ana conditions during the simulation is similar to that used for simulations incorporating wind speed, wind direction, and dead fuel moisture using the RANDOM_HISTORICAL option. At the start of each day designated as a Santa Ana, a uniform random number is chosen to index the same year/month/day record from all three files. The conditions experienced during the randomly chosen year/month/day are used during the given day in the simulation. For multi-day Santa Anas a new index is chosen at the start of the next day. See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties month   1 based month to retrieve conditions for day   1 based day in month to retrieve conditions for hour   value of 0-23 corresponding to hour on given month and day to retrieve conditions for waz   wind direction for the given mo-dy-hr fbedhgtm   fuel bed height in meters (used to determine windspeed reduction factor) wspmps   wind speed in meters per seconds for the given mo-dy-hr d1hfm   dead 1 hour fuel moisture for the given mo-dy-hr d10hfm   dead 10 hour fuel moisture for the given mo-dy-hr d100hfm   dead 100 hour fuel moisture for the given mo-dy-hr 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 124 of file SantaAna.c.

int IsSantaAnaNowFromProps ( ChHashTable * proptbl, int year, int month, int day )

Tests whether a Santa Ana event occurs during this day in the simulation. This method converts the value of the keyword SANTA_ANA_FREQUENCY_PER_YEAR to a probability relative to the length of the fire season and uses a uniform random number generator to determine if a Santa Ana event occurs this day. See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties year   current year in simulation month   current month in simulation day   current day in simulation Return values: int   Returns 1 (true) if there is a Santa Ana event this day, or 0 (false) otherwise. Definition at line 27 of file SantaAna.c.

---