generic_driver.h File Reference

Header file for Generic Driver. More...

#include "globals.h"

Include dependency graph for generic_driver.h:

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

Go to the source code of this file.

Defines
#define	numRunSets   150
Functions
void	get_parmf ()
	Get user's run-time parameters from configuration file.
void	setup ()
	Controller to call functions to set up & initialize the model.
void	track_time (int istep)
	Keep track of simulation time.
int	PTSL_test ()
	Test for presence of point-time series meteorological data.
int	ModExperim_test ()
	Test for presence of special parameter file for model experiments.
ViewParm *	read_output_parms (void)
	Call the read_output_parms function.
void	read_model_parameters (char *s_parm_name, int s_parm_relval)
	Call functions to read model parameters from datafiles.
void	getInt (FILE *inFile, const char *lString, int *iValPtr)
	Get an integer following a specific string.
void	getFloat (FILE *inFile, const char *lString, float *fValPtr)
	Get a float value following a specific string.
void	getString (FILE *inFile, const char *lString, char *inString)
	Get a string following a specific string.
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.
void	setup_platform ()
	Effectively unused in serial (non-parallel) implementation.
void	set_env_vars (void)
	Acquire necessary environment variables.
void	setup_grid ()
	Provide the 2D array size for the model domain.
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.
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	local_setup (int argc, char **argv)
	Does very little in serial implementation (opens a low-level debug file).
void	open_debug_outFile (int index)
	Open debug-related output files.
void	broadcastInt (int *iValPtr)
	Parallel code: does nothing in serial implementation).
void	sync_processors ()
	Parallel code: does nothing in serial implementation).
void	send_point_lists2 (SeriesParm *pSeries, int nSeries)
	Point time series output: print time series data to file(s).
void	open_point_lists (SeriesParm *pSeries, int nSeries)
	Point time series output: open files and print headers.
void	init_static_data (void)
	Initialize static spatial data.
void	init_dynam_data (void)
	Initialize dynamic spatial data.
void	init_eqns (void)
	Initialization of the model equations.
void	init_canals (int runNumb)
	Call to initialize the water managment canal network topology and data.
void	init_succession (void)
	Call to initialize the habitat succession module.
void	PtInterp_read (void)
	On-the-fly interpolations to develop spatial time series from point data. .
void	reinitBIR (void)
	Calls to re-initialize Basin/Indicator-Region data.
void	reinitCanals (void)
	Call to re-initialize canal storages.
void	alloc_memory ()
	Allocate memory.
void	gen_output (int step, ViewParm *view)
	Generate output.
void	get_map_dims (void)
	Get the map dimensions of the global model array.
int	call_cell_dyn (int sector, int step)
	Calling function for the cell_dyn** dynamic ecological modules.
Variables
int	NSector
int	iSector [MAX_SECTOR]
int	seed
int	ESPmodeON = 0
int	WatMgmtOn
int	HabSwitchOn
int	PositAnalOn = 0
int	IsSubstituteModel = 0
char	SimAlt [30]
char	SimModif [30]
char	outpath [120]
int	gbl_size [2]
char	initDateRead [15]
double	Jdate_init
double	Jdate_end
int	yr_in
int	mo_in
int	da_in
int	hr_in
int	mi_in
int	se_in
int	yr_end
int	mo_end
int	da_end
int	mo_R_in
int	da_R_in
int	PORnumday
int	N_iter
int	istep
float	step_Cell
float	avg_Intvl = 0
float	budg_Intvl = 0
float	BIRavg_Intvl = 0
float	BIRhyd_avg_Intvl = 0
float	can_Intvl = 0
int	budgCalendar
int	BIRhydCalendar
int	avgCalendar = 0
int	canalCalendar = 0
int	avgPrint = 0
int	canPrint = 0
ProgAttr *	ProgExec
ProgAttr **	RunList
float	gRTable []
ViewParm *	view
SeriesParm	pSeries [MAX_PTSERIES]
Point2D	dbgPt
struct nodenv	env
int	procnum
int	Lprocnum
int	nprocs [2]
int	recpnum [2]
int	tramType
int	tramNum [2]
int	lcl_size [2]
int	lcl_start [2]
char *	ModelPath
char *	ProjName
char *	OS_TYPE
char *	OutputPath
char	modelName [20]
char	modelVers [10]

---

Detailed Description

Header file for Generic Driver.

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

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

The Everglades Landscape Model (ELM).
last updated: Oct 2006

Definition in file generic_driver.h.

---

Define Documentation

#define numRunSets   150

Definition at line 84 of file generic_driver.h.

---

Function Documentation

void get_parmf

(

)

Get user's run-time parameters from configuration file.

This is where the application is set up by the user's edits to the Driver.parm text configuration file, providing the simulation start and end dates, grid cell size, debug level, model scenario name, etc.

Variables local to function

stop boolean flag to stop reading sector (celldyn module) numbers
ch character used in delineating the reading of sector (celldyn module) numbers/syntax
infile an input file pointer representing the Driver.parm file
filename the filename, including path, of the Driver.parm file
ss a string being parsed to read model configuration information from the Driver.parm file
Re_initDateRead data of simulation re-initialization (Position Analysis mode)
endDateRead date of end of simulation

Definition at line 288 of file Generic_Driver.c.

References alloc_mem_runs(), avg_Intvl, avgCalendar, BIRhyd_avg_Intvl, BIRhydCalendar, broadcastInt(), budg_Intvl, budgCalendar, can_Intvl, canalCalendar, canstep, CELL_SIZE, celWid, da_end, da_in, da_R_in, seriesParm::data, dbgPt, debug, dt, ESPmodeON, False, getFloat(), getInt(), getString(), gwstep, HabSwitchOn, hr_in, hyd_iter, initDateRead, iSector, Jdate_end, Jdate_init, julday(), MAX_PTSERIES, mi_in, mo_end, mo_in, mo_R_in, modelName, ModelPath, modelVers, msgStr, N_iter, NSector, open_debug_outFile(), outpath, OutputPath, PORnumday, PositAnalOn, procnum, ProgExec, ProjName, pSeries, RunList, prog_attr::S_ParmName, prog_attr::S_ParmRelVal, scan_forward(), se_in, sec_per_day, seed, SensiOn, sfstep, SimAlt, SimModif, skip_white(), sq_celWid, step_Cell, True, usrErr(), WatMgmtOn, WriteMsg(), point2D::x, point2D::y, yr_end, and yr_in.

Referenced by setup().

{
    int i=0, stop=0;
    unsigned char ch;
    FILE *infile;
    char filename[120], ss[120]; 
        char Re_initDateRead[15], endDateRead[15]; 
        int SParmNum_TEMP = 150; /* TODO: will get this from reading the senitivity-parameter list */
        
    sprintf(filename,"%s/%s/RunParms/Driver.parm",ModelPath,ProjName);
    infile = fopen(filename,"r");
    if(infile==NULL) { fprintf(stderr,"Error, can't open file %s",filename); exit(0); }

     
    fgets(ss,120,infile);
    sscanf(ss,"%s",outpath);    
    OutputPath = (char*)&outpath; /* path for all output */
    open_debug_outFile(0); /* opens the Driver0.out debug file */

    /* start date  */
    fgets(ss,120,infile);
    sscanf(ss,"%s",initDateRead); /* read in as yyyy/mm/dd format */

    sprintf(msgStr,"initDateRead=%s\n",initDateRead); WriteMsg(msgStr,1); 
    sscanf(initDateRead, "%4d/%2d/%2d,",&yr_in,&mo_in,&da_in); /* starting date of sim */

    /* julian day, returns a double (args = month, day, year, hour, minute, second) */
    Jdate_init = julday(mo_in, da_in, yr_in, hr_in, mi_in, se_in); 


     /* end date  */
    fgets(ss,120,infile);
    sscanf(ss,"%s",endDateRead); /* read in as yyyy/mm/dd format */

    sprintf(msgStr,"endDateRead=%s\n",endDateRead); WriteMsg(msgStr,1); 
    sscanf(endDateRead, "%4d/%2d/%2d,",&yr_end,&mo_end,&da_end); /* ending date of sim */
 
        /* julian day, returns a double (args = month, day, year, hour, minute, second) */
    Jdate_end = julday(mo_end, da_end, yr_end, hr_in, mi_in, se_in); 

    /* re-initialization date  */
    fgets(ss,120,infile);
    sscanf(ss,"%s",Re_initDateRead); /* read in as mm/dd format */

    sprintf(msgStr,"Re_initDateRead=%s\n",Re_initDateRead); WriteMsg(msgStr,1); 
    sscanf(Re_initDateRead, "%2d/%2d,",&mo_R_in,&da_R_in); /* re-initialize month/day */

    if (mo_R_in>0) {
        PositAnalOn=True;   /* in position analysis mode, we re-initialize every year on same month/day */
        sprintf(msgStr,"\n *** WARNING: Position Analysis capabilities are NOT VERIFIED FOR accuracy/consistency in ELMv2.3 - the Avg's, Basin/Indicator-Region output may not be reliable ***\n"); 
        WriteMsg(msgStr,1); 
        usrErr(msgStr); 
        }       /* TODO: fix the budget/stats re-inits for Position Analysis mode */ 

    fgets(ss,120,infile);
    sscanf(ss,"%s",modelName);    
    sprintf(msgStr, "Model Name= %s", modelName); usrErr(msgStr); WriteMsg(msgStr,1);
    getString(infile,"Model version=",modelVers); /* model version number (eg., v.2.1) */
    sprintf(msgStr,"Model version=%s\n",modelVers); WriteMsg(msgStr,1);  

    getFloat(infile,"CellArea=",&CELL_SIZE);
    sprintf(msgStr,"CellArea=%f\n",CELL_SIZE); WriteMsg(msgStr,1); 
    celWid = sqrt(CELL_SIZE); /* cell width, used in number of hydro calcs */
    sq_celWid = sqrt(celWid); /* square root of cell width, used in number of hydro calcs */
    

    getFloat(infile,"budg_Intvl=",&budg_Intvl);
    sprintf(msgStr,"budg_Intvl=%f\n",budg_Intvl); WriteMsg(msgStr,1); 
    budgCalendar = ( budg_Intvl == 0.0 ) ? (True) : (False); /* true/false flag signifying use of gregorian calendar for budget calcs
                                                                                a budg_Intvl of 0 days defaults to gregorian calendar-month
                                                                                intervals ( = #days/month, diff among months/years) 
                                                                                In this case, the true/false budgCalendar flag is set to True */

    getFloat(infile,"BIRhyd_avg_Intvl=",&BIRhyd_avg_Intvl);
    sprintf(msgStr,"BIRhyd_avg_Intvl=%f\n",BIRhyd_avg_Intvl); WriteMsg(msgStr,1); 
    BIRhydCalendar = ( BIRhyd_avg_Intvl == 0.0 ) ? (True) : (False); /* true/false flag signifying use of gregorian calendar for BIR hydro calcs
                                                                                a BIRhyd_avg_Intvl of 0 days defaults to gregorian calendar-month
                                                                                intervals ( = #days/month, diff among months/years) 
                                                                                In this case, the true/false budgCalendar flag is set to True */

    getFloat(infile,"avg_Intvl=",&avg_Intvl);
    sprintf(msgStr,"avg_Intvl=%f\n",avg_Intvl); WriteMsg(msgStr,1); 
    if ( avg_Intvl == 0 ) avgCalendar = True; /* true/false flag signifying use of gregorian calendar for recurring averaging calcs
                                                                                an avg_Intvl of 0 days defaults to gregorian calendar-month
                                                                                intervals ( = #days/month, diff among months/years) 
                                                                                In this case, the true/false avgCalendar flag is set to True */

    getFloat(infile,"can_Intvl=",&can_Intvl);
    sprintf(msgStr,"can_Intvl=%f\n",can_Intvl); WriteMsg(msgStr,1); 
    if ( can_Intvl == 0 ) canalCalendar = True; /* true/false flag signifying use of gregorian calendar for recurring canal (watmanage) calcs
                                                                                a can_Intvl of 0 days defaults to gregorian calendar-month
                                                                                intervals ( = #days/month, diff among months/years) 
                                                                                In this case, the true/false can_Intvl flag is set to True */

    getInt(infile,"seed=",&seed);
    sprintf(msgStr,"seed=%d\n",seed); WriteMsg(msgStr,1);  
    getFloat(infile,"dt=",&dt);
    sprintf(msgStr,"dt=%f\n",(double)dt); WriteMsg(msgStr,1);  
    getInt(infile,"hyd_iter=",&hyd_iter); 
    sprintf(msgStr,"hyd_iter=%d\n",hyd_iter); WriteMsg(msgStr,1); 

    sfstep = dt/hyd_iter;     /* time step for cell-cell overland flows */
    gwstep = dt/(hyd_iter/2); /* time step for cell-cell ground water flows (twice as long as surface water)*/
    canstep = dt/hyd_iter;             /* time step for canal flows */
    step_Cell = sq_celWid * sfstep/CELL_SIZE * sec_per_day; /* constant used in horizontal surface water raster flux equations */

    N_iter= (Jdate_end - Jdate_init + 1)/dt;
        sprintf(msgStr,"N_iter=%d\n",N_iter); WriteMsg(msgStr,1); 
    PORnumday = (int)(Jdate_end - Jdate_init + 1);   /* number of days of simulation Period Of Record */

    getInt(infile,"debug=",&debug);
    sprintf(msgStr,"debug=%d\n",debug); WriteMsg(msgStr,1);  
    getInt(infile,"debug_point=",&dbgPt.x);
    getInt(infile,NULL,&dbgPt.y);
    sprintf(msgStr,"debug point= (%d,%d)\n",dbgPt.x,dbgPt.y); WriteMsg(msgStr,1);  
        
        alloc_mem_runs(SParmNum_TEMP);
        RunList[0] = ProgExec; /* nominal parameter set */
        
    getString(infile,"S_ParmName=",ProgExec->S_ParmName); /* value can be: 
                                        1) "NONE", for no sensitivity analysis (nominal parameter set);
                                        2) the name of a global or habitat-specific parameter for a single-parm sensitivity analysis; 
                                        3) "ALL", leading to multi-parameter sensitivity analyses on 
                                           all parameters, to be read from an input list */
    sprintf(msgStr,"S_ParmName=%s\n",ProgExec->S_ParmName); WriteMsg(msgStr,1); 

    SensiOn = (strcmp(ProgExec->S_ParmName,"NONE")!=0) ? (True) : (False);
    ProgExec->S_ParmRelVal = 0; /* first run of program is ALWAYS the nominal (no parameter-changes) run */

        getInt(infile,"HabSwitchOn=",&HabSwitchOn); /* flag to turn on habitat switching */
    sprintf(msgStr,"HabSwitchOn=%d\n",HabSwitchOn); WriteMsg(msgStr,1); 
    getInt(infile,"WatMgmtOn=",&WatMgmtOn); /* flag to turn on canal/water management */
    sprintf(msgStr,"WatMgmtOn=%d\n",WatMgmtOn); WriteMsg(msgStr,1); 

    getString(infile,"Scenario=",SimAlt); /* simulation's scenario/alternative */
    sprintf(msgStr,"SimAlt=%s\n",SimAlt); WriteMsg(msgStr,1);  
    getString(infile,"Scenario modifier=",SimModif); /* simulation's scenario/alternative & modifier */
    sprintf(msgStr,"SimModif=%s\n",SimModif); WriteMsg(msgStr,1); 

        scan_forward(infile,"Sectors="); i=0; stop=0;
        while(1) {
            skip_white(infile);
            ch=fgetc(infile);
            if( isdigit(ch) ) ungetc(ch,infile);
            else {
                switch (ch) {
                    case ';':  NSector = i; stop=1; break;
                    case ',':  skip_white(infile); break;
                }
            }
            if(stop) break;
            else fscanf(infile,"%d",&iSector[i++]);
                /* sector 13 is the ESP (Everglades Settling-of Phosphorus, i.e., EWQModel emulation) mode - this sets the ESPmodeON flag*/
            if (iSector[i-1] == 13) ESPmodeON=1;
            
        }
        fclose(infile);  
    broadcastInt(&NSector);
    sprintf(msgStr,"\n(%d) NSector = %d: Sectors=",procnum,NSector); WriteMsg(msgStr,1); 
    for(i=0; i<NSector; i++) {
        broadcastInt(&iSector[i]);
        sprintf(msgStr,"(%d:%d)",i,iSector[i]); WriteMsg(msgStr,1);  
    }

    for(i=0; i<MAX_PTSERIES; i++) if(pSeries[i].data) { free((char*)pSeries[i].data);  pSeries[i].data = NULL; }
}

Here is the call graph for this function:

void setup

(

)

Controller to call functions to set up & initialize the model.

Several function calls here effectively do nothing in serial (i.e., non-parallel) implementations.

Definition at line 269 of file Generic_Driver.c.

References get_map_dims(), get_parmf(), MAX_PTSERIES, pSeries, set_env_vars(), setup_grid(), and setup_platform().

Referenced by main().

{
  int i;
  for(i=0; i<MAX_PTSERIES; i++)  pSeries[i].data = NULL; /* initialize Point Time Series arrays */
  setup_platform(); /* effectively unused in serial (non-parallel) implementation */
  set_env_vars();   /* get necessary enviroment variables */ 
  get_parmf();      /* get the run-time parameters  */ 
  get_map_dims();   /* get the row-column dimensions of the global model array size */
  setup_grid();     /* set up a grid size used in memory allocations (other stuff for parallel) */
}

Here is the call graph for this function:

void track_time

(

int

istep

)

Keep track of simulation time.

The elapsed days, the gregorian and julian calendars, and several end-of calendar- month, year etc flags are updated with each iteration.

Parameters:

istep

counter for number of model time iterations

Definition at line 473 of file Generic_Driver.c.

References avg_Intvl, avgCalendar, avgPrint, BIRavg_Intvl, BIRhyd_avg_Intvl, BIRhydCalendar, budg_Intvl, budgCalendar, calcdate(), can_Intvl, canalCalendar, canPrint, simTime::da, dryEndDay, dryEndMon, dt, False, simTime::hr, simTime::IsBIRavgEnd, simTime::IsBIRhydEnd, simTime::IsBudgEnd, simTime::IsBudgFirst, simTime::IsDay0, simTime::IsDrySeasEnd, simTime::IsMonthEnd, simTime::IsSimulationEnd, simTime::IsWetSeasEnd, simTime::IsYearEnd, simTime::Jdate, Jdate_init, simTime::mi, simTime::mo, N_iter, PORnumday, simTime::se, SensiOn, SimTime, simTime::TIME, True, wetEndDay, wetEndMon, and simTime::yr.

Referenced by main().

