FireConfig.h Source File

00001 
00027 #ifndef FireConfig_H
00028 #define FireConfig_H
00029 
00030 #include <stdlib.h>
00031 #include <stdio.h>
00032 
00033 /* configuration headers */
00034 #include "FireProp.h"
00035 #include "FireGridData.h"
00036 
00037 /* simulation support headers */
00038 #include "FireEnv.h"
00039 #include "FireTimer.h"
00040 
00041 /* abstract FuelModel headers */
00042 #include "FuelModel.h"
00043 
00044 /* FireEnv headers */
00045 #include "FuelsRegrowth.h"
00046 #include "Ignition.h"
00047 #include "WindAzimuth.h"
00048 #include "WindSpd.h"
00049 #include "DeadFuelMoist.h"
00050 #include "LiveFuelMoist.h"
00051 #include "SantaAna.h"
00052 
00053 /* generic support headers */
00054 #include "GridData.h"
00055 #include "List.h"
00056 #include "ChHashTable.h"
00057 #include "HashFuncs.h"
00058 #include "KeyVal.h"
00059 #include "FStreamIO.h"
00060 #include "RandSeedTable.h"
00061 #include "Err.h"
00062 
00063 /*
00064  *********************************************************
00065  * DEFINES, ENUMS
00066  *********************************************************
00067  */
00068 
00069 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00070 
00071 /* suggested capacity supplied to Hash Table initialization routine */
00072 #define FIRE_CONFIG_TBL_INI_CAPCTY                          (50)
00073 
00074 /* initial size of growable character buffer used by GetFireConfigLine */
00075 #define FIRE_CONFIG_INITIAL_SCAN_LINE_SIZE                  (125)
00076 
00077 /* used in tokenizing configuration file */
00078 #define FIRE_CONFIG_COMMENT_CHAR                            ("#")
00079 #define FIRE_CONFIG_SEPARATOR_CHARS                         (" =,\t")
00080 
00081 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00082  
00083 /*
00084  *********************************************************
00085  * STRUCTS, TYPEDEFS
00086  *********************************************************
00087  */
00088  
00089 /*
00090  *********************************************************
00091  * MACROS
00092  *********************************************************
00093  */
00094  
00095 /*
00096  *********************************************************
00097  * PUBLIC FUNCTIONS
00098  *********************************************************
00099  */
00100 
00115 int InitPropsFromFireConfig(ChHashTable ** proptbl, char * cfg_fname);
00116 
00134 int InitGridsFromPropsFireConfig(ChHashTable * proptbl, GridData ** elev, GridData ** slope, GridData ** aspect);
00135 
00151 int InitFireTimerFromPropsFireConfig(ChHashTable * proptbl, FireTimer ** ft);
00152 
00169 int InitFuelModelHashTableFromFuelModelListFireConfig(List * fmlist, ChHashTable ** fmtble);
00170 
00187 int InitStandAgeFromPropsFireConfig(ChHashTable * proptbl, GridData * elev, GridData ** std_age);
00188 
00204 int InitFireEnvFromPropsFireConfig(ChHashTable * proptbl, FireEnv ** fe);
00205 
00220 int InitRandNumGenFromPropsFireConfig(ChHashTable * proptbl, void(*RandInit)(long int seed));
00221 
00237 void FireConfigDumpPropsToStream(ChHashTable * proptbl, FILE * fstream);
00238 
00254 void FireConfigDumpFuelModelListToStream(List * pnvlist, FILE * fstream);
00255 
00256 #endif FireConfig_H     /* end of FireConfig.h */