Actions

UNTRIM GRID.DAT

From BAWiki

Basic Information

File-Type

untrim_grid.dat

Version

May 2011

Description-Date

May 2011

Significance of the File

contains grid data for the numerical model Untrim

This format has two variants. These variants can both be interpreted by the same interfaces:

  • Untrim_Grid_Baw (variant of the BAW)
  • Untrim_Grid_VC (variant of Prof. Vincenzo Casulli)

Both variants are ASCII formatted and are divided in two sections. The first section contains static information and the second section contains dynamic information. The differences between these variants are as follows:

  • In variant Untrim_Grid_Baw all information will be read and written by NAMELIST, in variant Untrim_Grid_VC only the static information will be read and written by NAMELIST.
  • The dynamic information side data and cell data are sorted different. In variant Untrim_Grid_Baw side data follows node data, in variant Untrim_Grid_VC it is opposite.
  • In variant Untrim_Grid_Baw it is possible to store multiple descriptive text lines. The variant Untrim_Grid_VC can store only one (in the static data section).
  • The static data max. number of sides per cell (nc) will be written to file only in variant Untrim_Grid_Baw.
  • The static data mean geographic latitude and depth limit is integer in variant Untrim_Grid_Baw and real in variant Untrim_Grid_VC.
  • The dynamic data water depth at nodes will only be stored on file in variant Untrim_Grid_Baw. In variant Untrim_Grid_VC this data will be computed out of the minimum depth at the adjacent sides.
  • The dynamic data cell type (triangle, square, ...) will only be stored on file in variant Untrim_Grid_Baw. In variant Untrim_Grid_VC this data will be computed out of the number of sides at a cell. Remark: At this time only the types "triangle" and "irregular quad" are possible.
  • The dynamic data material name of a side or cell will only be stored on file in variant Untrim_Grid_Baw. In variant Untrim_Grid_VC this data will be set to 0.
  • The dynamic data center coordinates of a cell will only be stored on file in variant Untrim_Grid_VC.
  • Both file variants may optionally contain additional informations to describe partitioned grids (domain decomposition). In this case the NAMELIST block names are different. Additional data related to communication and domain decomposition are stored in the last part of the file.
  • For partitioned grids data within limits 1:NV, 1:NS and 1:NE describe a fully UnTRIM compliant grid, which can be used in computations. Within limits NV+1:NVX, NS+1:NSX and NE+1:NEX data for the external halo follow.