{
    int yr_tom[2];                      /* calendar year of tomorrow's model time */
    int mo_tom[2];                              /* calendar month of tomorrow's  model time */
    int da_tom[2];                              /* calendar day of tomorrow's  model time */
    int hr_tom[2];                              /* calendar hour of tomorrow's  model time (unused in model calcs) */
    int mi_tom[2];                              /* calendar minute of tomorrow's  model time (unused in model calcs) */
    double se_tom[2];                   /* calendar second of tomorrow's  model time (unused in model calcs) */
     
    SimTime.TIME = istep*dt;
    SimTime.Jdate = Jdate_init+SimTime.TIME; /*  increment the julian day counter */
        
        /* use calendar functions to determine the end-of status of today's date */
        calcdate( (SimTime.Jdate+1), mo_tom, da_tom, yr_tom, hr_tom, mi_tom, se_tom); /* for TOMORROW, get the calendar date info from the julian date */
        calcdate( SimTime.Jdate, SimTime.mo, SimTime.da, SimTime.yr, SimTime.hr, SimTime.mi, SimTime.se); /* for TODAY, get the calendar date info from the julian date */

                SimTime.IsMonthEnd = ( SimTime.mo[0] != mo_tom[0] ) ? (True) : (False); /* true/false flag signifying end of a gregorian calendar month */
                SimTime.IsYearEnd =  ( SimTime.yr[0] != yr_tom[0] ) ? (True)  : (False); /* true/false flag signifying end of a gregorian calendar year */
                SimTime.IsWetSeasEnd = (( SimTime.mo[0] == wetEndMon ) && (SimTime.da[0] == wetEndDay))  ? (True) : (False); /* true/false flag signifying end of a gregorian calendar-based wet season */
                SimTime.IsDrySeasEnd = (( SimTime.mo[0] == dryEndMon ) && (SimTime.da[0] == dryEndDay))  ? (True) : (False); /* true/false flag signifying end of a gregorian calendar-based dry season */
                SimTime.IsSimulationEnd = ((PORnumday-1)==istep) ? (True) : (False);

        /* determine status of budget calc/printing flag (interval based on gregorian calendar or constant julian-day) */
        if (!budgCalendar) { 
                if ( fmod(SimTime.TIME, budg_Intvl) ==0) {
                /* not using gregorian calendar: at end of (constant) number of days, model time is end of budget interval */
                        SimTime.IsBudgEnd = True; 
                } 
                else { SimTime.IsBudgEnd = False; }
        }
        else {
                if ( SimTime.IsMonthEnd ) {
                /* using gregorian calendar: at calendar-month's end, model time is end of budget interval */
                        SimTime.IsBudgEnd = True; 
                        budg_Intvl= (float)SimTime.da[0]; /* dynamic interval becomes number of days in current gregorian-calendar month */
                } 
                else { SimTime.IsBudgEnd = False; }
        }

        /* v2.8  determine status of BIR hydro calc/printing flag (interval based on gregorian calendar or constant julian-day) */
        if (!BIRhydCalendar) { 
                if ( fmod(SimTime.TIME, BIRhyd_avg_Intvl) ==0) {
                /* not using gregorian calendar: at end of (constant) number of days, model time is end of budget interval */
                        SimTime.IsBIRhydEnd = True; 
                } 
                else { SimTime.IsBIRhydEnd = False; }
        }
        else {
                if ( SimTime.IsMonthEnd ) {
                /* using gregorian calendar: at calendar-month's end, model time is end of budget interval */
                        SimTime.IsBIRhydEnd = True; 
                        BIRhyd_avg_Intvl = (float)SimTime.da[0]; /* dynamic interval becomes number of days in current gregorian-calendar month */
                } 
                else { SimTime.IsBIRhydEnd = False; }
        }

        /* determine status of cell-specific averages calc/printing flag (interval based on gregorian calendar or constant julian-day) */
        if (!avgCalendar) {
                if ( fmod(SimTime.TIME, avg_Intvl) ==0) {
                /* not using gregorian calendar: check for time (day) to finalize and print budgets for current interval */
                        avgPrint = True; }
                else { avgPrint = False; }
        }
        else { 
                if ( SimTime.IsMonthEnd ) {
                /* using gregorian calendar: at month's end, it is time (day) to finalize and print budgets for current interval */
                        avgPrint = True;
                        avg_Intvl= (float)SimTime.da[0]; /* interval becomes number of days in current gregorian-calendar month */
                }
                else { avgPrint = False; }
        }

        /* determine status of canal data calc/printing flag (interval based on gregorian calendar or constant julian-day) */
        if (!canalCalendar) {
                if ( fmod(SimTime.TIME, can_Intvl) ==0) {
                /* not using gregorian calendar: check for time (day) to finalize and print canal data for current interval */
                        canPrint = True; }
                else { canPrint = False; }
        }
        else { 
                if ( SimTime.IsMonthEnd ) {
                /* using gregorian calendar: at month's end, it is time (day) to finalize and print canal data for current interval */
                        canPrint = True;
                        can_Intvl= (float)SimTime.da[0]; /* interval becomes number of days in current gregorian-calendar month */
                }
                else { canPrint = False; }
        }
        
        SimTime.IsBudgFirst = ( (SimTime.TIME/budg_Intvl) > 1 ) ? (False) : (True);
        SimTime.IsDay0 = (SimTime.TIME==0) ? (True) : (False);
        
        /* TODO: this is to be generalized in MultiRun.c */
        if (SensiOn) {
           BIRavg_Intvl = N_iter - 1;
           SimTime.IsBIRavgEnd = ( fmod(SimTime.TIME, BIRavg_Intvl) ==0) ? (True) : (False);
           
           BIRhyd_avg_Intvl = N_iter - 1;
           SimTime.IsBIRhydEnd = ( fmod(SimTime.TIME, BIRhyd_avg_Intvl) ==0) ? (True) : (False);
           
           budg_Intvl = N_iter - 1;
           SimTime.IsBudgEnd = ( fmod(SimTime.TIME, budg_Intvl) ==0) ? (True) : (False);
        }
        else {
           BIRavg_Intvl = budg_Intvl;
           SimTime.IsBIRavgEnd = SimTime.IsBudgEnd;
        }

}

Here is the call graph for this function:

int PTSL_test

(

)

Test for presence of point-time series meteorological data.

Most ELM applications, and particularly the regional applications, input the binary "gridIO" spatial time series data for rain and potential ET. For some fine- scaled applications, the gridIO data may be too coarse, or there may be a desire for longer simulation periods than available in the gridIO data. In those cases, if the data file named "rain.pts" (which defines the grid locations of associated time series data) exists in the application's Data directory, the simulation will attempt to use those point data for generating rainfall maps on the fly. If that is true, the "pET.pts" will also be assumed to exist (to generate potential ET maps on the fly). Finally, for these applications that generate interpolated meteorological maps on the fly, we currently (v2.6) do not use the gridIO data output from the SFWMM for depths along the ELM domain border. A more flexible data-approach may be encoded if/when needed in the future.

New function in v2.6

Definition at line 599 of file Generic_Driver.c.

References ModelPath, and ProjName.

Referenced by main().

{
    FILE *testfile;
    char filename[120], ss[120]; 
        
    sprintf(filename,"%s/%s/Data/rain.pts",ModelPath,ProjName);
    testfile = fopen(filename,"r");
    if(testfile==NULL) 
        return 0; /* the point data file does not exist, will use gridIO data */
    else
        { fclose(testfile); return 1; } /* the point data file exists, will use on-the-fly interpolations of point data */
}

int ModExperim_test

(

)

Test for presence of special parameter file for model experiments.

Most ELM applications, and particularly the regional applications, use the standard (GlobalParms and HabParms) parameter files. In special model research experiments, another parameter file may be used for specific questions. In v2.6, this is only used to modify stage/depth boundary conditions for fine-scale, long-term subregional applications.

New function in v2.6

Definition at line 622 of file Generic_Driver.c.

References ModelPath, and ProjName.

Referenced by main().

{
    FILE *testfile;
    char filename[120], ss[120]; 
        
    sprintf(filename,"%s/%s/Data/ModExperimParms_NOM",ModelPath,ProjName);
    testfile = fopen(filename,"r");
    if(testfile==NULL) 
        return 0; /* the point data file does not exist, will not use any special parameters */
    else
        { fclose(testfile); return 1; } /* the model experiment parameter file exists, will use special parameters */
}

ViewParm* read_output_parms

(

)

Call the read_output_parms function.

Returns:

pointer to struct of ViewParm

Definition at line 66 of file Driver_Utilities.c.

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

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.

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

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.

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

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.

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

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.

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

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

void setup_platform

(

)

Effectively unused in serial (non-parallel) implementation.

Definition at line 1937 of file Driver_Utilities.c.

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

void set_env_vars

(

void

)

Acquire necessary environment variables.

Definition at line 900 of file Driver_Utilities.c.

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

void setup_grid

(

)

Provide the 2D array size for the model domain.

Definition at line 392 of file Driver_Utilities.c.

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

}

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

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

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 local_setup	(	int	argc,
		char **	argv
	)

Does very little in serial implementation (opens a low-level debug file).

Primarily intended for parallel apps:
establish processor attributes, open a low-level debug file (in the user's current directory, set by the model execution script ("go"), and seed the pseudo-random number.

Parameters:

	argc	number of command line arguments
	argv	command line argument

Returns:

void

Definition at line 1403 of file Serial.c.

Referenced by main().

{
  int i;
  char debugfileName[300];
  nprocs[0] = 1;
  nprocs[1] = 1;
  tramType =  0;
  procnum = 1;
  recpnum[0] = 0;
  recpnum[1] = 0;
  Lprocnum = 1;
  /* the combo_table (ctable) used in Combine operation for spatial array summaries (debug-related) */ 
  max_combos_open = 0;  
  for(i = 0; i < MAXCOMBOS; i++) {
    ctable[i].ocnt = 0; 
    ctable[i].free = 1;
  }

  /* this debug output file is not used extensively in current code - it is opened before we get
     environment vars, thus is written to user's current directory ($ModelPath/$ProjName/Load if
     ELM is executed from the "go" script) */ 
 dFile = fopen("ELM.debug","w");
  if(dFile == NULL) { 
    usrErr("Can't open ELM.debug file."); 
    exit(0); 
  } 
  /* there are no random processes in current ELM (v2.4) w/o fire */ 
  srand(seed);
  fprintf(dFile," RAND_MAX = %d\n",(int)RAND_MAX);
}

void open_debug_outFile

(

int

index

)

Open debug-related output files.

The Driver0.out and Driver1.out are two output files with debug and/or standard error-warning information. They are always produced, but have varying levels of detail (esp. Driver1.out) depending on the user-selected (at run-time) level of the "debug" variable. Driver0.out basically provides initial, static information on data and setup of the model. Driver1.out provides dynamic information on the simulation. In sensitivity analysis mode, subsequent Driver2.out, Driver3.out, etc provide dynamic information on each new simulation.

Parameters:

index

Index to indicate file name w/ "0", "1", and subsequent runs under a sensitivity analysis

Definition at line 1172 of file Serial.c.

Referenced by get_parmf(), and main().

{
  char filename[120];
  
  sprintf(filename,"%s/%s/Output/Debug/Driver%d.out",OutputPath,ProjName,index);

  Driver_outfile = fopen(filename,"w");
  if(Driver_outfile == NULL) { 
        fprintf(stderr,"Error, unable to open %s file.\n",filename);
        fprintf(stderr,"OutputPath: %s\n",OutputPath);  
        fprintf(stderr,"Project: %s\n",ProjName);  
        exit(0); 
  }

}

void broadcastInt

(

int *

iValPtr

)

Parallel code: does nothing in serial implementation).

Definition at line 1512 of file Serial.c.

Referenced by get_parmf(), PTSL_ReadLists(), and read_map_dims().

{}

void sync_processors

(

)

Parallel code: does nothing in serial implementation).

Definition at line 1524 of file Serial.c.

Referenced by main().

{return;}

void send_point_lists2	(	SeriesParm *	pSeries,
		int	nSeries
	)

Point time series output: print time series data to file(s).

open_point_lists Has documentation relevant to this function

Parameters:

	pSeries	A struct of the variables to have point time series output
	nSeries	Number of point time series occurances

Definition at line 924 of file Serial.c.

Referenced by main().

{
  FILE *oFile;
  int i=0, ii, j, ix, iy, k= 0, last_pt;
  int yr_pt[2],mo_pt[2],da_pt[2],hr_pt[2],mi_pt[2];    
  double se_pt[2];           
  double Jdate_pt;
  
  if (numPtFiles==0) return;
  /* k = file/variable counter; i = indiv cellLoc time series counter */
  for (k = 0; k <= numPtFiles; k++) { /* loop over the number of point ts files */
      sprintf(msgStr,"%s%s/Output/PtSer/%s.pts",OutputPath,ProjName,pSeries[i].name);
      if( (oFile = fopen(msgStr,"a") ) == NULL) { 
          fprintf(stderr,"\nERROR, unable to open %s point time series output file.",msgStr); 
          exit(-1); 
      }

      for(j=pSeries[i].laststep; j<pSeries[i].Length; j++ ) { /*temporal loop */
          Jdate_pt = Jdate_init+j*pSeries[i].outstep;
          calcdate( Jdate_pt, mo_pt, da_pt, yr_pt, hr_pt, mi_pt, se_pt); /* get the calendar date info from the julian date */
          fprintf(oFile,"\n%d/%d/%d\t",yr_pt[0],mo_pt[0],da_pt[0] ); /* calendar date in col 1 */

          last_pt = i+cell_pts[k]; /* # of last cellLoc point of the current variable's file */
          for (ii=i; ii<last_pt; ii++) {/* loop over number of point locations per file */
              fprintf(oFile,"%f\t",pSeries[ii].data[j]);
          }
      }
      fclose (oFile); 
      pSeries[i].laststep = j; /* remember the last temporal outstep for this file */
      i += cell_pts[k];     /* increment the indiv cellLoc time series counter */ 
  }
  return;
}

void open_point_lists	(	SeriesParm *	pSeries,
		int	nSeries
	)

Point time series output: open files and print headers.

Provides for multi-column (locations), multi-file (model variables)format of point time series. The user can define (via Model.outList commands), for any variable in the model, one or more cell (point) locations for which point time series data are written. There can be multiple point TS each for different variables. Thus, we make a separate file for each variable (unknown until user chooses) that has multiple columns for multiple points (unknown until user chooses).

Parameters:

	pSeries	An array of SeriesParm structs for point time series output
	nSeries	Number of point time series occurances

Remarks:

A structure should/could be set up for this, but to maintain minimal changes between the parallel and serial versions of the code (ELMv1.0), for now we just maintain the original data structure and use some counters below to keep track of diff files and numbers of columns (also allowing different output steps as chosen by the user). (Note: The original SME code printed all variables in one column in one file).

Note:

TODO: this whole point-time-series output functionality needs improvement (not high priority, Jan 2005). One of the more important capabilities is to have ability to have irregular, calendar-month/year etc output intervals.

Definition at line 881 of file Serial.c.

Referenced by main().

{
  FILE *oFile;
  int i, j, ix, iy, k= 0 ;

  for (i=0; i<nSeries; i++) {
     if( pSeries[i].data == NULL ) {
        if ( numPtFiles>0 ) fclose(oFile); /* in (rare?) case where user asks for no point output, no files stream to close */
        return;
      }
      if (strcmp(pSeries[i].name,pSeries[i-1].name) != 0) {
              /* this is new variable, thus new file.  numPtFiles== increment counter of number of variables (one file per variable) used for output */
          if (i>0) { 
            numPtFiles++; 
            fclose (oFile); 
          }
          
          sprintf(msgStr,"%s%s/Output/PtSer/%s.pts",OutputPath,ProjName,pSeries[i].name);
          if( (oFile = fopen(msgStr,"w") ) == NULL) { 
              fprintf(stderr,"\nERROR, unable to open %s point time series output file.",msgStr); 
              exit(-1); 
          }
          fprintf (oFile, "%s %s %s %s scenario: \nDate\t", &modelName, &modelVers, &SimAlt, &SimModif);
          
      }
/* populate the grid cell locations in the header for this variable/file */
      ix = pSeries[i].Loc.x;
      iy = pSeries[i].Loc.y;
      fprintf(oFile,"%s:(%d,%d)\t",pSeries[i].name,ix,iy);
      cell_pts[numPtFiles]++; /* count the number of cell point locs per variable (1 var per file) */
      
  }
}

void init_static_data

(

void

)

Initialize static spatial data.

Definition at line 1710 of file UnitMod.c.

Referenced by main().

{
  usrErr0("Acquiring static spatial data..."); /* console message */
  
  read_map_file("ModArea",ON_MAP,'c',4.0,0.0);            /* defines model area, dimless unsigned char attributes, value 1 set to 4, 0=0 */
  read_map_file("BoundCond",BCondFlow,'d',1.0,0.0);       /* boundary condition flow restrictions, dimless integer attributes */
            /* ONLY when running the EWQM settling rate version of ELM */
  if (ESPmodeON) read_map_file("basinSetVel",WQMsettlVel,'f',0.0001,0.0);       /* basin-based settling rates (data in tenths mm/d, converted to m/d) */
  read_map_file("basins",basn,'d',1.0,0.0);               /* Basins/Indicator-Region map, dimless integer attributes  */

  alloc_mem_stats (); /* allocate memory for budget & stats arrays (need to have read the Basin/Indicator-Region map first) */
  BIRinit(); /* Set up the Basin/Indicator-Region (BIR) linkages/inheritances */
  BIRoutfiles(); /* Basin/Indicator-Region output files */
  
  usrErr("Done.");
} 

void init_dynam_data

(

void

)

Initialize dynamic spatial data.

Definition at line 1729 of file UnitMod.c.

Referenced by main().

