Everglades Landscape Model (ELM) Home Page
Main Page | Data Structures | Directories | File List | Data Fields | Globals

applicationStruct Struct Reference

#include <gridmap.h>

Collaboration diagram for applicationStruct:

Collaboration graph
[legend]

Data Fields

FILE * binfile_ptr
float * dataELM
float ** dataAnyGrid
char tag [GRID_TAG_LENGTH]
float * values
GRID grid
int dayCntr
int recCntr
int day
int step
int recRead
int skip

Detailed Description

An application-specific data structure for use by variety of data-input apps.

Definition at line 64 of file gridmap.h.


Field Documentation

FILE* applicationStruct::binfile_ptr
 

grid_io data file pointer, stays open

Definition at line 66 of file gridmap.h.

Referenced by initDataStruct(), and processData().

float* applicationStruct::dataELM
 

array of data at ELM grid dimension

Definition at line 67 of file gridmap.h.

Referenced by evap_data_wmm(), initDataStruct(), rain_data_wmm(), returnData(), and stage_data_wmm().

float** applicationStruct::dataAnyGrid
 

array of non-ELM-grid-dim grid_io data (gridio_batch_len * OGrow_tot * OGcol_tot)

Definition at line 68 of file gridmap.h.

Referenced by initDataStruct(), processData(), and returnData().

char applicationStruct::tag[GRID_TAG_LENGTH]
 

holds date field tag of the grid_io data set

Definition at line 69 of file gridmap.h.

Referenced by initDataStruct(), and processData().

float* applicationStruct::values
 

holds array of values of grid_io data

Definition at line 70 of file gridmap.h.

Referenced by initDataStruct(), and processData().

GRID applicationStruct::grid
 

grid_io data structure that holds the model grid information. this is declared in grid_io.h

Definition at line 71 of file gridmap.h.

Referenced by initDataStruct(), mapELM2Grid_io(), and processData().

int applicationStruct::dayCntr
 

control variable, must be in application

Definition at line 72 of file gridmap.h.

Referenced by returnData().

int applicationStruct::recCntr
 

control variable, must be in application

Definition at line 73 of file gridmap.h.

Referenced by returnData().

int applicationStruct::day
 

This variable keeps track of the number of records returned to UnitMod, calling program. It is always one batch behind the recRead and it gets added until program ends.

Definition at line 74 of file gridmap.h.

Referenced by evap_data_wmm(), initDataStruct(), rain_data_wmm(), returnData(), and stage_data_wmm().

int applicationStruct::step
 

This variable keeps track of the records in batch of data read in sofar. When batch of data all is returned to UnitMod, this variable gets reset per batch

Definition at line 78 of file gridmap.h.

Referenced by initDataStruct(), processData(), and returnData().

int applicationStruct::recRead
 

This variable keeps track of the total number of records read so far from the binary grid_io file. It increments until it equals PORnumday (# days in sim POR)

Definition at line 82 of file gridmap.h.

Referenced by evap_data_wmm(), initDataStruct(), processData(), rain_data_wmm(), returnData(), and stage_data_wmm().

int applicationStruct::skip
 

The user can ask for any starting date for the simulation. This is the number of records skipped to get to starting date in the grid_io binary file. The skip gets added to recRead-1 every time a new batch of binary data is being read. This tells grid_io which record from the beginning of file go to for the next batch. Gets reset per program execution.

Definition at line 85 of file gridmap.h.

Referenced by initDataStruct(), and processData().


The documentation for this struct was generated from the following file:
Generated on Thu Jul 6 11:20:53 2006 for ELM source code by  doxygen 1.3.9.1