File-Contents (in Catchwords)

  1. Every grid file is divided into several sections, containing the following grid data: static information (internal domain in case of domain decomposition):
    • total number of grid nodes, sides and cells;
    • number of red cells;
    • total number of boundary cells;
    • number of inner sides;
    • max. number of sides per cell (only Untrim_Grid_Baw);
    • total number lines with desriptive text (only Untrim_Grid_Baw);
    • depth limit to set computational domain;
    • mean geographic latitude;
    • descriptive text line (only Untrim_Grid_VC).
  2. optional static information (in case of domain decomposition):
    • total number of grid nodes including external halo nodes;
    • total number of grid edges including external grid edges;
    • total number of grid polygons including external halo polygons;
    • number of open boundary polygons lying in the external halo;
    • number for the last red polygon within the external halo;
    • total number of global communication pairs (only Untrim_Grid_Baw);
    • total number of grid partitions (only Untrim_Grid_Baw);
    • number of locally used communication partners (only Untrim_Grid_Baw).
  3. dynamic information:
    • descriptive text lines (only Untrim_Grid_Baw);
    • node data:
      • node name (only Untrim_Grid_Baw),
      • x- and y-coordinate and
      • water depth at node (only Untrim_Grid_Baw; actual depth or depth of the non-erodible layer).
    • side data:
      • side name (only Untrim_Grid_Baw);
      • names of belonging nodes,
      • material name (only Untrim_Grid_Baw),
      • names of neighbour cells (notice: in case of domain decomposition neighbours lying in adjacent domains are marked using negative numbers), and
      • water depth along the side(actual depth or depth of the non-erodible layer).
    • cell data:
      • cell name (only Untrim_Grid_Baw),
      • cell type (1=triangle, 2=square, ...) (only Untrim_Grid_Baw),
      • material name (only Untrim_Grid_Baw),
      • number of sides,
      • names of all belonging sides,
      • names of all belonging nodes and
      • center coordinates (only Untrim_Grid_VC).
  4. optional dynamic information (in case of domain decomposition):
    • general description of communication:
      • list of global communication pairs (younger and older MPI process partners);
      • list of local communication partners (MPI process number);
      • list with locally used global communication pairs (index list).
    • internal halo description for each communication partner (local numbering used):
      • list with nodes belonging to the internal halo;
      • list with edges belonging to the internal halo;
      • list with polygons belonging to the internal halo.
    • external halo description for each communication partner (local numbering used):
      • list with nodes belonging to the external halo;
      • list with edges belonging to the external halo;
      • list with polygons belonging to the external halo.
    • interface description (local numbering used):
      • list with nodes along the interface;
      • list with edges along the interface.
    • connectivity list for local and global numbering:
      • list with global node numbers for all local nodes;
      • list with global edge numbers for all local edges;
      • list with global polygons numbers for all local polygons.
    • description of communication partners for external halo polygons:
      • list with partition numbers to which each polygon of the external halo belongs;
      • list with local polygon number for all external halo polygons within their respective (neighbour) partition.
  5. (optional) Block GLOBAL_STATIC
    Can be used to fill in global attributes before generating a CF-NetCDF file.
    1. NH = number of history lines.
    2. NC = number of comment lines.
  6. (optional) Block GLOBAL
    Can be used to fill in global attributes before generating a CF-NetCDF file.
    1. INSTITUTION = institution which generates the data.
    2. REFERENCES = reference of the providing institution.
    3. CONVENTIONS = NetCDF conventions which are fulfilled by the file.
    4. TITLE = title of the file.
    5. SOURCE = source of the file.
  7. (optional) blocks GLOBAL_HISTORY
    Can be used to fill in global attributes before generating a CF-NetCDF file.
    1. HISTORY = a history line of the file.
  8. (optional) blocks GLOBAL_COMMENT
    Can be used to fill in global attributes before generating a CF-NetCDF file.
    1. COMMENT = a comment line of the file.
  9. (optional) Block CODE_AND_TIME_INFO
    Can be used to fill in attributes to the depth variable before generating a CF-NetCDF file.
    1. CODE = phydef code to explain the meaning of the depth data [17,617,1149].
    2. TIME = reference time of the depth data.
    3. BEGIN = start time of the validity period of the depth data.
    4. END = end time of the validity period of the depth data.


Notice: for files with data of a partitioned grid methods from within package mod_p_h_grid_ui.f90 can only be used.

Programs using this Type of File

ABDF, DATACONVERT, DIDAMERGE, DIDAMINTZ, DIDARENAME, DIDASPLIT, ENERF, FRQWF, GEOTRANSFORMER, GRIDCONVERT, GVIEW2D, HVIEW2D, IO_VOLUME, LZKAF, LZKSF, LZKVF, LZKWF, PGCALC, RSMERGE, TDKLF, TDKSF, TDKVF, TDKWF, TICLQ2, TOUTR, UNK, UNS, UNTRIM, UNTRIM2007, UTRPRE, UTRRND, VOLUMETH, VTDK, WARM, XTRDATA, XTRLQ2

Additional Information

Language

Fortran90

File-Form

FORMATTED

File-Access

SEQUENTIAL (DELIM=QUOTE)

File-Extension

.dat

WRITE-Subroutine(s)/Module(s)

  1. $PROGHOME/public/utr/*/mod_utrg_hor_interface.f90 (Utrgrid_Hor_Grid_Write), for non-partitioned grids only
  2. mod_p_h_grid_ui.f90 (User-Interface).

READ-Subroutine(s)/Module(s)

  1. $PROGHOME/public/utr/*/mod_utrg_hor_interface.f90 (Utrgrid_Hor_Grid_Read), for non-partitioned grids only
  2. mod_p_h_grid_ui.f90 (User-Interface).

Original Version

J. Jürges, G. Lang

Maintenance

J. Jürges, G. Lang

Example-File

see $PROGHOME/examples/lib/h_grid/
$PROGHOME/examples/lib/h_grid/h_grid_test_utr_plus_CF_Info_input.dat


back to: File Descriptions


Overview