{
  usrErr0("Acquiring dynamic spatial data..."); /* console message */
  
  read_map_file("Elevation",ELEVATION,'f',0.01,0.0);      /*  positive elevation relative to zero of vertical datum; input data in cm, converted to m; (prior to ELMv2.8, datum was always NGVD 1929; some apps in v2.8+ are in NAVD88; datum is independent of source code ) */
  read_map_file("HAB",HAB,'c',1.0,0.0);                   /* habitat (veg classifications, dimless unsigned char attributes) */
  read_map_file("icMacBio",MAC_TOT_BIOM,'f',0.015,0.0);      /* initial total biomass of macrophytes (data in xyz, converted to kg C/m2) */
  read_map_file("icSfWt",SURFACE_WAT,'f',0.01,0.0);       /* initial ponded surface water (data in cm, converted to m) */
  read_map_file("icUnsat",UNSAT_DEPTH,'f',0.01,0.0);      /* initial depth of unsaturated zone (data in cm, converted to m) */
  read_map_file("soilTP",TPtoSOIL,'f',0.000001,0.0);  /* soil TP map (data in mgP/kgSoil, converted to kgP/kgSoil) */
  read_map_file("soilBD",BulkD,'f',1.0,0.0);         /* soil bulk dens map (data in mgSoil/cm3 == kgSoil/m3)  */
  read_map_file("soil_orgBD",DOM_BD,'f',1.0,0.0);    /* organic soil bulk dens map (data in mgOM/cm3 == kgOM/m3)  */
  read_map_file("soilTPpore",TP_SEDWT_CONCACT,'f',0.000001,0.0);    /* porewater TP concentration map (data in ug/L, converted to g/L == kg/m3)  */
  read_map_file("AtmosPdepos",TP_AtmosDepos,'f',1.0,0.0);    /* rate of atmospheric deposition of total phosphorus (data in mgP/m^2/yr, convert units later with eqn inits)  */

  /* 2 static mapps need to be here for re-initialing w/ a multiplier (sensitivity analysis) */ 
  read_map_file("HydrCond",HYD_RCCONDUCT,'f',1.0,0.0);   /* hydraulic conductivity (no conversion, data in m/d)  */
  read_map_file("Bathymetry",Bathymetry,'f',0.01,0.0);      /* positive bathymetry (depth) relative to zero of vertical datum used in land elevation surveys (i.e., positive depth below NGVD29 or NAVD88); all positive depth data in cm, converted to m) */

  usrErr("Done."); /* console message */
} 

void init_eqns

(

void

)

Initialization of the model equations.

This calculates initial values of state variables, and which also provides constant values of pertinent flux equations if their corresponding cell_dyn module is not executed.

Definition at line 1757 of file UnitMod.c.

