driver_utilities.h File Reference

Header file for Driver Utilities. More...

#include "globals.h"

Include dependency graph for driver_utilities.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	Outlist_size   250
Functions
VOIDP	nalloc (unsigned mem_size, const char var_name[])
	Allocate memory for a variable.
void	init_pvar (VOIDP Map, UCHAR *mask, unsigned char Mtype, float iv)
	Initialize a variable to a value.
void	read_map_dims (const char *filename)
	Establish the number of rows and columns of the model.
void	read_model_parameters (char *s_parm_name, int s_parm_relval)
	Call functions to read model parameters from datafiles.
float *	get_DBase_parmOLD (const char *filename, int i0, int i1, int index)
float *	get_DBase_parm (const char *filename, float *dArray)
ViewParm *	read_output_parms (void)
	Call the read_output_parms function.
ViewParm *	readOutlist (int size)
	Get the file to configure model output.
int	readViewParms (FILE *vpFileName, int size, ViewParm **ppview)
	Read/process the command-parameters to configure model output.
void	setPrecision (ViewParm *vp, int value)
	(Effectively unused).
int	write_map_file (const char *filename, VOIDP Map, char Mtype, int index, float scale_value, float offset_value, int bSize, unsigned char type, const char *units, int outstep, char *fileName)
	Prepare the file and the data for writing output of map (array).
int	read_map_file (const char *filename, VOIDP Map, unsigned char Mtype, float scale_value, float offset_value)
	Get the file and read/convert the data of map (array).
void	print_loc_ave (Point3D *vt, void *Map, char Mtype, char *mName, int tIndex)
	Calculate summary statistics to determine local average.
void	write_output (int index, ViewParm *vp, void *Map, const char *filename, char Mtype, int step)
	Determine which functions to call for model output.
void	print_point (ViewParm *vp, void *Map, char Mtype, char *mName, int tIndex, int vpindex)
	Print data at point locations to memory (not to file/disk yet).
void	writeWindow (void *fValue, char *vName, char *desc, int x0, int y0, int N0, int N1, int index, UCHAR Mtype, UCHAR format)
	Prepare a local data set for writing a local data window in debug file.
void	calc_maxmin (ViewParm *vp, void *Map, char Mtype, char *mName, int step)
	Calculate maximum & minimum values in model output arrays.
void	quick_look (void *Map, char *name, unsigned char Mtype, int xc, int yc, int range, unsigned char format)
	Prepare data and write heading for writing a data window in debug file.
int	iclip (int x0, int min, int max)
	Constrain x0 value within a min and a max.
void	make_more_points (ViewParm *vp, int ptIncr)
	Allocate memory & set up another set of point-locations for output.
void	enc_Nb (UCHAR **sptr, SLONG value, int bytes)
	Place data in bytes into a buffer to assemble a binary array.
void	RP_SwapFields (RPoint *thisStruct, RPoint *that)
	Point Time Series interpolation (unused):.
void	RP_CopyFields (RPoint *thisStruct, RPoint *that)
	Point Time Series interpolation (unused):.
void	RP_SetFields (RPoint *thisStruct, int ix, int iy, float r, float value)
	Point Time Series interpolation (unused):.
void	RPL_AddrPoint (RPointList *thisStruct, int x, int y, float r, float value)
	Point Time Series interpolation (unused):.
void	RPL_Sort (RPointList *thisStruct)
	Point Time Series interpolation (unused):.
void	RPL_Free (RPointList *thisStruct)
	Point Time Series interpolation (unused):.
RPointList *	RPL_Init (int nPoints)
	Point Time Series interpolation (unused):.
void	PTS_CopyFields (PTSeries *thisStruct, PTSeries pV)
	Point Time Series interpolation (unused): copy fields.
void	PTS_Free (PTSeries *thisStruct)
	Point Time Series interpolation (unused): free up memory.
void	PTS_SetFields (PTSeries *thisStruct, int ix, int iy, int index, int format, int col)
	Point Time Series interpolation (unused): set up the fields.
void	PTSL_AddpTSeries (PTSeriesList *thisStruct, int x, int y, int index, int seriesNum, int col)
	Point Time Series interpolation (unused): add to the series.
void	PTSL_Free (PTSeriesList *thisStruct)
	Point Time Series interpolation (unused): free up memory.
void	PTSL_ReadLists (PTSeriesList *thisStruct, const char *ptsFileName, int index, float *timeStep, int *nPtTS, int col)
	Point Time Series interpolation (unused): read raw point data.
void	PTSL_CreatePointMap (PTSeriesList *pList, void *Map, unsigned char Mtype, int step, float scale)
	Point Time Series interpolation (unused): generate interpolated spatial (map) data.
float	PTSL_GetInterpolatedValue1 (PTSeriesList *thisStruct, int x, int y, int step)
	Point Time Series interpolation (unused): at point, calculate inverse distance interpolation (unrestricted power of distance).
float	PTSL_GetInterpolatedValue0 (PTSeriesList *thisStruct, int x, int y, int step)
	Point Time Series interpolation (unused): at point, calculate inverse distance squared interpolation (restricted, not using pow() function).
PTSeriesList *	PTSL_Init (int nSlots, int format)
	Point Time Series interpolation (unused): initialize structure.
void	calcdate (double jd, int *m, int *d, int *y, int *h, int *mi, double *sec)
	Determine the Gregorian date from a Julian calendar day.
double	julday (int mon, int day, int year, int h, int mi, double se)
	Determine the Julian calendar day from a Gregorian date.
float	FMOD (float x, float y)
	Modulus of a pair of (double) arguments.
void	setup_grid ()
	Provide the 2D array size for the model domain.
void	set_env_vars (void)
	Acquire necessary environment variables.
void	set_boundary (VOIDP Map, unsigned char Mtype, float bv)
void	fatal (const char *msg)
	Exit (code=9) from program after sending a message.
void	Exit (int code)
	Standard exit from program.
void	Copy (void *src, void *dst, int w, int n, int sw, int dw)
	Memory-copy data from large (global) domain to local domain.
void	getInt (FILE *inFile, const char *lString, int *iValPtr)
	Get an integer following a specific string.
void	getChar (FILE *inFile, const char *lString, char *cValPtr)
	Get a character following a specific string.
void	getString (FILE *inFile, const char *lString, char *inString)
	Get a string following a specific string.
void	getFloat (FILE *inFile, const char *lString, float *fValPtr)
	Get a float value following a specific string.
void	setFlag (ViewParm *vp, UINT mask, int value)
	(Effectively unused). From Model.outList data, set a flag indicating array or not
int	getFlag (ViewParm *vp, UINT mask)
	Unused (never called) function.
int	getPrecision (ViewParm *vp)
	(Effectively unused).
int	isInteger (char *target_str)
	Determine if an integer is present in string.
int	isFloat (char *target_str)
	Determine if a float is present in string.
int	skip_white (FILE *infile)
	Skip white space(s) in a file.
int	scan_forward (FILE *infile, const char *tstring)
	Scan forward until a particular string is found.
int	check_for (char *s0, const char *s1, int start, int cs, int rp)
	Check for occurrences of string s1 in string s0 after position start.
int	find_char (FILE *infile, char tchar)
	Find a character.
int	Round (float x)
	truncate (not rounding) to an integer
char *	name_from_path (char *name)
	Get the var name from a longer path/filename.
char *	Scip (char *s, char SYM)
	Skip ahead in a string until next field.
void	setup_platform ()
	Effectively unused in serial (non-parallel) implementation.
void	link_edges (VOIDP Map, unsigned char Mtype)
	Effectively unused in serial (non-parallel) implementation.
float	Normal (float mean, float sd)
	Unused, never called. Normal distribution.
int	Poisson (float mu)
	Unused, never called. Poisson distribution.
int	init_config_file (FILE *vpFile, char term1, char term2, char term3, char term4)
	Get format definition of output configuration file (does nothing effective!).
int	parse_packet (FILE *vpFile, int *nArgs, char *test)
	Parse through a configuration fileline to obtain the configuration commands.
void	Combine (float *fValue, char *label, int nComp, int cType, int step)
	A variety of stat summaries in a selected spatial window (debug-related).
void	writeMap (char *, void *, int, unsigned char, int)
	Write data for spatial (map) output binary file.
void	writeFloatMap (char *, char *, float *, int, unsigned char, int, char *, int)
	Write floating point data for spatial (map) output binary file (new v2.8.2).
void	writeFloatNetCDF (char *, char *, float *, int, unsigned char, int, char *, int)
void	writeSeries (void *fValue, char *label, char *desc, int N0, int N1, byte Mtype, byte format)
	Write to a spatial data window in a debug file.
float *	readSeriesCol (char *filename, int format, int index, int *Npt, float *TStep, int col)
	(Unused). Read time series input data for spatial interpolations
byte	readMap (char *, void *)
	Read data for spatial (map) input binary file.
int	on_this_proc (int x, int y)
	Parallel code: does nothing in serial implementation).
void	exchange_borders (UCHAR *map, int size)
	Parallel code: does nothing in serial implementation).
void	exparam (struct nodenv *envInfo)
	Parallel code: effectively unused in serial implementation.
void	exgridsplit (int nprocs, int ndim, int nprocs2[2])
	Parallel code: effectively unused in serial implementation.
void	exgridcoord (int pnum, int rnum[2])
	Parallel code: effectively unused in serial implementation.
void	exgridsize (int pnum, int gsize[2], int lsize[2], int lstart[2])
	Parallel code: effectively unused in serial implementation.
void	broadcastInt (int *iValPtr)
	Parallel code: does nothing in serial implementation).
int	exgridinit (int dim, int *nprocs)
	Parallel code: does nothing in serial implementation).
void	broadcastMsg (UCHAR *msgPtr)
	Parallel code: does nothing in serial implementation).
void	fasync (FILE *file)
	Parallel code: does nothing in serial implementation).
void	fmulti (FILE *file)
	Parallel code: does nothing in serial implementation).
int	ReadGlobalParms (char *s_parm_name, int s_parm_relval)
	Acquire the model parameters that are global to the domain.
int	ReadHabParms (char *s_parm_name, int s_parm_relval)
	Acquire the model parameters that are specific to different habitat types in the domain.
int	ReadModExperimParms (char *s_parm_name, int s_parm_relval)
	Acquire the model parameters that are used in special model experiments - used only in special, research-oriented applications. (Added for v2.6). NOTE that this was quickly set up for the ELM Peer Review (2006) project, and (at least in v2.6.0) should be used in conjunction with the spatial interpolators for rain and pET inputs. (because this is intended for scales that are potentially incompatible w/ simultaneous use of gridIO inputs on SFWMM stage/depth that are expected w/ gridIO rain/pET). NOTE: this has not been specifically developed/tested for inclusion within the automated sensitivity analyses - thus only been used at this point for the ModExperimParms_NOM nominal parameter set (Nov 2006). .
Variables
int	CalMonOut = 99999
char *	ModelPath
char *	ProjName
char *	DriverPath
char *	OS_TYPE
char *	OutputPath
char	modelName [20]
char	modelVers [10]
char	modelFileName [300]
int	gNPtTs
int	PListIndex = 0
int	total_memory = 0
float *	plot_array
float	gTS
int	gridSize
int	gTempSize
UCHAR *	gTemp
float *	floatOut
float *	nc_dataRowRev
float	offMap_float = -9999.0
char	gCArg [kCArgDepth][kCArgWidth]
FILE *	Driver_outfile
float	avg_Intvl
SeriesParm	pSeries [MAX_PTSERIES]
ViewParm *	view
Point2D	dbgPt
struct nodenv	env
int	gbl_size [2]
int	lcl_size [2]
int	lcl_start [2]
int	N_iter
int	istep
int	procnum
int	Lprocnum
int	nprocs [2]
int	recpnum [2]
float	gRTable []
float	GP_IDW_pow
int	numBasn

---

Detailed Description

Header file for Driver Utilities.

This defines or declares variables & functions that are global to Driver_Utilities.c.

Note: documented with Doxygen, which expects specific syntax within special comments.

The Everglades Landscape Model (ELM).
last updated: June 2008

Definition in file driver_utilities.h.

---

Define Documentation

#define Outlist_size   250

The (maximum) number of variables in model outlist

Definition at line 28 of file driver_utilities.h.

Referenced by read_output_parms().

---

Function Documentation

VOIDP nalloc	(	unsigned	mem_size,
		const char	var_name[]
	)

Allocate memory for a variable.

Parameters:

	mem_size	The size of memory space
	var_name	The variable's name

Returns:

Pointer to that memory

Definition at line 1857 of file Driver_Utilities.c.

{
  VOIDP rp;

  
  if(mem_size == 0) return(NULL);
  rp = (VOIDP)malloc( mem_size );
  total_memory += mem_size;
  fasync(stderr);
  if( rp == NULL ) {
    fprintf(stderr,"Sorry, out of memory(%d): %s\n",mem_size,var_name);
    Exit(0);
  }
  fmulti(stderr);
  return(rp);
}

void init_pvar	(	VOIDP	Map,
		UCHAR *	mask,
		unsigned char	Mtype,
		float	iv
	)

Initialize a variable to a value.

Parameters:

	Map	array of data
	mask	data mask
	Mtype	the data type of the map data
	iv	the value used to initialize variable

Definition at line 1008 of file Driver_Utilities.c.

Referenced by alloc_hab_hist(), alloc_mem_stats(), alloc_memory(), Canal_Network_Init(), Channel_configure(), and setup_grid().

{
  int i0, i1;
  
  switch(Mtype) {
  case 'b' :    /* added double for (non-map) basin (b) array budget calcs */
    for(i0=0; i0<=numBasn; i0++) {
        ((double*)Map)[i0] = iv;
      }
    break;
  case 'l' :    /* added double (l == letter "ell" ) for map arrays */
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) {
        if(mask==NULL) ((double*)Map)[T(i0,i1)] = iv;
        else if ( mask[T(i0,i1)] == 0 ) ((double*)Map)[T(i0,i1)] = 0;
        else ((double*)Map)[T(i0,i1)] = iv;
      }
    break;
  case 'f' :    
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) {
        if(mask==NULL) ((float*)Map)[T(i0,i1)] = iv;
        else if ( mask[T(i0,i1)] == 0 ) ((float*)Map)[T(i0,i1)] = 0;
        else ((float*)Map)[T(i0,i1)] = iv;
      }
    break;
  case 'i' :    case 'd' :      
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) {
        if(mask==NULL) ((int*)Map)[T(i0,i1)] = (int)iv;
        else if ( mask[T(i0,i1)] == 0 ) ((int*)Map)[T(i0,i1)] = 0;
        else ((int*)Map)[T(i0,i1)] = (int)iv;
      }
    break;
  case 'c' :    
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) {
        if(mask==NULL) ((unsigned char*)Map)[T(i0,i1)] = (unsigned char) '\0' + (int) iv;
        else if ( mask[T(i0,i1)] == 0 ) ((unsigned char*)Map)[T(i0,i1)] = '\0';
        else ((unsigned char*)Map)[T(i0,i1)] = (unsigned char) '\0' + (int) iv;
      } 
    break;
 
   default :
    printf(" in default case\n");
   break;
  }
}

void read_map_dims

(

const char *

filename

)

Establish the number of rows and columns of the model.

Read the map dimensions of the global model array, establishing rows=s0 and columns=s1

Parameters:

filename

character string of the representative map (usually "Elevation")

Definition at line 975 of file Driver_Utilities.c.

Referenced by get_map_dims().

{
  FILE *file;
  
  if (debug>3) { sprintf(msgStr,"Getting map dims: %s",filename); usrErr(msgStr);} 
  if(Lprocnum == 1) {
    sprintf(modelFileName,"%s/%s/Data/Map_head/%s",ModelPath,ProjName,filename);
    file = fopen(modelFileName,"r");
    if(file==NULL) { 
      fprintf(stderr,"Unable to open map header file %s.\n",modelFileName); 
      fflush(stderr); 
      Exit(0);
    }
    scan_forward(file,"cols:");
    fscanf(file,"%d",&gbl_size[1]);
    sprintf(msgStr,"cols = %d\n",gbl_size[1]); WriteMsg(msgStr,1);
    scan_forward(file,"rows:");
    fscanf(file,"%d",&gbl_size[0]);
    sprintf(msgStr,"rows = %d\n",gbl_size[0]); WriteMsg(msgStr,1);
    fclose(file);
  }
  broadcastInt(gbl_size);   /* does nothing in serial (non-parallel) implementation */
  broadcastInt(gbl_size+1); /* does nothing in serial (non-parallel) implementation */
  s0 = gbl_size[0];
  s1 = gbl_size[1];
}

void read_model_parameters	(	char *	s_parm_name,
		int	s_parm_relval
	)

Call functions to read model parameters from datafiles.

Parameters:

	s_parm_name	Name of the sensitivity parameter being varied for this run
	s_parm_relval	Indicator of current value of relative range in sensitivity parm values: nominal (0), low (1), or high (2)

Definition at line 39 of file Driver_Utilities.c.

References msgStr, ReadGlobalParms(), ReadHabParms(), ReadModExperimParms(), usrErr(), usrErr0(), and WriteMsg().

                                                                  {

    sprintf(msgStr,"Reading global parameters..."); 
    WriteMsg(msgStr,1); 
    usrErr0(msgStr);

        ReadGlobalParms(s_parm_name, s_parm_relval);
    sprintf(msgStr,"done."); 
    WriteMsg(msgStr,1); 
    usrErr(msgStr);
        
    sprintf(msgStr,"Reading habitat-specific parameters..."); 
    WriteMsg(msgStr,1); 
    usrErr0(msgStr);

        ReadHabParms(s_parm_name, s_parm_relval);
    sprintf(msgStr,"done."); 
    WriteMsg(msgStr,1); 
    usrErr(msgStr);
  
    /* v2.6 - don't write message to console until later (when determine if parm file is used or not) */
        ReadModExperimParms(s_parm_name, s_parm_relval);
        
}

Here is the call graph for this function:

float* get_DBase_parmOLD	(	const char *	filename,
		int	i0,
		int	i1,
		int	index
	)

float* get_DBase_parm	(	const char *	filename,
		float *	dArray
	)

ViewParm* read_output_parms

(

void

)

Call the read_output_parms function.

Returns:

pointer to struct of ViewParm

Definition at line 66 of file Driver_Utilities.c.

References Outlist_size, and readOutlist().

                              {
/* need to change the Outlist_size (#defined in header) if adding outlist variables to the data struct in gen_output of UnitMod.c */
    ViewParm* v = readOutlist(Outlist_size);
    return v;
} 

Here is the call graph for this function:

ViewParm* readOutlist

(

int

size

)

Get the file to configure model output.

Parameters:

size

Outlist_size, the number of variables in model outlist

Returns:

pointer to struct of ViewParm

Definition at line 75 of file Driver_Utilities.c.

References cnfgFile, H_OPSYS, modelFileName, ModelPath, msgStr, ProjName, readViewParms(), UNIX, and WriteMsg().

Referenced by read_output_parms().

{
  int Npt;
  ViewParm* vp;
  FILE   *cnfgFile;
  
  if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/RunParms/Model.outList",ModelPath,ProjName);
  else sprintf(modelFileName,"%s%s:RunParms:Model.outList",ModelPath,ProjName);
  cnfgFile = fopen(modelFileName, "r");
  if (cnfgFile == NULL) {
      sprintf(msgStr, "Error, can't open file %s", modelFileName);
      WriteMsg(msgStr, 1); exit(-1);}
  
  Npt = readViewParms(cnfgFile,size, &vp);
  return vp;

}

Here is the call graph for this function:

