stage.h File Reference

Header file for acquiring water depth (misnamed stage) grid_io data. More...

#include "gridmap.h"
#include "globals.h"

Include dependency graph for stage.h:

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

Go to the source code of this file.

Functions
int	stage_data_wmm (float *)
VOIDP	nalloc (unsigned mem_size, const char var_name[])
	Allocate memory for a variable.
Variables
applicationStruct	stage_struct
char	stage_binfilename [335]
char *	ModelPath
char *	ProjName

---

Detailed Description

Header file for acquiring water depth (misnamed stage) grid_io data.

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

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

The Everglades Landscape Model (ELM).
last updated: Jan 2005

Definition in file stage.h.

---

Function Documentation

int stage_data_wmm

(

float *

)

stage (depth) data array

Definition at line 31 of file stage_inp.c.

Referenced by cell_dyn1().

{

  int i,j,k;
  int success = 1, fail = -1;
  int stat = success;
  char gridmapfilename[335];

  if(SimTime.TIME==0)  {      
/* elm_OG_map is data structure containing the mapping attributes at two scales */
    elm_wmm_map = elm_OG_map;

    if(elm_wmm_map == NULL) {
      sprintf(msgStr, "Mapping grids and setting up stage data...");
      usrErr (msgStr);

      sprintf(gridmapfilename, "%s%s/Data/gridmapping.txt", ModelPath, ProjName );   
      stat = mapGrids(gridmapfilename);
      elm_wmm_map = elm_OG_map;
    }

    if(debug > 4) {
      printGridMap();
      sprintf(msgStr,"stage_data_wmm==> Finished mapping grids");
      usrErr (msgStr);
    }

    sprintf(stage_binfilename, "%s%s/Data/BoundCond_stage.BIN", ModelPath, ProjName );
    /* initializing data structures, move pointer to initial date (gridmap.c) */
    stat = initDataStruct(stage_binfilename,&stage_struct);  

    if(debug > 4) {
      /*printELM2Grid_io(); */
      /*drawELM2Grid_io(); */
      sprintf(msgStr,"stage_data_wmm==> Finished initializing");
      usrErr (msgStr); 
    }

  } /* end of SimTime.TIME=0 */
  
  
  if(stage_struct.day >= stage_struct.recRead) {      /* process the data in batch */
      sprintf(msgStr,"Processing batch of stage data...");
      usrErr (msgStr); 
      stat = processData(stage_binfilename,&stage_struct);

      if(debug > 4 ) {
        /*printBatchData(stageWMM,gridio_batch_len,widCnt);*/ /* TODO: remove this printBatchData function when sure is no longer needed */
        sprintf(msgStr,"stage_data_wmm==> Finished processing data");
        usrErr (msgStr); 
      }
  } /* end of if */


  if(stage_struct.day < stage_struct.recRead) {      /* pass the data day by day */
    returnData(stageSME,&stage_struct); 

    for(i = 0; i < s0; i++) {
      for(j = 0; j < s1; j++) {
        k = i*s1+j;
        stageSME[T((i+1),(j+1))] = stage_struct.dataELM[k] * conv_ftTOm;  /* convert data from feet to meters */
      }
    } 

    if(debug > 4) {
      sprintf(msgStr,"stage_data_wmm==> Finished returning data");
      usrErr (msgStr); 
    }

  } /* end of if */
    
  return success;
}

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

Allocate memory for a variable.

Parameters:

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

Returns:

Pointer to that memory

Definition at line 1857 of file Driver_Utilities.c.

{
  VOIDP rp;

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

---

Variable Documentation

applicationStruct stage_struct

Definition at line 18 of file stage.h.

Referenced by stage_data_wmm().

char stage_binfilename[335]

grid_io binary data file name

Definition at line 20 of file stage.h.

Referenced by stage_data_wmm().

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.