Referenced by main().

 {
int ix,iy, cellLoc;
float tmp; /* used in checking nutrient availability for MichMent kinetics */
float min_litTemp; /* used to determine min of temper, light cf's for alg and macs */
float I_ISat, Z_extinct, PO4Pconc, PO4P;
float MAC_PHtoNPH, MAC_PHtoNPH_Init;
double soil_propOrg; 
#define satDensity 0.9 /* assign the relative proportion (0 - 1) of a population maximum to be the saturation density for a population */

  usrErr0("Initializing unit model equations..."); /* console message */
  
  SimTime.TIME = 0;
  DAYJUL = ( FMOD(SimTime.TIME,365.0) >0.0 ) ? ( FMOD(SimTime.TIME,365.0) ) : ( 365.0);
  LATRAD = ((int)(GP_LATDEG)+(GP_LATDEG-(int)(GP_LATDEG))*5.0/3.0)*PI/180.0;
  /* AMPL = Exp(7.42+0.045*LATRAD*180.0/PI)/3600.0; */
  /* DAYLENGTH = AMPL*Sin((DAYJUL-79.0)*0.01721)+12.0; */
  SOLALPHA = 32.9835-64.884*(1.0-1.3614*Cos(LATRAD));
  SOLDEC1 = 0.39785*Sin(4.868961+0.017203*DAYJUL   +0.033446*Sin(6.224111+0.017202*DAYJUL));
  SOLCOSDEC = sqrt(1.0-pow(SOLDEC1,2.0));
  SOLELEV_SINE = Sin(LATRAD)*SOLDEC1+Cos(LATRAD)*SOLCOSDEC;
  SOLALTCORR = (1.0-Exp(-0.014*(GP_ALTIT-274.0)/(SOLELEV_SINE*274.0)));
  SOLBETA = 0.715-0.3183*(1.0-1.3614*Cos(LATRAD));
  SOLDEC = Arctan(SOLDEC1/sqrt(1.0-pow(SOLDEC1,2.0)));
  SOLRISSET_HA1 = -Tan(LATRAD)*Tan(SOLDEC);
  SOLRISSET_HA = ( (SOLRISSET_HA1==0.0) ) ? ( PI*0.5 ) : (   ( (SOLRISSET_HA1<0.0) ) ? ( PI+Arctan(sqrt(1.0-pow(SOLRISSET_HA1,2.0))/SOLRISSET_HA1)  ) : (      Arctan(sqrt(1.0-pow(SOLRISSET_HA1,2.0))/SOLRISSET_HA1)));
  SOLRADATMOS = 458.37*2.0*(1.0+0.033*Cos(360.0/365.0*PI/180.0*DAYJUL))* (Cos(LATRAD)*Cos(SOLDEC)*Sin(SOLRISSET_HA) + SOLRISSET_HA*180.0/(57.296*PI)*Sin(LATRAD)*Sin(SOLDEC));
        
        for(ix=0; ix<=s0+1; ix++) {
            for(iy=0; iy<=s1+1; iy++) { 
                  cellLoc = T(ix,iy);
                  
                  AIR_TEMP[cellLoc] = 25.0;  /* spatial time series unavailable after 1995; globally constant in v2.2+ */
/* rainfall read from sfwmm data, remapped to ELM resolution */
                  boundcond_rain[cellLoc] =  SF_WT_FROM_RAIN[cellLoc] = boundcond_ETp[cellLoc] = boundcond_depth[cellLoc] = 0.0;
       
                                /* used to have cloudiness influence on GP_SOLOMEGA, now 0 */
                 SOLRAD274[cellLoc] = SOLRADATMOS*(SOLBETA-GP_SOLOMEGA*0.0 )-SOLALPHA;
                 SOLRADGRD[cellLoc] = SOLRAD274[cellLoc]+((SOLRADATMOS+1.0)-SOLRAD274[cellLoc])*SOLALTCORR;
                 H2O_TEMP[cellLoc] = AIR_TEMP[cellLoc];
         
                 ALG_REFUGE[cellLoc] = HP_ALG_MAX[HAB[cellLoc]]*GP_ALG_REF_MULT;
                 ALG_SAT[cellLoc] = HP_ALG_MAX[HAB[cellLoc]]*0.9;

              /* v2.3: with southern everglades topo, put bathymetry back into the model */
                 ELEVATION[cellLoc] = ELEVATION[cellLoc] * GP_IC_ELEV_MULT;
                 Bathymetry[cellLoc] = Bathymetry[cellLoc] * GP_IC_BATHY_MULT;
                 SED_ELEV[cellLoc] =  ELEVATION[cellLoc] - Bathymetry[cellLoc] + GP_DATUM_DISTANCE; 
                 SED_INACT_Z[cellLoc] = SED_ELEV[cellLoc]-HP_DOM_MAXDEPTH[HAB[cellLoc]]; 

                 MAC_MAX_BIO[cellLoc] = HP_NPHBIO_MAX[HAB[cellLoc]]+HP_PHBIO_MAX[HAB[cellLoc]];
                 NPHBIO_REFUGE[cellLoc] = HP_NPHBIO_MAX[HAB[cellLoc]]*GP_MAC_REFUG_MULT;
                 NPHBIO_SAT[cellLoc] = HP_NPHBIO_MAX[HAB[cellLoc]] * satDensity;
                 PHBIO_REFUGE[cellLoc] = HP_PHBIO_MAX[HAB[cellLoc]]*GP_MAC_REFUG_MULT;
                 PHBIO_SAT[cellLoc] = HP_PHBIO_MAX[HAB[cellLoc]] * satDensity;
            }
        }
        for(ix=1; ix<s0+1; ix++) {
            for(iy=1; iy<s1+1; iy++) { cellLoc = T(ix,iy);
/*initialization of major state variables */

              /* hydro */
                 HYD_RCCONDUCT[cellLoc] = HYD_RCCONDUCT[cellLoc] * GP_calibGWat;

/* map */        UNSAT_DEPTH[cellLoc] = Max(UNSAT_DEPTH[cellLoc] + GP_HYD_IC_UNSAT_ADD,0.0); /* m */
                 SAT_WT_HEAD[cellLoc] = SED_ELEV[cellLoc]- UNSAT_DEPTH[cellLoc]; /* m */
                 SAT_WATER[cellLoc] = SAT_WT_HEAD[cellLoc] * HP_HYD_POROSITY[HAB[cellLoc]]; /* m */

                 UNSAT_WATER[cellLoc] = HP_HYD_POROSITY[HAB[cellLoc]]*UNSAT_DEPTH[cellLoc] *GP_HYD_ICUNSATMOIST; /* m */
                 UNSAT_CAP[cellLoc] = UNSAT_DEPTH[cellLoc]*HP_HYD_POROSITY[HAB[cellLoc]]; /* m */
                 UNSAT_MOIST_PRP[cellLoc]  =  /* dimless proportion, 0-1 */
                     ( UNSAT_CAP[cellLoc]>0.0 ) ? 
                     ( Min(UNSAT_WATER[cellLoc]/UNSAT_CAP[cellLoc],1.0) ) : 
                     ( 1.0); 

/* map */        SURFACE_WAT[cellLoc] =  Max(SURFACE_WAT[cellLoc] + GP_HYD_IC_SFWAT_ADD, 0.0); /* m */
                 SFWT_VOL[cellLoc] = SURFACE_WAT[cellLoc]*CELL_SIZE;

                 HYD_DOM_ACTWAT_VOL[cellLoc] = Max(HP_DOM_MAXDEPTH[HAB[cellLoc]]-UNSAT_DEPTH[cellLoc]*
                                                   (1.0-UNSAT_MOIST_PRP[cellLoc]),0.0)*HP_HYD_POROSITY[HAB[cellLoc]]*CELL_SIZE;
                 HYD_SED_WAT_VOL[cellLoc] = (SAT_WATER[cellLoc]+UNSAT_WATER[cellLoc])*CELL_SIZE;
                 
              /* soil */
/* map */        DOM_BD[cellLoc] = DOM_BD[cellLoc] * GP_IC_DOM_BD_MULT; /* kg/m3 */
/* map */        BulkD[cellLoc] = BulkD[cellLoc] * GP_IC_BulkD_MULT;    /* kgOM/m3 */

                 soil_propOrg = (double) DOM_BD[cellLoc] / BulkD[cellLoc];
                 DIM[cellLoc] =   (1.0 - soil_propOrg) * BulkD[cellLoc] * HP_DOM_MAXDEPTH[HAB[cellLoc]] * CELL_SIZE; /* kg inorganic matter */
                 DEPOS_ORG_MAT[cellLoc] = soil_propOrg * BulkD[cellLoc] * HP_DOM_MAXDEPTH[HAB[cellLoc]] ; /* kg organic matter/m2 */
//                 DEPOS_ORG_MAT[cellLoc] = soil_propOrg * BulkD[cellLoc] * HP_DOM_MAXDEPTH[HAB[cellLoc]] ; /* kg organic matter/m2 */
/* v2.8.4 new DEPOS_ORG_MAT init */

//                 Inorg_Z[cellLoc] = (1.0 - soil_propOrg) * HP_DOM_MAXDEPTH[HAB[cellLoc]]; /*  fixed inorganic depth (m) */
//                 DOM_Z[cellLoc] =   HP_DOM_MAXDEPTH[HAB[cellLoc]] - Inorg_Z[cellLoc]; /* m */
                 Inorg_Z[cellLoc] = DIM[cellLoc] / BulkD[cellLoc] * (1.0-soil_propOrg)  / CELL_SIZE ; /*  kgInorg / kgSoil/m3 * proprInorg / m2 == fixed inorganic depth (m) */
                 DOM_Z[cellLoc] =   HP_DOM_MAXDEPTH[HAB[cellLoc]] - Inorg_Z[cellLoc]; /* m */

// v2.8.4                 DEPOS_ORG_MAT[cellLoc] = DOM_BD[cellLoc]*DOM_Z[cellLoc]; /* (mgOM/cm3 ==> kgOM/m3) * m = kgOM/m2 */

                 DOM_SED_AEROB_Z[cellLoc] = Min(UNSAT_DEPTH[cellLoc]+HP_DOM_AEROBTHIN[HAB[cellLoc]],HP_DOM_MAXDEPTH[HAB[cellLoc]]); /* m */
                 DOM_SED_ANAEROB_Z[cellLoc] = HP_DOM_MAXDEPTH[HAB[cellLoc]]-DOM_SED_AEROB_Z[cellLoc]; /* m */

/* map */        TPtoSOIL[cellLoc] = TPtoSOIL[cellLoc] * GP_IC_TPtoSOIL_MULT; /* kgP/kgSoil */
                 DOP[cellLoc] =  (double) (1.0-GP_sorbToTP) * TPtoSOIL[cellLoc] * BulkD[cellLoc] * HP_DOM_MAXDEPTH[HAB[cellLoc]] ; /* kgP/kg_soil * kg_soil/m3 * m == kgP/m2 */

                 TP_SORB[cellLoc] =   (double)  GP_sorbToTP * TPtoSOIL[cellLoc] * BulkD[cellLoc] * HP_DOM_MAXDEPTH[HAB[cellLoc]] * CELL_SIZE; /* dimless * kgP/kg_soil * kg_soil/m3 * m * m^2 == kgP */

              /* floc layer of soil */
                 FLOC[cellLoc] = HP_FLOC_IC[HAB[cellLoc]]; /* kg OM/m2  */
                 FlocP[cellLoc] = FLOC[cellLoc]*HP_FLOC_IC_PC[HAB[cellLoc]]*HP_FLOC_IC_CTOOM[HAB[cellLoc]]; /* kg P /m2 */
                 FLOC_Z[cellLoc] = (double) FLOC[cellLoc] / GP_Floc_BD ; /* m */

              /* phosphorus */
                 TP_AtmosDepos[cellLoc]  = (double)TP_AtmosDepos[cellLoc] * conv_mgTOkg * CELL_SIZE / 365.0; /* P deposition, mgP/m2/yr * kg/mg * m2 / daysPerYear = kgP/day */
/* v2.4.4 */       TP_SFWT_CONC[cellLoc]  = GP_TP_ICSFWAT * conv_mgTOg; /* mg/L * g/mg  => g/L */
                 TP_SF_WT[cellLoc] =TP_SFWT_CONC[cellLoc] * SFWT_VOL[cellLoc]; /* kg P */
                 TP_SFWT_CONC_MG[cellLoc] = TP_SFWT_CONC[cellLoc] * conv_gTOmg; /* mg/L */
                      /* using regression for predicting PO4 from TP */
                 PO4Pconc = Max(TP_SFWT_CONC_MG[cellLoc]*GP_PO4toTP + GP_PO4toTPint, 0.10 * TP_SFWT_CONC_MG[cellLoc]); /* mg/L */
                 PO4P = PO4Pconc * SFWT_VOL[cellLoc] /conv_kgTOg; /*kg P available (from conc. in mg/l) */

/* v2.4.4 */ //      TP_SED_CONC[cellLoc] = GP_TP_ICSEDWAT * conv_mgTOg; /* mg/L * g/mg => g/L */
//                 TP_SED_WT[cellLoc] = TP_SED_CONC[cellLoc] * HYD_SED_WAT_VOL[cellLoc]; /* kg P */
//                      /* this is the active zone, where uptake, sorption, and mineralization take place */
//                  TP_Act_to_Tot[cellLoc] = 1.0 / HP_TP_CONC_GRAD[HAB[cellLoc]]; /* ratio of TP conc in active zone relative to total */
//                  TP_SED_WT_AZ[cellLoc] = TP_SED_CONC[cellLoc] * TP_Act_to_Tot[cellLoc] * HYD_DOM_ACTWAT_VOL[cellLoc]; /* kg P */
//                  TP_SEDWT_CONCACT[cellLoc] =(HYD_DOM_ACTWAT_VOL[cellLoc] > 0.0) ?
//                      ( TP_SED_WT_AZ[cellLoc]/HYD_DOM_ACTWAT_VOL[cellLoc] ) :
//                      ( TP_SED_CONC[cellLoc]); /* g/L */
//                  TP_SEDWT_CONCACTMG[cellLoc] = TP_SEDWT_CONCACT[cellLoc]*conv_gTOmg; /* mg/L */

/* v2.8.4 concentration in Active Zone (TP_SEDWT_CONCACT) is initialed by map (data here are g/L) */
                 TP_Act_to_Tot[cellLoc] = 1.0 / HP_TP_CONC_GRAD[HAB[cellLoc]]; /* ratio of TP conc in active zone relative to total */
                                 TP_SED_CONC[cellLoc] = (TP_Act_to_Tot[cellLoc]>0.0) ? (TP_SEDWT_CONCACT[cellLoc] / TP_Act_to_Tot[cellLoc]) : (0.0);
/* map */        TP_SEDWT_CONCACT[cellLoc] =(HYD_DOM_ACTWAT_VOL[cellLoc] > 0.0) ?
                     ( TP_SEDWT_CONCACT[cellLoc] ) :
                     ( 0.0 ); /* g/L */
                 TP_SEDWT_CONCACTMG[cellLoc] = TP_SEDWT_CONCACT[cellLoc]*conv_gTOmg; /* mg/L */
                 TP_SED_WT[cellLoc] = TP_SED_CONC[cellLoc] * HYD_SED_WAT_VOL[cellLoc]; /* kg P */
                 TP_SED_WT_AZ[cellLoc] = TP_SEDWT_CONCACT[cellLoc] * HYD_DOM_ACTWAT_VOL[cellLoc]; /* kg P */


              /* salt */
                 SALT_SED_WT[cellLoc] = HYD_SED_WAT_VOL[cellLoc]*HP_SALT_ICSEDWAT[HAB[cellLoc]];
                 SAL_SED_WT[cellLoc] = ( HYD_SED_WAT_VOL[cellLoc]>0.0 ) ? ( SALT_SED_WT[cellLoc]/HYD_SED_WAT_VOL[cellLoc] ) : ( 0.0);
                 SALT_SURF_WT[cellLoc] = SFWT_VOL[cellLoc]*HP_SALT_ICSFWAT[HAB[cellLoc]];
                 SAL_SF_WT[cellLoc] = ( SURFACE_WAT[cellLoc] > GP_WQualMonitZ ) ? ( SALT_SURF_WT[cellLoc]/SFWT_VOL[cellLoc] ) : ( 0.0);

              /* periphyton */
/* 2.4.4 */       NC_ALG[cellLoc] = HP_ALG_MAX[HAB[cellLoc]] * GP_ALG_IC_MULT * GP_ALG_REF_MULT ; /* start w/ low, refuge-level of non-calcareous (eutrophic) periphyton, g C/m2 */
/* 2.4.4 */       C_ALG[cellLoc]  = HP_ALG_MAX[HAB[cellLoc]] * GP_ALG_IC_MULT * (1.0 - GP_ALG_REF_MULT); /* g C/m2 */
                 /* ic PC of periph in oligotrophic area is 3% of max P:C, varies across space via (0.1->1.0) map */
/* 2.4.4 */       NC_ALG_PC[cellLoc] = GP_ALG_PC; /* gP/ gC */
/* 2.4.4 */       C_ALG_PC[cellLoc]  = GP_ALG_PC; /* gP/ gC */

                 NC_ALG_P[cellLoc] = NC_ALG[cellLoc]*NC_ALG_PC[cellLoc];   /* g P/m2 */
                 C_ALG_P[cellLoc] = C_ALG[cellLoc]*C_ALG_PC[cellLoc];  /* g P/m2 */  

              /* macrophytes */
/* 2.4.4 */       MAC_PH_BIOMAS[cellLoc] = MAC_TOT_BIOM[cellLoc] * GP_MAC_IC_MULT * HP_PHBIO_MAX[HAB[cellLoc]]/MAC_MAX_BIO[cellLoc]; /* kg C/m2 */
                   /*  now calc the P and OM associated with that C */
/* 2.4.4 */       mac_ph_PC[cellLoc] = HP_PHBIO_IC_PC[HAB[cellLoc]]; 
                 mac_ph_P[cellLoc] = MAC_PH_BIOMAS[cellLoc] * mac_ph_PC[cellLoc]; /* kg P/m2 */
                 mac_ph_OM[cellLoc] = MAC_PH_BIOMAS[cellLoc] / HP_PHBIO_IC_CTOOM[HAB[cellLoc]];
                 mac_ph_CtoOM[cellLoc] = HP_PHBIO_IC_CTOOM[HAB[cellLoc]];
                 PHBIO_AVAIL[cellLoc] = MAC_PH_BIOMAS[cellLoc]*Max(1.0-Max((PHBIO_SAT[cellLoc]-MAC_PH_BIOMAS[cellLoc]) /(PHBIO_SAT[cellLoc]-PHBIO_REFUGE[cellLoc]),0.0),0.0);

/* 2.4.4 */       MAC_NOPH_BIOMAS[cellLoc] = MAC_TOT_BIOM[cellLoc] * GP_MAC_IC_MULT * HP_NPHBIO_MAX[HAB[cellLoc]]/MAC_MAX_BIO[cellLoc]; /* kg C/m2 */
                   /*  now calc the P and OM associated with that C */
/* 2.4.4 */       mac_nph_PC[cellLoc] = HP_NPHBIO_IC_PC[HAB[cellLoc]]; 
                 mac_nph_P[cellLoc] = MAC_NOPH_BIOMAS[cellLoc] * mac_nph_PC[cellLoc];  /* kg P/m2 */
                 mac_nph_OM[cellLoc] = MAC_NOPH_BIOMAS[cellLoc] / HP_NPHBIO_IC_CTOOM[HAB[cellLoc]];
                 mac_nph_CtoOM[cellLoc] = HP_NPHBIO_IC_CTOOM[HAB[cellLoc]];
                 NPHBIO_AVAIL[cellLoc] = MAC_NOPH_BIOMAS[cellLoc]*Max(1.0-Max((NPHBIO_SAT[cellLoc]-MAC_NOPH_BIOMAS[cellLoc])/(NPHBIO_SAT[cellLoc]-NPHBIO_REFUGE[cellLoc]),0.0),0.0);

                 MAC_REL_BIOM[cellLoc] = ( MAC_TOT_BIOM[cellLoc] > 0 ) ? MAC_TOT_BIOM[cellLoc]/MAC_MAX_BIO[cellLoc] : 0.0;
                 MAC_LAI[cellLoc] = MAC_REL_BIOM[cellLoc]*HP_MAC_MAXLAI[HAB[cellLoc]];
                 MAC_HEIGHT[cellLoc] = MAC_REL_BIOM[cellLoc]*HP_MAC_MAXHT[HAB[cellLoc]];
                 LAI_eff[cellLoc] =  (MAC_HEIGHT[cellLoc]>0.0) ? (Max(1.0 - SURFACE_WAT[cellLoc]/MAC_HEIGHT[cellLoc], 0.0)*MAC_LAI[cellLoc]) : (0.0)  ;                 

/* end of initialization of major state variables */
                 
/* *************************** */
/* These are the multiple calculations used if particular modules are turned off. \n
 NOTE: THIS section (of init_eqns() ) is not fully updated for properly
 turning off individual **interacting** *biological/chemical* modules.  
 If one *biological/chemical* module is turned off, 
 they all need to be turned off. (Note that cell_dyn's 3,5,6 should always be off). \n

 *** \n
 The following *biological/chemical* modules must be ON or OFF as a group:
 (cell_dyn2 + cell_dyn4 + cell_dyn8 + cell_dyn9  + cell_dyn12)
 cell_dyn13, the net settling rate module, can be turned on only when above module group is off
 *** \n
 
 In particular, the budget will
 not properly reflect actual dynamics if those 
 modules are not treated as a group.
*/
     NC_ALG_MORT_POT[cellLoc] = ( UNSAT_DEPTH[cellLoc]>0.05 ) ? ( NC_ALG[cellLoc]*GP_ALG_RC_MORT_DRY ) : ( NC_ALG[cellLoc]*GP_ALG_RC_MORT);
                     /* calcareous periphyton */
     C_ALG_MORT_POT[cellLoc] = ( UNSAT_DEPTH[cellLoc]>0.05 ) ? ( C_ALG[cellLoc]*GP_ALG_RC_MORT_DRY ) : ( C_ALG[cellLoc]*GP_ALG_RC_MORT);
                 ALG_TEMP_CF[cellLoc]  = tempCF(0, 0.20, GP_ALG_TEMP_OPT, 5.0, 40.0, H2O_TEMP[cellLoc]);
     NC_ALG_RESP_POT[cellLoc]  = 
         ( UNSAT_DEPTH[cellLoc]<0.05 ) ? 
         ( GP_ALG_RC_RESP*ALG_TEMP_CF[cellLoc]*NC_ALG[cellLoc] ) : 
         ( 0.0);
     NC_ALG_RESP[cellLoc]  =  
         ( NC_ALG_RESP_POT[cellLoc]*DT>NC_ALG[cellLoc] ) ? 
         ( NC_ALG[cellLoc]/DT ) : 
         ( NC_ALG_RESP_POT[cellLoc]);
                     /* calcareous periphyton */
     C_ALG_RESP_POT[cellLoc]  = 
         ( UNSAT_DEPTH[cellLoc]<0.05 ) ? 
         ( GP_ALG_RC_RESP*ALG_TEMP_CF[cellLoc]*C_ALG[cellLoc] ) : 
         ( 0.0);
     C_ALG_RESP[cellLoc]  =  
         ( C_ALG_RESP_POT[cellLoc]*DT>C_ALG[cellLoc] ) ? 
         ( C_ALG[cellLoc]/DT ) : 
         ( C_ALG_RESP_POT[cellLoc]);

     NC_ALG_AVAIL_MORT[cellLoc] = NC_ALG[cellLoc]-ALG_REFUGE[cellLoc];
     NC_ALG_MORT[cellLoc] = ( (NC_ALG_MORT_POT[cellLoc])*DT>NC_ALG_AVAIL_MORT[cellLoc] ) ? ( (NC_ALG_AVAIL_MORT[cellLoc])/DT ) : ( NC_ALG_MORT_POT[cellLoc]);
                     /* calcareous periphyton */
     C_ALG_AVAIL_MORT[cellLoc]  = C_ALG[cellLoc]-ALG_REFUGE[cellLoc];
     C_ALG_MORT[cellLoc]  = ( (C_ALG_MORT_POT[cellLoc])*DT>C_ALG_AVAIL_MORT[cellLoc] ) ? ( (C_ALG_AVAIL_MORT[cellLoc])/DT ) : ( C_ALG_MORT_POT[cellLoc]);

/* light, water, temperature controls apply to calc and non-calc periphyton */
     ALG_LIGHT_EXTINCT[cellLoc]  =  0.01; /* light extinction coef */
                     /* algal self-shading implicit in density-dependent constraint function later */
     ALG_INCID_LIGHT[cellLoc]  = SOLRADGRD[cellLoc]*Exp(-MAC_LAI[cellLoc]*GP_ALG_SHADE_FACTOR);
                 Z_extinct = SURFACE_WAT[cellLoc]*ALG_LIGHT_EXTINCT[cellLoc];
     I_ISat = ALG_INCID_LIGHT[cellLoc]/GP_ALG_LIGHT_SAT;
                     /*  averaged over whole water column (based on Steele '65) */
     ALG_LIGHT_CF[cellLoc]  = ( Z_extinct > 0.0 ) ? 
         ( 2.718/Z_extinct * (Exp(-I_ISat * Exp(-Z_extinct)) - Exp(-I_ISat)) ) :
                (I_ISat*Exp(1.0-I_ISat));
                     /*  low-water growth constraint ready for something better based on data */
     ALG_WAT_CF[cellLoc]  = ( SURFACE_WAT[cellLoc]>0.0 ) ? ( 1.0 ) : ( 0.0);
/* the 2 communities have same growth response to avail phosphorus - avail P is roughly calc'd from TP */
     NC_ALG_NUT_CF[cellLoc]  =  PO4Pconc/(PO4Pconc+GP_NC_ALG_KS_P) ;
     C_ALG_NUT_CF[cellLoc]  = PO4Pconc/(PO4Pconc+GP_C_ALG_KS_P); 
      min_litTemp = Min(ALG_LIGHT_CF[cellLoc],ALG_TEMP_CF[cellLoc]);
      NC_ALG_PROD_CF[cellLoc]  = Min(min_litTemp,ALG_WAT_CF[cellLoc])*NC_ALG_NUT_CF[cellLoc];
      C_ALG_PROD_CF[cellLoc]   = Min(min_litTemp,ALG_WAT_CF[cellLoc])*C_ALG_NUT_CF[cellLoc];
/* gross production of the 2 communities (gC/m2, NOT kgC/m2) */
                     /* density constraint contains both noncalc and calc, competition effect accentuated by calc algae */
                     /* used to increase calc growth by factor of 10 */
      NC_ALG_GPP[cellLoc]  =  NC_ALG_PROD_CF[cellLoc]*GP_ALG_RC_PROD*NC_ALG[cellLoc]       
             *Max( (1.0-(GP_AlgComp*C_ALG[cellLoc]+NC_ALG[cellLoc])/HP_ALG_MAX[HAB[cellLoc]]),0.0);
     C_ALG_GPP[cellLoc]  =  C_ALG_PROD_CF[cellLoc]*GP_ALG_RC_PROD*C_ALG[cellLoc] 
       *Max( (1.0-(    C_ALG[cellLoc]+NC_ALG[cellLoc])/HP_ALG_MAX[HAB[cellLoc]]),0.0);
/* check for available P mass (the MichMent kinetics nutCF do not) */
     tmp = ( (NC_ALG_GPP[cellLoc]+C_ALG_GPP[cellLoc]) > 0) ? 
         PO4P / ( (NC_ALG_GPP[cellLoc]+C_ALG_GPP[cellLoc]) 
         * 0.001*GP_ALG_PC*CELL_SIZE*DT) :
         1.0;
     if (tmp < 1.0) {
         NC_ALG_GPP[cellLoc] *= tmp;   
         C_ALG_GPP[cellLoc] *= tmp; 
    /* can have high conc, but low mass of P avail, in presence of high peri biomass and high demand */
    /* reduce the production proportionally if excess demand is found */
       }
/* total of calc and noncalc algae available and their total NPP */
     NC_ALG_NPP[cellLoc]  = NC_ALG_GPP[cellLoc]-NC_ALG_RESP[cellLoc]; 
     C_ALG_NPP[cellLoc]  = C_ALG_GPP[cellLoc]-C_ALG_RESP[cellLoc]; 


     DOM_QUALITY_CF[cellLoc]  = (Max(TP_SFWT_CONC_MG[cellLoc],TP_SEDWT_CONCACTMG[cellLoc]))
         /GP_DOM_DECOMP_POPT; /* mg/L */
     DOM_TEMP_CF[cellLoc] = Exp(0.20*(H2O_TEMP[cellLoc]-GP_DOM_DECOMP_TOPT))*pow(((40.0-H2O_TEMP[cellLoc])/(40.0-GP_DOM_DECOMP_TOPT)),(0.20*(40.0-GP_DOM_DECOMP_TOPT)));
     soil_MOIST_CF[cellLoc] = pow(Max(UNSAT_MOIST_PRP[cellLoc],0.0),0.75);
     DOM_DECOMP_POT[cellLoc] = GP_DOM_RCDECOMP*DOM_QUALITY_CF[cellLoc]*DOM_TEMP_CF[cellLoc]*DEPOS_ORG_MAT[cellLoc]*(Min(DOM_SED_AEROB_Z[cellLoc]/HP_DOM_MAXDEPTH[HAB[cellLoc]],1.0)*soil_MOIST_CF[cellLoc]+GP_DOM_DECOMPRED*Min(DOM_SED_ANAEROB_Z[cellLoc]/HP_DOM_MAXDEPTH[HAB[cellLoc]],1.0));
     DOM_DECOMP[cellLoc] =  ( (DOM_DECOMP_POT[cellLoc])*DT>DEPOS_ORG_MAT[cellLoc] ) ? ( (DEPOS_ORG_MAT[cellLoc])/DT ) : ( DOM_DECOMP_POT[cellLoc]);
/* added for P DOM stoich */
     DOP_DECOMP[cellLoc] = DOM_DECOMP[cellLoc] * DOM_P_OM[cellLoc]; 

     SAT_VS_UNSAT[cellLoc] = 1/Exp(100.0*Max((SURFACE_WAT[cellLoc]-UNSAT_DEPTH[cellLoc]),0.0));
     UNSAT_WT_POT[cellLoc] = Max(UNSAT_CAP[cellLoc]-UNSAT_WATER[cellLoc],0.0);
         SF_WT_TO_SAT_DOWNFLOW[cellLoc]  = ( (1.0-SAT_VS_UNSAT[cellLoc])*UNSAT_WT_POT[cellLoc]*DT>SURFACE_WAT[cellLoc] ) ? ( SURFACE_WAT[cellLoc]/DT ) : ( (1.0-SAT_VS_UNSAT[cellLoc])*UNSAT_WT_POT[cellLoc]); 
     SAT_WT_RECHG[cellLoc] = ( GP_HYD_RCRECHG*DT>SAT_WATER[cellLoc] ) ? ( SAT_WATER[cellLoc]/DT ) : ( GP_HYD_RCRECHG);
     SF_WT_POT_INF[cellLoc] = ( (SURFACE_WAT[cellLoc]<HP_HYD_RCINFILT[HAB[cellLoc]]*DT) ) ? ( SURFACE_WAT[cellLoc]/DT ) : ( HP_HYD_RCINFILT[HAB[cellLoc]]);
     SF_WT_INFILTRATION[cellLoc] = ( SF_WT_POT_INF[cellLoc]*SAT_VS_UNSAT[cellLoc]*DT>UNSAT_WT_POT[cellLoc] ) ? ( (UNSAT_WT_POT[cellLoc])/DT ) : ( SF_WT_POT_INF[cellLoc]*SAT_VS_UNSAT[cellLoc]);
     HYD_DOM_ACTWAT_PRES[cellLoc] = ( HYD_DOM_ACTWAT_VOL[cellLoc] > 0.01 ) ? ( 1.0 ) : ( 0.0);
     HYD_WATER_AVAIL[cellLoc] = Min(1.0, UNSAT_MOIST_PRP[cellLoc]+Exp(-10.0*Max(UNSAT_DEPTH[cellLoc]-HP_NPHBIO_ROOTDEPTH[HAB[cellLoc]],0.0)));

     MAC_LIGHT_CF[cellLoc] = SOLRADGRD[cellLoc]/HP_MAC_LIGHTSAT[HAB[cellLoc]]*Exp(1.0-SOLRADGRD[cellLoc]/HP_MAC_LIGHTSAT[HAB[cellLoc]]);
     MAC_TEMP_CF[cellLoc] = Exp(0.20*(AIR_TEMP[cellLoc]-HP_MAC_TEMPOPT[HAB[cellLoc]])) *pow(((40.0-AIR_TEMP[cellLoc])/(40.0-HP_MAC_TEMPOPT[HAB[cellLoc]])),(0.20*(40.0-HP_MAC_TEMPOPT[HAB[cellLoc]])));
     MAC_WATER_AVAIL_CF[cellLoc] = graph8(0x0,HYD_WATER_AVAIL[cellLoc]);
     MAC_WATER_CF[cellLoc] = Min(MAC_WATER_AVAIL_CF[cellLoc], Max(1.0-Max((SURFACE_WAT[cellLoc]-HP_MAC_WAT_TOLER[HAB[cellLoc]])/HP_MAC_WAT_TOLER[HAB[cellLoc]],0.0),0.0));
     MAC_NUT_CF[cellLoc] =  TP_SEDWT_CONCACT[cellLoc]/(TP_SEDWT_CONCACT[cellLoc]+HP_MAC_KSP[HAB[cellLoc]]*0.001) ;

     MAC_SALT_CF[cellLoc] = ( HP_MAC_SALIN_THRESH[HAB[cellLoc]]>0.0 ) ? (  Max( 1.0-Max(SAL_SED_WT[cellLoc]-HP_MAC_SALIN_THRESH[HAB[cellLoc]],0.0)/HP_MAC_SALIN_THRESH[HAB[cellLoc]],0.0) ) : ( Max(1.0-SAL_SED_WT[cellLoc],0.0));
     min_litTemp = Min(MAC_LIGHT_CF[cellLoc], MAC_TEMP_CF[cellLoc]);
     MAC_PROD_CF[cellLoc]  = Min(min_litTemp,MAC_WATER_CF[cellLoc])
         *MAC_NUT_CF[cellLoc]*MAC_SALT_CF[cellLoc];
     PHBIO_NPP[cellLoc] = HP_PHBIO_RCNPP[HAB[cellLoc]]*MAC_PROD_CF[cellLoc]*MAC_PH_BIOMAS[cellLoc]* Max( (1.0-MAC_TOT_BIOM[cellLoc]/MAC_MAX_BIO[cellLoc]), 0.0);
/* check for available P mass that will be taken up (MichMent kinetics in nutCF does not) */
     tmp = (PHBIO_NPP[cellLoc] > 0) ? 
         TP_SED_WT[cellLoc] / ( PHBIO_NPP[cellLoc] * HP_NPHBIO_IC_PC[HAB[cellLoc]]*CELL_SIZE*DT) :
         1.0;
     if (tmp < 1.0) PHBIO_NPP[cellLoc] *= tmp;   
    /* reduce the production proportionally if excess demand is found */
    /* can have high conc, but low mass of P avail, in presence of high plant biomass and high demand */
/* now add the P and OM associated with that C */
     phbio_npp_P[cellLoc] = PHBIO_NPP[cellLoc] * HP_PHBIO_IC_PC[HAB[cellLoc]];     /* habitat-specfic stoichiometry */
     phbio_npp_OM[cellLoc] = PHBIO_NPP[cellLoc] / HP_PHBIO_IC_CTOOM[HAB[cellLoc]]; /* habitat-specfic stoichiometry */

/* init ("target") ph/nph ratio and new transloc algorithm */
     MAC_PHtoNPH_Init = HP_PHBIO_MAX[HAB[cellLoc]] / HP_NPHBIO_MAX[HAB[cellLoc]] ;
     MAC_PHtoNPH = MAC_PH_BIOMAS[cellLoc] / MAC_NOPH_BIOMAS[cellLoc];

     PHBIO_TRANSLOC_POT[cellLoc]  = 0.0; /* (MAC_PHtoNPH<MAC_PHtoNPH_Init) ? (exp(HP_MAC_TRANSLOC_RC[HAB[cellLoc]] *(MAC_PHtoNPH_Init-MAC_PHtoNPH)) - 1.0) : (0.0) */ 

     PHBIO_TRANSLOC[cellLoc] =  ( (PHBIO_TRANSLOC_POT[cellLoc])*DT >NPHBIO_AVAIL[cellLoc] ) ? ( (NPHBIO_AVAIL[cellLoc])/DT ) : ( PHBIO_TRANSLOC_POT[cellLoc]);
/*  now remove the P and OM associated with that C */
     phbio_transl_P[cellLoc] = PHBIO_TRANSLOC[cellLoc] * mac_nph_PC[cellLoc];
     phbio_transl_OM[cellLoc] = PHBIO_TRANSLOC[cellLoc] / mac_nph_CtoOM[cellLoc];
     NPHBIO_MORT_POT[cellLoc] = NPHBIO_AVAIL[cellLoc]*HP_PHBIO_RCMORT[HAB[cellLoc]]*(1.0-MAC_PH_BIOMAS[cellLoc]/HP_PHBIO_MAX[HAB[cellLoc]]);
     NPHBIO_MORT[cellLoc] =  ( (PHBIO_TRANSLOC[cellLoc]+NPHBIO_MORT_POT[cellLoc])*DT>NPHBIO_AVAIL[cellLoc] ) ? ( (NPHBIO_AVAIL[cellLoc]-PHBIO_TRANSLOC[cellLoc]*DT)/DT ) : ( NPHBIO_MORT_POT[cellLoc]);
     PHBIO_MORT_POT[cellLoc] = HP_PHBIO_RCMORT[HAB[cellLoc]] *PHBIO_AVAIL[cellLoc] *(1.0-MAC_WATER_AVAIL_CF[cellLoc]);
/* now remove the P and OM associated with that C */
     nphbio_mort_P[cellLoc] = NPHBIO_MORT[cellLoc] * mac_nph_PC[cellLoc];
     nphbio_mort_OM[cellLoc] = NPHBIO_MORT[cellLoc] / mac_nph_CtoOM[cellLoc];

     NPHBIO_TRANSLOC_POT[cellLoc] = 0.0; /* (MAC_PHtoNPH>MAC_PHtoNPH_Init) ? (exp(HP_MAC_TRANSLOC_RC[HAB[cellLoc]] *(MAC_PHtoNPH-MAC_PHtoNPH_Init)) - 1.0) : (0.0) */ 
     NPHBIO_TRANSLOC[cellLoc] = ( (NPHBIO_TRANSLOC_POT[cellLoc])*DT >MAC_PH_BIOMAS[cellLoc] ) ? ( (MAC_PH_BIOMAS[cellLoc])/DT ) : ( NPHBIO_TRANSLOC_POT[cellLoc]);
/*  now remove the P and OM associated with that C */
     nphbio_transl_P[cellLoc] = NPHBIO_TRANSLOC[cellLoc] * mac_ph_PC[cellLoc];
     nphbio_transl_OM[cellLoc] = NPHBIO_TRANSLOC[cellLoc] / mac_ph_CtoOM[cellLoc];
     PHBIO_MORT[cellLoc] = ( (PHBIO_MORT_POT[cellLoc]+NPHBIO_TRANSLOC[cellLoc])*DT>PHBIO_AVAIL[cellLoc] ) ? ( (PHBIO_AVAIL[cellLoc]-NPHBIO_TRANSLOC[cellLoc]*DT)/DT ) : ( PHBIO_MORT_POT[cellLoc]);
/*  now remove the P associated with that C */
     phbio_mort_P[cellLoc] = PHBIO_MORT[cellLoc] * mac_ph_PC[cellLoc];
     phbio_mort_OM[cellLoc] = PHBIO_MORT[cellLoc] / mac_ph_CtoOM[cellLoc];


     FLOC_DECOMP_QUAL_CF[cellLoc] = Min(TP_SFWT_CONC_MG[cellLoc]/GP_DOM_DECOMP_POPT,1.0) ;
     FLOC_DECOMP_POT[cellLoc] = GP_DOM_RCDECOMP*FLOC[cellLoc]*DOM_TEMP_CF[cellLoc] *FLOC_DECOMP_QUAL_CF[cellLoc];
     FLOC_DECOMP[cellLoc] = ( (FLOC_DECOMP_POT[cellLoc])*DT>FLOC[cellLoc] ) ? ( (FLOC[cellLoc])/DT ) : ( FLOC_DECOMP_POT[cellLoc]);
     FLOC_DEPO_POT[cellLoc] = (  SURFACE_WAT[cellLoc] > GP_DetentZ ) ? ( FLOC[cellLoc]*0.05 ) : ( FLOC[cellLoc]/DT);
     FLOC_DEPO[cellLoc] = ( (FLOC_DEPO_POT[cellLoc]+FLOC_DECOMP[cellLoc])*DT>FLOC[cellLoc] ) ? ( (FLOC[cellLoc]-FLOC_DECOMP[cellLoc]*DT)/DT ) : ( FLOC_DEPO_POT[cellLoc]);
 
     HYD_MANNINGS_N[cellLoc]  = Max(-Abs((HP_MAC_MAXROUGH[HAB[cellLoc]]-HP_MAC_MINROUGH[HAB[cellLoc]])*  (pow(2.0,(1.0-SURFACE_WAT[cellLoc]/MAC_HEIGHT[cellLoc]))-1.0)) + HP_MAC_MAXROUGH[HAB[cellLoc]],HP_MAC_MINROUGH[HAB[cellLoc]]);
  } /* spatial loop end */
  } /* spatial loop end */
  usrErr("Done.");

} /* end of init_eqns */

