Ignition.h Source File

00001 
00027 #ifndef Ignition_H
00028 #define Ignition_H
00029 
00030 #include <stdlib.h>
00031 
00032 #include "FireYear.h"
00033 #include "GridData.h"
00034 #include "NLIBRand.h"
00035 #include "ChHashTable.h"
00036 #include "KeyVal.h"
00037 #include "FireProp.h"
00038 #include "FireGridData.h"
00039 #include "List.h"
00040 #include "FStreamIO.h"
00041 #include "Err.h"
00042 #include "DblTwoDArray.h"
00043 #include "CoordTrans.h"
00044 
00045 /*
00046  *********************************************************
00047  * DEFINES, ENUMS
00048  *********************************************************
00049  */
00050 
00051 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00052  
00053 /* number of seconds per hour */
00054 #define IGNITION_SECS_PER_HOUR                              (3600)
00055 
00056 /* number of seconds in a day */
00057 #define IGNITION_SECS_PER_DAY                               ((IGNITION_SECS_PER_HOUR) * 24)
00058 
00059 /* used in tokenizing fixed ignition file */
00060 #define IGNITION_IGS_COMMENT_CHAR                           ("#")
00061 #define IGNITION_SEP_CHARS                                  (" =,\t")
00062 
00063 /* max number of attempts to retrieve location within domain before failing */
00064 #define IGNITION_RANDU_MAX_TRIALS                           (1000000) 
00065 #define IGNITION_RANDS_MAX_TRIALS                           (500000)
00066 
00067 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00068  
00069 /*
00070  *********************************************************
00071  * STRUCTS, TYPEDEFS
00072  *********************************************************
00073  */
00074  
00075 /*
00076  *********************************************************
00077  * MACROS
00078  *********************************************************
00079  */
00080  
00081 /*
00082  *********************************************************
00083  * PUBLIC FUNCTIONS
00084  *********************************************************
00085  */
00086 
00103 int IsIgnitionNowFIXEDFromProps(ChHashTable * proptbl);
00104 
00122 int IsIgnitionNowRANDFromProps(ChHashTable * proptbl);
00123  
00144 int GetIgnitionLocFIXEDFromProps(ChHashTable * proptbl, FireYear * fy, List ** rwxylist);
00145 
00167 int GetIgnitionLocRANDUFromProps(ChHashTable * proptbl, FireYear * fy, List ** rwxylist);
00168 
00194 int GetIgnitionLocRANDSFromProps(ChHashTable * proptbl, FireYear * fy, List ** rwxylist);
00195 
00196 #endif Ignition_H       /* end of Ignition.h */