int readViewParms	(	FILE *	vpFile,
		int	size,
		ViewParm **	ppview
	)

Read/process the command-parameters to configure model output.

The configuration file (Model.outList) is read to process the type (e.g., spatial maps, point time series, debug windows) and frequency (constant intervals of time) of model output.

Parameters:

	vpFile	Pointer to the Model.outList configuration file
	size	Outlist_size, the number of variables in model outlist
	ppview	Struct of ViewParm output configuration data

Returns:

value of Outlist_size

Definition at line 105 of file Driver_Utilities.c.

References avg_Intvl, viewParm::bounds, CalMonOut, debug, viewParm::fileName, point3D::format, gCArg, init_config_file(), ISARRAY, isFloat(), isInteger(), make_more_points(), viewParm::mapType, viewParm::maxPoints, msgStr, nalloc(), viewParm::nPoints, scale1::o, parse_packet(), viewParm::points, scale1::s, viewParm::scale, setFlag(), setPrecision(), viewParm::step, point3D::type, usrErr(), viewParm::varUnits, view, scale2::Vmax, scale2::Vmin, WriteMsg(), point3D::x, point3D::y, and point3D::z.

Referenced by readOutlist().

{
  char test;
  char cmd;
  int index=0, ix, iy, iz, i, nArgs, precision, format=0, Ocmd;
  float x,y;
  ViewParm *vp, *view;

  format = init_config_file(vpFile, '#', '*', '@', '~');
  view = (ViewParm *)nalloc(size * sizeof(ViewParm), "view");
  *ppview = view;
  
  for (i = 0; i < size; i++) {
    vp = view+i;
    vp->scale.s = 1.0;
    vp->scale.o = 0.0;
    vp->step = 0;
    Ocmd=0;
    vp->nPoints = 0;
    vp->points = NULL;
    vp->maxPoints = 0;
    vp->mapType = 'N';
    precision = 1;
    setPrecision(vp,precision);
  }

  while(1) {
    index = parse_packet(vpFile, &nArgs, &test);/*fix*/
    if( index == -1)  break; 
    if( index == -3)  break; 
    if(index >= size) { 
      fprintf(stderr,"\n Read index Error in configuration: index out of range: %d ", index); 
      break; 
    }
    if( index == -2) break;
    else {
      vp = view+index;
      strncpy(vp->fileName,gCArg[0],23);
      vp->fileName[23]='\0';
      if( test == '*' ) setFlag(vp,ISARRAY,1); 
      else if (test == '@') setFlag(vp,ISARRAY,0);
      else { 
        sprintf(msgStr," %s: Syntax Error in configuration, test char = %c ",gCArg[0],test); 
        usrErr(msgStr);  
        break; 
      }
      if(debug && gCArg[1][0] != 'U') { 
        sprintf(msgStr,"\nReading Output Config for %s: Nargs = %d, CMD0 = %c index = %d",
                gCArg[0],nArgs,gCArg[1][0],index);      
        WriteMsg(msgStr,1);  
      }                         
      cmd = gCArg[1][0]; 
      switch (cmd) {    
          case 'U': /* v2.8.2 - new "command" for variables' units; this is actually not a "command" for requesting output, but simply uses the command syntax to encapsulate the string of units */
              strncpy(vp->varUnits,gCArg[2],23);
              vp->varUnits[23]='\0';
              if(debug > 3) { 
                  sprintf(msgStr,"\n%s Output Config: Units= %s",gCArg[0],gCArg[2]);    
                  WriteMsg(msgStr,1); 
              }                         
              
              break;
          case 'O':
              if( isInteger(gCArg[2])  ) { ix = atoi(gCArg[2]);  }
              else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);     
              if(debug) { 
                  sprintf(msgStr,"\n%s Output Config: O(%d)",gCArg[0],ix);      
                  WriteMsg(msgStr,1); 
              }                         
              vp->step = ix; Ocmd=1;
              /* TODO: develop flexible output of calendar-based and julian-based outsteps (jan 11, 2005) */
              /* kluge here in checking use of Model.outList outstep relative to Driver.parm avg_Intvl */
              if (vp->step == CalMonOut && avg_Intvl != 0) {
                  sprintf(msgStr,"\n***ERROR in Model.outList & Driver.parm integration: Driver.parm's avg_Intvl must be 0 for calendar-based Outstep of %s.",gCArg[0]);        
                  usrErr(msgStr); 
                  exit(-1);
              }
              
              break;
          case 'A':
              if( isInteger(gCArg[2]) && nArgs > 2 ) { ix = atoi(gCArg[2]);  }
              else  { 
                  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);  
                  WriteMsg(msgStr,1); 
              } 
              if(debug) { 
                  sprintf(msgStr,"\n%s Output Config: A()",gCArg[0]); 
                  WriteMsg(msgStr,1); 
              }                                 
              vp->mapType = 'H';
              if( Ocmd == 0 ) vp->step = 1;
              break;
          case 'G':
              if ( nArgs > 2 )  { 
                  if( isInteger(gCArg[2])  ) { 
                      vp->mapType = atoi(gCArg[2]); 
                  } 
                  else { vp->mapType =gCArg[2][0]; } 
              }
              if ( nArgs > 3 ) 
                  if( isInteger(gCArg[3])  ) { 
                      precision = atoi(gCArg[3]); 
                  }
              if ( nArgs > 4 ) strcpy(vp->fileName,gCArg[4]);
              if( precision > 1 && precision < 5 ) setPrecision(vp,precision);
              if( Ocmd == 0 ) vp->step = 1;
              break;
          case 'B':
              if( isFloat(gCArg[2]) && isFloat(gCArg[3])  && nArgs > 3 ) { 
                  vp->bounds.Vmax = atof(gCArg[2]); 
                  vp->bounds.Vmin = atof(gCArg[3]); 
              }
              if(debug) { 
                  sprintf(msgStr,"\n Output Config: G(%.1f,%.1f)",
                          vp->bounds.Vmax, vp->bounds.Vmin); 
                  WriteMsg(msgStr,1); 
              } 
              break;
          case 'P':
              if( isInteger(gCArg[2]) &&  isInteger(gCArg[3]) && nArgs > 3 )  {         
                  if( (i = (++(vp->nPoints)-1)) >= (vp->maxPoints)) make_more_points(vp,7);
                  ix = atoi(gCArg[2]); iy = atoi(gCArg[3]);  
              }
              else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);
              if(debug) { 
                  sprintf(msgStr,"\n%s Output Config: P(%d,%d), index = %d",gCArg[0],ix,iy,i); 
                  WriteMsg(msgStr,1);  
              }                         
              vp->points[i].x = ix; 
              vp->points[i].y = iy;
              vp->points[i].type = 'p';
              /* TODO: develop flexible output of calendar-based and julian-based outsteps (jan 11, 2005) */
              /* kluge here in preventing use of point time series output using calendar-based outstep  */
              if (vp->step == CalMonOut) {
                  sprintf(msgStr,"\n***ERROR in Model.outList: sorry, but you can't have point-time series output with calendar-based Outstep of %s.  Go yell at Carl!",gCArg[0]);      
                  usrErr(msgStr); 
                  exit(-1);
              }
              break;
          case 'W':
              if( isInteger(gCArg[2]) &&  isInteger(gCArg[3]) &&  isInteger(gCArg[4]) && nArgs > 4 ) {
                  if( (i = (++(vp->nPoints)-1)) >= (vp->maxPoints)) make_more_points(vp,7);
                  ix = atoi(gCArg[2]); iy = atoi(gCArg[3]); iz = atoi(gCArg[4]);  
              }
              else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);
              if( nArgs > 5 )  vp->points[i].format = gCArg[5][0];
              vp->points[i].type = 'w';
              vp->points[i].x = ix;     
              vp->points[i].y = iy;     
              vp->points[i].z = iz;
              if(debug) { 
                  sprintf(msgStr,"\n%s Output Config: W(%d,%d,%d,%c), index = %d",
                          gCArg[0],ix,iy,iz,vp->points[i].format,i);    
                  WriteMsg(msgStr,1);  
              }                         
              if( Ocmd == 0 ) vp->step = 1;
              break;
          case 'S': case 'C':
              if( gCArg[1][1] == 'm' || gCArg[1][0] == 'C' ) {     
                  if( isInteger(gCArg[2]) &&  isInteger(gCArg[3]) &&  isInteger(gCArg[4]) && nArgs > 5 ) {
                      if( (i = (++(vp->nPoints)-1)) >= (vp->maxPoints)) make_more_points(vp,7);
                      ix = atoi(gCArg[2]); iy = atoi(gCArg[3]); iz = atoi(gCArg[4]); 
                      vp->points[i].type =  gCArg[5][0];
                  }
                  else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);
                  vp->points[i].x = ix;         
                  vp->points[i].y = iy;         
                  vp->points[i].z = iz;
                  if(debug) { 
                      sprintf(msgStr,"\n%s Output Config: Sm(%d,%d,%d,%c), index = %d",
                              gCArg[0],ix,iy,iz,gCArg[4][0],i);  
                      WriteMsg(msgStr,1); 
                  }                             
                  if( Ocmd == 0 ) vp->step = 1; 
              } 
              else {                                                            
                  if( nArgs > 2 ) {
                      if( isFloat(gCArg[2]) ) { x = atof(gCArg[2]); }
                      else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);
                  }
                  if( nArgs > 3 ) {
                      if( isFloat(gCArg[3]) ) { y = atof(gCArg[3]); }
                      else  fprintf(stderr," %s: Syntax Error in configuration ",gCArg[0]);
                  }
                  if(debug) { 
                      sprintf(msgStr,"\n%s Output Config: S(%f,%f)",gCArg[0],x,y); 
                      WriteMsg(msgStr,1); 
                  }                             
                  vp->scale.s = x; 
                  vp->scale.o = y;
              }
              break;
      } /* end of switch */
    } /* end of else */
  } /* end of while */
  return size;
}

Here is the call graph for this function:

void setPrecision	(	ViewParm *	vp,
		int	value
	)

(Effectively unused).

Definition at line 1417 of file Driver_Utilities.c.

References viewParm::flags, PMASK1, and PMASK2.

Referenced by readViewParms().

{
  if(value/3) vp->flags |= PMASK2; else vp->flags &= ~PMASK2;
  if((value-1)%2) vp->flags |= PMASK1; else vp->flags &= ~PMASK1;
}

int write_map_file	(	const char *	filename,
		VOIDP	Map,
		char	Mtype,
		int	index,
		float	scale_value,
		float	offset_value,
		int	bSize,
		unsigned char	type,
		const char *	thisvarUnits,
		int	outstep,
		char *	ncFileName
	)

Prepare the file and the data for writing output of map (array).

Parameters:

	filename	Output file name
	Map	Model variable array data
	Mtype	General output format type
	index	Count index of the output iteration for this variable (may be > step)
	scale_value	Variable-scaling multiplier
	offset_value	Variable-scaling offset
	bSize	The byte size of the output array
	type	The output map storage type
	thisvarUnits	Units of the output variable
	outstep	The output interval time step
	ncFileName	The filename for netCDF output

Definition at line 473 of file Driver_Utilities.c.

References CASE, check_for(), simTime::da, dbgPt, debug, enc_Nb(), END, floatOut, gridSize, gTemp, gTempSize, H_OPSYS, HDF4, simTime::mo, modelFileName, msgStr, nalloc(), NCDF3, offMap_float, ON_MAP, OutputPath, ProjName, quick_look(), s0, s1, SimTime, T, UNIX, writeFloatMap(), writeMap(), WriteMsg(), point2D::x, point2D::y, and simTime::yr.

Referenced by write_output().

{       
  int i, j, pathType=0;
  char ftype[10], gSize;
  float ftmp; 
  SLONG itmp, imax, imin;
  UCHAR *mPtr;
  char s_mo[3], s_da[3];
  FILE* bFile; 
   
/* below provides old (v1.0) increasing integer, non-date, appendage to filenames */
/*   ftype[0] = '0' + (index / 100); */
/*   ftype[1] = '0' + ((index%100) / 10); */
/*   ftype[2] = '0' + (index % 10); */
 /*  ftype[8] = '\0'; */

/*  append the date (yyyymmdd) to the root filename*/
  if (SimTime.mo[0]<10) sprintf(s_mo,"0%d", SimTime.mo[0]);
  else sprintf(s_mo,"%d", SimTime.mo[0]);
  if (SimTime.da[0]<10) sprintf(s_da,"0%d", SimTime.da[0]);
  else sprintf(s_da,"%d", SimTime.da[0]);
  sprintf(ftype,"%d%s%s\0",SimTime.yr[0],s_mo,s_da);
  
  if( HDF4 && type=='H' ) sprintf(ftype,".hdf");
   
  if( NCDF3 && type=='C' ) sprintf(ftype,".nc");
   
  gSize = gridSize*bSize + 1;
  if( gSize > gTempSize ) { 
    if(gTempSize) free((char*)gTemp); 
    gTemp = (UCHAR*) nalloc( gSize, "gTemp" );  
    gTempSize = gSize; 
  }
  
  if( H_OPSYS == UNIX ){ 
    if(check_for((char*)filename, "/", 0, CASE, END ) >= 0 ) { 
      if(filename[0] != '/' ) pathType = 1; 
      else pathType = 2; 
    }
  }
  else { if(check_for ((char*)filename, ":", 0, CASE, END ) >= 0 ) { if( filename[0] == ':' ) pathType = 1; else pathType = 2; }}
  
  if(type=='H') {                         /* HDF format */
    switch(pathType) {
    case 0:     /* No Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/HDF/%s%s\0",OutputPath,ProjName,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:HDF:%s%s\0",OutputPath,ProjName,filename,ftype);
      break;
    case 1:     /* Relative Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/HDF/%s%s\0",OutputPath,ProjName,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:HDF:%s%s\0",OutputPath,ProjName,filename,ftype);
      break;
    case 2:     /* Full Path */
      sprintf(modelFileName,"%s.hdf\0",filename);
      break;
    }
  }

 else if(type=='C') {                         /* netCDF format */
    switch(pathType) {
    case 0:     /* No Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/NCDF/%s%s\0",OutputPath,ProjName,ncFileName,ftype);
      else sprintf(modelFileName,"%s%s:Output:NCDF:%s%s\0",OutputPath,ProjName,ncFileName,ftype);
      break;
    case 1:     /* Relative Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/NCDF/%s%s\0",OutputPath,ProjName,ncFileName,ftype);
      else sprintf(modelFileName,"%s%s:Output:NCDF:%s%s\0",OutputPath,ProjName,ncFileName,ftype);
      break;
    case 2:     /* Full Path (not used) */
      sprintf(modelFileName,"%s.hdf\0",filename);
      break;
    }
  }

  else if(type=='M') {  
    switch(pathType) {                   /* M==Map, generic binary (possibly larger than uchar size binary) Format */
    case 0:                                                             /* No Path */
// v2.8.2 changed to varname-specific directory, must be existing directory (user will have to create, for now
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/%s/%s%s\0",OutputPath,ProjName,filename,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:%s:%s%s\0",OutputPath,ProjName,filename,filename,ftype);
      break;
    case 1:     /* Relative Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/%s/%s%s\0",OutputPath,ProjName,filename,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:%s:%s%s\0",OutputPath,ProjName,filename,filename,ftype);
      break;
    case 2:     /* Full Path */
      sprintf(modelFileName,"%s%s\0",filename,ftype);
      break;
    }
  }
  else {
        bSize = 1;
    switch(pathType) {                   /* Generic Binary Format (uchar, 0-254 ints) */
    case 0:                                                             /* No Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/Animation%d/%s%s\0",OutputPath,ProjName,type,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:Animation%d:%s%s\0",OutputPath,ProjName,type,filename,ftype);
      break;
    case 1:     /* Relative Path */
      if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Output/Animation%d/%s%s\0",OutputPath,ProjName,type,filename,ftype);
      else sprintf(modelFileName,"%s%s:Output:Animation%d:%s%s\0",OutputPath,ProjName,type,filename,ftype);
      break;
    case 2:     /* Full Path */
      sprintf(modelFileName,"%s%s\0",filename,ftype);
      break;
    }
  }
  
  bSize = (bSize < 1) ? 1 : bSize;
  bSize = (bSize > 4) ? 4 : bSize;
  if( Mtype == 'c' ) bSize = 1;
  
/*  New for v.2.8.2, providing capability to write (4 byte) floating point output maps.
        This may not be elegant, but will get it done for now.  The issue is that 
        the size of the arrays are actually s0+2, s1+2, which will later result in
        having larger array sizes for these output maps.  Would need to use the equivalent
        of enc_Nb to consider only the data in s0,s1 array.  */
  if (bSize == 4) {
  
  for (i=0; i< (s0+2); i++) { /* was trying to only resample within 0,s0, but gave up and using whole s0+2 array */
    for (j=0; j< (s1+2); j++) { /* was trying to only resample within 0,s1, but gave up and using whole s1+2 array */
      if( ON_MAP[T(i,j)] ) { /* for resampling, was using T(i+1,j+1) */
         floatOut[T(i,j)] = (( (float*) Map)[T(i,j)]); 
      }
      else {
         floatOut[T(i,j)] = offMap_float; /* for resampling */
//              ( (float*) Map)[T(i,j)]  = offMap_float; /* arrays were initialized to 0 */
      }
    }
  }
  
  if  ( debug >3) {  sprintf(msgStr,"\n\nWriting Float Map %s: no scaling should be used (scale and offset values are ignored, but should be 1 & 0, respectively) scale_value = %f, offset_value = %f, index = %d, filename = %s, type = %c, bSize = %d, pathType = %d, type = %d, units = %s\n",
                           filename,scale_value,offset_value,index,modelFileName,Mtype,bSize,pathType,type,thisvarUnits);   WriteMsg(msgStr,1); }

  writeFloatMap(modelFileName,filename,floatOut,bSize,type,index,thisvarUnits,outstep); 
  /* we're done with writing floats (no scaling done) */
  return(0);
  } 


  if(bSize == 1) { imax = 255; imin = 0; }
  else if(bSize == 2) { imax = 255*128; imin = -imax; } 
  else if(bSize == 3) { imax = 256*256*128; imin = -imax; }
  mPtr = gTemp;
  
  if  ( debug >3) {  sprintf(msgStr,"\n\nWriting Map %s: scale_value = %f, offset_value = %f, index = %d, filename = %s, type = %c, bSize = %d, pathType = %d, type = %d\n",
                           filename,scale_value,offset_value,index,modelFileName,Mtype,bSize,pathType,type);   WriteMsg(msgStr,1); }
  
  for (i=0; i<s0; i++) {
    for (j=0; j<s1; j++) {
      if( ON_MAP[T(i+1,j+1)] ) {
        switch(Mtype) {
        case 'l' :
      ftmp = ((( (double*) Map)[T(i+1,j+1)] - offset_value) / scale_value); /* v2.3.2 added double (casting to float ftmp) */
          itmp = (int) ftmp;
          itmp = (itmp > imax-1) ? imax-1 : itmp;
          itmp = (itmp < imin) ? imin : itmp;
          break;
        case 'f' :                      
          ftmp = ((( (float*) Map)[T(i+1,j+1)] - offset_value) / scale_value); 
          itmp = (int) ftmp;
          itmp = (itmp > imax-1) ? imax-1 : itmp;
          itmp = (itmp < imin) ? imin : itmp;
          break;
        case 'd' : case 'i' :   
          ftmp = ((( (int*) Map)[T(i+1,j+1)] - offset_value) / scale_value); 
          itmp = (int) ftmp;
          itmp = (itmp > imax-1) ? imax-1 : itmp;
          itmp = (itmp < imin) ? imin : itmp;
          break;
        case 'c' :                              
          itmp = ((unsigned char*) Map)[T(i+1,j+1)];
          itmp = (itmp > imax-1) ? imax-1 : itmp;
          itmp = (itmp < imin) ? imin : itmp;
          break;
        }
      }
      else   itmp = imax;  
      
      
      enc_Nb(&mPtr,itmp,bSize);
      
    }
  }     

  writeMap(modelFileName,gTemp,bSize,type,index);
  if(debug) quick_look(Map, (char*)filename, Mtype, dbgPt.x, dbgPt.y, 2,'E');
  return(0);
}