void init_canals

(

int

irun

)

Call to initialize the water managment canal network topology and data.

Parameters:

irun

a counter of number of times a new simulation run is executed

Definition at line 2110 of file UnitMod.c.

Referenced by main().

{
   if (irun == 1) {
      usrErr("Initializing Water Management...");
      Canal_Network_Init(GP_DATUM_DISTANCE,SED_ELEV); /* WatMgmt.c - initialize the canal network topology and data */
      usrErr("Done Water Management.");
   }
   else {
      reinitCanals();
   }

}

void init_succession

(

void

)

Call to initialize the habitat succession module.

Definition at line 2124 of file UnitMod.c.

Referenced by main().

{
   HabSwitch_Init( ); 

}

void PtInterp_read

(

)

On-the-fly interpolations to develop spatial time series from point data.
.

Read the point data into the lists.
Note that this was quickly set up for the ELM Peer Review (2006) project, and (at least in v2.6.0) needs to be used in conjunction with the model experiment parms for synthetic stage boundary conditions (because it skips all gridIO inputs, including SFWMM stage/depth).

For ELM v2.6, extracted/re-used these code fragments from ELM v2.1 code, with associated updated uses/documentation

Definition at line 2680 of file UnitMod.c.

Referenced by main().

{
                /* rainfall and pET point data for models that do not use gridIO inputs, but use interpolated point time series */
            /* final arg in PTSL_ReadLists is the column number of of the data (not incl. the 3 date columns) */
        usrErr0 ("\n*** WARNING: You are not using gridIO spatial time series data for rain, pET, and SFWMM-output depth.  \nReading rainfall and pET point time series data... ");
                pTSList2 = PTSL_Init(50, 2);
                PTSL_ReadLists(pTSList2,"rain",TIndex2++,&Timestep2,&NPtTS2, 1); /* rainfall in data-col 1 (file's col 4) */
        
        pTSList3 = PTSL_Init(50, 2);
        PTSL_ReadLists(pTSList3,"pET",TIndex3++,&Timestep3,&NPtTS3, 1); /* pET data in data-col 1 (file's col 4) */

        usrErr("done.\n");

        if (99 == 66) { /* never-get-here: temporary v2.6 PTSL - Below (old code frags extracted from v2.1) are left here as template for other data (or re-implementing the ELM v2.1 pET calculations if data available) */
        pTSList4 = PTSL_Init(50, 2);
        PTSL_ReadLists(pTSList4,"pET",TIndex4++,&Timestep4,&NPtTS4, 2);  /* dew point temperature data can be in data-col 2 */
        pTSList5 = PTSL_Init(50, 2);
        PTSL_ReadLists(pTSList5,"pET",TIndex5++,&Timestep5,&NPtTS5, 3);  /* wind speed data can be in data-col 3 */
        pTSList6 = PTSL_Init(50, 2);
        PTSL_ReadLists(pTSList6,"pET",TIndex6++,&Timestep6,&NPtTS6, 4);  /* cloud cover data can be in data-col 4 */
        }
}

void reinitBIR

(

void

)

Calls to re-initialize Basin/Indicator-Region data.

Definition at line 2131 of file UnitMod.c.

Referenced by main().

{
   usrErr0("Re-initializing Basin/Indicator-Region info...");
   BIRstats_reset(); 
   BIRbudg_reset(); 
   Cell_reset_avg(); 
   Cell_reset_hydper(); 
   usrErr("Done.");
}

void reinitCanals

(

void

)

Call to re-initialize canal storages.

Definition at line 2142 of file UnitMod.c.

Referenced by init_canals(), and main().

{
   usrErr0("Re-initializing Canal depths & constituent masses...");
   CanalReInit();  
   usrErr("Done.");
}

void alloc_memory

(

)

Allocate memory.

Allocate memory for model variables, and initialize (not context-specific) values.

Definition at line 2717 of file UnitMod.c.

Referenced by main().

{
  usrErr0("Allocating Memory...");  /* console message */
  
  ON_MAP = (unsigned char *) nalloc(sizeof(unsigned char)*(s0+2)*(s1+2),"ON_MAP");
  init_pvar(ON_MAP,NULL,'c',0.0);

  BCondFlow = (int *) nalloc(sizeof(int)*(s0+2)*(s1+2),"BCondFlow");
  init_pvar(BCondFlow,NULL,'d',0.0);
  HAB = (unsigned char *) nalloc(sizeof(unsigned char)*(s0+2)*(s1+2),"HAB");
  init_pvar(HAB,NULL,'c',0.0);
  basn = (int *) nalloc(sizeof(int)*(s0+2)*(s1+2),"basn"); /* Basin/Indicator-Region map */
  init_pvar(basn,NULL,'d',0.0);

  ALG_INCID_LIGHT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_INCID_LIGHT");
  init_pvar(ALG_INCID_LIGHT,NULL,'f',0.0);
  ALG_LIGHT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_LIGHT_CF");
  init_pvar(ALG_LIGHT_CF,NULL,'f',0.0);
  ALG_LIGHT_EXTINCT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_LIGHT_EXTINCT");
  init_pvar(ALG_LIGHT_EXTINCT,NULL,'f',0.0);
  ALG_WAT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_WAT_CF");
  init_pvar(ALG_WAT_CF,NULL,'f',0.0);
  ALG_TEMP_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_TEMP_CF");
  init_pvar(ALG_TEMP_CF,NULL,'f',0.0);
  ALG_REFUGE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_REFUGE");
  init_pvar(ALG_REFUGE,NULL,'f',0.0);
  ALG_SAT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_SAT");
  init_pvar(ALG_SAT,NULL,'f',0.0);
  ALG_TOT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ALG_TOT");
  init_pvar(ALG_TOT,NULL,'f',0.0);

  NC_ALG_AVAIL_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_AVAIL_MORT");
  init_pvar(NC_ALG_AVAIL_MORT,NULL,'f',0.0);
  NC_ALG_GPP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_GPP");
  init_pvar(NC_ALG_GPP,NULL,'f',0.0);
  NC_ALG_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_MORT");
  init_pvar(NC_ALG_MORT,NULL,'f',0.0);
  NC_ALG_MORT_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_MORT_POT");
  init_pvar(NC_ALG_MORT_POT,NULL,'f',0.0);
  NC_ALG_NPP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_NPP");
  init_pvar(NC_ALG_NPP,NULL,'f',0.0);
  NC_ALG_NUT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_NUT_CF");
  init_pvar(NC_ALG_NUT_CF,NULL,'f',0.0);
  NC_ALG_PROD_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_PROD_CF");
  init_pvar(NC_ALG_PROD_CF,NULL,'f',0.0);
  NC_ALG_RESP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_RESP");
  init_pvar(NC_ALG_RESP,NULL,'f',0.0);
  NC_ALG_RESP_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_RESP_POT");
  init_pvar(NC_ALG_RESP_POT,NULL,'f',0.0);
  NC_ALG = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG");
  init_pvar(NC_ALG,NULL,'f',0.0);
  C_ALG_AVAIL_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_AVAIL_MORT");
  init_pvar(C_ALG_AVAIL_MORT,NULL,'f',0.0);
  C_ALG_GPP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_GPP");
  init_pvar(C_ALG_GPP,NULL,'f',0.0);
  C_ALG_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_MORT");
  init_pvar(C_ALG_MORT,NULL,'f',0.0);
  C_ALG_MORT_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_MORT_POT");
  init_pvar(C_ALG_MORT_POT,NULL,'f',0.0);
  C_ALG_NPP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_NPP");
  init_pvar(C_ALG_NPP,NULL,'f',0.0);
  C_ALG_NUT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_NUT_CF");
  init_pvar(C_ALG_NUT_CF,NULL,'f',0.0);
  C_ALG_PROD_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_PROD_CF");
  init_pvar(C_ALG_PROD_CF,NULL,'f',0.0);
  C_ALG_RESP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_RESP");
  init_pvar(C_ALG_RESP,NULL,'f',0.0);
  C_ALG_RESP_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_RESP_POT");
  init_pvar(C_ALG_RESP_POT,NULL,'f',0.0);
  C_ALG = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG");
  init_pvar(C_ALG,NULL,'f',0.0);
  NC_ALG_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_P");
  init_pvar(NC_ALG_P,NULL,'f',0.0);
  C_ALG_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_P");
  init_pvar(C_ALG_P,NULL,'f',0.0);
  NC_ALG_GPP_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_GPP_P");
  init_pvar(NC_ALG_GPP_P,NULL,'f',0.0);
  C_ALG_GPP_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_GPP_P");
  init_pvar(C_ALG_GPP_P,NULL,'f',0.0);
  NC_ALG_MORT_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_MORT_P");
  init_pvar(NC_ALG_MORT_P,NULL,'f',0.0);
  C_ALG_MORT_P = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_MORT_P");
  init_pvar(C_ALG_MORT_P,NULL,'f',0.0);
  NC_ALG_PCrep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NC_ALG_PCrep");
  init_pvar(NC_ALG_PCrep,NULL,'f',0.0);
  C_ALG_PCrep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"C_ALG_PCrep");
  init_pvar(C_ALG_PCrep,NULL,'f',0.0);
  NC_ALG_PC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"NC_ALG_PC");
  init_pvar(NC_ALG_PC,NULL,'l',0.0);
  C_ALG_PC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"C_ALG_PC");
  init_pvar(C_ALG_PC,NULL,'l',0.0);

  DEPOS_ORG_MAT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"DEPOS_ORG_MAT");
  init_pvar(DEPOS_ORG_MAT,NULL,'l',0.0);
        
  DOM_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_Z");
  init_pvar(DOM_Z,NULL,'f',0.0);
  DOM_DECOMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_DECOMP");
  init_pvar(DOM_DECOMP,NULL,'f',0.0);
  DOM_DECOMP_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_DECOMP_POT");
  init_pvar(DOM_DECOMP_POT,NULL,'f',0.0);
  DOM_fr_nphBio = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_fr_nphBio");
  init_pvar(DOM_fr_nphBio,NULL,'f',0.0);
  
  Floc_fr_phBio = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"Floc_fr_phBio");
  init_pvar(Floc_fr_phBio,NULL,'f',0.0);
  DOM_FR_FLOC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_FR_FLOC");
  init_pvar(DOM_FR_FLOC,NULL,'f',0.0);
  soil_MOIST_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"soil_MOIST_CF");
  init_pvar(soil_MOIST_CF,NULL,'f',0.0);
  DOM_QUALITY_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_QUALITY_CF");
  init_pvar(DOM_QUALITY_CF,NULL,'f',0.0);
  DOM_SED_AEROB_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_SED_AEROB_Z");
  init_pvar(DOM_SED_AEROB_Z,NULL,'f',0.0);
  DOM_SED_ANAEROB_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_SED_ANAEROB_Z");
  init_pvar(DOM_SED_ANAEROB_Z,NULL,'f',0.0);
  DOM_TEMP_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_TEMP_CF");
  init_pvar(DOM_TEMP_CF,NULL,'f',0.0);
  ELEVATION = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"ELEVATION");
  init_pvar(ELEVATION,NULL,'f',0.0);
  Bathymetry = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"Bathymetry");
  init_pvar(Bathymetry,NULL,'f',0.0);
  SED_ELEV = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SED_ELEV");
  init_pvar(SED_ELEV,NULL,'f',0.0);
  SED_INACT_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SED_INACT_Z");
  init_pvar(SED_INACT_Z,NULL,'f',0.0);
  DOP_FLOC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOP_FLOC");
  init_pvar(DOP_FLOC,NULL,'f',0.0);
  DOP_nphBio = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOP_nphBio");
  init_pvar(DOP_nphBio,NULL,'f',0.0);

  DOM_P_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"DOM_P_OM");
  init_pvar(DOM_P_OM,NULL,'l',0.0);

  TPtoSOIL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TPtoSOIL");
  init_pvar(TPtoSOIL,NULL,'f',0.0);
  TPtoSOIL_rep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TPtoSOIL_rep");
  init_pvar(TPtoSOIL_rep,NULL,'f',0.0);
  TPtoVOL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TPtoVOL");
  init_pvar(TPtoVOL,NULL,'f',0.0);
  TPtoVOL_rep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TPtoVOL_rep");
  init_pvar(TPtoVOL_rep,NULL,'f',0.0);
  BulkD = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"BulkD");
  init_pvar(BulkD,NULL,'f',0.0);
  DOM_BD = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOM_BD");
  init_pvar(DOM_BD,NULL,'f',0.0);
  Inorg_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"Inorg_Z");
  init_pvar(Inorg_Z,NULL,'f',0.0);
  DIM = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DIM");
  init_pvar(DIM,NULL,'f',0.0);
  DOP_DECOMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"DOP_DECOMP");
  init_pvar(DOP_DECOMP,NULL,'f',0.0);

  DOP = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"DOP");
  init_pvar(DOP,NULL,'l',0.0);

