Main Page   Compound List   File List   Compound Members   File Members  

LiveFuelMoist.c File Reference

#include "LiveFuelMoist.h"

Go to the source code of this file.

Functions

int GetLiveFuelMoistFIXEDFromProps (ChHashTable * proptbl, int year, int month, int day, unsigned int row, unsigned int col, double * lhfm, double * lwfm)
 retrieves time and space dependent live fuel moisture value at a cell. More...

int GetLiveFuelMoistRANDHFromProps (ChHashTable * proptbl, int year, int month, int day, unsigned int row, unsigned int col, double * lhfm, double * lwfm)
 retrieves time and space dependent live fuel moisture value at a cell. More...

int GetLiveFuelMoistSPATIALFromProps (ChHashTable * proptbl, int year, int month, int day, unsigned int row, unsigned int col, double * lhfm, double * lwfm)
 retrieves time and space dependent live 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 LiveFuelMoist.c.

Function Documentation

int AdvanceRecToDate ( DblTwoDArray * da,
int month,
int day,
int * rec )
 

Definition at line 288 of file LiveFuelMoist.c.

int GetLiveFuelMoistFIXEDFromProps ( ChHashTable * proptbl,
int year,
int month,
int day,
unsigned int row,
unsigned int col,
double * lhfm,
double * lwfm )
 

retrieves time and space dependent live fuel moisture value at a cell.

Using this option each cell in the simulation domain is assigned a live 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
lhfm   if function returns successfully, live herb fuel moisture
lwfm   if function returns successfully, live woody 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 LiveFuelMoist.c.

int GetLiveFuelMoistRANDHFromProps ( ChHashTable * proptbl,
int year,
int month,
int day,
unsigned int row,
unsigned int col,
double * lhfm,
double * lwfm )
 

retrieves time and space dependent live fuel moisture value at a cell.

Using this option each cell in the simulation domain is assigned a live fuel moisture based upon a probablity function of historical live 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
lhfm   if function returns successfully, live herb fuel moisture
lwfm   if function returns successfully, live woody 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 135 of file LiveFuelMoist.c.

int GetLiveFuelMoistSPATIALFromProps ( ChHashTable * proptbl,
int year,
int month,
int day,
unsigned int row,
unsigned int col,
double * lhfm,
double * lwfm )
 

retrieves time and space dependent live fuel moisture value at a cell.

Using this option each cell in the simulation domain is assigned a live fuel moisture based upon lookup into a raster of live 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
lhfm   if function returns successfully, live herb fuel moisture
lwfm   if function returns successfully, live woody 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 277 of file LiveFuelMoist.c.

Generated at Fri Jun 22 00:46:53 2001 for HFire by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000