Here is the call graph for this function:

int read_map_file	(	const char *	filename,
		VOIDP	Map,
		unsigned char	Mtype,
		float	scale_value,
		float	offset_value
	)

Get the file and read/convert the data of map (array).

Parameters:

	filename	Input file name
	Map	Model variable array data
	Mtype	General data format type
	scale_value	Variable-scaling multiplier
	offset_value	Variable-scaling offset

Returns:

byte size of data values

Definition at line 674 of file Driver_Utilities.c.

Referenced by init_dynam_data(), and init_static_data().

{
  int i, j, k0, size;
  unsigned temp;
  UCHAR *tmpPtr, Dsize;
  
gridSize = (s0+2)*(s1+2);
gTempSize = gridSize*8;


  size = gridSize*4 +1;
  if( size > gTempSize ) { 
    if(gTemp) free((char*)gTemp); 
    gTemp = (UCHAR*)nalloc( size, "gTemp" );    
    gTempSize = size; 
  }
  
  if(debug>2) { 
    sprintf(msgStr,"Reading %s\n",filename);  
    usrErr(msgStr); 
    WriteMsg(msgStr,1); 
  } 
  
  Dsize = readMap(filename,gTemp);
  
  if(debug) { 
    sprintf(msgStr,"name = %s, proc = %d, scale_value = %f, offset_value = %f, size = %x\n ",
            filename,procnum,scale_value,offset_value,Dsize);  
    WriteMsg(msgStr,1); 
  } 
  for (i=1; i<=s0; i++) {
    for (j=1; j<=s1; j++) {
      k0 = Dsize*((i-1)*lcl_size[1] + (j-1));
      tmpPtr = gTemp+k0;
      switch(Dsize) {
        case 1: temp = gTemp[k0]; break;
        case 2: temp = gTemp[k0]*256 + gTemp[k0+1]; break;
        case 3: temp = gTemp[k0]*65536 + gTemp[k0+1]*256 + gTemp[k0+2]; break;
        case 4: temp = gTemp[k0]*16777216 + gTemp[k0+1]*65536 + gTemp[k0+2]*256 + gTemp[k0+3]; break;
        default: fprintf(stderr,"ERROR, illegal size: %x\n",Dsize); temp = 0;
      }                                         
      switch (Mtype) {
        case 'f' :
          ((float*)Map)[T(i,j)] = scale_value*((float)temp)+offset_value; 
        break;
        case 'd' : case 'i' :
          ((int*)Map)[T(i,j)] = (int)(scale_value * (float)temp + offset_value); 
        break;
        case 'c' :
          ((unsigned char*)Map)[T(i,j)] = (int)(scale_value * (unsigned char)temp); 
        break;
      }
    }
  }
  if(debug) quick_look(Map, (char*)filename, Mtype, dbgPt.x, dbgPt.y, 2,'E');
  link_edges(Map,Mtype);
  fflush(stderr);
  return Dsize;
}

void print_loc_ave	(	Point3D *	vt,
		void *	Map,
		char	Mtype,
		char *	mName,
		int	tIndex
	)

Calculate summary statistics to determine local average.

Parameters:

	vt	struct of cell points
	Map	Model variable data array
	Mtype	the data type of the map data
	mName	variable name
	tIndex	the current iteration number

Definition at line 1065 of file Driver_Utilities.c.

References Combine(), kAVE, kAVECUM, kSUM, kSUMCUM, lcl_start, ON_MAP, s0, s1, T, point3D::type, point3D::x, point3D::y, and point3D::z.

Referenced by write_output().

{
  int ix, iy, x, y, x0, y0, range, xmax, ymax, xmin, ymin, type = 11;
  float vout[4];
  double sum = 0, normCoef = 0;
  
  if(Mtype != 'f') { fprintf(stderr,"Warning: Wrong type in Loc Ave: %s(%c)\n",mName,Mtype); return; }  
  x0 = vt->x;
  y0 = vt->y;
  range = vt->z;
  x = x0 - lcl_start[0]; 
  y = y0 - lcl_start[1];
  xmin = x - range;
  xmax = x + range;
  ymin = y - range;
  ymax = y + range;
  xmax = (xmax > (s0)) ? (s0) : xmax;
  xmin = (xmin <  0  ) ?   0  : xmin;
  ymax = (ymax > (s1)) ? (s1) : ymax;
  ymin = (ymin <  0  ) ?   0  : ymin;
  
  for(ix=xmin; ix<xmax; ix++)  {
    for(iy=ymin; iy<ymax; iy++) { 
      if( ON_MAP[T(ix+1,iy+1)] ) sum += ((float*)Map)[T(ix+1,iy+1)];                    
      normCoef += 1.0;
    }
  }
  
  vout[0] = sum; vout[1] = normCoef;
  
  switch (vt->type) {
     case 's' :  Combine(vout,mName,1,kSUM,tIndex); break; /* Sum for all window cells at outStep iterations */
     case 'a' :  Combine(vout,mName,2,kAVE,tIndex); break; /* Average for all window cells at outStep iterations */
     case 'A' :  Combine(vout,mName,2,kAVECUM,tIndex); break; /* Cumulative average for all window cells over all outStep iterations */
     case 'S' :  Combine(vout,mName,1,kSUMCUM,tIndex); break; /* Cumulative sum for all window cells over all outStep iterations */
  }  
}

Here is the call graph for this function:

void write_output	(	int	index,
		ViewParm *	vp,
		void *	Map,
		const char *	filename,
		char	Mtype,
		int	step
	)

Determine which functions to call for model output.

Parameters:

	index	Count index of the output iteration for this variable (may be > step)
	vp	A struct of ViewParm, outlist configuration
	Map	Model variable array data
	filename	Output file name
	Mtype	General output format type
	step	The current output step

Definition at line 435 of file Driver_Utilities.c.

Referenced by gen_output().

{
        int i; Point3D point;
        

        if(vp->mapType != 'N' ) { 
                        write_map_file((char*)filename,Map,Mtype,index,vp->scale.s,vp->scale.o,getPrecision(vp),vp->mapType,vp->varUnits,vp->step,vp->fileName); /* v2.8.2 added varUnits, vp->step (which is outstep interval), and fileName for netCDF use */
                        if (debug > 3) calc_maxmin(vp,Map,Mtype,(char*)filename,step);
        }
        for(i=0; i< (vp->nPoints); i++ ) {
                point = vp->points[i];
            if (debug > 3) { sprintf(msgStr,"\nwriting Out: %s(%d): %c(), index = %d, step=%d\n", filename, i, point.type, index, step ); 
            WriteMsg(msgStr,1); 
            }
            
                switch( point.type ) {  
                    case 'm': case 'M': calc_maxmin( vp,Map,Mtype,(char*)filename,step); break; 
                    case 'w': quick_look( Map,(char*) filename, Mtype, point.x, point.y, point.z, point.format ); break;
                    case 'a': case 's': case 'A': case 'S': print_loc_ave( &point, Map, Mtype, (char*)filename, step ); break;
                    case 'p': print_point( vp, Map, Mtype, (char*)filename, step, i ); break;
                }
        }
}

void print_point	(	ViewParm *	vp,
		void *	Map,
		char	Mtype,
		char *	mName,
		int	tIndex,
		int	vpindex
	)

Print data at point locations to memory (not to file/disk yet).

Parameters:

	vp	struct of ViewParm output configuration
	Map	Array data of variable
	Mtype	General output format type
	mName	The name of the variable
	tIndex	Current model iteration number
	vpindex	Index of the current point number

Definition at line 929 of file Driver_Utilities.c.

References seriesParm::data, debug, fatal(), lcl_start, seriesParm::Length, seriesParm::Loc, MAX_PTSERIES, msgStr, N_iter, seriesParm::outstep, PListIndex, viewParm::points, pSeries, s0, s1, viewParm::step, T, usrErr(), WriteMsg(), point2D::x, point3D::x, point2D::y, point3D::y, and point3D::z.

Referenced by write_output().

{
        int x, y;
        Point3D *pt;
  
        pt = vp->points + vpindex;
    x = pt->x - lcl_start[0];
    y = pt->y - lcl_start[1];
    if(  (x >= 0) && (x < s0)  &&  (y >= 0) && (y < s1)  ) {
      if(tIndex==0) { pt->z = PListIndex; pSeries[PListIndex].Length=0; 
    }
    else PListIndex = pt->z; 
    if(tIndex==0) {                     
              /* TODO: develop flexible output of calendar-based and julian-based outsteps (jan 11, 2005) */
          if(PListIndex >= MAX_PTSERIES ) fatal("Too many Point series.");
          else if( pSeries[PListIndex].data == NULL ) pSeries[PListIndex].data = (float*) malloc( (N_iter*sizeof(float)/vp->step)+2 );
      if( pSeries[PListIndex].data == NULL ) usrErr("out of Memory for Spatial Timeseries.");
          pSeries[PListIndex].Loc.x = pt->x;
          pSeries[PListIndex].Loc.y = pt->y;
          pSeries[PListIndex].outstep = vp->step; 
          strcpy(pSeries[PListIndex].name,mName);
          if(debug >2) { 
                        sprintf(msgStr,"\nSetup Pointlist %d for %s(%d), step=%d, point=(%d,%d)\n", PListIndex, mName, vpindex, vp->step, x, y ); 
                        WriteMsg(msgStr,1); 
            }
     }
      switch(Mtype) {
                  case 'f' :  pSeries[PListIndex].data[ pSeries[PListIndex].Length++ ] = ((float*)Map)[T(x+1,y+1)];     break;          
                  case 'i' :    pSeries[PListIndex].data[ pSeries[PListIndex].Length++ ] = ((int*)Map)[T(x+1,y+1)]; break;
                  case 'c' :  pSeries[PListIndex].data[ pSeries[PListIndex].Length++ ] = ((unsigned char*)Map)[T(x+1,y+1)];
      }
          if(debug >3) { 
                  sprintf(msgStr,"\nWriting Point %d for %s(%d), point=(%d,%d), value = %f, index = %d\n", 
                                                        PListIndex, mName, vpindex, x, y, ((float*)Map)[T(x+1,y+1)], pSeries[PListIndex].Length-1 ); 
                  WriteMsg(msgStr,1); 
          }
      PListIndex++;
    }
}

Here is the call graph for this function:

void writeWindow	(	void *	fValue,
		char *	vName,
		char *	desc,
		int	x0,
		int	y0,
		int	N0,
		int	N1,
		int	index,
		UCHAR	Mtype,
		UCHAR	format
	)

Prepare a local data set for writing a local data window in debug file.

Parameters:

	fValue	Model variable array data
	vName	Model variable name
	desc	Message describing the output
	x0	Lower x (row!) value
	y0	Lower y (col!) value
	N0	Range in x (row!) values
	N1	Range in y (col!) values
	index	Current iteration number
	Mtype	General output format type
	format	Numeric format type

Definition at line 843 of file Driver_Utilities.c.

References Copy(), gTemp, gTempSize, s1, T, and writeSeries().

Referenced by quick_look().

{
  int mSize, size;
  char ctemp[200];
  
  switch(Mtype) {
  case 'l':                             size = sizeof(double); break; /* v2.3.2 added */
  case 'f': case 'L': case 'E':         size = sizeof(float); break;
  case 'd': case 'i':                   size = sizeof(int);  break;
  case 'c':                             size = sizeof(char); break;
  }
  if( (mSize=size*N0*N1) > gTempSize ) {
    if(gTemp != NULL) free((char*)gTemp);
    gTemp = (UCHAR*)malloc(gTempSize=mSize);
  }
  
  Copy(((UCHAR*)fValue)+T(x0,y0)*size, gTemp, N1*size, N0, (s1+2)*size, N1*size);
  sprintf(ctemp,"(%d)WIND: %s",index,vName);
  writeSeries(gTemp,ctemp,desc,N0,N1,Mtype,format);
}

Here is the call graph for this function:

void calc_maxmin	(	ViewParm *	vp,
		void *	Map,
		char	Mtype,
		char *	mName,
		int	step
	)

Calculate maximum & minimum values in model output arrays.

For each model variable to be output (info in ViewParm struct), calculate the maximum and minimum values across the variable's spatial array.

Parameters:

	vp	struct of ViewParm data
	Map	Model variable array data
	Mtype	General output format type
	mName	Variable name
	step	The current iteration number

Definition at line 344 of file Driver_Utilities.c.

References Combine(), viewParm::gScale, kMAXMIN, ON_MAP, s0, s1, T, scale2::Vmax, and scale2::Vmin.

Referenced by write_output().

{
  int ix, iy;
  float vout[4], ftmp, fmax = -1000, fmin = 1000;
  
  switch(Mtype) {
  case 'f' :    
    for(ix=1; ix<=s0; ix++) 
      for(iy=1; iy<=s1; iy++) {
        if( ON_MAP[T(ix,iy)] ) {
          if( (ftmp = ((float*)Map)[T(ix,iy)]) > fmax ) {
            fmax = ftmp; 
          }
          if( ftmp < fmin ) fmin = ftmp;
        }
      }
    break;
  case 'i' :    case 'd' :      
    for(ix=1; ix<=s0; ix++) 
      for(iy=1; iy<=s1; iy++) {
        if( ON_MAP[T(ix,iy)] ) {
          if((ftmp = ((int*)Map)[T(ix,iy)]) > fmax ) fmax = ftmp;
          if( ftmp < fmin ) fmin = ftmp;
        }
      }
    break;
  case 'c' :    
    for(ix=1; ix<=s0; ix++) 
      for(iy=1; iy<=s1; iy++) {
        if( ON_MAP[T(ix,iy)] ) {
          if( (ftmp = (float)((unsigned char*)Map)[T(ix,iy)]) > fmax ) fmax = ftmp;
          if( ftmp < fmin ) fmin = ftmp;
        }
      } 
    break;
  }
  if(step==0) {
    vp->gScale.Vmax = fmax;
    vp->gScale.Vmin = fmin;
  } else {
    if( fmax > vp->gScale.Vmax ) vp->gScale.Vmax = fmax;
    if( fmin < vp->gScale.Vmin ) vp->gScale.Vmin = fmin;
  }
  vout[0] = fmax; vout[1] = vp->gScale.Vmax; vout[2] = fmin; vout[3] = vp->gScale.Vmin;
  Combine(vout,mName,4,kMAXMIN,step); /* Iterative and cumulative, maximum and minimum values for all window cells at outstep iterations */
}

Here is the call graph for this function:

void quick_look	(	void *	Map,
		char *	name,
		unsigned char	Mtype,
		int	xc,
		int	yc,
		int	range,
		unsigned char	format
	)

Prepare data and write heading for writing a data window in debug file.

Parameters:

	Map	Model variable array data
	name	Model variable name
	Mtype	General output format type
	xc	Point location x (row!)
	yc	Point location y (col!)
	range	Size range (cells) of window
	format	Numeric format type

Definition at line 802 of file Driver_Utilities.c.

References debug, iclip(), istep, lcl_start, msgStr, name_from_path(), on_this_proc(), recpnum, s0, s1, and writeWindow().

Referenced by read_map_file(), write_map_file(), and write_output().

{
  int ymin, ymax, xmin, xmax, x, y, N0, N1;
  char* namePtr;

  if (!on_this_proc(xc,yc)) return;
  x = xc - lcl_start[0] + 1;
  y = yc - lcl_start[1] + 1;
  xmin = x - range;
  xmax = x + range + 1;
  ymin = y - range;
  ymax = y + range + 1;
  xmax = iclip( xmax, 0, s0+2);
  xmin = iclip( xmin, 0, s0+2);
  ymax = iclip( ymax, 0, s1+2);
  ymin = iclip( ymin, 0, s1+2);
  N0 = xmax-xmin;
  N1 = ymax-ymin;
  namePtr = name_from_path(name);
  if (debug >3) {
    sprintf(msgStr,"Window to Map %s, s=%d, proc0 = %d, proc1 = %d; Corners(gbl): (%d,%d) (%d,%d)\n",
            namePtr,range,recpnum[0],recpnum[1],xc-range,yc-range,xc+range+1,yc+range+1);
    writeWindow(Map,namePtr,msgStr,xmin,ymin,N0,N1,istep,Mtype,format);
  }
  
}

Here is the call graph for this function:

int iclip	(	int	x0,
		int	min,
		int	max
	)

Constrain x0 value within a min and a max.

Parameters:

	x0	number to work on
	min	the minimum
	max	the maximum

Returns:

result

Definition at line 872 of file Driver_Utilities.c.

Referenced by quick_look().

{
  int rv;
  rv = ( x0 > max) ?  max : x0;
  rv = ( rv < min) ?  min : rv;
  return rv;
}

void make_more_points	(	ViewParm *	vp,
		int	ptIncr
	)

Allocate memory & set up another set of point-locations for output.

For each model variable to be output (info in ViewParm struct), increment the number of point-locations (cells) based on the number requested in the model output configuration file.

Parameters:

	vp	Pointer to struct of ViewParm
	ptIncr	number of points to increment

Definition at line 312 of file Driver_Utilities.c.

References debug, viewParm::fileName, viewParm::maxPoints, msgStr, viewParm::points, point3D::type, WriteMsg(), point3D::x, point3D::y, and point3D::z.

Referenced by readViewParms().

{
        Point3D *new_pts;
        int i;
        
        new_pts = (Point3D *) malloc( (vp->maxPoints+ptIncr) * sizeof(Point3D) );
        for(i=0; i < vp->maxPoints; i++) {
                new_pts[i].x = vp->points[i].x;
                new_pts[i].y = vp->points[i].y;
                new_pts[i].z = vp->points[i].z;
                new_pts[i].type = vp->points[i].type;
        }
        if( vp->points != NULL ) { free((char*)vp->points); }
        vp->points = new_pts;
        vp->maxPoints += ptIncr;
        if(debug) {
                sprintf(msgStr,"Made %d more points for %s for %d total points",ptIncr,vp->fileName,vp->maxPoints); 
                WriteMsg(msgStr,1);
        }
}

Here is the call graph for this function:

void enc_Nb	(	UCHAR **	sptr,
		SLONG	value,
		int	bytes
	)

Place data in bytes into a buffer to assemble a binary array.

Place a 1,2,3, or 4 (N) byte signed value into the specified buffer and advance the buffer pointer past the placed object.

Parameters:

	sptr	a pointer to pointer to UCHAR (the buffer)
	value	The value to place in the buffer
	bytes	Number of bytes in data

Definition at line 761 of file Driver_Utilities.c.

Referenced by write_map_file().

{
  UCHAR tmp[4];
  switch(bytes) {
  case 1:
    *(*sptr)++ = value;
    break;
  case 2:
    *(*sptr)++ = (value >> 8);
    *(*sptr)++ = value;
    break;
  case 3:
    tmp[0] = value;
    tmp[1] = (value >>= 8);
    tmp[2] = (value >> 8);
    *(*sptr)++ = tmp[2];
    *(*sptr)++ = tmp[1];
    *(*sptr)++ = tmp[0];
    break;
  case 4:
    tmp[0] = value;
    tmp[1] = (value >>= 8);
    tmp[2] = (value >>= 8);
    tmp[3] = (value >> 8);
    *(*sptr)++ = tmp[3];
    *(*sptr)++ = tmp[2];
    *(*sptr)++ = tmp[1];
    *(*sptr)++ = tmp[0];
    break;
  }
}