/* placeholder for fire */
  FIREdummy = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FIREdummy");
  init_pvar(FIREdummy,NULL,'f',0.0);
        
  HYD_DOM_ACTWAT_PRES = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_DOM_ACTWAT_PRES");
  init_pvar(HYD_DOM_ACTWAT_PRES,NULL,'f',0.0);
  HYD_DOM_ACTWAT_VOL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_DOM_ACTWAT_VOL");
  init_pvar(HYD_DOM_ACTWAT_VOL,NULL,'f',0.0);
  HYD_EVAP_CALC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_EVAP_CALC");
  init_pvar(HYD_EVAP_CALC,NULL,'f',0.0);
  HYD_MANNINGS_N = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_MANNINGS_N");
  init_pvar(HYD_MANNINGS_N,NULL,'f',0.0);
  HYD_RCCONDUCT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_RCCONDUCT");
  init_pvar(HYD_RCCONDUCT,NULL,'f',0.0);
  HYD_SAT_POT_TRANS = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_SAT_POT_TRANS");
  init_pvar(HYD_SAT_POT_TRANS,NULL,'f',0.0);
  HYD_SED_WAT_VOL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_SED_WAT_VOL");
  init_pvar(HYD_SED_WAT_VOL,NULL,'f',0.0);
  HYD_TOT_POT_TRANSP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_TOT_POT_TRANSP");
  init_pvar(HYD_TOT_POT_TRANSP,NULL,'f',0.0);
  HydTotHd = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HydTotHd");
  init_pvar(HydTotHd,NULL,'f',0.0);
  HydRelDepPosNeg = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HydRelDepPosNeg");
  init_pvar(HydRelDepPosNeg,NULL,'f',0.0);
  HYD_TRANSP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_TRANSP");
  init_pvar(HYD_TRANSP,NULL,'f',0.0);
  HYD_ET = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_ET");
  init_pvar(HYD_ET,NULL,'f',0.0);
  HYD_UNSAT_POT_TRANS = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_UNSAT_POT_TRANS");
  init_pvar(HYD_UNSAT_POT_TRANS,NULL,'f',0.0);
  HYD_WATER_AVAIL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"HYD_WATER_AVAIL");
  init_pvar(HYD_WATER_AVAIL,NULL,'f',0.0);

/* sfwmm rainfall, stage, and pET mapped to elm grid */
  boundcond_rain = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"boundcond_rain");
  init_pvar(boundcond_rain,NULL,'f',0.0);
  boundcond_depth = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"boundcond_depth");
  init_pvar(boundcond_depth,NULL,'f',0.0);
  boundcond_ETp = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"boundcond_ETp");
  init_pvar(boundcond_ETp,NULL,'f',0.0);

  SAT_TO_UNSAT_FL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_TO_UNSAT_FL");
  init_pvar(SAT_TO_UNSAT_FL,NULL,'f',0.0);
  SAT_VS_UNSAT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_VS_UNSAT");
  init_pvar(SAT_VS_UNSAT,NULL,'f',0.0);
  SAT_WATER = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_WATER");
  init_pvar(SAT_WATER,NULL,'f',0.0);
  SAT_WT_HEAD = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_WT_HEAD");
  init_pvar(SAT_WT_HEAD,NULL,'f',0.0);
  SAT_WT_RECHG = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_WT_RECHG");
  init_pvar(SAT_WT_RECHG,NULL,'f',0.0);
  SAT_WT_TRANSP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAT_WT_TRANSP");
  init_pvar(SAT_WT_TRANSP,NULL,'f',0.0);
  SF_WT_EVAP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_EVAP");
  init_pvar(SF_WT_EVAP,NULL,'f',0.0);
  SF_WT_FROM_RAIN = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_FROM_RAIN");
  init_pvar(SF_WT_FROM_RAIN,NULL,'f',0.0);
  SF_WT_INFILTRATION = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_INFILTRATION");
  init_pvar(SF_WT_INFILTRATION,NULL,'f',0.0);
  SF_WT_POT_INF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_POT_INF");
  init_pvar(SF_WT_POT_INF,NULL,'f',0.0);
  SF_WT_TO_SAT_DOWNFLOW = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_TO_SAT_DOWNFLOW");
  init_pvar(SF_WT_TO_SAT_DOWNFLOW,NULL,'f',0.0);
  SFWT_VOL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SFWT_VOL");
  init_pvar(SFWT_VOL,NULL,'f',0.0);
  SURFACE_WAT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SURFACE_WAT");
  init_pvar(SURFACE_WAT,NULL,'f',0.0);
  SF_WT_VEL_mag = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SF_WT_VEL_mag");
  init_pvar(SF_WT_VEL_mag,NULL,'f',0.0); 
  BCmodel_sfwat = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"BCmodel_sfwat");
  init_pvar(BCmodel_sfwat,NULL,'f',0.0); 

  UNSAT_AVAIL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_AVAIL");
  init_pvar(UNSAT_AVAIL,NULL,'f',0.0);
  UNSAT_CAP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_CAP");
  init_pvar(UNSAT_CAP,NULL,'f',0.0);
  UNSAT_DEPTH = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_DEPTH");
  init_pvar(UNSAT_DEPTH,NULL,'f',0.0);
  UNSAT_HYD_COND_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_HYD_COND_CF");
  init_pvar(UNSAT_HYD_COND_CF,NULL,'f',0.0);
  UNSAT_MOIST_PRP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_MOIST_PRP");
  init_pvar(UNSAT_MOIST_PRP,NULL,'f',0.0);
  UNSAT_PERC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_PERC");
  init_pvar(UNSAT_PERC,NULL,'f',0.0);
  UNSAT_TO_SAT_FL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_TO_SAT_FL");
  init_pvar(UNSAT_TO_SAT_FL,NULL,'f',0.0);
  UNSAT_TRANSP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_TRANSP");
  init_pvar(UNSAT_TRANSP,NULL,'f',0.0);
  UNSAT_WATER = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_WATER");
  init_pvar(UNSAT_WATER,NULL,'f',0.0);
  UNSAT_WT_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"UNSAT_WT_POT");
  init_pvar(UNSAT_WT_POT,NULL,'f',0.0);

  MAC_HEIGHT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_HEIGHT");
  init_pvar(MAC_HEIGHT,NULL,'f',0.0);
  MAC_LAI = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_LAI");
  init_pvar(MAC_LAI,NULL,'f',0.0);
  LAI_eff = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"LAI_eff");
  init_pvar(LAI_eff,NULL,'f',0.0);
  MAC_LIGHT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_LIGHT_CF");
  init_pvar(MAC_LIGHT_CF,NULL,'f',0.0);
  MAC_MAX_BIO = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_MAX_BIO");
  init_pvar(MAC_MAX_BIO,NULL,'f',0.0);
  MAC_NOPH_BIOMAS = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_NOPH_BIOMAS");
  init_pvar(MAC_NOPH_BIOMAS,NULL,'f',0.0);
  MAC_NUT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_NUT_CF");
  init_pvar(MAC_NUT_CF,NULL,'f',0.0);
  MAC_PH_BIOMAS = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_PH_BIOMAS");
  init_pvar(MAC_PH_BIOMAS,NULL,'f',0.0);
  MAC_PROD_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_PROD_CF");
  init_pvar(MAC_PROD_CF,NULL,'f',0.0);
  MAC_REL_BIOM = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_REL_BIOM");
  init_pvar(MAC_REL_BIOM,NULL,'f',0.0);
  MAC_SALT_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_SALT_CF");
  init_pvar(MAC_SALT_CF,NULL,'f',0.0);
  MAC_TEMP_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_TEMP_CF");
  init_pvar(MAC_TEMP_CF,NULL,'f',0.0);
  MAC_TOT_BIOM = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_TOT_BIOM");
  init_pvar(MAC_TOT_BIOM,NULL,'f',0.0);
  MAC_WATER_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_WATER_CF");
  init_pvar(MAC_WATER_CF,NULL,'f',0.0);
  MAC_WATER_AVAIL_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"MAC_WATER_AVAIL_CF");
  init_pvar(MAC_WATER_AVAIL_CF,NULL,'f',0.0);
  NPHBIO_AVAIL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_AVAIL");
  init_pvar(NPHBIO_AVAIL,NULL,'f',0.0);
  NPHBIO_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_MORT");
  init_pvar(NPHBIO_MORT,NULL,'f',0.0);
  NPHBIO_MORT_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_MORT_POT");
  init_pvar(NPHBIO_MORT_POT,NULL,'f',0.0);
  NPHBIO_REFUGE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_REFUGE");
  init_pvar(NPHBIO_REFUGE,NULL,'f',0.0);
  NPHBIO_SAT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_SAT");
  init_pvar(NPHBIO_SAT,NULL,'f',0.0);
  NPHBIO_TRANSLOC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_TRANSLOC");
  init_pvar(NPHBIO_TRANSLOC,NULL,'f',0.0);
  NPHBIO_TRANSLOC_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"NPHBIO_TRANSLOC_POT");
  init_pvar(NPHBIO_TRANSLOC_POT,NULL,'f',0.0);
  PHBIO_AVAIL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_AVAIL");
  init_pvar(PHBIO_AVAIL,NULL,'f',0.0);
  PHBIO_MORT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_MORT");
  init_pvar(PHBIO_MORT,NULL,'f',0.0);
  PHBIO_MORT_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_MORT_POT");
  init_pvar(PHBIO_MORT_POT,NULL,'f',0.0);
  PHBIO_NPP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_NPP");
  init_pvar(PHBIO_NPP,NULL,'f',0.0);
  PHBIO_REFUGE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_REFUGE");
  init_pvar(PHBIO_REFUGE,NULL,'f',0.0);
  PHBIO_SAT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_SAT");
  init_pvar(PHBIO_SAT,NULL,'f',0.0); 
  PHBIO_TRANSLOC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_TRANSLOC");
  init_pvar(PHBIO_TRANSLOC,NULL,'f',0.0);
  PHBIO_TRANSLOC_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"PHBIO_TRANSLOC_POT");
  init_pvar(PHBIO_TRANSLOC_POT,NULL,'f',0.0);

  phbio_npp_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_npp_P");
  init_pvar(phbio_npp_P,NULL,'l',0.0);
  phbio_npp_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_npp_OM");
  init_pvar(phbio_npp_OM,NULL,'l',0.0);
  phbio_mort_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_mort_P");
  init_pvar(phbio_mort_P,NULL,'l',0.0);
  phbio_mort_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_mort_OM");
  init_pvar(phbio_mort_OM,NULL,'l',0.0);
  phbio_transl_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_transl_P");
  init_pvar(phbio_transl_P,NULL,'l',0.0);
  phbio_transl_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"phbio_transl_OM");
  init_pvar(phbio_transl_OM,NULL,'l',0.0);
  nphbio_transl_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"nphbio_transl_P");
  init_pvar(nphbio_transl_P,NULL,'l',0.0);
  nphbio_transl_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"nphbio_transl_OM");
  init_pvar(nphbio_transl_OM,NULL,'l',0.0);
  nphbio_mort_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"nphbio_mort_P");
  init_pvar(nphbio_mort_P,NULL,'l',0.0);
  nphbio_mort_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"nphbio_mort_OM");
  init_pvar(nphbio_mort_OM,NULL,'l',0.0);
  mac_nph_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_nph_P");
  init_pvar(mac_nph_P,NULL,'l',0.0);
  mac_nph_PC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_nph_PC");
  init_pvar(mac_nph_PC,NULL,'l',0.0);
  mac_nph_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_nph_OM");
  init_pvar(mac_nph_OM,NULL,'l',0.0);
  mac_nph_CtoOM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_nph_CtoOM");
  init_pvar(mac_nph_CtoOM,NULL,'l',0.0);
  mac_ph_P = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_ph_P");
  init_pvar(mac_ph_P,NULL,'l',0.0);
  mac_ph_PC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_ph_PC");
  init_pvar(mac_ph_PC,NULL,'l',0.0);
  mac_ph_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_ph_OM");
  init_pvar(mac_ph_OM,NULL,'l',0.0);
  mac_ph_CtoOM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"mac_ph_CtoOM");
  init_pvar(mac_ph_CtoOM,NULL,'l',0.0);

  mac_nph_PC_rep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"mac_nph_PC_rep");
  init_pvar(mac_nph_PC_rep,NULL,'f',0.0);
  mac_ph_PC_rep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"mac_ph_PC_rep");
  init_pvar(mac_ph_PC_rep,NULL,'f',0.0);

  TP_SED_WT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SED_WT");
  init_pvar(TP_SED_WT,NULL,'l',0.0);
  TP_SED_CONC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SED_CONC");
  init_pvar(TP_SED_CONC,NULL,'l',0.0);
  TP_SEDWT_CONCACT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SEDWT_CONCACT");
  init_pvar(TP_SEDWT_CONCACT,NULL,'l',0.0);
  TP_SF_WT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SF_WT");
  init_pvar(TP_SF_WT,NULL,'l',0.0);
  TP_SFWT_CONC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SFWT_CONC");
  init_pvar(TP_SFWT_CONC,NULL,'l',0.0);
  TP_SORB = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SORB");
  init_pvar(TP_SORB,NULL,'l',0.0);
  TP_SORBCONC = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SORBCONC");
  init_pvar(TP_SORBCONC,NULL,'l',0.0);
  TP_SED_WT_AZ = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_SED_WT_AZ");
  init_pvar(TP_SED_WT_AZ,NULL,'l',0.0);
  TP_Act_to_Tot = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"TP_Act_to_Tot");
  init_pvar(TP_Act_to_Tot,NULL,'l',0.0);

  TP_Act_to_TotRep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_Act_to_TotRep");
  init_pvar(TP_Act_to_TotRep,NULL,'f',0.0);
  TP_SORBCONC_rep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SORBCONC_rep");
  init_pvar(TP_SORBCONC_rep,NULL,'f',0.0);

  TP_DNFLOW = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_DNFLOW");
  init_pvar(TP_DNFLOW,NULL,'f',0.0);
  TP_DNFLOW_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_DNFLOW_POT");
  init_pvar(TP_DNFLOW_POT,NULL,'f',0.0);
  TP_Atm_Depos = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_Atm_Depos");
  init_pvar(TP_Atm_Depos,NULL,'f',0.0);
/* v2.6 added map of atmospheric TP deposition rate */
  TP_AtmosDepos = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_AtmosDepos");
  init_pvar(TP_AtmosDepos,NULL,'f',0.0);
  TP_K = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_K");
  init_pvar(TP_K,NULL,'f',0.0);
  TP_SED_MINER = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SED_MINER");
  init_pvar(TP_SED_MINER,NULL,'f',0.0);
  TP_SEDWT_CONCACTMG = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SEDWT_CONCACTMG");
  init_pvar(TP_SEDWT_CONCACTMG,NULL,'f',0.0);
  TP_SEDWT_UPTAKE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SEDWT_UPTAKE");
  init_pvar(TP_SEDWT_UPTAKE,NULL,'f',0.0);
  TP_SFWT_CONC_MG = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SFWT_CONC_MG");
  init_pvar(TP_SFWT_CONC_MG,NULL,'f',0.0);
  TP_SFWT_MINER = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SFWT_MINER");
  init_pvar(TP_SFWT_MINER,NULL,'f',0.0);
  TP_SFWT_UPTAK = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SFWT_UPTAK");
  init_pvar(TP_SFWT_UPTAK,NULL,'f',0.0);
  TP_settl = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_settl");
  init_pvar(TP_settl,NULL,'f',0.0);
  TP_SORB_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SORB_POT");
  init_pvar(TP_SORB_POT,NULL,'f',0.0);
  TP_SORBTION = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_SORBTION");
  init_pvar(TP_SORBTION,NULL,'f',0.0);
  TP_UPFLOW = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_UPFLOW");
  init_pvar(TP_UPFLOW,NULL,'f',0.0);
  TP_UPFLOW_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_UPFLOW_POT");
  init_pvar(TP_UPFLOW_POT,NULL,'f',0.0);
  P_SUM_CELL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"P_SUM_CELL");
  init_pvar(P_SUM_CELL,NULL,'f',0.0);

  DINdummy = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"DINdummy");
  init_pvar(DINdummy,NULL,'l',0.0);

  WQMsettlVel = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"WQMsettlVel");
  init_pvar(WQMsettlVel,NULL,'f',0.0);
  TP_settlDays = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"TP_settlDays");
  init_pvar(TP_settlDays,NULL,'f',0.0);

  SAL_SED_WT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"SAL_SED_WT");
  init_pvar(SAL_SED_WT,NULL,'l',0.0);
  SAL_SF_WT_mb = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"SAL_SF_WT_mb");
  init_pvar(SAL_SF_WT_mb,NULL,'l',0.0);
  SALT_SED_WT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"SALT_SED_WT");
  init_pvar(SALT_SED_WT,NULL,'l',0.0);
  SALT_SURF_WT = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"SALT_SURF_WT");
  init_pvar(SALT_SURF_WT,NULL,'l',0.0);
        
  SAL_SF_WT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SAL_SF_WT");
  init_pvar(SAL_SF_WT,NULL,'f',0.0);
  SALT_Atm_Depos = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SALT_Atm_Depos");
  init_pvar(SALT_Atm_Depos,NULL,'f',0.0);
  SALT_SED_TO_SF_FLOW = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SALT_SED_TO_SF_FLOW");
  init_pvar(SALT_SED_TO_SF_FLOW,NULL,'f',0.0);
  SALT_SFWAT_DOWNFL = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SALT_SFWAT_DOWNFL");
  init_pvar(SALT_SFWAT_DOWNFL,NULL,'f',0.0);
  SALT_SFWAT_DOWNFL_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SALT_SFWAT_DOWNFL_POT");
  init_pvar(SALT_SFWAT_DOWNFL_POT,NULL,'f',0.0);

  FLOC_DECOMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_DECOMP");
  init_pvar(FLOC_DECOMP,NULL,'f',0.0);
  FLOC_DECOMP_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_DECOMP_POT");
  init_pvar(FLOC_DECOMP_POT,NULL,'f',0.0);
  FLOC_DECOMP_QUAL_CF = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_DECOMP_QUAL_CF");
  init_pvar(FLOC_DECOMP_QUAL_CF,NULL,'f',0.0);
  FLOC_Z = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_Z");
  init_pvar(FLOC_Z,NULL,'f',0.0);
  FLOC_DEPO = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_DEPO");
  init_pvar(FLOC_DEPO,NULL,'f',0.0);
  FLOC_DEPO_POT = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_DEPO_POT");
  init_pvar(FLOC_DEPO_POT,NULL,'f',0.0);
  FLOC_FR_ALGAE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC_FR_ALGAE");
  init_pvar(FLOC_FR_ALGAE,NULL,'f',0.0);
  FLOC = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FLOC");
  init_pvar(FLOC,NULL,'f',0.0);
  FlocP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP");
  init_pvar(FlocP,NULL,'f',0.0);
  FlocP_DECOMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP_DECOMP");
  init_pvar(FlocP_DECOMP,NULL,'f',0.0);
  FlocP_FR_ALGAE = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP_FR_ALGAE");
  init_pvar(FlocP_FR_ALGAE,NULL,'f',0.0);
  FlocP_PhBio = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP_PhBio");
  init_pvar(FlocP_PhBio,NULL,'f',0.0);
  FlocP_DEPO = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP_DEPO");
  init_pvar(FlocP_DEPO,NULL,'f',0.0);
  FlocP_OMrep = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"FlocP_OMrep");
  init_pvar(FlocP_OMrep,NULL,'f',0.0);
  FlocP_OM = (double *) nalloc(sizeof(double)*(s0+2)*(s1+2),"FlocP_OM");
  init_pvar(FlocP_OM,NULL,'l',0.0);

  SOLRADGRD = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SOLRADGRD");
  init_pvar(SOLRADGRD,NULL,'f',0.0);
  SOLRAD274 = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"SOLRAD274");
  init_pvar(SOLRAD274,NULL,'f',0.0);
  AIR_TEMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"AIR_TEMP");
  init_pvar(AIR_TEMP,NULL,'f',0.0);
  H2O_TEMP = (float *) nalloc(sizeof(float)*(s0+2)*(s1+2),"H2O_TEMP");
  init_pvar(H2O_TEMP,NULL,'f',0.0);

