Main Page   Compound List   File List   Compound Members   File Members  

Roth1972.c File Reference

#include "Roth1972.h"

Go to the source code of this file.

Functions

int Roth1972FireSpreadSetFuelBed (RothFuelModel * rfm)
 Step 1 of FireSpread Pipeline. More...

int Roth1972FireSpreadNoWindNoSlope (RothFuelModel * rfm, double d1hfm, double d10hfm, double d100hfm, double lhfm, double lwfm)
 Step 2 of FireSpread Pipeline. More...

int Roth1972FireSpreadWindSlopeMax (RothFuelModel * rfm, double wnd_fpm, double wnd_az, double slp_pcnt, double asp)
 Step 3 of FireSpread Pipeline. More...

int Roth1972FireSpreadGetAtAzimuth (RothFuelModel * rfm, double az)
 Step 4 of FireSpread Pipeline. 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 Roth1972.c.


Define Documentation

#define ROTH_1972_WTG_CLASSES   (6)
 

Definition at line 27 of file Roth1972.c.


Function Documentation

int Roth1972FireSpreadGetAtAzimuth ( RothFuelModel * rfm,
double az )
 

Step 4 of FireSpread Pipeline.

Calculates the rate of spread through the fuel bed in the direction specified as an argument. RothFuelModel units must be ENGLISH. Steps 1, 2, and 3 in FireSpread Pipeline must have been completed without error prior to calling this function.

See also:
RothFuelModel
Parameters:
rfm   RothFuelModel structure containing fuel particle attributes
az   azimuth in the direction which rate-of-spread is calculated
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 520 of file Roth1972.c.

int Roth1972FireSpreadNoWindNoSlope ( RothFuelModel * rfm,
double d1hfm,
double d10hfm,
double d100hfm,
double lhfm,
double lwfm )
 

Step 2 of FireSpread Pipeline.

Calculates the NoWind-NoSlope rate of spread through the fuel bed represented by RothFuelModel. RothFuelModel units must be ENGLISH. Step 1 in FireSpread Pipeline(SetFuelBed) must have been completed prior to calling this function, however calling SetFuelBed prior to every call to NoWindNoSlope is unnecessary. Instead, SetFuelBed need only be called when any of the fuel particle attributes (load,sav,dens,hc,stot,seff) have changed.

See also:
RothFuelModel
Parameters:
rfm   RothFuelModel structure containing fuel particle attributes
d1hfm   dead 1 hour fuel moisture
d10hfm   dead 10 hour fuel moisture
d100hfm   dead 100 hour fuel moisture
lhfm   live herb fuel moisture
lwfm   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 163 of file Roth1972.c.

int Roth1972FireSpreadSetFuelBed ( RothFuelModel * rfm )
 

Step 1 of FireSpread Pipeline.

Converts RothFuelModel structure containing individual fuel particles comprising fuel bed into a single representative fuel bed. If RothFuelModel units are METRIC, then converts values to ENGLISH.

See also:
RothFuelModel
Parameters:
rfm   RothFuelModel structure containing fuel particle attributes
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 32 of file Roth1972.c.

Referenced by InitRothFuelModelListFromProps().

int Roth1972FireSpreadWindSlopeMax ( RothFuelModel * rfm,
double wnd_fpm,
double wnd_az,
double slp_pcnt,
double asp )
 

Step 3 of FireSpread Pipeline.

Calculates the maximum rate of spread through the fuel bed given the supplied wind and slope related arguments. RothFuelModel units must be ENGLISH. Steps 1 and 2 in FireSpread Pipeline must have been completed without error prior to calling this function.

See also:
RothFuelModel
Parameters:
rfm   RothFuelModel structure containing fuel particle attributes
wnd_fpm   midflame windspeed in ft/min
wnd_az   azimuth from which wind is coming (same as measured by RAWS)
slp_pcnt   slope percent (as whole number eg 100 corresponds to 100% slope or [1 unit rise]/[1 unit run] )
asp   aspect (eg direction of maximum rate of change of slope aka downslope)
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 331 of file Roth1972.c.


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