void RP_SwapFields	(	RPoint *	thisStruct,
		RPoint *	that
	)

Point Time Series interpolation (unused):.

Definition at line 1329 of file Driver_Utilities.c.

References RP_CopyFields().

Referenced by RPL_Sort().

{
  RPoint temp;
  RP_CopyFields (&temp, thisStruct);
  RP_CopyFields (thisStruct, that);
  RP_CopyFields (that, &temp);
}

Here is the call graph for this function:

void RP_CopyFields	(	RPoint *	thisStruct,
		RPoint *	that
	)

Point Time Series interpolation (unused):.

Definition at line 1320 of file Driver_Utilities.c.

References rPoint::fr, rPoint::fValue, rPoint::fX, and rPoint::fY.

Referenced by RP_SwapFields(), and RPL_AddrPoint().

{
  thisStruct->fX = that->fX;
  thisStruct->fY = that->fY;
  thisStruct->fr = that->fr;
  thisStruct->fValue = that->fValue;
}

void RP_SetFields	(	RPoint *	thisStruct,
		int	ix,
		int	iy,
		float	r,
		float	value
	)

Point Time Series interpolation (unused):.

Definition at line 1311 of file Driver_Utilities.c.

References rPoint::fr, rPoint::fValue, rPoint::fX, and rPoint::fY.

Referenced by RPL_AddrPoint().

{
  thisStruct->fX = ix;
  thisStruct->fY = iy;
  thisStruct->fr = r;
  thisStruct->fValue = value;   
}

void RPL_AddrPoint	(	RPointList *	thisStruct,
		int	x,
		int	y,
		float	r,
		float	value
	)

Point Time Series interpolation (unused):.

Definition at line 1349 of file Driver_Utilities.c.

References rPointList::fList, rPointList::fNPt, rPointList::fNPtUsed, RP_CopyFields(), and RP_SetFields().

Referenced by PTSL_GetInterpolatedValue1().

{
  RPoint* pointListtemp;
  int i, newPoints;
  
  if( thisStruct->fNPtUsed >= thisStruct->fNPt ) {
    newPoints = 20;
    thisStruct->fNPt += newPoints;
    pointListtemp = (RPoint*) malloc(sizeof(RPoint)*(thisStruct->fNPt));
    for(i=0; i<thisStruct->fNPtUsed; i++) {
      RP_CopyFields(pointListtemp+i,thisStruct->fList+i);
    }
    if( thisStruct->fList != NULL ) free((char*)thisStruct->fList);
    thisStruct->fList = pointListtemp;
  }
  
  RP_SetFields( thisStruct->fList + thisStruct->fNPtUsed, x, y, r, value);
  thisStruct->fNPtUsed++;
}

Here is the call graph for this function:

void RPL_Sort

(

RPointList *

thisStruct

)

Point Time Series interpolation (unused):.

Definition at line 1370 of file Driver_Utilities.c.

References rPointList::fList, rPointList::fNPtUsed, rPoint::fr, and RP_SwapFields().

Referenced by PTSL_GetInterpolatedValue1().

{
  int i, go=1;
  
  while(go) {
    go = 0;
    for(i=1; i<thisStruct->fNPtUsed; i++) if(thisStruct->fList[i-1].fr > thisStruct->fList[i].fr) {
      RP_SwapFields (thisStruct->fList+i-1, thisStruct->fList+i);
      go = 1;
    }
  }             
}

Here is the call graph for this function:

void RPL_Free

(

RPointList *

thisStruct

)

Point Time Series interpolation (unused):.

Definition at line 1385 of file Driver_Utilities.c.

References rPointList::fList.

Referenced by PTSL_GetInterpolatedValue1().

{
  if(thisStruct == NULL) return;
   if( thisStruct->fList != NULL ) free((char*)thisStruct->fList);
  free((char*)thisStruct);
  thisStruct = NULL;
}

RPointList* RPL_Init

(

int

nPoints

)

Point Time Series interpolation (unused):.

Definition at line 1338 of file Driver_Utilities.c.

References rPointList::fList, rPointList::fNPt, and rPointList::fNPtUsed.

Referenced by PTSL_GetInterpolatedValue1().

{
  RPointList *thisStruct;
  thisStruct = (RPointList*) malloc(sizeof(RPointList));
  thisStruct->fList = (RPoint*) malloc(sizeof(RPoint)*nPoints);
  thisStruct->fNPt = nPoints;
  thisStruct->fNPtUsed = 0;
  return thisStruct;
}

void PTS_CopyFields	(	PTSeries *	thisStruct,
		PTSeries	pV
	)

Point Time Series interpolation (unused): copy fields.

Definition at line 1131 of file Driver_Utilities.c.

References pTSeries::fValue, pTSeries::fX, and pTSeries::fY.

Referenced by PTSL_AddpTSeries().

{
  thisStruct->fX = pV.fX;
  thisStruct->fY = pV.fY;
  thisStruct->fValue = pV.fValue;
}

void PTS_Free

(

PTSeries *

thisStruct

)

Point Time Series interpolation (unused): free up memory.

Definition at line 1124 of file Driver_Utilities.c.

References pTSeries::fValue.

Referenced by PTSL_Free().

{
  if(thisStruct->fValue) free((char*)thisStruct->fValue);
}

void PTS_SetFields	(	PTSeries *	thisStruct,
		int	ix,
		int	iy,
		int	index,
		int	format,
		int	col
	)

Point Time Series interpolation (unused): set up the fields.

Definition at line 1105 of file Driver_Utilities.c.

References debug, pTSeries::fNpt, pTSeries::fTS, pTSeries::fValue, pTSeries::fX, pTSeries::fY, gNPtTs, gTS, modelFileName, msgStr, readSeriesCol(), and WriteMsg().

Referenced by PTSL_AddpTSeries().

{
  float ptstep = 1.0, *value; 
  int n0;
  
  thisStruct->fX = ix;
  thisStruct->fY = iy;
  if(thisStruct->fValue) free((char*)thisStruct->fValue); 

  thisStruct->fValue = readSeriesCol(modelFileName,format,index,&n0,&ptstep,col);
  
  gNPtTs = thisStruct->fNpt = n0;
  gTS = thisStruct->fTS = ptstep;
  value = thisStruct->fValue;
  if  ( debug>2 ) {  sprintf(msgStr,"\nPTS_SetFields: TSVals: %f %f %f, TS: %f, NPt: %d \n",value[0],value[1],value[2],ptstep,n0);  WriteMsg(msgStr,1); }
}

Here is the call graph for this function:

void PTSL_AddpTSeries	(	PTSeriesList *	thisStruct,
		int	x,
		int	y,
		int	index,
		int	seriesNum,
		int	col
	)

Point Time Series interpolation (unused): add to the series.

Definition at line 1154 of file Driver_Utilities.c.

References pTSeriesList::fFormat, pTSeriesList::fList, pTSeries::fNpt, pTSeriesList::fNptTS, pTSeriesList::fNSlots, pTSeriesList::fNSlotsUsed, pTSeries::fValue, Max, PTS_CopyFields(), and PTS_SetFields().

Referenced by PTSL_ReadLists().

{
  PTSeries* valListtemp;
  int i, newSlots;
  
  if( seriesNum >= thisStruct->fNSlots ) {
    newSlots = Max(20,(int)(thisStruct->fNSlots * 0.2));
    thisStruct->fNSlots += newSlots;
    valListtemp = (PTSeries*) malloc(sizeof(PTSeries)*(thisStruct->fNSlots));
    for(i=0; i<thisStruct->fNSlotsUsed; i++) {
      valListtemp[i].fNpt = thisStruct->fNptTS;
      PTS_CopyFields(valListtemp+i,thisStruct->fList[i]);
    }
    for(i=thisStruct->fNSlotsUsed; i<thisStruct->fNSlots; i++) valListtemp[i].fValue = NULL;
    if( thisStruct->fList != NULL ) free((char*)thisStruct->fList);
    thisStruct->fList = valListtemp;
  }
  
  PTS_SetFields( thisStruct->fList + seriesNum, x, y, index, thisStruct->fFormat, col );
  thisStruct->fNSlotsUsed = seriesNum;
}

Here is the call graph for this function:

void PTSL_Free

(

PTSeriesList *

thisStruct

)

Point Time Series interpolation (unused): free up memory.

Definition at line 1177 of file Driver_Utilities.c.

References pTSeriesList::fList, pTSeriesList::fNSlotsUsed, and PTS_Free().

{
  int i;
  if(thisStruct == NULL) return;
  for(i=0; i<thisStruct->fNSlotsUsed; i++) PTS_Free( thisStruct->fList +i );
  if( thisStruct->fList != NULL ) free((char*)thisStruct->fList);
  free((char*)thisStruct);
  thisStruct = NULL;
}

Here is the call graph for this function:

void PTSL_ReadLists	(	PTSeriesList *	thisStruct,
		const char *	ptsFileName,
		int	index,
		float *	timeStep,
		int *	nPtTS,
		int	col
	)

Point Time Series interpolation (unused): read raw point data.

Definition at line 1218 of file Driver_Utilities.c.

Referenced by PtInterp_read().

{
  char pathname[150], infilename[60], ss[201], ret = '\n';
  FILE* cfile;
  int ix, iy, tst, sCnt=0;
  if( Lprocnum == 1 ) {
    if(H_OPSYS==UNIX) sprintf(modelFileName,"%s/%s/Data/%s.pts",ModelPath,ProjName,ptsFileName);
    else sprintf(modelFileName,"%s%s:Data:%s.pts",ModelPath,ProjName,ptsFileName); 
    cfile = fopen(modelFileName,"r");
    if(cfile==NULL) {fprintf(stdout,"\nERROR: Unable to open timeseries file %s\n",modelFileName); Exit(1); }
    else { sprintf(msgStr,"\nReading file %s\n",modelFileName); WriteMsg(msgStr,1); } 
    if (debug > 2) {sprintf(msgStr,"Reading %s timeseries, column %d",modelFileName, col); usrErr(msgStr);}
    
  

    fgets(ss,200,cfile); /* skip header line */
  }
  while(1) {
    if( Lprocnum == 1 ) {
      tst = fscanf(cfile,"%d",&ix);
      if( tst > 0  ) {
        fscanf(cfile,"%d",&iy); 
        tst = fscanf(cfile,"%s",infilename); 
        sprintf(modelFileName,"%s/%s/Data/%s",ModelPath,ProjName,infilename);
      }
    }
    broadcastInt(&tst); 
    if(tst<1) break;
    broadcastInt(&ix); 
    broadcastInt(&iy); 
    PTSL_AddpTSeries(thisStruct, ix, iy, index, sCnt, col);
    sCnt++;
  }
  if( Lprocnum == 1 ) fclose(cfile);  
  *nPtTS = gNPtTs;
  *timeStep = gTS;
} 

void PTSL_CreatePointMap	(	PTSeriesList *	pList,
		void *	Map,
		unsigned char	Mtype,
		int	step,
		float	scale
	)

Point Time Series interpolation (unused): generate interpolated spatial (map) data.

Definition at line 1258 of file Driver_Utilities.c.

Referenced by cell_dyn1().

{
  int i0, i1;
  
  switch(Mtype) {
  case 'f' :    
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) 
        ((float*)Map)[T(i0,i1)] = (ON_MAP[T(i0,i1)]) ? PTSL_GetInterpolatedValue0(pList,i0,i1,step)*scale : 0.0 /*was this value (v0.5beta) -0.012 */; 
    break;
  case 'i' :    case 'd' :      
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) 
        ((int*)Map)[T(i0,i1)] = (int)  ( (ON_MAP[T(i0,i1)]) ? PTSL_GetInterpolatedValue0(pList,i0,i1,step)*scale : 0 );
    break;
  case 'c' :    
    for(i0=0; i0<=s0+1; i0++) 
      for(i1=0; i1<=s1+1; i1++) 
        ((unsigned char*)Map)[T(i0,i1)] = (unsigned char) '\0' + (int)  ( (ON_MAP[T(i0,i1)]) ? PTSL_GetInterpolatedValue0(pList,i0,i1,step)*scale : 0 );
    break;
  }
}

float PTSL_GetInterpolatedValue1	(	PTSeriesList *	thisStruct,
		int	x,
		int	y,
		int	step
	)

Point Time Series interpolation (unused): at point, calculate inverse distance interpolation (unrestricted power of distance).

Definition at line 1283 of file Driver_Utilities.c.

References pTSeriesList::fList, pTSeriesList::fNSlotsUsed, pTSeries::fValue, pTSeries::fX, pTSeries::fY, GP_IDW_pow, RPL_AddrPoint(), RPL_Free(), RPL_Init(), and RPL_Sort().

{
  int i,  dx, dy;
  PTSeries pV;
  RPointList *pList;
  float  wpow;
  double weight, InterpValue=0.0, distance=0.0;
  long r;
  
  pList = RPL_Init( 20 );
  wpow = GP_IDW_pow; /* GP_IDW_pow is "adjustable" parameter in global parm input file */
  for(i=0; i<thisStruct->fNSlotsUsed; i++) {
    pV = thisStruct->fList[i];
    dx = (pV.fX-x);
    dy = (pV.fY-y);
    r = dx*dx + dy*dy;
    if( r == 0 ) return pV.fValue[step];
    RPL_AddrPoint(pList, dx, dy, r, pV.fValue[step]);
    weight = (wpow == 1.0) ? ((double)1.0)/r : pow(r,-wpow);
    InterpValue += pV.fValue[step]*weight;
    distance += weight;
  }
  RPL_Sort(pList);
  RPL_Free(pList);
  return (float) InterpValue;
}

Here is the call graph for this function:

float PTSL_GetInterpolatedValue0	(	PTSeriesList *	thisStruct,
		int	x,
		int	y,
		int	step
	)

Point Time Series interpolation (unused): at point, calculate inverse distance squared interpolation (restricted, not using pow() function).

Definition at line 1188 of file Driver_Utilities.c.

References pTSeriesList::fList, pTSeriesList::fNSlotsUsed, pTSeries::fValue, pTSeries::fX, pTSeries::fY, GP_IDW_pow, and lcl_start.

Referenced by PTSL_CreatePointMap().

{
  int i,  dx, dy, my_debug;
  PTSeries pV;
  float  wpow;
  float weight, InterpValue=0.0, distance=0.0; /* was double in v1.0 */
  int r;
  
  wpow = GP_IDW_pow; /* GP_IDW_pow is "adjustable" parameter in global parm input file */

  
  for(i=0; i<thisStruct->fNSlotsUsed; i++) {
    pV = thisStruct->fList[i];
    dx = (pV.fX-(x+lcl_start[0]));
    dy = (pV.fY-(y+lcl_start[1]));
    r = (dx*dx + dy*dy);
    if( r == 0 ) return pV.fValue[step];
    weight = (wpow == 1.0) ? (1.0)/r : 1.0/(r*r);
        /* the pow() and double was incredibly slow (signif slowed simualtion), so removed it
           and gave the choice of only inverse distance or inverse distance**2 weighting */
    /* weight = (wpow == 1.0) ? ( (double)1.0)/r : pow(r,-wpow) ; */
    InterpValue += pV.fValue[step]*weight;
    distance += weight;
  }
  if (distance > 0) InterpValue /= distance;
  else InterpValue = (thisStruct->fList[0]).fValue[step];
  return (float) InterpValue;
}

PTSeriesList* PTSL_Init	(	int	nSlots,
		int	format
	)

Point Time Series interpolation (unused): initialize structure.

Definition at line 1139 of file Driver_Utilities.c.

References pTSeriesList::fFormat, pTSeriesList::fList, pTSeriesList::fNptTS, pTSeriesList::fNSlots, pTSeriesList::fNSlotsUsed, and pTSeries::fValue.

Referenced by PtInterp_read().

{
  int i;
  PTSeriesList* thisStruct;
  thisStruct = (PTSeriesList*) malloc(sizeof(PTSeriesList));
  thisStruct->fList = (PTSeries*) malloc(sizeof(PTSeries)*nSlots);
  for(i=0; i<nSlots; i++) thisStruct->fList[i].fValue = NULL;
  thisStruct->fNSlots = nSlots;
  thisStruct->fNSlotsUsed = 0;
  thisStruct->fNptTS = 0;
  thisStruct->fFormat = format;
  return(thisStruct);
}

void calcdate	(	double	jd,
		int *	m,
		int *	d,
		int *	y,
		int *	h,
		int *	mi,
		double *	sec
	)

Determine the Gregorian date from a Julian calendar day.

Julian date converter. Takes a julian date (the number of days since some distant epoch or other), and returns an int pointer to static space. ip[0] = month; ip[1] = day of month; ip[2] = year (actual year, like 1977, not 77 unless it was 77 a.d.); ip[3] = day of week (0->Sunday to 6->Saturday) These are Gregorian. Copied from Algorithm 199 in Collected algorithms of the CACM Author: Robert G. Tantzen, Translator: Nat Howard. All taken (unmodified) from SFWMD HSM's /vol/hsm/src/libs/xmgr_julday/ directory.

Parameters:

	jd	Julian day
	m	Month
	d	Day
	y	Year
	h	Hour
	mi	Minute
	sec	Second

Definition at line 1630 of file Driver_Utilities.c.

{
  static int ret[4];

  long j = (long)jd;
  double tmp, frac = jd - j;

  if (frac >= 0.5) {
    frac = frac - 0.5;
    j++;
  } 
  else {
    frac = frac + 0.5;
  }

  ret[3] = (j + 1L) % 7L;
  j -= 1721119L;
  *y  = (4L * j - 1L) / 146097L;
  j = 4L * j - 1L - 146097L * *y;
  *d  = j / 4L;
  j = (4L * *d + 3L) / 1461L;
  *d = 4L * *d + 3L - 1461L * j;
  *d = (*d + 4L) / 4L;
  *m = (5L * *d - 3L) / 153L;
  *d = 5L * *d - 3 - 153L * *m;
  *d = (*d + 5L) / 5L;
  *y = 100L * *y + j;
  if (*m < 10)
    *m += 3;
  else {
    *m -= 9;
    *y += 1;
  }
  tmp = 3600.0 * (frac * 24.0);
  *h = (int) (tmp / 3600.0);
  tmp = tmp - *h * 3600.0;

  *mi = (int) (tmp / 60.0);
  *sec = tmp - *mi * 60.0;
}

double julday	(	int	mon,
		int	day,
		int	year,
		int	h,
		int	mi,
		double	se
	)

Determine the Julian calendar day from a Gregorian date.

Returns:

julian day + hms as a real number

Takes a date, and returns a Julian day. A Julian day is the number of days since some base date (in the very distant past). Handy for getting date of x number of days after a given Julian date (use jdate to get that from the Gregorian date). Author: Robert G. Tantzen, translator: Nat Howard Translated from the algol original in Collected Algorithms of CACM (This and jdate are algorithm 199). All taken (unmodified) from SFWMD HSM's /vol/hsm/src/libs/xmgr_julday/ directory.

Parameters:

	mon	Month
	day	Day
	year	Year
	h	Hour
	mi	Minute
	se	Second

Returns:

Julian day

Definition at line 1583 of file Driver_Utilities.c.