/* habitat-specific parameter arrays */
  HP_ALG_MAX = NULL;

  HP_DOM_MAXDEPTH = NULL;
  HP_DOM_AEROBTHIN = NULL;

  HP_TP_CONC_GRAD = NULL;

  HP_SALT_ICSEDWAT = NULL;
  HP_SALT_ICSFWAT = NULL;

  HP_PHBIO_MAX = NULL;
  HP_NPHBIO_MAX = NULL;
  HP_MAC_MAXHT = NULL;
  HP_NPHBIO_ROOTDEPTH = NULL;
  HP_MAC_MAXROUGH = NULL;
  HP_MAC_MINROUGH = NULL;
  HP_MAC_MAXLAI = NULL;
  HP_MAC_MAXCANOPCOND = NULL;
  HP_MAC_CANOPDECOUP = NULL;
  HP_MAC_TEMPOPT = NULL;
  HP_MAC_LIGHTSAT = NULL;
  HP_MAC_KSP = NULL;
  HP_PHBIO_RCNPP = NULL;
  HP_PHBIO_RCMORT = NULL;
  HP_MAC_WAT_TOLER = NULL;
  HP_MAC_SALIN_THRESH = NULL;
  HP_PHBIO_IC_CTOOM = NULL;
  HP_NPHBIO_IC_CTOOM = NULL;
  HP_PHBIO_IC_PC = NULL;
  HP_NPHBIO_IC_PC = NULL;
  HP_MAC_TRANSLOC_RC = NULL;

  HP_HYD_RCINFILT = NULL;
  HP_HYD_SPEC_YIELD = NULL;
  HP_HYD_POROSITY = NULL;

  HP_FLOC_IC = NULL;
  HP_FLOC_IC_CTOOM = NULL;
  HP_FLOC_IC_PC = NULL;

  HP_SfDepthLo = NULL;
  HP_SfDepthHi = NULL;
  HP_SfDepthInt = NULL;
  HP_PhosLo = NULL;
  HP_PhosHi = NULL;
  HP_PhosInt = NULL;
  HP_FireInt = NULL;
  HP_SalinLo = NULL;
  HP_SalinHi = NULL;
  HP_SalinInt = NULL;
  
  usrErr("Done."); /* console message */

}

void gen_output	(	int	step,
		ViewParm *	view
	)

Generate output.

Create output of spatial maps, point locations and debug data (if any)

Parameters:

	step	The current iteration number
	view	The struct containing output configuration data

Remarks:

You need to ensure that the Outlist_size (define in driver_utilities.h) is greater than (at least equal to) the number of output variables here (important if adding variables to this output list).

Remarks:

This UnitMod.c code "fragment" (gen_output function, populating tgen[] array) is generated from the "ModelOutlist_creator_v?.xls" OpenOffice workbook. Editing this source directly is not recommended w/o changing ModelOutlist_creator.
The order of the variables in the Model.outList configuration (model input) file MUST EXACTLY match their order in the tgen[] array of the struct.
The ModelOutlist_creator automatically generates both the Model.outList and the tgen[] code.
It is recommended that you utilize the ModelOutlist_creator to generate both the config file and the source code. NOTE: the code generator has a bug, and puts an 'f' argument in all variables, float or not. You must change doubles ('d') and unsigned chars ('c') by hand.

Definition at line 2162 of file UnitMod.c.

Referenced by main().

{
    #define numOutputs 50000
    static int iw[numOutputs];
    int oIndex;
    ViewParm   *vp;

    static outVar_struct tgen[] = {
      { (float**)&TP_settlDays, "TP_settlDays", 'f' },
      { (float**)&FLOC, "FLOC", 'f' },
      { (float**)&FLOC_DECOMP, "FLOC_DECOMP", 'f' },
      { (float**)&FLOC_DECOMP_POT, "FLOC_DECOMP_POT", 'f' },
      { (float**)&FLOC_DECOMP_QUAL_CF, "FLOC_DECOMP_QUAL_CF", 'f' },
      { (float**)&FLOC_DEPO, "FLOC_DEPO", 'f' },
      { (float**)&FLOC_DEPO_POT, "FLOC_DEPO_POT", 'f' },
      { (float**)&FLOC_FR_ALGAE, "FLOC_FR_ALGAE", 'f' },
      { (float**)&FLOC_Z, "FLOC_Z", 'f' },
      { (float**)&FlocP_OMrep, "FlocP_OMrep", 'f' },
      { (float**)&soil_MOIST_CF, "soil_MOIST_CF", 'f' },
      { (float**)&TP_SED_MINER, "TP_SED_MINER", 'f' },
      { (float**)&TP_SFWT_MINER, "TP_SFWT_MINER", 'f' },
      { (float**)&AIR_TEMP, "AIR_TEMP", 'f' },
      { (unsigned char**)&HAB, "HAB", 'c' },
      { (float**)&SOLRAD274, "SOLRAD274", 'f' },
      { (float**)&SOLRADGRD, "SOLRADGRD", 'f' },
      { (float**)&H2O_TEMP, "H2O_TEMP", 'f' },
      { (float**)&HYD_DOM_ACTWAT_PRES, "HYD_DOM_ACTWAT_PRES", 'f' },
      { (float**)&HYD_DOM_ACTWAT_VOL, "HYD_DOM_ACTWAT_VOL", 'f' },
      { (float**)&HYD_ET, "HYD_ET", 'f' },
      { (float**)&HYD_EVAP_CALC, "HYD_EVAP_CALC", 'f' },
      { (float**)&HYD_MANNINGS_N, "HYD_MANNINGS_N", 'f' },
      { (float**)&HYD_SAT_POT_TRANS, "HYD_SAT_POT_TRANS", 'f' },
      { (float**)&HYD_SED_WAT_VOL, "HYD_SED_WAT_VOL", 'f' },
      { (float**)&HYD_TOT_POT_TRANSP, "HYD_TOT_POT_TRANSP", 'f' },
      { (float**)&HYD_TRANSP, "HYD_TRANSP", 'f' },
      { (float**)&HYD_UNSAT_POT_TRANS, "HYD_UNSAT_POT_TRANS", 'f' },
      { (float**)&HYD_WATER_AVAIL, "HYD_WATER_AVAIL", 'f' },
      { (float**)&HydTotHd, "HydTotHd", 'f' },
      { (float**)&HydRelDepPosNeg, "HydRelDepPosNeg", 'f' },
      { (float**)&LAI_eff, "LAI_eff", 'f' },
      { (float**)&MAC_WATER_AVAIL_CF, "MAC_WATER_AVAIL_CF", 'f' },
      { (float**)&SAT_TO_UNSAT_FL, "SAT_TO_UNSAT_FL", 'f' },
      { (float**)&SAT_VS_UNSAT, "SAT_VS_UNSAT", 'f' },
      { (float**)&SAT_WATER, "SAT_WATER", 'f' },
      { (float**)&SAT_WT_HEAD, "SAT_WT_HEAD", 'f' },
      { (float**)&SAT_WT_RECHG, "SAT_WT_RECHG", 'f' },
      { (float**)&SAT_WT_TRANSP, "SAT_WT_TRANSP", 'f' },
      { (float**)&SF_WT_EVAP, "SF_WT_EVAP", 'f' },
      { (float**)&SF_WT_FROM_RAIN, "SF_WT_FROM_RAIN", 'f' },
      { (float**)&SF_WT_INFILTRATION, "SF_WT_INFILTRATION", 'f' },
      { (float**)&SF_WT_POT_INF, "SF_WT_POT_INF", 'f' },
      { (float**)&SF_WT_TO_SAT_DOWNFLOW, "SF_WT_TO_SAT_DOWNFLOW", 'f' },
      { (float**)&SF_WT_VEL_mag, "SF_WT_VEL_mag", 'f' },
      { (float**)&BCmodel_sfwat, "BCmodel_sfwat", 'f' },
      { (float**)&SFWT_VOL, "SFWT_VOL", 'f' },
      { (float**)&SURFACE_WAT, "SURFACE_WAT", 'f' },
      { (float**)&UNSAT_AVAIL, "UNSAT_AVAIL", 'f' },
      { (float**)&UNSAT_CAP, "UNSAT_CAP", 'f' },
      { (float**)&UNSAT_DEPTH, "UNSAT_DEPTH", 'f' },
      { (float**)&UNSAT_HYD_COND_CF, "UNSAT_HYD_COND_CF", 'f' },
      { (float**)&UNSAT_MOIST_PRP, "UNSAT_MOIST_PRP", 'f' },
      { (float**)&UNSAT_PERC, "UNSAT_PERC", 'f' },
      { (float**)&UNSAT_TO_SAT_FL, "UNSAT_TO_SAT_FL", 'f' },
      { (float**)&UNSAT_TRANSP, "UNSAT_TRANSP", 'f' },
      { (float**)&UNSAT_WATER, "UNSAT_WATER", 'f' },
      { (float**)&UNSAT_WT_POT, "UNSAT_WT_POT", 'f' },
      { (float**)&ELEVATION, "ELEVATION", 'f' },
      { (float**)&HYD_RCCONDUCT, "HYD_RCCONDUCT", 'f' },
      { (unsigned char**)&ON_MAP, "ON_MAP", 'c' },
      { (float**)&SED_INACT_Z, "SED_INACT_Z", 'f' },
      { (float**)&MAC_HEIGHT, "MAC_HEIGHT", 'f' },
      { (float**)&MAC_LAI, "MAC_LAI", 'f' },
      { (float**)&MAC_LIGHT_CF, "MAC_LIGHT_CF", 'f' },
      { (float**)&MAC_MAX_BIO, "MAC_MAX_BIO", 'f' },
      { (float**)&MAC_NOPH_BIOMAS, "MAC_NOPH_BIOMAS", 'f' },
      { (float**)&mac_nph_PC_rep, "mac_nph_PC_rep", 'f' },
      { (float**)&MAC_NUT_CF, "MAC_NUT_CF", 'f' },
      { (float**)&MAC_PH_BIOMAS, "MAC_PH_BIOMAS", 'f' },
      { (float**)&mac_ph_PC_rep, "mac_ph_PC_rep", 'f' },
      { (float**)&MAC_PROD_CF, "MAC_PROD_CF", 'f' },
      { (float**)&MAC_REL_BIOM, "MAC_REL_BIOM", 'f' },
      { (float**)&MAC_SALT_CF, "MAC_SALT_CF", 'f' },
      { (float**)&MAC_TEMP_CF, "MAC_TEMP_CF", 'f' },
      { (float**)&MAC_TOT_BIOM, "MAC_TOT_BIOM", 'f' },
      { (float**)&MAC_WATER_CF, "MAC_WATER_CF", 'f' },
      { (float**)&NPHBIO_AVAIL, "NPHBIO_AVAIL", 'f' },
      { (float**)&NPHBIO_MORT, "NPHBIO_MORT", 'f' },
      { (float**)&NPHBIO_MORT_POT, "NPHBIO_MORT_POT", 'f' },
      { (float**)&NPHBIO_REFUGE, "NPHBIO_REFUGE", 'f' },
      { (float**)&NPHBIO_SAT, "NPHBIO_SAT", 'f' },
      { (float**)&NPHBIO_TRANSLOC, "NPHBIO_TRANSLOC", 'f' },
      { (float**)&NPHBIO_TRANSLOC_POT, "NPHBIO_TRANSLOC_POT", 'f' },
      { (float**)&PHBIO_AVAIL, "PHBIO_AVAIL", 'f' },
      { (float**)&PHBIO_MORT, "PHBIO_MORT", 'f' },
      { (float**)&PHBIO_MORT_POT, "PHBIO_MORT_POT", 'f' },
      { (float**)&PHBIO_NPP, "PHBIO_NPP", 'f' },
      { (float**)&PHBIO_REFUGE, "PHBIO_REFUGE", 'f' },
      { (float**)&PHBIO_SAT, "PHBIO_SAT", 'f' },
      { (float**)&PHBIO_TRANSLOC, "PHBIO_TRANSLOC", 'f' },
      { (float**)&PHBIO_TRANSLOC_POT, "PHBIO_TRANSLOC_POT", 'f' },
      { (float**)&TP_SEDWT_UPTAKE, "TP_SEDWT_UPTAKE", 'f' },
      { (float**)&ALG_INCID_LIGHT, "ALG_INCID_LIGHT", 'f' },
      { (float**)&ALG_LIGHT_CF, "ALG_LIGHT_CF", 'f' },
      { (float**)&ALG_LIGHT_EXTINCT, "ALG_LIGHT_EXTINCT", 'f' },
      { (float**)&ALG_REFUGE, "ALG_REFUGE", 'f' },
      { (float**)&ALG_SAT, "ALG_SAT", 'f' },
      { (float**)&ALG_TEMP_CF, "ALG_TEMP_CF", 'f' },
      { (float**)&ALG_TOT, "ALG_TOT", 'f' },
      { (float**)&ALG_WAT_CF, "ALG_WAT_CF", 'f' },
      { (float**)&C_ALG, "C_ALG", 'f' },
      { (float**)&C_ALG_AVAIL_MORT, "C_ALG_AVAIL_MORT", 'f' },
      { (float**)&C_ALG_GPP, "C_ALG_GPP", 'f' },
      { (float**)&C_ALG_MORT, "C_ALG_MORT", 'f' },
      { (float**)&C_ALG_MORT_POT, "C_ALG_MORT_POT", 'f' },
      { (float**)&C_ALG_NPP, "C_ALG_NPP", 'f' },
      { (float**)&C_ALG_NUT_CF, "C_ALG_NUT_CF", 'f' },
      { (float**)&C_ALG_PROD_CF, "C_ALG_PROD_CF", 'f' },
      { (float**)&C_ALG_RESP, "C_ALG_RESP", 'f' },
      { (float**)&C_ALG_RESP_POT, "C_ALG_RESP_POT", 'f' },
      { (float**)&NC_ALG, "NC_ALG", 'f' },
      { (float**)&NC_ALG_AVAIL_MORT, "NC_ALG_AVAIL_MORT", 'f' },
      { (float**)&NC_ALG_GPP, "NC_ALG_GPP", 'f' },
      { (float**)&NC_ALG_MORT, "NC_ALG_MORT", 'f' },
      { (float**)&NC_ALG_MORT_POT, "NC_ALG_MORT_POT", 'f' },
      { (float**)&NC_ALG_NPP, "NC_ALG_NPP", 'f' },
      { (float**)&NC_ALG_NUT_CF, "NC_ALG_NUT_CF", 'f' },
      { (float**)&NC_ALG_PROD_CF, "NC_ALG_PROD_CF", 'f' },
      { (float**)&NC_ALG_RESP, "NC_ALG_RESP", 'f' },
      { (float**)&NC_ALG_RESP_POT, "NC_ALG_RESP_POT", 'f' },
      { (float**)&TP_SFWT_UPTAK, "TP_SFWT_UPTAK", 'f' },
      { (float**)&TP_Act_to_TotRep, "TP_Act_to_TotRep", 'f' },
      { (float**)&TP_DNFLOW, "TP_DNFLOW", 'f' },
      { (float**)&TP_DNFLOW_POT, "TP_DNFLOW_POT", 'f' },
      { (float**)&TP_Atm_Depos, "TP_Atm_Depos", 'f' },
      { (float**)&TP_K, "TP_K", 'f' },
      { (double**)&TP_SED_CONC, "TP_SED_CONC", 'd' },
      { (double**)&TP_SED_WT, "TP_SED_WT", 'd' },
      { (double**)&TP_SED_WT_AZ, "TP_SED_WT_AZ", 'd' },
      { (double**)&TP_SEDWT_CONCACT, "TP_SEDWT_CONCACT", 'd' },
      { (float**)&TP_SEDWT_CONCACTMG, "TP_SEDWT_CONCACTMG", 'f' },
      { (float**)&TP_settl, "TP_settl", 'f' },
      { (double**)&TP_SF_WT, "TP_SF_WT", 'd' },
      { (double**)&TP_SFWT_CONC, "TP_SFWT_CONC", 'd' },
      { (float**)&TP_SFWT_CONC_MG, "TP_SFWT_CONC_MG", 'f' },
      { (double**)&TP_SORB, "TP_SORB", 'd' },
      { (float**)&TP_SORB_POT, "TP_SORB_POT", 'f' },
      { (double**)&TP_SORBCONC, "TP_SORBCONC", 'd' },
      { (float**)&TP_SORBCONC_rep, "TP_SORBCONC_rep", 'f' },
      { (float**)&TP_SORBTION, "TP_SORBTION", 'f' },
      { (float**)&TP_UPFLOW, "TP_UPFLOW", 'f' },
      { (float**)&TP_UPFLOW_POT, "TP_UPFLOW_POT", 'f' },
      { (double**)&SAL_SED_WT, "SAL_SED_WT", 'd' },
      { (float**)&SAL_SF_WT, "SAL_SF_WT", 'f' },
      { (float**)&SALT_SED_TO_SF_FLOW, "SALT_SED_TO_SF_FLOW", 'f' },
      { (double**)&SALT_SED_WT, "SALT_SED_WT", 'd' },
      { (float**)&SALT_SFWAT_DOWNFL, "SALT_SFWAT_DOWNFL", 'f' },
      { (float**)&SALT_SFWAT_DOWNFL_POT, "SALT_SFWAT_DOWNFL_POT", 'f' },
      { (double**)&SALT_SURF_WT, "SALT_SURF_WT", 'd' },
      { (float**)&SALT_Atm_Depos, "SALT_Atm_Depos", 'f' },
      { (double**)&DEPOS_ORG_MAT, "DEPOS_ORG_MAT", 'd' },
      { (float**)&DOM_DECOMP, "DOM_DECOMP", 'f' },
      { (float**)&DOM_DECOMP_POT, "DOM_DECOMP_POT", 'f' },
      { (float**)&DOM_FR_FLOC, "DOM_FR_FLOC", 'f' },
      { (double**)&DOM_P_OM, "DOM_P_OM", 'd' },
      { (float**)&DOM_QUALITY_CF, "DOM_QUALITY_CF", 'f' },
      { (float**)&DOM_SED_AEROB_Z, "DOM_SED_AEROB_Z", 'f' },
      { (float**)&DOM_SED_ANAEROB_Z, "DOM_SED_ANAEROB_Z", 'f' },
      { (float**)&DOM_TEMP_CF, "DOM_TEMP_CF", 'f' },
      { (float**)&DOM_Z, "DOM_Z", 'f' },
      { (double**)&DOP, "DOP", 'd' },
      { (float**)&DOP_DECOMP, "DOP_DECOMP", 'f' },
      { (float**)&P_SUM_CELL, "P_SUM_CELL", 'f' },
      { (float**)&SED_ELEV, "SED_ELEV", 'f' },
      { (float**)&TPtoSOIL_rep, "TPtoSOIL_rep", 'f' },
      { (float**)&Floc_fr_phBioAvg, "Floc_fr_phBioAvg", 'f' },
      { (float**)&TPSfMinAvg, "TPSfMinAvg", 'f' },
      { (float**)&ETAvg, "ETAvg", 'f' },
      { (float**)&EvapAvg, "EvapAvg", 'f' },
      { (float**)&HydPerAnn, "HydPerAnn", 'f' },
      { (float**)&LAI_effAvg, "LAI_effAvg", 'f' },
      { (float**)&Manning_nAvg, "Manning_nAvg", 'f' },
      { (float**)&RainAvg, "RainAvg", 'f' },
      { (float**)&SfWatAvg, "SfWatAvg", 'f' },
      { (float**)&TotHeadAvg, "TotHeadAvg", 'f' },
      { (float**)&HydRelDepPosNegAvg, "HydRelDepPosNegAvg", 'f' },
      { (float**)&TranspAvg, "TranspAvg", 'f' },
      { (float**)&UnsatMoistAvg, "UnsatMoistAvg", 'f' },
      { (float**)&UnsatZavg, "UnsatZavg", 'f' },
      { (float**)&SF_WT_VEL_magAvg, "SF_WT_VEL_magAvg", 'f' },
      { (float**)&BCmodel_sfwatAvg, "BCmodel_sfwatAvg", 'f' },
      { (float**)&mac_nph_PCAvg, "mac_nph_PCAvg", 'f' },
      { (float**)&Mac_nphBioAvg, "Mac_nphBioAvg", 'f' },
      { (float**)&Mac_nphMortAvg, "Mac_nphMortAvg", 'f' },
      { (float**)&Mac_nppAvg, "Mac_nppAvg", 'f' },
      { (float**)&mac_ph_PCAvg, "mac_ph_PCAvg", 'f' },
      { (float**)&Mac_phBioAvg, "Mac_phBioAvg", 'f' },
      { (float**)&Mac_phMortAvg, "Mac_phMortAvg", 'f' },
      { (float**)&Mac_totBioAvg, "Mac_totBioAvg", 'f' },
      { (float**)&MacNutCfAvg, "MacNutCfAvg", 'f' },
      { (float**)&MacWatCfAvg, "MacWatCfAvg", 'f' },
      { (float**)&TPSedUptAvg, "TPSedUptAvg", 'f' },
      { (float**)&C_Peri_mortAvg, "C_Peri_mortAvg", 'f' },
      { (float**)&C_Peri_nppAvg, "C_Peri_nppAvg", 'f' },
      { (float**)&C_Peri_PCAvg, "C_Peri_PCAvg", 'f' },
      { (float**)&C_PeriAvg, "C_PeriAvg", 'f' },
      { (float**)&C_PeriNutCFAvg, "C_PeriNutCFAvg", 'f' },
      { (float**)&C_PeriRespAvg, "C_PeriRespAvg", 'f' },
      { (float**)&NC_Peri_mortAvg, "NC_Peri_mortAvg", 'f' },
      { (float**)&NC_Peri_nppAvg, "NC_Peri_nppAvg", 'f' },
      { (float**)&NC_Peri_PCAvg, "NC_Peri_PCAvg", 'f' },
      { (float**)&NC_PeriAvg, "NC_PeriAvg", 'f' },
      { (float**)&NC_PeriNutCFAvg, "NC_PeriNutCFAvg", 'f' },
      { (float**)&NC_PeriRespAvg, "NC_PeriRespAvg", 'f' },
      { (float**)&PeriAvg, "PeriAvg", 'f' },
      { (float**)&PeriLiteCFAvg, "PeriLiteCFAvg", 'f' },
      { (float**)&TPSfUptAvg, "TPSfUptAvg", 'f' },
      { (float**)&TP_settlAvg, "TP_settlAvg", 'f' },
      { (float**)&TPSedWatAvg, "TPSedWatAvg", 'f' },
      { (float**)&TPSfWatAvg, "TPSfWatAvg", 'f' },
      { (float**)&SaltSedAvg, "SaltSedAvg", 'f' },
      { (float**)&SaltSfAvg, "SaltSfAvg", 'f' },
      { (float**)&SedElevAvg, "SedElevAvg", 'f' },
      { (float**)&TPSedMinAvg, "TPSedMinAvg", 'f' },
      { (float**)&TPSorbAvg, "TPSorbAvg", 'f' },
      { (float**)&TPtoSOILAvg, "TPtoSOILAvg", 'f' },
      { (float**)&TPtoVOLAvg, "TPtoVOLAvg", 'f' },








      { NULL, NULL, '\0' },
  };
  
    outVar_struct *ptable;
    int  i;

    for (i = 0, ptable = tgen; ptable->pfvar != NULL; ptable++, i++)
    {
  vp = view + i;

/* TODO: develop flexible output of calendar-based and julian-based outsteps (jan 11, 2005) */
if (vp->step > 0)
                
            if (strcmp(ptable->pname,"HydPerAnn")!=0) { /* i.e., not the HydPerAnn variable */
                
                if  (step % vp->step == 0 && (vp->step != CalMonOut) ) {   /* standard julian-day outstep interval variables (note: the != CalMonOut needed for step=0) */ 
                    oIndex = iw[i]++;
                    write_output(oIndex, vp, *(ptable->pfvar), ptable->pname, ptable->ctype, step);
                }
                else if ( (avgPrint) && (vp->step == CalMonOut) ) { /* variables output at the special 1-calendar-month outstep interval */  
                    oIndex = iw[i]++;
                    write_output(oIndex, vp, *(ptable->pfvar), ptable->pname, ptable->ctype, step);
                }
            }
        
            else
                if (FMOD(DAYJUL, 273.0) ==0) { /* hydroperiod is printed at a special-case time (approximately Oct 1 every year) */
                    oIndex = iw[i]++;
                    write_output(oIndex, vp, *(ptable->pfvar), ptable->pname, ptable->ctype, step);
                }
        
     
    }

        /* after printing, zero the arrays holding averages or hydroperiods (v2.2.1note using avgPrint var)*/
    if (avgPrint) {
        Cell_reset_avg();
    }

    if (FMOD(DAYJUL, 273.0) ==0) {
        Cell_reset_hydper();
    }


} /* end of gen_output routine */

