Driver_Utilities.c File Reference

Most Input/Output utility & related functions. More...

#include "driver_utilities.h"

Include dependency graph for Driver_Utilities.c:

Go to the source code of this file.

Functions
void	read_model_parameters (char *s_parm_name, int s_parm_relval)
	Call functions to read model parameters from datafiles.
ViewParm *	read_output_parms ()
	Call the read_output_parms function.
ViewParm *	readOutlist (int size)
	Get the file to configure model output.
int	readViewParms (FILE *vpFile, int size, ViewParm **ppview)
	Read/process the command-parameters to configure model output.
void	make_more_points (ViewParm *vp, int ptIncr)
	Allocate memory & set up another set of point-locations for output.
void	calc_maxmin (ViewParm *vp, void *Map, char Mtype, char *mName, int step)
	Calculate maximum & minimum values in model output arrays.
void	setup_grid ()
	Provide the 2D array size for the model domain.
void	write_output (int index, ViewParm *vp, void *Map, const char *filename, char Mtype, int step)
	Determine which functions to call for model output.
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).
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	enc_Nb (UCHAR **sptr, SLONG value, int bytes)
	Place data in bytes into a buffer to assemble a binary array.
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.
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.
int	iclip (int x0, int min, int max)
	Constrain x0 value within a min and a max.
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	set_env_vars (void)
	Acquire necessary environment variables.
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	read_map_dims (const char *filename)
	Establish the number of rows and columns of the model.
void	init_pvar (VOIDP Map, UCHAR *mask, unsigned char Mtype, float iv)
	Initialize a variable to a value.
void	print_loc_ave (Point3D *vt, void *Map, char Mtype, char *mName, int tIndex)
	Calculate summary statistics to determine local average.
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	PTS_Free (PTSeries *thisStruct)
	Point Time Series interpolation (unused): free up memory.
void	PTS_CopyFields (PTSeries *thisStruct, PTSeries pV)
	Point Time Series interpolation (unused): copy fields.
PTSeriesList *	PTSL_Init (int nSlots, int format)
	Point Time Series interpolation (unused): initialize structure.
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.
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).
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).
void	RP_SetFields (RPoint *thisStruct, int ix, int iy, float r, float value)
	Point Time Series interpolation (unused):.
void	RP_CopyFields (RPoint *thisStruct, RPoint *that)
	Point Time Series interpolation (unused):.
void	RP_SwapFields (RPoint *thisStruct, RPoint *that)
	Point Time Series interpolation (unused):.
RPointList *	RPL_Init (int nPoints)
	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):.
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.
void	setPrecision (ViewParm *vp, int value)
	(Effectively unused).
int	getPrecision (ViewParm *vp)
	(Effectively unused).
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	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.
void	WriteMsg (const char *msg, int wh)
	Send a message to a debug file or to the console.
void	usrErr0 (const char *dString)
	Send a message to the console.
void	usrErr (const char *dString)
	Send a message to the console.
void	Exit (int code)
	Standard exit from program.
void	fatal (const char *msg)
	Exit (code=9) from program after sending a message.
double	julday (int mon, int day, int year, int h, int mi, double se)
	Determine the Julian calendar day from a Gregorian date.
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.
float	FMOD (float x, float y)
	Modulus of a pair of (double) arguments.
void	getFloat (FILE *inFile, const char *lString, float *fValPtr)
	Get a float value 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	getInt (FILE *inFile, const char *lString, int *iValPtr)
	Get an integer following a specific string.
int	find_char (FILE *infile, char tchar)
	Find a character.
int	Round (float x)
	truncate (not rounding) to an integer
char *	Scip (char *s, char SYM)
	Skip ahead in a string until next field.
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.
char *	name_from_path (char *name)
	Get the var name from a longer path/filename.
VOIDP	nalloc (unsigned mem_size, const char var_name[])
	Allocate memory for a variable.
float	Normal (float mean, float sd)
	Unused, never called. Normal distribution.
int	Poisson (float mu)
	Unused, never called. Poisson distribution.
void	link_edges (VOIDP Map, unsigned char Mtype)
	Effectively unused in serial (non-parallel) implementation.
void	setup_platform ()
	Effectively unused in serial (non-parallel) implementation.

---

Detailed Description

Most Input/Output utility & related functions.

This source file contains a large number of functions used in "utility" tasks that generally relate to I/O, set-up of the simulation environment, etc.

Major categories of functions are (roughly) grouped in this order:
1) Output
2) Parameter and other data input
3) Spatial interpolation
4) Routine tasks (parsing text, values, error conditions, etc)
5) [effectively unused] Calls/definitions for parallel (not serial) implementation

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.c.

---

Function Documentation

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().