{
  long m = mon, d = day, y = year;
  long c, ya, j;
  double seconds = h * 3600.0 + mi * 60 + se;

  if (m > 2)
    m -= 3;
  else {
    m += 9;
    --y;
  }
  c = y / 100L;
  ya = y - (100L * c);
  j = (146097L * c) / 4L + (1461L * ya) / 4L + (153L * m + 2L) / 5L + d + 1721119L;
  if (seconds < 12 * 3600.0) {
    j--;
    seconds += 12.0 * 3600.0;
  } 
  else {
    seconds = seconds - 12.0 * 3600.0;
  }
  return (j + (seconds / 3600.0) / 24.0);
}

float FMOD	(	float	x,
		float	y
	)

Modulus of a pair of (double) arguments.

Parameters:

	x	Numerator
	y	Denominator

Returns:

modulus (float) result

Definition at line 1675 of file Driver_Utilities.c.

                             { 
return (float)fmod((double)x, (double)y); 
} 

void setup_grid

(

)

Provide the 2D array size for the model domain.

Definition at line 392 of file Driver_Utilities.c.

References exgridsize(), floatOut, gbl_size, gridSize, gTemp, gTempSize, init_pvar(), lcl_size, lcl_start, msgStr, nalloc(), nc_dataRowRev, procnum, s0, s1, and WriteMsg().

                  {
  
  exgridsize(procnum,gbl_size,lcl_size,lcl_start); /* effectively unused in serial (non-parallel) implementation */

  /*  s0 and s1 remain unchanged in serial (non-parallel) implementation */
  s0 = lcl_size[0];
  s1 = lcl_size[1];
  
  gridSize = (s0+2)*(s1+2); /* the gridSize is increased by 2 in each dimension for buffer strips around processor domain(s) (functional mainly to parallel implementation) */
  
  sprintf(msgStr,"\nGRID DATA::[ gsize: (%d, %d), lstart: (%d, %d), lend: (%d, %d), lsize: (%d, %d) ]\n",
          gbl_size[0], gbl_size[1], lcl_start[0], 
          lcl_start[1], lcl_start[0]+lcl_size[0]-1, 
          lcl_start[1]+lcl_size[1]-1, lcl_size[0], lcl_size[1] );
  WriteMsg(msgStr,1);  
  sprintf(msgStr,"\nVP DATA:: size: (%d), Variable sizes: float: %d, int: %d, long: %d,  double: %d\n", 
            sizeof(ViewParm), sizeof(float),sizeof(int) ,sizeof(long) ,sizeof(double)   );
  WriteMsg(msgStr,1);

  gTempSize = gridSize*8;
  gTemp = (UCHAR*) nalloc(gTempSize,"gTemp");  

/* v2.8.2 new temp array for output - all variables' arrays are 2 rows and 2 cols larger than the actual data 
        this is used to hold only the size of s0, s1 */
  floatOut = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"floatOut");
//  init_pvar(floatOut,NULL,'f',0.0);

/* v2.8.2 new temp array for output - netCDF output files now have origin at lower (not upper) left */
  nc_dataRowRev = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"nc_dataRowRev");
  init_pvar(nc_dataRowRev,NULL,'f',0.0);
    

}

Here is the call graph for this function:

void set_env_vars

(

void

)

Acquire necessary environment variables.

Definition at line 900 of file Driver_Utilities.c.

References DriverPath, ModelPath, msgStr, OS_TYPE, ProjName, and usrErr().

                        {
  
  FILE *infile;
  char filename[100], ch;
  static long start;
  int i, maxLen =200;
  
    ModelPath = getenv("ModelPath"); 
    ProjName = getenv("ProjName");
    DriverPath = getenv("DriverPath");
    OS_TYPE = getenv("OSTYPE"); /* OSTYPE not used in code, only here for informational output */

        sprintf(msgStr,"OS type = %s ",OS_TYPE); 
    usrErr(msgStr);
    
        sprintf(msgStr,"Project Name = %s ",ProjName); 
    usrErr(msgStr);
 
}

Here is the call graph for this function:

void set_boundary	(	VOIDP	Map,
		unsigned char	Mtype,
		float	bv
	)

void fatal

(

const char *

msg

)

Exit (code=9) from program after sending a message.

Definition at line 1551 of file Driver_Utilities.c.

Referenced by goto_index(), and print_point().

{
  printf("%s",msg);
  fflush(stdout);
  Exit(9);
}

void Exit

(

int

code

)

Standard exit from program.

Definition at line 1548 of file Driver_Utilities.c.

Referenced by fatal(), get_global_parm(), get_modexperim_parm(), getCanalElev(), nalloc(), PTSL_ReadLists(), and read_map_dims().

{ exit(code); }

void Copy	(	void *	src,
		void *	dst,
		int	w,
		int	n,
		int	sw,
		int	dw
	)

Memory-copy data from large (global) domain to local domain.

Parameters:

	src	The source of info
	dst	The destination of info
	w	The number of characters
	n	The number of (row) repetitions
	sw	The source size in col direction
	dw	The destination size in col direction

Returns:

resulting (destination) copy

Definition at line 889 of file Driver_Utilities.c.

Referenced by writeWindow().

{
  int i;
  for(i=0; i<n; i++) 
    memcpy( ((UCHAR*)dst)+i*dw, ((UCHAR*)src)+i*sw, w ); /* copy w chars from source to dest, return destination */
}

void getInt	(	FILE *	inFile,
		const char *	lString,
		int *	iValPtr
	)

Get an integer following a specific string.

Parameters:

	inFile	File that is open
	lString	The string being read
	iValPtr	The char value found

Definition at line 1740 of file Driver_Utilities.c.

{
  int test;
  UCHAR iEx=0;
  if(lString)  
    scan_forward(inFile,lString);
  test = fscanf(inFile,"%d",iValPtr);
  if(test != 1) {
    fprintf(stderr,"Read Error (%d):",test);
    if(lString) fprintf(stderr,"%s\n",lString);
    *iValPtr = 0;
    iEx = 1;
  }
  if (iEx) exit(0);
}

void getChar	(	FILE *	inFile,
		const char *	lString,
		char *	cValPtr
	)

Get a character following a specific string.

Parameters:

	inFile	File that is open
	lString	The string being read
	cValPtr	The char value found

Definition at line 1702 of file Driver_Utilities.c.

{
  int test;
  UCHAR iEx=0;
  if(lString)  scan_forward(inFile,lString);
  test = fscanf(inFile,"%c",cValPtr);
  if(test != 1) {
    fprintf(stderr,"Read Error (%d):",test);
    if(lString) fprintf(stderr,"%s\n",lString);
    iEx = 1;
    *cValPtr = '\0';
  }
  if (iEx) exit(0);
}

void getString	(	FILE *	inFile,
		const char *	lString,
		char *	inString
	)

Get a string following a specific string.

Parameters:

	inFile	File that is open
	lString	The string being read
	inString	The string found

Definition at line 1722 of file Driver_Utilities.c.

References scan_forward().

{
  int test;
  UCHAR iEx=0;
  if(lString)  scan_forward(inFile,lString);
  test = fscanf(inFile,"%s",inString);
  if(test != 1) {
    fprintf(stderr,"Read Error (%d):",test);
    if(lString) fprintf(stderr,"%s\n",lString);
    iEx = 1;
  }
  if (iEx) exit(0);
}

Here is the call graph for this function:

void getFloat	(	FILE *	inFile,
		const char *	lString,
		float *	fValPtr
	)

Get a float value following a specific string.

Parameters:

	inFile	File that is open
	lString	The string being read
	fValPtr	The float number found

Definition at line 1683 of file Driver_Utilities.c.

References scan_forward().

{
  int test, fSize;
  UCHAR iEx=0;
  if(lString)  scan_forward(inFile,lString);
  test = fscanf(inFile,"%f",fValPtr);
  if(test != 1) {
    fprintf(stderr,"Read Error (%d):",test);
    if(lString) fprintf(stderr,"%s\n",lString);
    *fValPtr = 0.0;
    iEx = 1;
  }
  if (iEx) exit(0);
}

Here is the call graph for this function:

void setFlag	(	ViewParm *	vp,
		UINT	mask,
		int	value
	)

(Effectively unused). From Model.outList data, set a flag indicating array or not

In reading the Model.outList, each line pertain to either a 2D array (variable) or a non-array varible/parameter. This function pertains to very early version of ELM (translating Stella models), and Model.outList always refers to variables that are arrays.

Parameters:

	vp	struct of ViewParm w/ output configuration
	mask	array mask
	value	is always = 1 (is an array)

Definition at line 1405 of file Driver_Utilities.c.

References viewParm::flags.

Referenced by readViewParms().

 { 
  if(value) vp->flags |= mask; else vp->flags &= ~mask;
}

int getFlag	(	ViewParm *	vp,
		UINT	mask
	)

Unused (never called) function.

Definition at line 1411 of file Driver_Utilities.c.

References viewParm::flags.

{ 
  if( vp->flags & mask ) return 1; else return 0;
}

int getPrecision

(

ViewParm *

vp

)

(Effectively unused).

Definition at line 1424 of file Driver_Utilities.c.

References viewParm::flags, PMASK1, and PMASK2.

Referenced by write_output().

 { 
  int rv = 1;
  if(vp->flags & PMASK2) rv +=2;
  if(vp->flags & PMASK1) rv +=1;
  return rv;
}

int isInteger

(

char *

target_str

)

Determine if an integer is present in string.

Parameters:

target_str

Target string

Returns:

true or false (found int or not)

Definition at line 1475 of file Driver_Utilities.c.

Referenced by ReadStructures(), and readViewParms().

                                 {

        int i=-1,first_num=0;
        char ch;

        while( (ch=target_str[++i]) != '\0' ) { 
                        if( isdigit(ch) ) first_num=1;
                        if( (ch=='-' || ch=='+') && first_num ) return(0);  
                        if( !( isspace(ch) || isdigit(ch) || ch=='-' || ch=='+') ) return(0);  
        }
        return(1);              
}

int isFloat

(

char *

target_str

)

Determine if a float is present in string.

Parameters:

target_str

Target string

Returns:

true or false (found float or not)

Definition at line 1493 of file Driver_Utilities.c.

Referenced by ReadStructures(), and readViewParms().

                               {

        int i=-1,first_num=0;
        char ch;

        while( (ch=target_str[++i]) != '\0' ) { 
                        if( isdigit(ch) ) first_num=1;
                        if( (ch=='-' || ch=='+') && first_num ) return(0);  
                        if( !( isspace(ch) || isdigit(ch) || ch=='-' || ch=='+' || ch=='.' || toupper(ch) == 'E') ) return(0);  
        }
        return(1);              
}

int skip_white

(

FILE *

infile

)

Skip white space(s) in a file.

Parameters:

infile

Returns:

success/failure

Definition at line 1800 of file Driver_Utilities.c.

{
  int ch;
  
  while( isspace(ch=fgetc(infile)) ) {;}
  if(ch==EOF) return 0;
  ungetc(ch,infile);
  return 1;             
}  

int scan_forward	(	FILE *	infile,
		const char *	tstring
	)

Scan forward until a particular string is found.

Parameters:

	infile	The file being read
	tstring	The sought-after string

Returns:

Success/failure

Definition at line 1814 of file Driver_Utilities.c.

{
  int sLen, i, cnt=0;
  char Input_string[100], test;
  
  sLen = strlen(tstring);
  while( ( test = fgetc(infile) ) != EOF ) {
    for(i=0; i<(sLen-1); i++) 
        Input_string[i] = Input_string[i+1];
    Input_string[sLen-1] = test;
    Input_string[sLen] = '\0';
    if(++cnt >= sLen) {
      test =  strcmp(Input_string,tstring);
      if( test == 0 ) return 1;
    }
  }
  return(-1);
}

int check_for	(	char *	s0,
		const char *	s1,
		int	start,
		int	cs,
		int	rp
	)

Check for occurrences of string s1 in string s0 after position start.

After position start, check for occurrences of string s1 in string s0.

Parameters:

	s0	String array
	s1	String array
	start	Starting position
	cs	Case sensitivity
	rp	Return pointer to beginning or not

Returns:

location in string

Definition at line 1443 of file Driver_Utilities.c.

References BEG, and NOCASE.

Referenced by write_map_file().

{
  /*  Check for occurrences of string s1 in string s0   */
  /*  after position start. Return -1 if not found.             */
  /* if cs = CASE -> case sensitive, cs = NOCASE, not case sens.        */
  /* if rp = BEG -> return position of beginning of s1,         */
  /*                    otherwise return position of (next char following the) end of s1                */
  int i, j=0, k=-1, Len1 = strlen(s1), Len0 = strlen(s0);
  char t1, t2;
  
  while(k<0) {
    k=0;
    for(i=start; i< Len0; ++i) { 
      t1 = s0[i];
      t2 = s1[j];
      if(cs==NOCASE) { t1 = tolower(t1); t2 = tolower(t2); }   
      if (t1 == t2)  j++;
      else {j=0; k=0;}
      if(j==Len1) { k=1; break; }
    }
  }
  if(k<=0)              return(-1);
  else if(rp==BEG)      return(i-Len1+1);
  else                  return(i+1);
}

int find_char	(	FILE *	infile,
		char	tchar
	)

Find a character.

Parameters:

	infile	The file that is open
	tchar	The character being sought

Returns:

true/false (0 or 1)

Definition at line 1760 of file Driver_Utilities.c.

Referenced by get_Nth_parm(), and goto_index().

{
  char test = '1', cchar = '#';
  int in_c=0;

  while( test != EOF ) {
    test = fgetc(infile);
    if(test == tchar && in_c==0 ) { return 1; }
    if(test == cchar ) in_c=1;
    if(test == '\n' )  in_c=0;
  }
  return(0);
}

int Round

(

float

x

)

truncate (not rounding) to an integer

Parameters:

x

the value being operated on

Returns:

result

Definition at line 1777 of file Driver_Utilities.c.

Referenced by Channel_configure().

{ 
  int i = (int)x;
  return (i);
}

char* name_from_path

(

char *

name

)

Get the var name from a longer path/filename.

Parameters:

name

The var name & path

Returns:

Pointer to var name alone

Definition at line 1837 of file Driver_Utilities.c.

Referenced by quick_look().

{
  char* namePtr; int i, slen;
  char dirCh;
  
  namePtr = name;
  dirCh = '/';
  slen = strlen(name);
  
  for(i=0; i<slen; i++) {
        if( name[slen-i-1] == dirCh ) { namePtr = name+slen-i; break; }
  }
  return namePtr;  
}

char* Scip	(	char *	s,
		char	SYM
	)

Skip ahead in a string until next field.

Parameters:

	s	A character array
	SYM	The specific symbol being used to skip over

Returns:

Location in string

Definition at line 1788 of file Driver_Utilities.c.

Referenced by BIRinit(), get_hab_parm(), Read_schedule(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), and ReadStructures().

{
  if(*s == SYM ) return ++s;
  while(*s != SYM && *s != EOS ) s++;
  if(*s != EOS) return ++s;
  else  return s;
}

void setup_platform

(

)

Effectively unused in serial (non-parallel) implementation.

Definition at line 1937 of file Driver_Utilities.c.

References env, exgridcoord(), exgridinit(), exgridsplit(), exparam(), nprocs, nodenv::nprocs, nodenv::procnum, procnum, recpnum, and usrErr().

                      {
 
  exparam(&env);
  procnum = env.procnum;
  exgridsplit(env.nprocs, 2, nprocs);
  if( exgridinit(2, nprocs) < 0) { usrErr("Failed to Setup Grid"); exit(0); }
  exgridcoord(procnum, recpnum);
}

Here is the call graph for this function:

void link_edges	(	VOIDP	Map,
		unsigned char	Mtype
	)

Effectively unused in serial (non-parallel) implementation.

Definition at line 1924 of file Driver_Utilities.c.

References exchange_borders().

Referenced by read_map_file().

{
  switch(Mtype) {
  case 'f' :    
    exchange_borders((byte*)Map,sizeof(float)); break;
  case 'd' : case 'i' : 
    exchange_borders((byte*)Map,sizeof(int)); break;
  case 'c' :    
    exchange_borders((byte*)Map,sizeof(UCHAR)); break;
  }     
}

Here is the call graph for this function:

float Normal	(	float	mean,
		float	sd
	)

Unused, never called. Normal distribution.

Definition at line 1875 of file Driver_Utilities.c.

References gRTable, and SMDRAND().

{
    int table_loc ;
    double rand_num ;
    float sign ;
    float interval = .1 ;
    int n_interval = 40 ;
    float high, low ;
    float return_val = 0.0;

    sign = SMDRAND(0.0, 1.0) ;
    sign = (sign < .5 ? -1 : 1) ;
    rand_num = SMDRAND(.5, 1.0);
    low = gRTable[0] ;
    for (table_loc=1; table_loc<n_interval; table_loc++)
    {
        high = gRTable[table_loc] ;
        if (high > rand_num + .5)
        {
            return_val = mean + sd * (sign  * interval * (table_loc - 1 +
                                                          (rand_num+.5-low)/(high-low))) ;
            return(return_val) ;
        }
        low = high ;
    }
    return(return_val) ;
}

Here is the call graph for this function:

int Poisson

(

float

mu

)

Unused, never called. Poisson distribution.

Definition at line 1904 of file Driver_Utilities.c.

References Exp, and SMDRAND().

{
  int ix;
  float f0, r, Lp = 1, xf = 1, p=0;
  
  p = f0 = Exp(-mu);
  r = SMDRAND(0.0,1.0);
  
  for( ix=0; ix<500; ix++) {
    if( r < p ) return ix;
    Lp *= mu;
    if(ix>0) xf *= ix;
    p += (Lp*f0)/xf;
  }
  return ix;    
}

Here is the call graph for this function:

int init_config_file	(	FILE *	vpFile,
		char	term1,
		char	term2,
		char	term3,
		char	term4
	)

Get format definition of output configuration file (does nothing effective!).

Identifies the leading characters in the Model.outlist output configuration file that define its format, which will never change from it's value of "#2". (This is another SME component of past flexibility.)

Parameters:

	vpFile	Pointer to the (model outlist) configuration file
	term1	The character "#"
	term2	The character "*"
	term3	The character "@"
	term4	The character "~"

Returns:

The (integer) format of the configuration file

Definition at line 1199 of file Serial.c.

Referenced by readViewParms().

{
  char test;
  int format,size=-1;

  gTerm[0] = term1;
  gTerm[1] = term2;  
  gTerm[2] = term3;  
  gTerm[3] = term4;  
  skip_white(vpFile);
  test = fgetc(vpFile);
  if(test == gTerm[0])
      fscanf(vpFile,"%d",&format);
  else
      format = -1;
  return format;
}

int parse_packet	(	FILE *	vpFile,
		int *	nArgs,
		char *	test
	)

Parse through a configuration fileline to obtain the configuration commands.

Populates gCArg[][] with command info. In very early versions of ELM, this was used in reading the configuration file that translated "Stella" model equations into spatial (SME) code. Thus, much of the detail here is unused (ELM v1.0 and later) when reading the output (e.g., Model.outList) configuration file (both w/ similar syntax).

Parameters:

	vpFile	Pointer to the (model outlist) configuration file
	nArgs	Number of arguments in command
	test	A character that will be used to indicate an array (in outlist, always is array, char="*")

Returns:

The index (aka index sequence of variables) of the ViewParm

Definition at line 1248 of file Serial.c.

Referenced by readViewParms().