void get_map_dims

(

)

Get the map dimensions of the global model array.

This mererly calls the "read_map_dims" function

Definition at line 2707 of file UnitMod.c.

Referenced by setup().

{
  read_map_dims("Elevation");
}

int call_cell_dyn	(	int	sector,
		int	step
	)

Calling function for the cell_dyn** dynamic ecological modules.

This function calls the cell_dyn dynamic modules as defined in the Driver.parm data file. Normal order for calling ELM modules(Sectors): 1 0 7 10 9 2 8 4 12 99.

S#0 hydro: cell-cell horiz (&canals if WaterManagement is on)
S#1 global forcings
S#2 algae/periphyton
S#4 DOM/DOP
S#7 hydro: vertical
S#8 macrophytes
S#9 phosphorus
S#10 salt
S#12 FLOC
S#13 TP net settling
S#99 mass balance, budget, avg, hydroperiod, etc calculations

Returns:

rv (=1)

Parameters:

	sector	The number of the cell_dyn** module being called
	step	The current iteration number

Definition at line 150 of file UnitMod.c.

Referenced by main().

 {
  int rv=0;

  switch(sector) {

    case 99: { stats(step); rv=1; } break;
    case 0: { horizFlow(step); rv=1; } break;
    case 1: { cell_dyn1(step); rv=1; } break;
    case 2: { cell_dyn2(step); rv=1; } break;
    case 4: { cell_dyn4(step); rv=1; } break;
    case 7: { cell_dyn7(step); rv=1; } break;
    case 8: { cell_dyn8(step); rv=1; } break;
    case 9: { cell_dyn9(step); rv=1; } break;
    case 10: { cell_dyn10(step); rv=1; } break;
    case 12: { cell_dyn12(step); rv=1; } break;
    case 13: { cell_dyn13(step); rv=1; } break;
            default:  printf("Warning, undefined sector number:%d\n",sector);
  }
  return rv;
}

---

Variable Documentation

int NSector

number of Sectors (dynamic cell_dyn modules)

Definition at line 28 of file generic_driver.h.

Referenced by get_parmf(), and main().

int iSector[MAX_SECTOR]

sector (dynamic cell_dyn module) number

Definition at line 29 of file generic_driver.h.

Referenced by get_parmf(), and main().

int seed

the seed value for (pseudo-) random number generator (unused)

Definition at line 30 of file generic_driver.h.

Referenced by get_parmf(), and local_setup().

int ESPmodeON = 0

boolean flag indicating Everglades Settling-of Phosphorus mode. A mode with all biol/chem (non-hydro) modules turned off, running only a net settling rate module that reproduces equations and data from the SFWMD's old Everglades Water Quality Model (EWQM). Done only for comparision to full ecological ELM - ESP doesn't work very well!!

Definition at line 31 of file generic_driver.h.

Referenced by BIRbudg_date(), BIRbudg_print(), BIRbudg_reset(), BIRbudg_sum(), BIRbudg_sumFinal(), BIRoutfiles(), get_parmf(), init_static_data(), and main().

int WatMgmtOn

boolean flag indicating water management mode

Definition at line 34 of file generic_driver.h.

Referenced by Flux_SWstuff(), get_parmf(), horizFlow(), and main().

int HabSwitchOn

boolean flag indicating habitat succession mode

Definition at line 35 of file generic_driver.h.

Referenced by cell_dyn1(), get_parmf(), and main().

int PositAnalOn = 0

flag for Position Analysis mode: for probability analysis of near-term water management options, Position Analysis mode involves re-inititialization of model on particular month/day at recurring yearly interval

Definition at line 36 of file generic_driver.h.

Referenced by get_parmf(), and main().

int IsSubstituteModel = 0

flag to indicate whether user is asking to substitute the Boundary Condition Model's "stage_minus_landElevation" variable into ELM hydro variables, running only the cell_dyn1 vertical solution module of ELM. This is used to post-process the SFWMM or NSM using the same procedures as ELM

Definition at line 38 of file generic_driver.h.

Referenced by cell_dyn1(), and main().

char SimAlt[30]

simulation scenario/alterative name

Definition at line 42 of file generic_driver.h.

Referenced by BIRoutfiles(), Canal_Network_Init(), get_parmf(), open_point_lists(), Read_schedule(), ReadChanStruct(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), ReadStructures(), and writeFloatNetCDF().

char SimModif[30]

simulation scenario/alterative modifier name/note

Definition at line 43 of file generic_driver.h.

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

char outpath[120]

base pathname for all output

Definition at line 44 of file generic_driver.h.

Referenced by get_parmf().

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.

Referenced by read_header(), read_map_dims(), readMap(), setup_grid(), write_header(), writeFloatMap(), and writeMap().

char initDateRead[15]

calendar date of simulation initialization

Definition at line 48 of file generic_driver.h.

Referenced by formatDate(), get_parmf(), and writeFloatNetCDF().

double Jdate_init

julian day (since epochs ago) of the initialization of model

Definition at line 49 of file generic_driver.h.

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

double Jdate_end

julian day (since epochs ago) of the ending of model

Definition at line 50 of file generic_driver.h.

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

int yr_in

Variables associated with the gregorian calendar

yr_in calendar year of initialization of model
mo_in calendar month of initialization of model
da_in calendar day of initialization of model
yr_end calendar year of ending of model
mo_end calendar month of ending of model
da_end calendar day of ending of model
hr_in hour of initialization of model (unused)
mi_in min of initialization of model (unused)
se_in seconds of initialization of model (unused)

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int mo_in

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int da_in

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int hr_in

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf().

int mi_in

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf().

int se_in

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf().

int yr_end

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int mo_end

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int da_end

Definition at line 62 of file generic_driver.h.

Referenced by get_parmf(), and main().

int mo_R_in

month of Re-initialization in Position analysis mode

Definition at line 63 of file generic_driver.h.

Referenced by get_parmf(), and main().

int da_R_in

day of Re-initialization in Position analysis mode

Definition at line 64 of file generic_driver.h.

Referenced by get_parmf(), and main().

int PORnumday

number of days of simulation Period Of Record (incl. start day)

Definition at line 65 of file generic_driver.h.

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

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

float step_Cell

constant used in horizontal surface water raster flux equations ( m^(-1.5) * sec )

Definition at line 69 of file generic_driver.h.

Referenced by Flux_SWcells(), and get_parmf().

float avg_Intvl = 0

time (day) interval between recurring-average summaries

Definition at line 71 of file generic_driver.h.

Referenced by CellAvg(), get_parmf(), readViewParms(), and track_time().

float budg_Intvl = 0

time (day) interval between budget summaries

Definition at line 72 of file generic_driver.h.

Referenced by BIRbudg_print(), get_parmf(), and track_time().

float BIRavg_Intvl = 0

time (day) interval between Basin/Indicator-Region stat summaries

Definition at line 73 of file generic_driver.h.

Referenced by BIRstats_print(), and track_time().

float BIRhyd_avg_Intvl = 0

time (day) interval between Basin/Indicator-Region hydro stat summaries

Definition at line 74 of file generic_driver.h.

Referenced by BIRstats_hydro_print(), get_parmf(), and track_time().

float can_Intvl = 0

time (day) interval between canal (water management) summaries

Definition at line 75 of file generic_driver.h.

Referenced by get_parmf(), and track_time().

int budgCalendar

boolean flag signifying use of gregorian calendar for budget and BIRavg calcs

Definition at line 77 of file generic_driver.h.

Referenced by get_parmf(), and track_time().

int BIRhydCalendar

boolean flag signifying use of gregorian calendar for BIR hydro avg calcs

Definition at line 78 of file generic_driver.h.

Referenced by get_parmf(), and track_time().

int avgCalendar = 0

boolean flag signifying use of gregorian calendar for recurring-average calcs

Definition at line 79 of file generic_driver.h.

Referenced by get_parmf(), and track_time().

int canalCalendar = 0

boolean flag signifying use of gregorian calendar for canal data output

Definition at line 80 of file generic_driver.h.

Referenced by get_parmf(), and track_time().

int avgPrint = 0

boolean flag to indicate if recurring-averages is to be printed at current time

Definition at line 81 of file generic_driver.h.

Referenced by CellAvg(), gen_output(), and track_time().

int canPrint = 0

boolean flag to indicate if canal data is to be printed at current time

Definition at line 82 of file generic_driver.h.

Referenced by Run_Canal_Network(), and track_time().

ProgAttr* ProgExec

Definition at line 86 of file generic_driver.h.

Referenced by alloc_mem_runs(), BIRstats_date(), get_global_parm(), get_hab_parm(), get_modexperim_parm(), get_parmf(), main(), and SensiParm_list().

ProgAttr** RunList

Definition at line 87 of file generic_driver.h.

Referenced by alloc_mem_runs(), get_parmf(), main(), and SensiParm_list().

float gRTable[]

Initial value:

        {.5000,.5398,.5793,.6179,.6554,.6915,.7257,.7580,.7881,.8159,
         .8413,.8643,.8849,.9032,.9192,.9332,.9452,.9554,.9641,.9713,
         .9773,.9821,.9861,.9893,.9918,.9938,.9953,.9965,.9974,.9981,
         .9987,.9990,.9993,.9995,.9997,.9998,.9998,.9999,.9999,1.00}

data used in function Normal, which is unused

Definition at line 89 of file generic_driver.h.

Referenced by Normal().

ViewParm* view

Definition at line 95 of file generic_driver.h.

Referenced by main(), and readViewParms().

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

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

Referenced by get_parmf(), local_setup(), main(), read_map_file(), setup_grid(), and setup_platform().

int Lprocnum

Definition at line 111 of file generic_driver.h.

Referenced by local_setup(), PTSL_ReadLists(), and read_map_dims().

int nprocs[2]

Definition at line 111 of file generic_driver.h.

Referenced by exgridsize(), local_setup(), and setup_platform().

int recpnum[2]

Definition at line 111 of file generic_driver.h.

Referenced by exgridsize(), local_setup(), quick_look(), and setup_platform().

int tramType

Definition at line 111 of file generic_driver.h.

Referenced by local_setup().

int tramNum[2]

Definition at line 111 of file generic_driver.h.

Referenced by exgridcoord().

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

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.

char * ProjName

Definition at line 40 of file driver_utilities.h.

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