eOGMap Struct Reference

#include <gridmap.h>

Data Fields
int	OGID
int *	elmID
int	eidCnt
int	index
int	OGROW
int	OGCOL

---

Detailed Description

This data structure is specific to the output of the (C++) "grmap" pre-processor program. That pre-processor program must be run (once) for each new combination of ELM-grid-data (grain/extent) and data utilizing another grid. The resulting ELM-input data file is expected to reside in the standard ELM-input data directory.

Since gridmap can map any data-grid (for now, coarser in resolution only) to the ELM grid, we call the name of struct ELM+AnyOtherGrid+Map (eOGMap) to be generic enough. The data-input application that uses this struct can be called to reflect the applied grid; i.e struct eOGMap *elm_wmm_map This is global and can be used by applications. Only one copy is enough.

Definition at line 36 of file gridmap.h.

---

Field Documentation

int eOGMap::OGID

each Other-Grid ID (OGID) holds one or more elmID in its array

Definition at line 37 of file gridmap.h.

Referenced by mapELM2Grid_io(), mapGrids(), printGridMap(), and returnData().

int* eOGMap::elmID

at most one Other-Grid (OG) cell maps into how many elm cells, elmID=-1 means there is no elm cell in this OGID. This is used in a loop

Definition at line 38 of file gridmap.h.

Referenced by cleanUp(), mapELM2Grid_io(), mapGrids(), printGridMap(), and returnData().

int eOGMap::eidCnt

exact elmID array

Definition at line 40 of file gridmap.h.

Referenced by mapGrids(), printGridMap(), and returnData().

int eOGMap::index

the index of elm_OG_map[OGrow_tot*OGcol_tot] where elm cell falls in Other-Grid (OG) cell. Otherwise the index number gets different values according to different cases:

• NOT_ELM_NOT_GRIO: outside of ELM domain, and Other-Grid (OG) cell does not have data (does not fall in grid_io (GRIO) data domain). index= -1, no data for elm, no grid_io increment, elmID= -1
• NOT_ELM_IN_GRIO: outside of ELM domain, and Other-Grid (OG) cell is in grid_io (GRIO) data domain, but not needed. index= -2, no data for elm, grid_io increment values, elmID= -1
• IN_ELM_NOT_GRIO: ELM cell within Other-Grid (OG) cell, and OG cell does not have data (OG cell does not fall in grid_io (GRIO) data domain). index= -3, data estimate needed for elm, no grid_io increment, elmID= x
• case4: ELM cell within Other-Grid (OG) cell, and OG cell does have data (falls in grid_io (GRIO) data domain). index=elm_OG_map[i] where i = {0,1,...,OGrow_tot*OGcol_tot}, data avai. for elm, grid_io increment, elmID= x

Definition at line 41 of file gridmap.h.

Referenced by mapELM2Grid_io(), mapGrids(), printGridMap(), and returnData().

int eOGMap::OGROW

row ID of Other-Grid (OG) cell

Definition at line 57 of file gridmap.h.

Referenced by mapGrids(), printGridMap(), and returnData().

int eOGMap::OGCOL

column ID of Other-Grid (OG) cell

Definition at line 58 of file gridmap.h.

Referenced by mapGrids(), printGridMap(), and returnData().

---

The documentation for this struct was generated from the following file:

• gridmap.h