{
    static      int     gVPindex = -1;
    static      char    gCnfg;
    
        char ch = ' ', eChar = ' '; 
        int btype=0, argc=2, go=1, i=0, j=0, new_name = 0;

        if(vpFile == NULL) return -3;
        while (1) {
                if ( skip_cnfg_space(vpFile, &ch) < 0) return -3; j=0;
                if( ch == gTerm[1] || ch == gTerm[2] ) {
                    gCnfg = ch; ch = ' ';
                        if ( skip_cnfg_space(vpFile, &ch) < 0 ) return -3;
                        while ( !isspace(ch) ) { cTemp[j++] = ch; ch=fgetc(vpFile); }
                        cTemp[j++] = '\0'; new_name = 1;
                        gVPindex++;
                }
                else break;
        }
        strcpy(gCArg[0],cTemp);
        *test = gCnfg;
        while ( isalnum( ch ) ) { gCArg[1][i++]=ch; ch=fgetc(vpFile); }
        gCArg[1][i]='\0'; i=0;

        while( 1 ) {
                if( ch == '(' ) { eChar = ')'; break;} 
                else if( ch == '[' ) { eChar = ']'; break;} 
                else if( ch == '{' ) { eChar = '}'; break;} 
                else if( !isspace(ch) ) { return -3;}
                ch=fgetc(vpFile);
        }
        while (go) {
                while( ch=fgetc(vpFile) ) {
                        if( ch == ',' ) { argc++; break; }
                        if( ch == ')' ||  ch == '}' ||  ch == ']')  { 
                                if( ch == eChar ) {  argc++; go=0; break;} 
                                else { printf( "\nWarning: Syntax error in parse_config, var: %s\n",gCArg[0]); return -2; } 
                        }
                        gCArg[argc][i++]=ch;
                        if( i==(kCArgWidth-1) ) break;
                }
                if(i==0) { printf( "\nWarning: Syntax error in parse_config, var: %s\n",gCArg[0]); return -2; } 
                else { gCArg[argc-1][i]='\0'; i=0; }
                if(argc == kCArgDepth) { 
                        while( ch != eChar ) ch=fgetc(vpFile);  
                        go = 0; 
                }
        }
        *nArgs = argc;
        if(argc==0) { printf( "\nWarning: Syntax error in parse_config, var: %s\n",gCArg[0]); return -2; }
        else return gVPindex;           
} 

void Combine	(	float *	fValue,
		char *	label,
		int	nComp,
		int	cType,
		int	step
	)

A variety of stat summaries in a selected spatial window (debug-related).

This determines maximum, minimum, sum, average, either cumulatively over iterations or not cumulatively. This Model.outList command has not been used in ELM, and has not been verified for accuracy.

Parameters:

	fValue	Model variable (local) array data
	label	variable name
	nComp	number of comps
	cType	The combination (stats) type
	step	The current iteration number

Definition at line 1050 of file Serial.c.

Referenced by calc_maxmin(), and print_loc_ave().

{
        int print, cIndex, i, cum;
        static int type = 11;
        char tmpStr[50];
        if( ++type > 99) type = 11;

        cum = ((cType == kAVECUM) || (cType == kSUMCUM)) ? 1 : 0;       
        if(cum) { cIndex = getCombineIndex(label,step,cType,&print); }
        
        switch(cType) {
                case kMAXMIN: 
                        sprintf(msgStr,"\nMAXMIN(%d) for %s:",step,label); 
                        for(i=0; i<nComp; i++) { sprintf(tmpStr," %f",fValue[i]); strcat(msgStr,tmpStr); }
                        WriteMsg(msgStr,1);
                break;
                case kMAX:
                        sprintf(msgStr,"\nMAX(%d) for %s:",step,label); 
                        for(i=0; i<nComp; i++) { sprintf(tmpStr," %f",fValue[i]); strcat(msgStr,tmpStr); }
                        WriteMsg(msgStr,1);
                break;
                case kMIN:
                        sprintf(msgStr,"\nMIN(%d) for %s:",step,label); 
                        for(i=0; i<nComp; i++) { sprintf(tmpStr," %f",fValue[i]); strcat(msgStr,tmpStr); }
                        WriteMsg(msgStr,1);
                break;
                case kSUM:
                        sprintf(msgStr,"\nSUM(%d) for %s:",step,label); 
                        for(i=0; i<nComp; i++) { sprintf(tmpStr," %f",fValue[i]); strcat(msgStr,tmpStr); }
                        WriteMsg(msgStr,1);
                break;
                case kAVE:
                        sprintf(msgStr,"\nAVE(%d) for %s:",step,label); 
                        for(i=0; i<nComp; i+=2) { sprintf(tmpStr," %f",fValue[i]/fValue[i+1]); strcat(msgStr,tmpStr); }
                        WriteMsg(msgStr,1);
                break;
                case kSUMCUM:
                        if( print == -1) {
                                for(i=0; i<nComp; i++) ctable[cIndex].fvalue[i] = fValue[i]; 
                        
                        } else {
                                for(i=0; i<nComp; i++) ctable[cIndex].fvalue[i] += fValue[i]; 
                        }
                        if(print==1) {                          
                                sprintf(msgStr,"\nSUMCUM(%d) for %s:",step,label); 
                                for(i=0; i<nComp; i++) { sprintf(tmpStr," %f",ctable[cIndex].fvalue[i]); strcat(msgStr,tmpStr); }
                                WriteMsg(msgStr,1);
                        }
                break;
                case kAVECUM:
                        if( print == -1) {
                                for(i=0; i<nComp; i++) ctable[cIndex].fvalue[i] = fValue[i]; 
                        
                        } else {
                                for(i=0; i<nComp; i++) ctable[cIndex].fvalue[i] += fValue[i]; 
                        }
                        if(print==1) {                          
                                sprintf(msgStr,"\nAVECUM(%d) for %s:",step,label); 
                                for(i=0; i<nComp; i+=2) { sprintf(tmpStr," %f",ctable[cIndex].fvalue[i]/ctable[cIndex].fvalue[i+1]); strcat(msgStr,tmpStr); }
                                WriteMsg(msgStr,1);
                        }
                break;
        }
}       

void writeMap	(	char *	filename,
		void *	data,
		int	bSize,
		unsigned char	type,
		int	index
	)

Write data for spatial (map) output binary file.

Parameters:

	filename	Filename (variable name) of data
	data	Data array
	bSize	Byte size of data
	type	Type, or format, of (binary) data
	index	Index used in HDF output

Definition at line 151 of file Serial.c.

Referenced by write_map_file().

{
  int gsize, istat;
  FILE* bFile; 
  
if (index == 0 && type=='M') write_header(filename,bSize);
  
  if(type == 'H') {
#if HDF4
    if(index==0) { istat = DFR8putimage(filename,(char*)data,s1,s0,0); }
    else { istat = DFR8addimage(filename,(char*)data,s1,s0,0); }
    if(istat != 0) printf("\nerror writing HDF file: %s\n",filename);
#endif
  } 

  else if(type == 'C') {
    printf("\nError in configuring netCDF output, which can only be 4-byte floating point values: %s\n",filename);
      exit(0); 
  } 

  else {
    if((bFile = fopen(filename,"wb") ) == NULL ) { 
      fprintf(stderr,"Can't Open Mapfile: %s",filename); 
      exit(0); 
    }
    gsize = gbl_size[0]*gbl_size[1]*bSize;
    fwrite((char*)data, gsize, 1, bFile ); 
        
    fclose(bFile);
  }
}

void writeFloatMap	(	char *	filename,
		char *	VARNAME,
		float *	data,
		int	bSize,
		unsigned char	type,
		int	index,
		char *	thisvarUnits,
		int	outstep
	)

Write floating point data for spatial (map) output binary file (new v2.8.2).

Parameters:

	filename	Filename (path and variable names) of data
	VARNAME	The variable name of data
	data	Data array of the variable
	bSize	Byte size of data
	type	Type, or format, of (binary) data
	index	Index used in output sequence
	thisvarUnits	Units of the output variable

Remarks:

New for v.2.8.2, providing capability to write (4 byte) floating point output maps. Some of this may not be elegant, but will get it done for now. One issue is that the size of the output array is actually s0+2, s1+2, which results in having larger array sizes for these output maps.

Definition at line 197 of file Serial.c.

Referenced by write_map_file().

{
  int gsize;
  FILE* bFile; 
  
    
  if(type == 'H') { /* HDF */
    printf("\nError in configuring HDF output, which can only be 1-byte values (you requested 4): %s\n",filename);
      exit(0); 
  } 

  else if(type == 'C') { /* netCDF */
        writeFloatNetCDF(filename,VARNAME,data,bSize,type,index,thisvarUnits, outstep); 

  } 
  else if(type == 'M')  { /* generic binary Map */
    if (index == 0) write_header(filename,bSize);

        if((bFile = fopen(filename,"wb") ) == NULL ) { 
      fprintf(stderr,"Can't Open output Mapfile: %s",filename); 
      exit(0); 
    }
    gsize = (gbl_size[0]+2)*(gbl_size[1]+2)*bSize; /* note size is 2 rows and 2 cols larger than standard input/output arrays */
    fwrite(data, gsize, 1, bFile ); 
        
    fclose(bFile);
  }

  else { /* this error shouldn't be reached, but it is possible */
    printf("\nError in configuring 4-byte output request, which can only be netCDF ('C' argument in 'G' command) or generic map binary ('M' argument in 'G' command): output variable= %s\n",filename);
  } 

}

void writeFloatNetCDF	(	char *	,
		char *	,
		float *	,
		int	,
		unsigned	char,
		int	,
		char *	,
		int
	)

Definition at line 252 of file Serial.c.

Referenced by writeFloatMap().

{
  int retval;
  int ncid, dimids[NDIMS];
  size_t start[NDIMS], count[NDIMS];
  int time_dimid, x_dimid, y_dimid;
  int x_id, y_id, time_id, varid, date_id, TM_id;
  char s_mo[3], s_da[3], ELMdate[11], dateUnits[100], attribute_string[1000];
  float north[s0+2],east[s1+2];
  float northrev[s0+2];  /* for the reversal of the row ordering in having output w/ origin at lower left */

  time_t begin_sim, end_sim; /* Feb 2011 - just threw in here - poor practice!! */
  struct tm *local_begin_time; /* struct holding real-time calendar time from standard time.h */
  /* a couple of items that use the standard time.h to clock the simulation runtime*/
  begin_sim = time(NULL); 
  local_begin_time = localtime(&begin_sim);

  
  int i,j, irev;

/* this prevents code from being compiled when netCDF is not installed 
        (If you do not have netCDF installed on your system, you must set NCDF3 to false in globals.h) */
#if NCDF3
/*  append the date (yyyymmdd) to the root filename*/
  if (SimTime.mo[0]<10) sprintf(s_mo,"0%d", SimTime.mo[0]);
  else sprintf(s_mo,"%d", SimTime.mo[0]);
  if (SimTime.da[0]<10) sprintf(s_da,"0%d", SimTime.da[0]);
  else sprintf(s_da,"%d", SimTime.da[0]);
  sprintf(ELMdate,"%d-%s-%s",SimTime.yr[0],s_mo,s_da);
  
/*  Coordinates used for the netCDF cell attributes are the centroids:
        float maps are 1-cell larger on each side, so
        subtract 1 cell width to start at western edge, and 
        add 1 cell width to start at northern edge 
        (remember that origin of SME/ELM is upper left,
        while UTM goes in positive direction from lower left) 
        We then use the centroid (not upper and left edge) of each cell for coords,
        so (- celWid + 0.5*celWid) = (-0.5*celWid) */
for (i=0; i< (s0+2); i++) { 
    for (j=0; j< (s1+2); j++) { 
//               east[j] = UTMwest  - 0.5 * celWid + (j * celWid); 
//               north[i]= UTMnorth + 0.5 * celWid - (i * celWid); 
// Note that we've switched to having output in NAD83 horizontal datum - if you change this, be sure to alter the metadata strings below
         east[j] = UTMwestNAD83  - 0.5 * celWid + (j * celWid); 
         north[i]= UTMnorthNAD83 + 0.5 * celWid - (i * celWid); 
    }
  }

/* reverse row order (ELM origin is upper left, this outputs origin at lower left) */
for (i=0; i< (s0+2); i++) { 
    for (j=0; j< (s1+2); j++) { 
         irev = (s0+1) - i; 
         nc_dataRowRev[T(irev,j)] = data[T(i,j)]; 
         northrev[irev] = north[i]; 
    }
  }

   /* Create the file. The NC_CLOBBER parameter tells netCDF to
    * overwrite this file, if it already exists; NC_NOCLOBBER does not overwrite.  */
   if (index==0) {
                 if ( (retval = nc_create(filename, NC_CLOBBER, &ncid)))
                           ERR(retval);

   /* Define the dimensions: x, y, and time outstep-number (sequence). NetCDF will hand back an ID for each. */
           if ((retval = nc_def_dim(ncid, "time", NC_UNLIMITED, &time_dimid)))
              ERR(retval);
           if ((retval = nc_def_dim(ncid, "y", (s0+2), &y_dimid))) /* note the s0+2 array size */
              ERR(retval);
           if ((retval = nc_def_dim(ncid, "x", (s1+2), &x_dimid))) /* note the s1+2 array size */
              ERR(retval);

   /* The dimids array is used to pass the IDs of the dimensions of
    * the variable. */
           dimids[0] = time_dimid;
           dimids[1] = y_dimid;
           dimids[2] = x_dimid;

   /* Define the model output variable, time, x, y, and transverse_mercator (required for EverVIEW application) variables. 
   The type of the model output variable in this case is * NC_FLOAT (4-byte floating point). */
           if ((retval = nc_def_var(ncid, "transverse_mercator", NC_CHAR, 0, 
                            0, &TM_id)))
              {  printf("oops: %s",nc_strerror(retval) );  exit(-1); }

           if ((retval = nc_def_var(ncid, VARNAME, NC_FLOAT, NDIMS, 
                            dimids, &varid)))
              ERR(retval);
           if ((retval = nc_def_var(ncid, "time", NC_FLOAT, 1, 
                            &time_dimid, &time_id)))  
              ERR(retval);
           if ((retval = nc_def_var(ncid, "y", NC_FLOAT, 1, 
                            &y_dimid, &y_id)))
              ERR(retval);
           if ((retval = nc_def_var(ncid, "x", NC_FLOAT, 1, 
                            &x_dimid, &x_id)))
              ERR(retval);

   /* #### Attributes of the time variable. #### */
           if ((retval = nc_put_att_text(ncid, time_id, "long_name", 
                                         strlen("model time"), "model time")))
              ERR(retval);
   /* Assign units attributes to the julian time. In definition mode, the current date is initial day 0 of simulation */
           sprintf(dateUnits,"days since %sT12:00:00Z",ELMdate);
           if ((retval = nc_put_att_text(ncid, time_id, "units", 
                                         strlen(dateUnits), dateUnits)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, time_id, "_CoordinateAxisType", 
                                         strlen("Time"), "Time")))
              ERR(retval);


   /* #### Attributes of the model output variable. #### */
   /* Assign "long_name" attribute to the variable - to do this right, need to pass the variable's description into here. */
           if ((retval = nc_put_att_text(ncid, varid, "long_name", 
                                         strlen(VARNAME), VARNAME)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, varid, "units", 
                                         strlen(thisvarUnits), thisvarUnits)))
              ERR(retval);
           if ((retval = nc_put_att_float(ncid, varid, "missing_value",  /* note that "_FillValue" is updated attribute, but EverVIEW didn't respond to that, so using deprecated "missing_value" */
                                         NC_FLOAT, 1, &offMap_float)))
              ERR(retval);
           if ((retval = nc_put_att_int(ncid, varid, "OutputInterval_inDays", 
                                         NC_INT, 1, &outstep)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, varid, "coordinates", 
                                         strlen("x y"), "x y")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, varid, "grid_mapping", 
                                         strlen("transverse_mercator"), "transverse_mercator")))
              ERR(retval);

/* for compatability with other south Florida models, we switched (only the netCDF) output to NAD83 (in the above spatial loop) */
           sprintf(attribute_string,"PROJCS[\"NAD_1983_UTM_Zone_17N\",GEOGCS[\"GCS_North_American_1983\",DATUM[\"D_North_American_1983\",SPHEROID[\"GRS_1980\",6378137.0,298.257222101]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",500000.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",-81.0],PARAMETER[\"Scale_Factor\",0.9996],PARAMETER[\"Latitude_Of_Origin\",0.0],UNIT[\"Meter\",1.0]]");

           if ((retval = nc_put_att_text(ncid, varid, "esri_pe_string", 
                                         strlen(attribute_string), attribute_string)))
              ERR(retval);

   /* #### Attributes of the UTM coordinate variables. #### */
           if ((retval = nc_put_att_text(ncid, x_id, "long_name", 
                                         strlen("easting (x) coordinate"), "easting (x) coordinate")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, y_id, "long_name", 
                                         strlen("northing (y) coordinate"), "northing (y) coordinate")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, x_id, "standard_name", 
                                         strlen("projection_x_coordinate"), "projection_x_coordinate")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, y_id, "standard_name", 
                                         strlen("projection_y_coordinate"), "projection_y_coordinate")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, x_id, "units", 
                                         strlen("m"), "m")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, y_id, "units", 
                                         strlen("m"), "m")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, x_id, "_CoordinateAxisType", 
                                         strlen("GeoX"), "GeoX")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, y_id, "_CoordinateAxisType", 
                                         strlen("GeoY"), "GeoY")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, x_id, "CellRegistration", 
                                         strlen("coords are at cell centroids"), "coords are at cell centroids")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, y_id, "CellRegistration", 
                                         strlen("coords are at cell centroids"), "coords are at cell centroids")))
              ERR(retval);

     /* #### Attributes of the transverse_mercator variable (done only for EverVIEW application). #### */
           if ((retval = nc_put_att_text(ncid, TM_id, "grid_mapping_name", 
                                         strlen("transverse_mercator"), "transverse_mercator")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "longitude_of_central_meridian", 
                                         strlen(" -81."), " -81.")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "latitude_of_projection_origin", 
                                         strlen("0."), "0.")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "scale_factor_at_central_meridian", 
                                         strlen("0.9996"), "0.9996")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "false_easting", 
                                         strlen("500000."), "500000.")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "false_northing", 
                                         strlen("0."), "0.")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "_CoordinateTransformType", 
                                         strlen("Projection"), "Projection")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "_CoordinateAxisTypes", 
                                         strlen("GeoX GeoY"), "GeoX GeoY")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, TM_id, "units", 
                                         strlen("m"), "m")))
              ERR(retval);


 /* #### Global attributes. #### */
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "title", 
                                         strlen("Everglades Landscape Model output"), "Everglades Landscape Model output")))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "ModelName", 
                                         strlen(modelName), modelName)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "ModelVersion", 
                                         strlen(modelVers), modelVers)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "ScenarioType", 
                                         strlen(SimAlt), SimAlt)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "Scenario", 
                                         strlen(SimModif), SimModif)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "Day0_SimulationPeriod", 
                                         strlen(initDateRead), initDateRead)))
              ERR(retval);
           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "Time_model_run_started", 
                                         strlen(asctime(local_begin_time)), asctime(local_begin_time))))
              ERR(retval);
           /* todo get rid of this hardcoding */
           sprintf(attribute_string,"H. Carl Fitz, carlfitz3@gmail.com, EcoLandMod, Inc, http://www.ecolandmod.com");

           if ((retval = nc_put_att_text(ncid, NC_GLOBAL, "modelDeveloper", 
                                         strlen(attribute_string), attribute_string)))
              ERR(retval);


   /* #### End define mode. This tells netCDF we are done defining metadata. #### */
           if ((retval = nc_enddef(ncid)))
              ERR(retval);



