LiveFuelMoist.h Source File

00001 
00027 #ifndef LiveFuelMoist_H
00028 #define LiveFuelMoist_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 LFH and LFW files */
00050 #define LIVE_FUEL_MOIST_COMMENT_CHAR                        ("#")
00051 #define LIVE_FUEL_MOIST_SEP_CHARS                           (" =,;\t")
00052 
00053 /* returns corresponding field index in LFH and LFW files */
00054 #define LIVE_FUEL_MOIST_MO_TBL_INDEX                        (0)
00055 #define LIVE_FUEL_MOIST_DY_TBL_INDEX                        (1)
00056 #define LIVE_FUEL_MOIST_FIXED_VAL_TBL_INDEX                 (2)
00057 #define LIVE_FUEL_MOIST_MEAN_TBL_INDEX                      (2)
00058 #define LIVE_FUEL_MOIST_STDEV_TBL_INDEX                     (3)
00059 
00060 /* keyword indicating annual mean and stddev of live fuel moisture */
00061 #define LIVE_FUEL_MOIST_KEYWORD_ANNMEAN                     ("ANNMEAN")
00062 #define LIVE_FUEL_MOIST_KEYWORD_ANNSTDEV                    ("ANNSTDEV")
00063 
00064 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00065  
00066 /*
00067  *********************************************************
00068  * STRUCTS, TYPEDEFS
00069  *********************************************************
00070  */
00071  
00072 /*
00073  *********************************************************
00074  * MACROS
00075  *********************************************************
00076  */
00077  
00078 /*
00079  *********************************************************
00080  * PUBLIC FUNCTIONS
00081  *********************************************************
00082  */
00083 
00109 int GetLiveFuelMoistFIXEDFromProps(ChHashTable * proptbl, int year, int month, int day,
00110                                             unsigned int row, unsigned int col, 
00111                                             double * lhfm, double * lwfm);
00112 
00138 int GetLiveFuelMoistRANDHFromProps(ChHashTable * proptbl, int year, int month, int day,
00139                                             unsigned int row, unsigned int col,
00140                                             double * lhfm, double * lwfm);
00141 
00167 int GetLiveFuelMoistSPATIALFromProps(ChHashTable * proptbl, int year, int month, int day,
00168                                             unsigned int row, unsigned int col,
00169                                             double * lhfm, double * lwfm);
00170   
00171 #endif LiveFuelMoist_H      /* end of LiveFuelMoist.h */