---

DeadFuelMoist.c File Reference

#include "DeadFuelMoist.h"

Go to the source code of this file.

Functions
int	GetDeadFuelMoistFIXEDFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm)
	retrieves time and space dependent dead fuel moisture value at a cell. More...
int	GetDeadFuelMoistRANDHFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm)
	retrieves time and space dependent dead fuel moisture value at a cell. More...
int	GetDeadFuelMoistSPATIALFromProps (ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm)
	retrieves time and space dependent dead fuel moisture value at a cell. 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 DeadFuelMoist.c.

---

Function Documentation

int GetDeadFuelMoistFIXEDFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm )

retrieves time and space dependent dead fuel moisture value at a cell. Using this option each cell in the simulation domain is assigned a dead fuel moisture based upon index into a table of historical values See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties year   date to retreive live fuel moisture for month   date to retreive live fuel moisture for day   date to retreive live fuel moisture for row   index of cell to retrieve moisture from col   index of cell to retrieve moisture from d1hfm   if function returns successfully, dead 1 hour fuel moisture d10hfm   if function returns successfully, dead 10 hour fuel moisture d100hfm   if function returns successfully, dead 100 hour fuel moisture 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 DeadFuelMoist.c.

int GetDeadFuelMoistRANDHFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm )

retrieves time and space dependent dead fuel moisture value at a cell. Using this option each cell in the simulation domain is assigned a dead fuel moisture based upon random index into a table of historical values See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties year   date to retreive live fuel moisture for month   date to retreive live fuel moisture for day   date to retreive live fuel moisture for row   index of cell to retrieve moisture from col   index of cell to retrieve moisture from d1hfm   if function returns successfully, dead 1 hour fuel moisture d10hfm   if function returns successfully, dead 10 hour fuel moisture d100hfm   if function returns successfully, dead 100 hour fuel moisture 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 100 of file DeadFuelMoist.c.

int GetDeadFuelMoistSPATIALFromProps ( ChHashTable * proptbl, int month, int day, int hour, unsigned int row, unsigned int col, double * d1hfm, double * d10hfm, double * d100hfm )

retrieves time and space dependent dead fuel moisture value at a cell. Using this option each cell in the simulation domain is assigned a dead fuel moisture based upon lookup into a raster of dead fuel moisture values See also: ChHashTable , Check the config file documentation Parameters: proptbl   ChHashTable of simulation properties year   date to retreive live fuel moisture for month   date to retreive live fuel moisture for day   date to retreive live fuel moisture for row   index of cell to retrieve moisture from col   index of cell to retrieve moisture from d1hfm   if function returns successfully, dead 1 hour fuel moisture d10hfm   if function returns successfully, dead 10 hour fuel moisture d100hfm   if function returns successfully, dead 100 hour fuel moisture 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 171 of file DeadFuelMoist.c.

---