/* Still on the first outstep, write the coordinate variable data. This will put the northings
      and eastings of our data grid into the netCDF file. */
           if ((retval = nc_put_var_float(ncid, y_id, &northrev[0])))  /* note the use of reverse rows */
              ERR(retval);
           if ((retval = nc_put_var_float(ncid, x_id, &east[0])))
              ERR(retval);

           if ((retval = nc_close(ncid)))
              ERR(retval);


        } /* end of all defs. Done once, prior to first writing of data; have a closed file */

   /* These settings tell netcdf to write one timestep of data. (The
     value of start[0] below tells netCDF which (index)
     timestep to write.) */
   count[0] = 1;
   count[1] = s0+2; /* was s0+2 */
   count[2] = s1+2; /* was s1+2 */
   start[1] = 0;
   start[2] = 0;

        start[0] = index; /* tried to use 'SimTime.TIME' , but it filled in multiple blank days */
        /* now open the ncdf file, and write to it */
   if ((retval = nc_open(filename, NC_WRITE, &ncid)))
      ERR(retval);
   if ((retval = nc_inq_varid(ncid, VARNAME, &varid)))
      ERR(retval);
   if ((retval = nc_inq_varid(ncid, "time", &time_id)))  
      ERR(retval);

   /* Write the data to the file.  */
   if ((retval = nc_put_vara_float(ncid, varid, start, count, nc_dataRowRev)))
      ERR(retval);
   if ((retval = nc_put_var1_float(ncid, time_id,  start, &SimTime.TIME )))
      ERR(retval);

   /* Close the file. This frees up any internal netCDF resources
    * associated with the file, and flushes any buffers. */
   if ((retval = nc_close(ncid)))
      ERR(retval);

/* end of netCDF code */
#else

    printf("\nError in configuring 4-byte output request, you asked for netCDF ('C' argument in 'G' command) output, but your globals.h file has NCDF3 set to false: output variable= %s\n",filename);
    exit(0); 

#endif
}

void writeSeries	(	void *	fValue,
		char *	label,
		char *	desc,
		int	N0,
		int	N1,
		byte	Mtype,
		byte	format
	)

Write to a spatial data window in a debug file.

Parameters:

	fValue	Model variable (local) array data
	label	Output message label (w/ variable name)
	desc	Message describing the output
	N0	Range in x (row!) values
	N1	Range in y (col!) values
	Mtype	General output format type
	format	Numeric format type

Definition at line 970 of file Serial.c.

Referenced by writeWindow().

{
        /* check on these! (who wrote this? Why? (HCF Dec'04) )*/
  int ix, iy; 
  static unsigned char first_write = 1;
  long int  ret, dimsizes[2];
  unsigned short int refnum;
  if(format == 'H') {
  
/* NOTE: June 2008 (v2.8.2): do not #define HDF in globals.h to true until until the code here is updated - 
   this code needs to be updated to HDF4 before it will compile and be used */
#if HDF   
          dimsizes[0] = N0;
          dimsizes[1] = N1;
          sprintf(cTemp,"%s%s:Output:Windows.hdf",OutputPath,ProjName);
          DFSDclear();
          
          switch(Mtype) {
                 case 'f': 
                    DFSDsetNT(DFNT_FLOAT32);  break;
                 case 'L': 
                    DFSDsetNT(DFNT_FLOAT32);  break;
                 case 'E': 
                    DFSDsetNT(DFNT_FLOAT32);  break;
                 case 'd': case 'i': 
                    DFSDsetNT(DFNT_INT32);  break;
                 case 'c': 
                    DFSDsetNT(DFNT_UINT8);  break;
          }
          if(first_write) {
                ret = DFSDputdata(cTemp,2,dimsizes,fValue);
                first_write = 0;
          } else {
                ret = DFSDadddata(cTemp,2,dimsizes,fValue);
          }
          HDF_VERIFY("DFSDadddata");
          refnum = DFSDlastref();
          ret = DFANputlabel(cTemp,DFTAG_SDG,refnum,label);
          HDF_VERIFY("DFANputlabel");
          ret = DFANputdesc(cTemp,DFTAG_SDG,refnum,desc,strlen(desc));
          HDF_VERIFY("DFANputdesc");
#endif
  }
  else {
    fprintf(Driver_outfile,"\n_________%s\n",label);    
    fprintf(Driver_outfile,"%s\n",desc);        
    for (ix=0; ix<N0; ix++) {
      fprintf(Driver_outfile,"\n");
      for (iy=0; iy<N1; iy++) {
        switch(Mtype) {
          case 'f': 
                if(format=='L')                 fprintf(Driver_outfile,"%f ",*(((float*)fValue)+iy+ix*N1)); 
                else if(format=='E')    fprintf(Driver_outfile,"%.3E ",*(((float*)fValue)+iy+ix*N1)); 
                        else                            fprintf(Driver_outfile,"%.3f ",*(((float*)fValue)+iy+ix*N1));
                        break;
        case 'd': case 'i': 
                        fprintf(Driver_outfile,"%d ",*(((int*)fValue)+iy+ix*N1)); 
                        break;
        case 'c': 
                        fprintf(Driver_outfile,"%x ",*(((UCHAR*)fValue)+iy+ix*N1)); 
                        break;
        }
      }
    }  
  }
}

float* readSeriesCol	(	char *	filename,
		int	format,
		int	index,
		int *	Npt,
		float *	TStep,
		int	col
	)

(Unused). Read time series input data for spatial interpolations

Parameters:

	filename	Filename of data
	format	Always float data format
	index	Unused. Was used to concatenate multiple files over time
	Npt	Number of time points
	TStep	Time step
	col	column ID (for different variables)

Definition at line 585 of file Serial.c.

Referenced by PTS_SetFields().

{
    int line = 0, cread=1, itest, j, sLen = 372 ;
    FILE *cfile;
    char  ctest, cmark[373], ret = '\n';
    unsigned char cmove[373], cmv=0;
    char tfilename[200], date_read[20],ss[200];
    int yyyy,mm, dd;
    double Jdate_read; 
    float  *tvar, *nullvar, first[10];

    sprintf(tfilename,"%s%d.ts",filename,index);
    if(debug>4) fprintf(dFile,"\nReading file %s, col %d, index = %d\n",tfilename,col,index); fflush(dFile);
    cfile = fopen(tfilename,"r"); 
    if(cfile==NULL) {  
        if( index > 0 ) {  fprintf(stdout,"\nWARNING: Unable to open timeseries file %s, using %s0.ts\n",tfilename,filename); return 0; } 
        else { fprintf(stdout,"\nERROR: Unable to open timeseries file %s\n",tfilename); exit(-1); } 
    }

    if (format != 2) { fprintf(stderr,"ERROR: only using floats in read_timeseries: %d\n",format); exit(0); }
    
           sLen = PORnumday; /* read/determined in genericDriver */
            tvar = (float*) nalloc( (sLen+2)*sizeof(float), "timeseries temp" );
            scan_forward(cfile,"{END COMMENT}\n");
            fgets(ss,200,cfile); /* skip  the header line */
            
            do {
                fscanf(cfile, "%d %d %d %f %f %f %f", &yyyy,&mm,&dd,&first[1],&first[2],&first[3],&first[4] ); 
        /* julian day, returns a double (args = month, day, year, hours, minutes, seconds) */
                Jdate_read = julday(mm, dd, yyyy, 0, 0, 0); 
                if (Jdate_read > Jdate_init) {printf (" \n***Error\nInit date in %s file > simulation start date.\n",tfilename); exit (-1);}
                if (feof(cfile)) {
        printf (" \n***Error\nNon-matching starting date for %s meteorological time series\n",tfilename); 
                        exit (-1);
                }
            } while (Jdate_read < Jdate_init);
            
            tvar[0] = first[col]; /* have now read the first data record, assign to array */
            if(debug>4) fprintf(dFile,"%d %d %d %f\n",yyyy,mm,dd,tvar[0]);
            for (line = 1; line<sLen; line++) {
            
            /* each case for reading a different column */
                switch (col) {
                    case 1:
                        itest = fscanf(cfile,"%d %d %d %f %f %f %f",&yyyy,&mm,&dd, &(tvar[ line ]),&nullvar, &nullvar, &nullvar);
                        break;
                    case 2:
                        itest = fscanf(cfile,"%d %d %d %f %f %f %f",&yyyy,&mm,&dd,&nullvar, &(tvar[ line ]), &nullvar, &nullvar);
                        break;
                    case 3:
                        itest = fscanf(cfile,"%d %d %d %f %f %f %f",&yyyy,&mm,&dd,&nullvar, &nullvar, &(tvar[ line ]), &nullvar);
                        break;
                    case 4:
                        itest = fscanf(cfile,"%d %d %d %f %f %f %f",&yyyy,&mm,&dd,&nullvar, &nullvar, &nullvar, &(tvar[ line ]));
                        break;
                    default:
                        printf ("\nError in interpolation time series data.\n"); 
                        exit(-1);
                        break;
                } /* end switch */

                if(debug>4) fprintf(dFile,"%d %d %d %f\n",yyyy,mm,dd,tvar[ line ]);
                if (feof(cfile)) {printf (" \n***Error\nExceeded number of records for %s meteorological time series\n",tfilename);  exit (-1); } 
            }
            tvar[ sLen ] = *TStep;
 
    if(debug>4) { fprintf(dFile,"\nDone Reading file %s\n",tfilename); fflush(dFile); }
    
    fflush(stdout);
    fclose(cfile);
    *Npt = sLen;
    return tvar;
}

byte readMap	(	char *	filename,
		void *	data
	)

Read data for spatial (map) input binary file.

Parameters:

	filename	data variable's name
	data	variable's array data

Returns:

byte size of data values

Definition at line 43 of file Serial.c.

Referenced by read_map_file().

{
  int gsize, nbytes; byte bsize;
  FILE* bFile;
  char binFileName[300];
  
  bsize = read_header(filename);

  sprintf(binFileName,"%s/%s/Data/Map_bin/%s",ModelPath,ProjName,filename);

  if((bFile = fopen(binFileName,"rb") ) == NULL ) { 
    fprintf(stderr,"Can't Open Mapfile: %s",binFileName); 
    exit(0); 
  }
  gsize = gbl_size[0] * gbl_size[1];
  nbytes = fread((char*)data, (int)bsize, gsize, bFile );
  if(debug) { 
    fprintf(dFile," %d of %d items Read for %s, size = %x bytes ",
            nbytes,gsize,filename,bsize); 
  }
  fclose(bFile);
  return bsize;
}

int on_this_proc	(	int	x,
		int	y
	)

Parallel code: does nothing in serial implementation).

Definition at line 1500 of file Serial.c.

Referenced by quick_look().

{ return 1; }

void exchange_borders	(	UCHAR *	map,
		int	size
	)

Parallel code: does nothing in serial implementation).

Definition at line 1496 of file Serial.c.

Referenced by link_edges().

{return;}

void exparam

(

struct nodenv *

envInfo

)

Parallel code: effectively unused in serial implementation.

Definition at line 1439 of file Serial.c.

Referenced by setup_platform().

{       
        envInfo->procnum = 1;
        envInfo->nprocs = 1;
        envInfo->groupid = 0;
        envInfo->taskid = 0;
 
}

void exgridsplit	(	int	nprocs,
		int	ndim,
		int	nprocs2[2]
	)

Parallel code: effectively unused in serial implementation.

Definition at line 1453 of file Serial.c.

Referenced by setup_platform().

{
  nprocs2[0] = 1;
  nprocs2[1] = 1;
}

void exgridcoord	(	int	pnum,
		int	rnum[2]
	)

Parallel code: effectively unused in serial implementation.

Definition at line 1460 of file Serial.c.

Referenced by setup_platform().

{
    tramNum[0] = rnum[0] = 0;
    tramNum[1] = rnum[1] = 0;
}

void exgridsize	(	int	pnum,
		int	gsize[2],
		int	lsize[2],
		int	lstart[2]
	)

Parallel code: effectively unused in serial implementation.

Definition at line 1467 of file Serial.c.

Referenced by setup_grid().

{
        int rem[2], i, j;
        for( i=0; i<2; i++ ) {
                lsize[i] = gsize[i]/nprocs[i];
                rem[i] = gsize[i] - lsize[i]*nprocs[i];
                if(recpnum[i]<rem[i]) lsize[i]++;
                for(j=0; j<recpnum[i]; j++) if( j<rem[i] && recpnum[i] >= rem[i] ) lstart[i] += (lsize[i]+1); else lstart[i] += lsize[i];
        }
}

void broadcastInt

(

int *

iValPtr

)

Parallel code: does nothing in serial implementation).

Definition at line 1512 of file Serial.c.

{}

int exgridinit	(	int	dim,
		int *	nprocs
	)

Parallel code: does nothing in serial implementation).

Definition at line 1449 of file Serial.c.

Referenced by setup_platform().

{ return 0;}

void broadcastMsg

(

UCHAR *

msgPtr

)

Parallel code: does nothing in serial implementation).

Definition at line 1508 of file Serial.c.

{}

void fasync

(

FILE *

file

)

Parallel code: does nothing in serial implementation).

Definition at line 1491 of file Serial.c.

Referenced by nalloc().

{ return;}

void fmulti

(

FILE *

file

)

Parallel code: does nothing in serial implementation).

Definition at line 1483 of file Serial.c.

Referenced by nalloc().

{ return;}

int ReadGlobalParms	(	char *	s_parm_name,
		int	s_parm_relval
	)

Acquire the model parameters that are global to the domain.

Parameters:

	s_parm_name	Name of the sensitivity parameter being varied for this run
	s_parm_relval	Indicator of current value of relative range in sensitivity parm values: nominal (0), low (1), or high (2)

Definition at line 2532 of file UnitMod.c.

Referenced by read_model_parameters().

 {
     
/* Geography, hydrology */
    GP_SOLOMEGA = get_global_parm(s_parm_name, s_parm_relval,"GP_SOLOMEGA"); 
    GP_ALTIT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALTIT"); 
    GP_LATDEG = get_global_parm(s_parm_name, s_parm_relval,"GP_LATDEG"); 
    GP_mannDepthPow = get_global_parm(s_parm_name, s_parm_relval,"GP_mannDepthPow"); 
    GP_mannHeadPow = get_global_parm(s_parm_name, s_parm_relval,"GP_mannHeadPow"); 
    GP_calibGWat = get_global_parm(s_parm_name, s_parm_relval,"GP_calibGWat"); 
    GP_IDW_pow = get_global_parm(s_parm_name, s_parm_relval,"GP_IDW_pow"); 
    GP_calibET = get_global_parm(s_parm_name, s_parm_relval,"GP_calibET"); 
    GP_DATUM_DISTANCE = get_global_parm(s_parm_name, s_parm_relval,"GP_DATUM_DISTANCE"); 
    GP_HYD_IC_SFWAT_ADD = get_global_parm(s_parm_name, s_parm_relval,"GP_HYD_IC_SFWAT_ADD"); 
    GP_HYD_IC_UNSAT_ADD = get_global_parm(s_parm_name, s_parm_relval,"GP_HYD_IC_UNSAT_ADD"); 
    GP_HYD_RCRECHG = get_global_parm(s_parm_name, s_parm_relval,"GP_HYD_RCRECHG"); 
    GP_HYD_ICUNSATMOIST = get_global_parm(s_parm_name, s_parm_relval,"GP_HYD_ICUNSATMOIST"); 
    GP_DetentZ = get_global_parm(s_parm_name, s_parm_relval,"GP_DetentZ"); 
    GP_WQualMonitZ = get_global_parm(s_parm_name, s_parm_relval,"GP_WQualMonitZ"); 
    GP_MinCheck = get_global_parm(s_parm_name, s_parm_relval,"GP_MinCheck"); 
    GP_SLRise = get_global_parm(s_parm_name, s_parm_relval,"GP_SLRise"); 
    GP_dispLenRef = get_global_parm(s_parm_name, s_parm_relval,"GP_dispLenRef"); 
    GP_dispParm = get_global_parm(s_parm_name, s_parm_relval,"GP_dispParm"); 
 
 /* Periphyton/Algae */
    GP_ALG_IC_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_IC_MULT"); 
    GP_alg_uptake_coef = get_global_parm(s_parm_name, s_parm_relval,"GP_alg_uptake_coef"); 
    GP_ALG_SHADE_FACTOR = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_SHADE_FACTOR"); 
    GP_algMortDepth = get_global_parm(s_parm_name, s_parm_relval,"GP_algMortDepth"); 
    GP_ALG_RC_MORT_DRY = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_RC_MORT_DRY"); 
    GP_ALG_RC_MORT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_RC_MORT"); 
    GP_ALG_RC_PROD = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_RC_PROD"); 
    GP_ALG_RC_RESP = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_RC_RESP"); 
    GP_alg_R_accel = get_global_parm(s_parm_name, s_parm_relval,"GP_alg_R_accel"); 
    GP_AlgComp = get_global_parm(s_parm_name, s_parm_relval,"GP_AlgComp"); 
    GP_ALG_REF_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_REF_MULT"); 
    GP_NC_ALG_KS_P = get_global_parm(s_parm_name, s_parm_relval,"GP_NC_ALG_KS_P"); 
    GP_alg_alkP_min = get_global_parm(s_parm_name, s_parm_relval,"GP_alg_alkP_min"); 
    GP_C_ALG_KS_P = get_global_parm(s_parm_name, s_parm_relval,"GP_C_ALG_KS_P"); 
    GP_ALG_TEMP_OPT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_TEMP_OPT"); 
    GP_C_ALG_threshTP = get_global_parm(s_parm_name, s_parm_relval,"GP_C_ALG_threshTP"); 
    GP_ALG_C_TO_OM = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_C_TO_OM"); 
    GP_alg_light_ext_coef = get_global_parm(s_parm_name, s_parm_relval,"GP_alg_light_ext_coef"); 
    GP_ALG_LIGHT_SAT = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_LIGHT_SAT"); 
    GP_ALG_PC = get_global_parm(s_parm_name, s_parm_relval,"GP_ALG_PC"); 

/* Soil */
    GP_DOM_RCDECOMP = get_global_parm(s_parm_name, s_parm_relval,"GP_DOM_RCDECOMP"); 
    GP_DOM_DECOMPRED = get_global_parm(s_parm_name, s_parm_relval,"GP_DOM_DECOMPRED"); 
    GP_calibDecomp = get_global_parm(s_parm_name, s_parm_relval,"GP_calibDecomp"); 
    GP_DOM_decomp_coef = get_global_parm(s_parm_name, s_parm_relval,"GP_DOM_decomp_coef"); 
    GP_DOM_DECOMP_POPT = get_global_parm(s_parm_name, s_parm_relval,"GP_DOM_DECOMP_POPT"); 
    GP_DOM_DECOMP_TOPT = get_global_parm(s_parm_name, s_parm_relval,"GP_DOM_DECOMP_TOPT"); 
    GP_sorbToTP = get_global_parm(s_parm_name, s_parm_relval,"GP_sorbToTP"); 
    GP_IC_ELEV_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_IC_ELEV_MULT"); 
    GP_IC_BATHY_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_IC_BATHY_MULT"); 
    GP_IC_DOM_BD_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_IC_DOM_BD_MULT"); 
    GP_IC_BulkD_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_IC_BulkD_MULT"); 
    GP_IC_TPtoSOIL_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_IC_TPtoSOIL_MULT"); 
 
/* Macrophytes */
    GP_MAC_IC_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_MAC_IC_MULT"); 
    GP_MAC_REFUG_MULT = get_global_parm(s_parm_name, s_parm_relval,"GP_MAC_REFUG_MULT"); 
    GP_mac_uptake_coef = get_global_parm(s_parm_name, s_parm_relval,"GP_mac_uptake_coef"); 
    GP_mann_height_coef = get_global_parm(s_parm_name, s_parm_relval,"GP_mann_height_coef"); 

/* Floc */
    GP_Floc_BD = get_global_parm(s_parm_name, s_parm_relval,"GP_Floc_BD"); 
    GP_FlocMax = get_global_parm(s_parm_name, s_parm_relval,"GP_FlocMax"); 
    GP_TP_P_OM = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_P_OM"); 
    GP_Floc_rcSoil = get_global_parm(s_parm_name, s_parm_relval,"GP_Floc_rcSoil"); 
                
/* Phosphorus */
    GP_TP_DIFFCOEF = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_DIFFCOEF"); 
    GP_TP_K_INTER = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_K_INTER"); 
    GP_TP_K_SLOPE = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_K_SLOPE"); 
    GP_WQMthresh = get_global_parm(s_parm_name, s_parm_relval,"GP_WQMthresh"); 
    GP_PO4toTP = get_global_parm(s_parm_name, s_parm_relval,"GP_PO4toTP"); 
    GP_TP_IN_RAIN = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_IN_RAIN"); 
    GP_CL_IN_RAIN = get_global_parm(s_parm_name, s_parm_relval,"GP_CL_IN_RAIN"); 
    GP_PO4toTPint = get_global_parm(s_parm_name, s_parm_relval,"GP_PO4toTPint"); 
    GP_TP_ICSFWAT = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_ICSFWAT"); 
    GP_TP_ICSEDWAT = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_ICSEDWAT"); 
    GP_TPpart_thresh = get_global_parm(s_parm_name, s_parm_relval,"GP_TPpart_thresh"); 
    GP_TP_DIFFDEPTH = get_global_parm(s_parm_name, s_parm_relval,"GP_TP_DIFFDEPTH"); 
    GP_settlVel = get_global_parm(s_parm_name, s_parm_relval,"GP_settlVel"); 
    
}

