SantaAna.h Source File

00001 
00027 #ifndef SantaAna_H
00028 #define SantaAna_H
00029 
00030 #include <stdlib.h>
00031 
00032 #include "Units.h"
00033 #include "FireTimer.h"
00034 #include "WindAzimuth.h"
00035 #include "WindSpd.h"
00036 #include "DeadFuelMoist.h"
00037 #include "FireProp.h"
00038 #include "FireExport.h"
00039 #include "FStreamIO.h"
00040 #include "NLIBRand.h"
00041 #include "Err.h"
00042 
00043 /*
00044  *********************************************************
00045  * DEFINES, ENUMS
00046  *********************************************************
00047  */
00048 
00049 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00050 
00051 /* returns corresponding field index in Santa Ana file */
00052 #define SANTA_ANA_YR_TBL_INDEX                          (0)
00053 #define SANTA_ANA_MO_TBL_INDEX                          (1)
00054 #define SANTA_ANA_DY_TBL_INDEX                          (2)
00055 
00056 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00057  
00058 /*
00059  *********************************************************
00060  * STRUCTS, TYPEDEFS
00061  *********************************************************
00062  */
00063  
00064 /*
00065  *********************************************************
00066  * MACROS
00067  *********************************************************
00068  */
00069 
00070 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00071 
00072 /* takes an hour 0-23 and returns corresponding field index in Santa Ana file */
00073 #define SANTA_ANA_HR_TO_TBL_INDEX(hour)                 ((hour) + 3)
00074 
00075 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
00076  
00077 /*
00078  *********************************************************
00079  * PUBLIC FUNCTIONS
00080  *********************************************************
00081  */
00082 
00097 int IsSantaAnaNowFromProps(ChHashTable * proptbl, int year, int month, int day);
00098 
00130 int GetSantaAnaEnvFromProps(ChHashTable * proptbl, int month, int day, int hour,
00131                                     double * waz, double fbedhgtm, double * wspmps,
00132                                     double * d1hfm, double * d10hfm, double * d100hfm);
00133   
00134 #endif SantaAna_H       /* end of SantaAna.h */