---

Extinction.c File Reference

#include "Extinction.h"

Go to the source code of this file.

Functions
int	UpdateExtinctionHOURS (ChHashTable * proptbl, int month, int day, int hour, CellState * cs, ByteTwoDArray * hrs_brn)
	Extinguishes cell if it has been ignited for longer than threshold in simulation properties table. More...
int	UpdateExtinctionROS (ChHashTable * proptbl, int i, int j, double mpsros, CellState * cs, ByteTwoDArray * hrs_brn)
	Extinguishes cell if rate of spread below threshold in simulation properties 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 Extinction.c.

---

Function Documentation

int IsExtinguishedHOURS ( ChHashTable * proptbl, unsigned char hours )

Definition at line 105 of file Extinction.c.

int IsExtinguishedROS ( ChHashTable * proptbl, double mpsros )

Definition at line 54 of file Extinction.c.

int UpdateExtinctionHOURS ( ChHashTable * proptbl, int month, int day, int hour, CellState * cs, ByteTwoDArray * hrs_brn )

Extinguishes cell if it has been ignited for longer than threshold in simulation properties table. See also: Check the config file documentation Parameters: proptbl   ChHashTable of current simulation properties month   current simulation month, 1-based index day   current simulation day, 1-based index hour   current simulation hour, 0000-2400 cs   simulation CellState hrs_brn   two-dimensional array storing number of hours cell has been ignited 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 139 of file Extinction.c.

int UpdateExtinctionROS ( ChHashTable * proptbl, int i, int j, double mpsros, CellState * cs, ByteTwoDArray * hrs_brn )

Extinguishes cell if rate of spread below threshold in simulation properties table. See also: Check the config file documentation Parameters: proptbl   ChHashTable of current simulation properties i   array row index of cell j   array column index of cell mpsros   rate of spread in meters per second of cell at i,j cs   simulation CellState hrs_brn   two-dimensional array storing number of hours cell has been ignited 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 213 of file Extinction.c.

---