int ReadHabParms	(	char *	s_parm_name,
		int	s_parm_relval
	)

Acquire the model parameters that are specific to different habitat types in the domain.

Parameters:

	s_parm_name	Name of the sensitivity parameter being varied for this run
	s_parm_relval	Indicator of current value of relative range in sensitivity parm values: nominal (0), low (1), or high (2)

Remarks:

The get_hab_parm function called during initialization expects the appropriate habitat-specific parameter to have a first header line that has parameter names that exactly match those in this code.

The ordering of function calls to read the parameters is unimportant; the ordering of the modules in the datafile is unimportant. However, the sequence of the column-field parameter names in header must (obviously?) correspond to the data columns.

Definition at line 2463 of file UnitMod.c.

Referenced by read_model_parameters().

{

 /* Periphyton/Algae */
  HP_ALG_MAX = get_hab_parm(s_parm_name, s_parm_relval, "HP_ALG_MAX"); 

/* Soil */
  HP_DOM_MAXDEPTH = get_hab_parm(s_parm_name, s_parm_relval,"HP_DOM_MAXDEPTH");  
  HP_DOM_AEROBTHIN = get_hab_parm(s_parm_name, s_parm_relval,"HP_DOM_AEROBTHIN"); 

/* Phosphorus */
  HP_TP_CONC_GRAD = get_hab_parm(s_parm_name, s_parm_relval,"HP_TP_CONC_GRAD"); 

/* Salt/tracer */
  HP_SALT_ICSEDWAT = get_hab_parm(s_parm_name, s_parm_relval,"HP_SALT_ICSEDWAT"); 
  HP_SALT_ICSFWAT = get_hab_parm(s_parm_name, s_parm_relval,"HP_SALT_ICSFWAT"); 
        
/* Macrophytes */
  HP_PHBIO_MAX = get_hab_parm(s_parm_name, s_parm_relval,"HP_PHBIO_MAX"); 
  HP_NPHBIO_MAX = get_hab_parm(s_parm_name, s_parm_relval,"HP_NPHBIO_MAX"); 
  HP_MAC_MAXHT = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_MAXHT"); 
  HP_NPHBIO_ROOTDEPTH = get_hab_parm(s_parm_name, s_parm_relval,"HP_NPHBIO_ROOTDEPTH"); 
  HP_MAC_MAXROUGH = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_MAXROUGH"); 
  HP_MAC_MINROUGH = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_MINROUGH"); 
  HP_MAC_MAXLAI = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_MAXLAI"); 
  HP_MAC_MAXCANOPCOND = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_MAXCANOPCOND"); /* unused in ELMv2.2, 2.3 */ 
  HP_MAC_CANOPDECOUP = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_CANOPDECOUP"); /* unused in ELMv2.2, 2.3 */ 
  HP_MAC_TEMPOPT = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_TEMPOPT"); 
  HP_MAC_LIGHTSAT = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_LIGHTSAT"); 
  HP_MAC_KSP = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_KSP"); 
  HP_PHBIO_RCNPP = get_hab_parm(s_parm_name, s_parm_relval,"HP_PHBIO_RCNPP"); 
  HP_PHBIO_RCMORT = get_hab_parm(s_parm_name, s_parm_relval,"HP_PHBIO_RCMORT"); 
  HP_MAC_WAT_TOLER = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_WAT_TOLER"); 
  HP_MAC_SALIN_THRESH = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_SALIN_THRESH"); /* unused in ELMv2.2, 2.3 */ 
  HP_PHBIO_IC_CTOOM = get_hab_parm(s_parm_name, s_parm_relval,"HP_PHBIO_IC_CTOOM"); 
  HP_NPHBIO_IC_CTOOM = get_hab_parm(s_parm_name, s_parm_relval,"HP_NPHBIO_IC_CTOOM"); 
  HP_PHBIO_IC_PC = get_hab_parm(s_parm_name, s_parm_relval,"HP_PHBIO_IC_PC"); 
  HP_NPHBIO_IC_PC = get_hab_parm(s_parm_name, s_parm_relval,"HP_NPHBIO_IC_PC"); 
  HP_MAC_TRANSLOC_RC = get_hab_parm(s_parm_name, s_parm_relval,"HP_MAC_TRANSLOC_RC"); 

/* Hydrology */
  HP_HYD_RCINFILT = get_hab_parm(s_parm_name, s_parm_relval,"HP_HYD_RCINFILT"); 
  HP_HYD_SPEC_YIELD = get_hab_parm(s_parm_name, s_parm_relval,"HP_HYD_SPEC_YIELD");  
  HP_HYD_POROSITY = get_hab_parm(s_parm_name, s_parm_relval,"HP_HYD_POROSITY"); 

/* Floc */
  HP_FLOC_IC = get_hab_parm(s_parm_name, s_parm_relval,"HP_FLOC_IC"); 
  HP_FLOC_IC_CTOOM = get_hab_parm(s_parm_name, s_parm_relval,"HP_FLOC_IC_CTOOM"); 
  HP_FLOC_IC_PC = get_hab_parm(s_parm_name, s_parm_relval,"HP_FLOC_IC_PC"); 

/* Habitat succession */
  HP_SfDepthLo = get_hab_parm(s_parm_name, s_parm_relval,"HP_SfDepthLo"); 
  HP_SfDepthHi = get_hab_parm(s_parm_name, s_parm_relval,"HP_SfDepthHi"); 
  HP_SfDepthInt = get_hab_parm(s_parm_name, s_parm_relval,"HP_SfDepthInt"); 
  HP_PhosLo = get_hab_parm(s_parm_name, s_parm_relval,"HP_PhosLo"); 
  HP_PhosHi = get_hab_parm(s_parm_name, s_parm_relval,"HP_PhosHi"); 
  HP_PhosInt = get_hab_parm(s_parm_name, s_parm_relval,"HP_PhosInt"); 
  HP_FireInt = get_hab_parm(s_parm_name, s_parm_relval,"HP_FireInt"); 
  HP_SalinLo = get_hab_parm(s_parm_name, s_parm_relval,"HP_SalinLo"); 
  HP_SalinHi = get_hab_parm(s_parm_name, s_parm_relval,"HP_SalinHi"); 
  HP_SalinInt = get_hab_parm(s_parm_name, s_parm_relval,"HP_SalinInt"); 
  
}

int ReadModExperimParms	(	char *	s_parm_name,
		int	s_parm_relval
	)

Acquire the model parameters that are used in special model experiments - used only in special, research-oriented applications. (Added for v2.6).
NOTE that this was quickly set up for the ELM Peer Review (2006) project, and (at least in v2.6.0) should be used in conjunction with the spatial interpolators for rain and pET inputs. (because this is intended for scales that are potentially incompatible w/ simultaneous use of gridIO inputs on SFWMM stage/depth that are expected w/ gridIO rain/pET).
NOTE: this has not been specifically developed/tested for inclusion within the automated sensitivity analyses - thus only been used at this point for the ModExperimParms_NOM nominal parameter set (Nov 2006).
.

Parameters:

	s_parm_name	Name of the sensitivity parameter being varied for this run
	s_parm_relval	Indicator of current value of relative range in sensitivity parm values: nominal (0), low (1), or high (2)

Definition at line 2636 of file UnitMod.c.

Referenced by read_model_parameters().

 {
    if (isModExperim) {
                 sprintf(msgStr,"####### Reading special model experiment parameters.  \nYou should NOT be using gridIO spatial time series data for rain, pET, and SFWMM-output depth #######..."); 
            WriteMsg(msgStr,1); 
            usrErr0(msgStr);
            
        GP_BC_SfWat_add = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_SfWat_add"); 
        GP_BC_SfWat_addHi = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_SfWat_addHi"); 
        GP_BC_SatWat_add = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_SatWat_add"); 
        GP_BC_SfWat_targ = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_SfWat_targ"); 
        GP_BC_InputRow = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_InputRow"); 
        GP_BC_Pconc = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_Pconc"); /* ug/L */
        GP_BC_Sconc = get_modexperim_parm(s_parm_name, s_parm_relval,"GP_BC_Sconc"); /* g/L */
        
        GP_BC_Pconc /= conv_kgTOmg; /* convert from ug/L to g/L (same as div by the kg->mg conversion) */

            sprintf(msgStr,"done."); 
            WriteMsg(msgStr,1); 
            usrErr(msgStr);
    }
    else {
        GP_BC_SfWat_add = 0.0; /* value of 0.0 has no effect on model results (adds nothing to boundary depth/stages) */
        GP_BC_SfWat_addHi = 0.0; /* value of 0.0 has no effect on model results (adds nothing to boundary depth/stages) */
        GP_BC_SatWat_add = 0.0; /* value of 0.0 has no effect on model results (adds nothing to boundary depth/stages) */
        GP_BC_SfWat_targ = 0.0; /* value of 0.0 has no effect on model results (only used in Oct06 specialized model experiment - code doesn't use this parm otherwise) */
        GP_BC_InputRow = 0; /* value of 0 has no effect on model results (only used in Oct06 specialized model experiment - code doesn't use this parm otherwise) */
        GP_BC_Pconc = 0.0;
        GP_BC_Sconc = 0.0;
    }
 } 

---

Variable Documentation

int CalMonOut = 99999

The outstep interval (in Model.outList input file) used to denote output intervals of 1-calendar-month instead of selectable-julian-day

Definition at line 32 of file driver_utilities.h.

Referenced by gen_output(), and readViewParms().

char* ModelPath

Environment variables used in model

ModelPath environment variable, base pathname for executable and input data
ProjName environment variable, the name of the model project
DriverPath environment variable, base pathname for source code
OS_TYPE environment variable, the type of operating system being used (informational purpose only, not used in code)

Definition at line 40 of file driver_utilities.h.

Referenced by BIRinit(), evap_data_wmm(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), get_parmf(), ModExperim_test(), PTSL_ReadLists(), PTSL_test(), rain_data_wmm(), read_header(), read_map_dims(), Read_schedule(), ReadChanStruct(), readMap(), readOutlist(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), ReadStructures(), SensiParm_list(), set_env_vars(), and stage_data_wmm().

char * ProjName

Definition at line 40 of file driver_utilities.h.

Referenced by BIRinit(), BIRoutfiles(), Canal_Network_Init(), cell_dyn1(), Channel_configure(), evap_data_wmm(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), get_parmf(), main(), ModExperim_test(), open_debug_outFile(), open_point_lists(), PTSL_ReadLists(), PTSL_test(), rain_data_wmm(), read_header(), read_map_dims(), Read_schedule(), ReadChanStruct(), readMap(), readOutlist(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), ReadStructures(), send_point_lists2(), SensiParm_list(), set_env_vars(), stage_data_wmm(), write_map_file(), and writeSeries().

char * DriverPath

Definition at line 40 of file driver_utilities.h.

Referenced by set_env_vars().

char * OS_TYPE

Definition at line 40 of file driver_utilities.h.

Referenced by main(), and set_env_vars().

char* OutputPath

base pathname for all model output (user input)

Definition at line 42 of file driver_utilities.h.

Referenced by BIRoutfiles(), Canal_Network_Init(), cell_dyn1(), Channel_configure(), get_parmf(), main(), open_debug_outFile(), open_point_lists(), send_point_lists2(), write_map_file(), and writeSeries().

char modelName[20]

Model name/version (user input)

modelName Name given to model implementation (user input)
modelVers Version given to model implementation (e.g., v.2.1) (user input)

Definition at line 48 of file driver_utilities.h.

Referenced by BIRinit(), BIRoutfiles(), Canal_Network_Init(), get_parmf(), open_point_lists(), Read_schedule(), ReadChanStruct(), ReadStructures(), and writeFloatNetCDF().

char modelVers[10]

Definition at line 48 of file driver_utilities.h.

Referenced by BIRoutfiles(), Canal_Network_Init(), get_parmf(), open_point_lists(), and writeFloatNetCDF().

char modelFileName[300]

Generic string for input/output file name (overwritten/reused)

Definition at line 50 of file driver_utilities.h.

Referenced by BIRinit(), BIRoutfiles(), Canal_Network_Init(), Channel_configure(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), PTS_SetFields(), PTSL_ReadLists(), read_map_dims(), Read_schedule(), ReadChanStruct(), readOutlist(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), ReadStructures(), SensiParm_list(), and write_map_file().

int gNPtTs

Definition at line 52 of file driver_utilities.h.

Referenced by PTS_SetFields(), and PTSL_ReadLists().

int PListIndex = 0

Definition at line 53 of file driver_utilities.h.

Referenced by print_point().

int total_memory = 0

Definition at line 54 of file driver_utilities.h.

Referenced by nalloc().

float* plot_array

Definition at line 55 of file driver_utilities.h.

float gTS

Definition at line 55 of file driver_utilities.h.

Referenced by PTS_SetFields(), and PTSL_ReadLists().

int gridSize

row x col size of model grid domain, adding 2 to each dimension for local grid buffer (intended primarily for parallel implementation)

Definition at line 57 of file driver_utilities.h.

Referenced by read_map_file(), setup_grid(), and write_map_file().

int gTempSize

intermediate variable for model grid memory alloc

Definition at line 58 of file driver_utilities.h.

Referenced by read_map_file(), setup_grid(), write_map_file(), and writeWindow().

UCHAR* gTemp

intermediate variable for model grid memory alloc

Definition at line 59 of file driver_utilities.h.

Referenced by read_map_file(), setup_grid(), write_map_file(), and writeWindow().

float* floatOut

temporary array to hold an s0+2,s1+2 size array of any variable's floating point values for writing to generic binary map files output

Definition at line 62 of file driver_utilities.h.

Referenced by setup_grid(), and write_map_file().

float* nc_dataRowRev

temporary array to hold an s0+2,s1+2 size array of any variable's floating point values for writing to netCDF time series file output

Definition at line 63 of file driver_utilities.h.

Referenced by setup_grid(), and writeFloatNetCDF().

float offMap_float = -9999.0

off-map values (i.e., missing_value in netCDF)

Definition at line 64 of file driver_utilities.h.

Referenced by write_map_file(), and writeFloatNetCDF().

char gCArg[kCArgDepth][kCArgWidth]

Output command arguments, parsed from the output configuration file

Definition at line 55 of file serial.h.

Referenced by parse_packet(), and readViewParms().

FILE* Driver_outfile

File pointer to (Driver0.out, or DriverX.out (for X'th simulation run)) debug file(s)

Definition at line 61 of file serial.h.

Referenced by open_debug_outFile(), WriteMsg(), and writeSeries().

float avg_Intvl

time (day) interval between recurring-average summaries

Definition at line 71 of file generic_driver.h.

SeriesParm pSeries[MAX_PTSERIES]

An array of SeriesParm structs for point time series output

Definition at line 96 of file generic_driver.h.

Referenced by get_parmf(), main(), print_point(), and setup().

ViewParm* view

Definition at line 95 of file generic_driver.h.

Referenced by main(), and readViewParms().

Point2D dbgPt

struct of type Point2D, the grid location of a point

Definition at line 97 of file generic_driver.h.

Referenced by get_parmf(), read_map_file(), and write_map_file().

struct nodenv env

struct of nodenv, with parallel code info

Definition at line 99 of file generic_driver.h.

Referenced by setup_platform().

int gbl_size[2]

row [0] and column [1] dimensions of model grid domain, serial implementation

Definition at line 46 of file generic_driver.h.

int lcl_size[2]

Definition at line 111 of file generic_driver.h.

Referenced by read_map_file(), and setup_grid().

int lcl_start[2]

Definition at line 111 of file generic_driver.h.

Referenced by print_loc_ave(), print_point(), PTSL_GetInterpolatedValue0(), quick_look(), and setup_grid().

int N_iter

count of maximum number of model time iterations

Definition at line 67 of file generic_driver.h.

Referenced by get_parmf(), main(), print_point(), and track_time().

int istep

counter for number of model time iterations

Definition at line 68 of file generic_driver.h.

Referenced by main(), and quick_look().

int procnum

Data for parallel implementation, basically ignore

Lprocnum NA for serial implementation (=1)
procnum NA for serial implementation (also see nodenv struct)
nprocs NA for serial implementation (also see nodenv struct)
recpnum NA for serial implementation
tramType NA for serial implementation
tramNum NA for serial implementation
lcl_size used in serial code, but not really pertinent: in serial implementation, rows lcl_size[0]=s0 and columns lcl_size[1]=s1, dimensions of model grid domain local to one processor (for parallel implementation)
lcl_start used in serial code, but not really pertinent: in serial implementation, starting row lcl_start[0]=0 and starting column lcl_start[1]=0 in model grid domain local to one processor (for parallel implementation)

Definition at line 111 of file generic_driver.h.

int Lprocnum

Definition at line 111 of file generic_driver.h.

int nprocs[2]

Definition at line 111 of file generic_driver.h.

int recpnum[2]

Definition at line 111 of file generic_driver.h.

float gRTable[]

data used in function Normal, which is unused

Definition at line 89 of file generic_driver.h.

Referenced by Normal().

float GP_IDW_pow

Global parameter. _Units_: dimless; _Brief_: ***power for (all) inverse distance^parm interpolations; _Extended_: have always used IDW^2 (parm=2.0) when running meteorological interpolations; no ELM-calculated interpolations in ELM v2.2 - v2.4

Definition at line 38 of file unitmod_globparms.h.

Referenced by PTSL_GetInterpolatedValue0(), PTSL_GetInterpolatedValue1(), and ReadGlobalParms().

int numBasn

number of basins in model domain

Definition at line 33 of file budgstats.h.

Referenced by alloc_mem_stats(), BIRbudg_date(), BIRbudg_reset(), BIRbudg_sumFinal(), BIRinit(), BIRoutfiles(), BIRstats_date(), BIRstats_hydro_reset(), BIRstats_hydro_sumFinal(), BIRstats_reset(), BIRstats_sumFinal(), init_pvar(), and ReadChanStruct().