globals.h

Go to the documentation of this file.

/* General notes on revisions to this source file. 
       Nov/Dec 2004 v2.3.2: documentation upgrade 
                - Re-organized, clarified scopes, Doxygen tags added 
       Apr 2005 v2.4.4 - final version of all code for internal review
       Oct 2006 v2.6.0 - increased functionality for boundary conditions
            - added isPTSL true/false flag to determine use of gridIO vs on-the-fly interpolations
            - added isModExperim true/false flag to determine use of special parameters for model experiments
            - added alternative data-method for input of atmospheric P deposition (here only added conv_mgTOkg #define)
       Sep 2007 v2.6.1 - increased the number of point time series locations that can be output
            - MAX_PTSERIES set at 8000 (was 800)
        
*/

#ifndef GLOBALS_H
#define GLOBALS_H

#include <ctype.h> 
#include <time.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <math.h> 

typedef int             BOOL;
typedef FILE*           STREAM; 
typedef char*           STRING; 
typedef unsigned char   UCHAR;
typedef unsigned char   byte;
typedef unsigned int    UINT;
typedef unsigned short  USHORT;
typedef long            SLONG;
typedef unsigned long   ULONG;

typedef struct prog_attr {
        char S_ParmName[30];    
        int S_ParmRelVal;       
        float S_ParmVal;        
} ProgAttr;

int SensiOn;            
struct simTime {
  float TIME;                           
  double Jdate;                         
  int yr[2];                            
  int mo[2];                            
  int da[2];                            
  int hr[2];                            
  int mi[2];                            
  double se[2];                         
  int IsSimulationEnd;          
  int IsMonthEnd;                       
  int IsYearEnd;                        
  int IsWetSeasEnd;             
  int IsDrySeasEnd;             
  int IsBudgEnd;                        
  int IsBIRavgEnd;                      
  int IsBIRhydEnd;                      
  int IsBudgFirst;                      
  int IsDay0;                           
} SimTime; 

typedef struct pTSeries {
  int fX;
  int fY;
  int fNpt;
  float fTS;
  float *fValue;
} PTSeries;

typedef struct pTSeriesList {
  PTSeries* fList;
  int fNSlots;
  int fNSlotsUsed;
  int fNptTS;
  int fFormat;
  int fIndex;
} PTSeriesList;

typedef struct rPoint {
  float fr;
  int fX;
  int fY;
  float falpha;
  float fValue;
} RPoint;

typedef struct rPointList {
  RPoint* fList;
  int fNPt;
  int fNPtUsed;
} RPointList;


typedef struct {
  float **pfvar;                
  const char  *pname;   
  char  ctype;                  
} outVar_struct;

typedef struct basndef {
  char basnTxt[12];     
  int numIR;                    
  int IR[30];                   
  int FLok[30];                 
  int numFLok;                  
  int parent;                   
  int family;                   
  double conv_m3TOcm;           
  double conv_kgTOmgm2;         
} basnDef; 


typedef struct point3D {
  int x;                                                
  int y;                                                
  int z;                                                
  unsigned char type;                   
  unsigned char format;                 
} Point3D;

typedef struct point2D {
  int x;                                                
  int y;                                                
} Point2D;

typedef struct scale1 {
  float s;                                              
  float o;                                              
} Scale1;

typedef struct scale2 {
  float Vmin;                                           
  float Vmax;                                           
} Scale2;

typedef struct viewParm {
  Scale1 scale;                                 
  Scale2 gScale;                                
  Scale2 bounds;                                
  Point3D *points;                              
  unsigned char nPoints;                
  unsigned char maxPoints;              
  int step;                                             
  unsigned char mapType;                
  unsigned int flags;                   
  char fileName[24];                    
  char varUnits[24];                    
} ViewParm;

typedef struct seriesParm {
  float* data;                                  
  Point2D Loc;                                  
  char name[24];                                
  int Length;                                   
  int outstep;                                  
  int laststep;                                 
} SeriesParm;

typedef struct nodenv {
  int procnum;            
  int nprocs;             
  int groupid;            
  int taskid;             
} nodenv;


#define VOIDP void*
                
#define HDF 0 
/* if the user installs HDF 4 and/or NetCDF 3 on their system, and points to those libs and includes in the Driver.make file, 
   the user may write spatial map output in these formats using the Model.outlist commands */
#define HDF4 0 
#define NCDF3 1 
#define UNIX    1    
#define H_OPSYS UNIX 
#define kMAX 0          
#define kMIN 1          
#define kMAXMIN 2               
#define kSUM 3          
#define kAVE 4          
#define kSUMCUM 5               
#define kAVECUM 6               
#define MAX_PTSERIES  8000  
#define MAX_TS_FILES  50  
#define MAX_MSG_SIZE 1200       
#define ISARRAY         0x8000          /* TRUE/ is Array       */
#define PMASK2          0x0200          /* TRUE/        */
#define PMASK1          0x0100          /* TRUE/        */
                
#define kCArgDepth      10      
#define kCArgWidth      50      
#define EOL '\n'
#define EOS '\0'
#define TAB '\t'
#define POUND  ((UCHAR)0x23)
#define True 1
#define False 0
#define CASE 0
#define NOCASE 1
#define BEG 0
#define END 1

#define DT dt   
#define T(x,y) ((int)((x)*(s1+2)+(y)))  
#define sec_per_day 86400.0     
#define PI 3.1415927
#define wetEndMon 9   
#define wetEndDay 30  
#define dryEndMon 4   
#define dryEndDay 30  
#define Abs(x) (((x)>=0) ? (x) : -(x))
#define Cos(x) cos((double)x)
#define Sin(x) sin((double)x)
#define Tan(x) tan((double)x)
#define Arctan(x) atan((double)x)
#define Exp(x) exp((double)x)
#define Max(x,y) (((x)>(y))?(x):(y))
#define Min(x,y) (((y)>(x))?(x):(y))
#define ramp(x) (((x)>0)?(x):0)
#define sgn(x) (((x)>=0) ? 1.0 : -1.0)

#define conv_mgTOg 1.0e-3  
#define conv_gTOkg 1.0e-3  
#define conv_mgTOkg 1.0e-6  
#define conv_kgTO_Mg 1.0e-3  
#define conv_mgTOug 1.0e3  
#define conv_gTOmg 1.0e3  
#define conv_kgTOg 1.0e3  
#define conv_kgTOmg 1.0e6  
#define conv_inTOtenths_mm 254.0  
#define conv_ftTOm 0.3048  
#define conv_mTOcm 100.0  
#define conv_cmTOmm 10.0  
#define conv_mTOkm 0.001  
/* v2.8.2 UTM datum conversions */
#define conv_northing_NAD27toNAD83 203.8  
#define conv_easting_NAD27toNAD83 21.3  
#define MAX_NHAB 255    
#define MAX_SECTOR  30  
char  msgStr[MAX_MSG_SIZE];     
float dt, sfstep, gwstep, canstep;
int hyd_iter;        
unsigned char *ON_MAP;  
float CELL_SIZE, celWid, sq_celWid;       
int s0;         
int s1;         
int debug; 
int dynERRORnum; 
/* v2.6  */
int isPTSL;  
int isModExperim;  
void WriteMsg(const char* msg, int wh);
void usrErr(const char* dString);
void usrErr0(const char* dString);


#endif /* GLOBALS_H */