DeadFuelMoist.h Source File

00001 
00027 #ifndef DeadFuelMoist_H
00028 #define DeadFuelMoist_H
00029 
00030 #include <stdlib.h>
00031 
00032 #include "Units.h"
00033 #include "NLIBRand.h"
00034 #include "FireProp.h"
00035 #include "ChHashTable.h"
00036 #include "KeyVal.h"
00037 #include "DblTwoDArray.h"
00038 #include "FStreamIO.h"
00039 #include "Err.h"
00040 
00041 /*
00042  *********************************************************
00043  * DEFINES, ENUMS
00044  *********************************************************
00045  */
00046  
00047 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00048  
00049 /* used in tokenizing 10h files */
00050 #define DEAD_FUEL_MOIST_10H_COMMENT_CHAR                        ("#")
00051 #define DEAD_FUEL_MOIST_10H_SEP_CHARS                           (" =,;\t")
00052 
00053 /* returns corresponding field index in WAZ file */
00054 #define DEAD_FUEL_MOIST_YR_10H_TBL_INDEX                        (0)
00055 #define DEAD_FUEL_MOIST_MO_10H_TBL_INDEX                        (1)
00056 #define DEAD_FUEL_MOIST_DY_10H_TBL_INDEX                        (2)
00057 
00058 /* value of NO DATA used in 10H files */
00059 #define DEAD_FUEL_MOIST_10H_NO_DATA_VALUE                       (-1)
00060 
00061 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00062  
00063 /*
00064  *********************************************************
00065  * STRUCTS, TYPEDEFS
00066  *********************************************************
00067  */
00068  
00069 /*
00070  *********************************************************
00071  * MACROS
00072  *********************************************************
00073  */
00074 
00075 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00076 
00077 /* takes an hour 0-23 and returns corresponding field index in 10H file */
00078 #define DEAD_FUEL_MOIST_HR_TO_10H_TBL_INDEX(hour)               ((hour) + 3)
00079 
00080 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00081  
00082 /*
00083  *********************************************************
00084  * PUBLIC FUNCTIONS
00085  *********************************************************
00086  */
00087 
00114 int GetDeadFuelMoistFIXEDFromProps(ChHashTable * proptbl, int month, int day, int hour, 
00115                                             unsigned int row, unsigned int col, 
00116                                             double * d1hfm, double * d10hfm, double * d100hfm);
00117 
00144 int GetDeadFuelMoistRANDHFromProps(ChHashTable * proptbl, int month, int day, int hour, 
00145                                             unsigned int row, unsigned int col,
00146                                             double * d1hfm, double * d10hfm, double * d100hfm);
00147 
00174 int GetDeadFuelMoistSPATIALFromProps(ChHashTable * proptbl, int month, int day, int hour, 
00175                                             unsigned int row, unsigned int col, 
00176                                             double * d1hfm, double * d10hfm, double * d100hfm);
00177                                                                              
00178 #endif DeadFuelMoist_H      /* end of DeadFuelMoist.h */