Referenced by main().

                                                                  {

    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:

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().

Referenced by main().

                              {
/* 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 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 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 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().

Referenced by setup().

                  {
  
  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 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.

References calc_maxmin(), debug, viewParm::fileName, point3D::format, getPrecision(), viewParm::mapType, msgStr, viewParm::nPoints, scale1::o, viewParm::points, print_loc_ave(), print_point(), quick_look(), scale1::s, viewParm::scale, viewParm::step, point3D::type, viewParm::varUnits, write_map_file(), WriteMsg(), point3D::x, point3D::y, and point3D::z.

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;
                }
        }
}

Here is the call graph for this function:

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.

References dbgPt, debug, gridSize, gTemp, gTempSize, lcl_size, link_edges(), msgStr, nalloc(), procnum, quick_look(), readMap(), s0, s1, T, usrErr(), WriteMsg(), point2D::x, and point2D::y.

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;
}

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 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:

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:

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 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 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().

Referenced by setup().

                        {
  
  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 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 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.

References broadcastInt(), debug, Exit(), gbl_size, Lprocnum, modelFileName, ModelPath, msgStr, ProjName, s0, s1, scan_forward(), usrErr(), and WriteMsg().

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];
}

Here is the call graph for this function:

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.

References numBasn, s0, s1, and T.

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 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 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 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_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;
}

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 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:

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;
}

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.

References broadcastInt(), debug, Exit(), gNPtTs, gTS, H_OPSYS, Lprocnum, modelFileName, ModelPath, msgStr, ProjName, PTSL_AddpTSeries(), UNIX, usrErr(), and WriteMsg().

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;
} 

Here is the call graph for this function:

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.

References ON_MAP, PTSL_GetInterpolatedValue0(), s0, s1, and T.

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;
  }
}

Here is the call graph for this function:

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:

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 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_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:

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 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;
}

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;
}

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 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 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 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);              
}

void WriteMsg	(	const char *	msg,
		int	wh
	)

Send a message to a debug file or to the console.

Depending on when this function is called, messages are sent to one of two debug-related files, or to the console. During initial model set-up, the first (Driver0.out) debug-info file is used to print confirmation information on items such as init/end dates of simulation, the model parameter values that were read, etc. During later access to this function while the model is iterating, the second (Driver1.out) file is opened and accessed here, followed by the X'th for multi-run sensitivity analyses.

Parameters:

	msg	A string message for printing
	wh	Unused

Definition at line 1519 of file Driver_Utilities.c.

References Driver_outfile.

Referenced by cell_dyn1(), cell_dyn12(), cell_dyn2(), cell_dyn7(), cell_dyn8(), cell_dyn9(), Combine(), flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), Flux_GWcells(), Flux_SWstuff(), FluxChannel(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), get_Nth_parm(), get_parmf(), HabSwitch_Init(), main(), make_more_points(), print_point(), PTS_SetFields(), PTSL_ReadLists(), read_map_dims(), read_map_file(), read_model_parameters(), Read_schedule(), ReadModExperimParms(), readOutlist(), ReadStructures(), readViewParms(), SensiParm_list(), setup_grid(), write_map_file(), and write_output().

                                       {
  wh = 1;
  if(Driver_outfile) fprintf(Driver_outfile,"%s\n",msg);
  else fprintf(stdout,"%s\n",msg);
  fflush(stdout);
}

void usrErr0

(

const char *

dString

)

Send a message to the console.

The message text is not followed by a line feed.

Parameters:

dString

A string message to print

Definition at line 1530 of file Driver_Utilities.c.

Referenced by alloc_mem_stats(), alloc_memory(), horizFlow(), init_dynam_data(), init_eqns(), init_static_data(), main(), PtInterp_read(), rain_data_wmm(), read_model_parameters(), ReadModExperimParms(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), reinitBIR(), and reinitCanals().

{
  fprintf(stderr,"%s", dString); 
  fflush(stderr);
}

void usrErr

(

const char *

dString

)

Send a message to the console.

The message text is followed by a line feed.

Parameters:

dString

A string message to print

Definition at line 1540 of file Driver_Utilities.c.

Referenced by alloc_mem_runs(), alloc_memory(), BIRinit(), Canal_Network_Init(), cell_dyn9(), evap_data_wmm(), flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), get_Nth_parm(), get_parmf(), getCombineIndex(), HabSwitch_Init(), init_canals(), init_dynam_data(), init_eqns(), init_static_data(), local_setup(), main(), match_Sparm(), print_point(), PtInterp_read(), PTSL_ReadLists(), rain_data_wmm(), read_map_dims(), read_map_file(), read_model_parameters(), Read_schedule(), ReadChanStruct(), ReadModExperimParms(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), ReadStructures(), readViewParms(), reinitBIR(), reinitCanals(), SensiParm_list(), set_env_vars(), setup_platform(), and stage_data_wmm().

{
  fprintf(stderr,"%s\n", dString); 
  fflush(stderr);
}

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 fatal

(

const char *

msg

)

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

Definition at line 1551 of file Driver_Utilities.c.

References Exit().

Referenced by goto_index(), and print_point().

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

Here is the call graph for this function:

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.

Referenced by get_parmf(), readSeriesCol(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), and ReadStructTS_PtSer().

{
  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);
}

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.

Referenced by send_point_lists2(), and track_time().

{
  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;
}

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.

Referenced by cell_dyn1(), CellAvg(), Flows_in_Structures(), gen_output(), init_eqns(), main(), and Run_Canal_Network().

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

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().

Referenced by get_parmf().

{
  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 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.

References scan_forward().

{
  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);
}

Here is the call graph for this function:

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().

Referenced by get_parmf().

{
  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 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.

References scan_forward().

Referenced by get_parmf().

{
  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);
}

Here is the call graph for this function:

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* 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.

References EOS.

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;
}

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.

Referenced by get_parmf(), and init_config_file().

{
  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.

Referenced by get_global_parm(), get_modexperim_parm(), get_parmf(), getChar(), getFloat(), getInt(), getString(), read_header(), read_map_dims(), and readSeriesCol().

{
  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);
}

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;  
}

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.

References Exit(), fasync(), fmulti(), total_memory, and VOIDP.

Referenced by alloc_hab_hist(), alloc_mem_stats(), alloc_memory(), Canal_Network_Init(), Channel_configure(), initDataStruct(), read_map_file(), readSeriesCol(), ReadStructFlow_PtSer(), readViewParms(), setup_grid(), and write_map_file().

{
  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);
}

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:

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:

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().

Referenced by setup().

                      {
 
  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: