---

RothPipeline.h File Reference

Facility for storing state of variables used in pipelined fire spread calculations. More...

#include <stdlib.h>
#include "Err.h"

Go to the source code of this file.

Compounds
struct	RothPipeline_
Defines
#define	ROTH_PIPELINE_NO_WIND_LIMIT   (0)
	wind limit on rate of spread not reached. More...
#define	ROTH_PIPELINE_AT_WIND_LIMIT   (1)
	wind limit on rate of spread reached. More...
Typedefs
typedef enum EnumFireSpreadPipe_	EnumFireSpreadPipe
typedef struct RothPipeline_	RothPipeline
Enumerations
enum	EnumFireSpreadPipe_ {   EnumInitPipe = 0,   EnumSetFuelBedPipe = 1,   EnumNoWindNoSlopePipe = 2,   EnumWindSlopeMaxPipe = 3,   EnumGetAtAzimuthPipe = 4 }
	constant storing current step in fire spread prediction pipe. More...

---

Detailed Description

Facility for storing state of variables used in pipelined fire spread calculations.

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 RothPipeline.h.

---

Define Documentation

#define ROTH_PIPELINE_AT_WIND_LIMIT   (1)

wind limit on rate of spread reached. Definition at line 46 of file RothPipeline.h.

#define ROTH_PIPELINE_NO_WIND_LIMIT   (0)

wind limit on rate of spread not reached. Definition at line 42 of file RothPipeline.h.

---

Typedef Documentation

typedef enum EnumFireSpreadPipe_ EnumFireSpreadPipe

Type name for EnumFireSpreadPipe_ See also: For a list of constants goto EnumFireSpreadPipe_ Definition at line 74 of file RothPipeline.h.

typedef struct RothPipeline_ RothPipeline

Type name for RothPipeline_ See also: For a list of members goto RothPipeline_ Definition at line 79 of file RothPipeline.h.

---

Enumeration Type Documentation

enum EnumFireSpreadPipe_

constant storing current step in fire spread prediction pipe. Note: EnumInitPipe memory allocated for pipeline structure EnumSetFuelBedPipe step 1 completed EnumNoWindNoSlopePipe step 2 completed EnumWindSlopeMaxPipe step 3 completed EnumGetAtAzimuthPipe step 4 completed Definition at line 57 of file RothPipeline.h.

---