Main Page   Compound List   File List   Compound Members   File Members  

FuelsRegrowth.c File Reference

#include "FuelsRegrowth.h"

Go to the source code of this file.

Functions

int GetFuelsRegrowthFIXEDFromProps (ChHashTable * proptbl, GridData * std_age, GridData ** fuels)
 Returns fuels raster spatial data based upon values set in Hash Table property table. More...

int GetFuelsRegrowthSTATICFromProps (ChHashTable * proptbl, GridData * std_age, GridData ** fuels)
 Returns fuels raster spatial data based upon values set in Hash Table property table. More...

int GetFuelsRegrowthPNVFromProps (ChHashTable * proptbl, GridData * std_age, GridData ** fuels)
 Returns fuels raster spatial data based upon values set in Hash Table property table. 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 FuelsRegrowth.c.


Function Documentation

int GetFuelsRegrowthFIXEDFromProps ( ChHashTable * proptbl,
GridData * std_age,
GridData ** fuels )
 

Returns fuels raster spatial data based upon values set in Hash Table property table.

For FIXED implementations fuel model number from keyword FUELS_FIXED_MODEL_NUM is assigned to every cell that is not NO DATA in the std_age GridData.

See also:
ChHashTable , GridData , Check the config file documentation
Parameters:
proptbl   HashTable of simulation properties
std_age   stand age GridData
fuels   returned fuels GridData
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 FuelsRegrowth.c.

int GetFuelsRegrowthPNVFromProps ( ChHashTable * proptbl,
GridData * std_age,
GridData ** fuels )
 

Returns fuels raster spatial data based upon values set in Hash Table property table.

For PNV implementations raster data in FUELS_PNV_XXX is indexed against the FUELS_PNV_RGR_FILE file contents to create a new fuels array.

See also:
ChHashTable , GridData , Check the config file documentation
Parameters:
proptbl   HashTable of simulation properties
std_age   stand age GridData
fuels   returned fuels GridData
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 91 of file FuelsRegrowth.c.

int GetFuelsRegrowthSTATICFromProps ( ChHashTable * proptbl,
GridData * std_age,
GridData ** fuels )
 

Returns fuels raster spatial data based upon values set in Hash Table property table.

For STATIC implementations keyword FUELS_STATIC_XXX is used to create fuel raster data.

See also:
ChHashTable , GridData , Check the config file documentation
Parameters:
proptbl   HashTable of simulation properties
std_age   stand age GridData
fuels   returned fuels GridData
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 80 of file FuelsRegrowth.c.


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