serial.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 
        Oct 2006 v2.6.0: added model-experiment parameters (boundary condition experiments right now)

        
*/

#ifndef SERIAL_H
#define SERIAL_H

#include "globals.h"
#if HDF4 /* v2.8.1 changed this from HDF to HDF4 */ /* (Nov 2004): do not #define HDF to true (globals.h) until hdf header sources are updated */
#include "hdf.h"
#endif
#if NCDF3
#include "netcdf.h"
#endif

#define HDF_VERIFY(a) if(ret == FAIL) { printf("*** UNEXPECTED RETURN from %s is %d\n", a, (int)ret); }

struct combo_table      
{
  char  name[25];       
  int step;             
  int type;             
  int ocnt;             
  float fvalue[10];     
  UCHAR  free;          
};


/* char gSectorChar = '¥'; */ /* this was changed (in HabParms dbase); the ascii special char had Macintosh origin (worked in code, but obscure translation in other OS) */
/* char gHabChar = 'É'; */    /* this was changed (in HabParms dbase); the ascii special char had Macintosh origin (worked in code, but obscure translation in other OS) */
char gSectorChar = '@';         
char gHabChar = '^';             
int habNumTot = 0;                                      
char fileDelimitChar = 'È'; /* unused in v2.3 and above; the special char removed from .c source, put here only to indicate the past use of this special char in file name delimitation */
char cTemp[200];                
char gTerm[4];                  
char gCArg[kCArgDepth][kCArgWidth];     
int cell_pts[MAX_TS_FILES];     
int numPtFiles=0;                               
FILE* dFile;                    
FILE* Driver_outfile;   
FILE* *cnfgFile;                
#define MAXCOMBOS  30                                   
struct combo_table ctable[MAXCOMBOS];   
UINT max_combos_open;                                    
/* v2.8.2 - the UTM coordinates of model, for use in NetCDF output */
int isFirstVar=1;
float UTMnorth, UTMsouth, UTMeast, UTMwest; 
float UTMnorthNAD83, UTMsouthNAD83, UTMeastNAD83, UTMwestNAD83; 
extern float offMap_float; 
extern float *nc_dataRowRev; 
void writeMap(char*, void*, int, unsigned char, int);
void writeFloatMap(char*, char*, float*, int, unsigned char, int, char*,int); /* new for v.2.8.2 */
void writeFloatNetCDF(char*, char*, float*, int, unsigned char, int, char*,int); /* new for v.2.8.2 */
void write_header(char* mapFileName,int size);
void send_point_lists2(SeriesParm *pSeries, int nSeries);
void writeSeries(void* fValue, char* label, char* desc, int N0, int N1, byte Mtype, byte format);
void Combine(float* fValue, char* label, int nComp, int cType, int step);
void open_point_lists(SeriesParm *pSeries, int nSeries);

void exparam( struct nodenv* envInfo);
void exgridsplit(int nprocs, int ndim,int nprocs2[2]);
void exgridcoord(int pnum, int rnum[2]);
void exgridsize( int pnum, int gsize[2],int lsize[2],int lstart[2]);
void set_async_mode(FILE* file);
void fmulti(FILE* file);
void fsingl(FILE* file);
void fasync(FILE* file);
void exchange_borders(UCHAR* map, int size);
void Cplot(VOIDP Map, unsigned char Mtype, float max_value, float min_value);
void broadcastMsg( UCHAR* msgPtr);
void broadcastInt(int* iValPtr);
void broadcastChar(UCHAR* cPtr);
void broadcastData( void* dataPtr, int *dataSize);
void broadcastFloat(void* dataPtr);
void sync_processors();
void open_debug_outFile(int index);
int exgridinit(int dim, int* nprocs);
int on_this_proc(int x,int y);
void local_setup(int argc, char** argv);

int init_config_file(FILE *vpFile, char term1, char term2, char term3, char term4);
int skip_cnfg_space(FILE *vpFile, char* tch);
int parse_packet( FILE *vpFile, int* nArgs, char* test);
int get_number(FILE *infile );
int goto_index(FILE *infile, char tchar, int index);
int read_header(char* mapfile);
int getCombineIndex( char* name, int step,int type,int *last);

float* get_hab_parm(char* s_parm_name, int s_parm_relval, char* parmName);
float get_global_parm(char* s_parm_name, int s_parm_relval, char* parmName );
float get_modexperim_parm(char* s_parm_name, int s_parm_relval, char* parmName ); /* added for v2.6 */
float get_Nth_parm( FILE *infile, int pIndex, int* end, int hIndex );
char* match_Sparm( char* s_parm_name, int s_parm_relval, char* parmName); 

float SMDRAND(float fminVal, float fmaxVal);
float* readSeriesCol(char *filename, int format, int index, int* Npt, float* TStep, int col);

byte readMap(char*, void*);

int gSLen[MAX_NHAB]; /* unused */

/* externs */
/* from driver_utilities.h */
extern char *ProjName;
extern char *ModelPath;
extern char *OutputPath;
extern char modelName[20], modelVers[10];

extern void fatal(const char *msg);
extern void calcdate(double jd, int *m, int *d, int *y, int *h, int *mi, double *sec);
extern int skip_white(FILE* infile);
extern int scan_forward (FILE* infile, const char* tstring);
extern int find_char(FILE *infile, char tchar);
extern double julday(int mon, int day, int year, int h, int mi, double se);
extern VOIDP nalloc(unsigned mem_size, const char var_name[]);

/* from generic_driver.h */
extern char SimAlt[20];        
extern char SimModif[20];        
extern int gbl_size[2]; 
extern int seed; 
extern int procnum, Lprocnum, nprocs[2], nproc, recpnum[2], tramType, tramNum[2];
extern int PORnumday;
extern double Jdate_init;
extern char initDateRead[15];   

#endif  /* SERIAL_H */