3. Results 3Di

The results of a simulation are written to file. The result file is created using NetCDF, which is a set of software libraries and self-describing, machine-independent data formats that support the creation, access, and sharing of array-oriented scientific data. The set of libraries can be used by multiple tools and programming languages, such as matlab, python and excel, to extract the data from the netcdf data formats.

The 3Di Plugin visualizes the information stored in this file. An overview of the data format in the output file is given in this chapter, to help users in reading data from file. To facilitate users in the direct access to the results from the output file, users can make use of the python package threedigrid. Which can be downloaded from https://pypi.org/project/threedigrid. This package helps to link the output data to the input data.

During the spring release of 2018 the output file has been changed. The changes include a change in name from subgrid_map.nc to results_3di.nc and changes to the data format within the output file. An overview of both data formats is presented below.

These files consist of all relevant variables that are necessary to analyze the results of a simulation. The user defines the output time step. The snapshots of the flow are saved at these intervals. Note, that the output time step in combination with the size of the model will define the size of the output file. In addition to these snap shots, 3Di can generate aggregated results. More about this can be found in Aggregated output.

3.1. Data format results_3di.nc

The current output NetCDF file consists of all flow variables of the 1D and the 2D mesh. The results file is constructed according to the CF Conventions . In this data format, the 2D and 1D mesh are split, so each part of the mesh has its own result and mesh variable. A description of all the flow and mesh variables for the 1D and 2D mesh are given below:

3.1.1. 2D Mesh Cell/Node variables:

This concerns the meta information that defines the computational grid.

3.1.1.1. Coordinates:

Mesh2DFace_xcc:

  • Name: Flow Face 2D center x coordinate
  • Unit: [m]

Mesh2DFace_ycc:

  • Name: Flow Face 2D center y coordinate
  • Unit: [m]

Mesh2DFace_zcc:

  • Name: Flow Face 2D center z coordinate
  • Unit: [m MSL]

Mesh2DContour_x:

  • Name: List of x-coordinates forming Face
  • Unit: m

Mesh2DContour_y:

  • Name: List of y-coordinates forming Face
  • Unit: m

3.1.1.2. Attributes:

Mesh2DNode_id:

  • Name: Node Identifier

Mesh2DFace_sumax:

  • Name: Total cell surface
  • Unit: m2

Mesh2DNode_type:

  • Name: Type of 2D mesh node/face
  • Types: surface_water_2d, grounwater_2d, groundwater_2d, open_water_boundary_2d, groundwater_boundary_2d

3.1.1.3. Dimensions:

nMesh2D_nodes:

  • Name: Number of 2D mesh nodes/faces.

3.1.1.4. Flow Variables:

These are the variable that are defined in the cell centers.

Mesh2D_s1:

  • Name: waterlevel
  • Unit: m MSL

Depending on the node, it is the surface or the groundwater level.

Mesh2D_vol:

  • Name: Water volume
  • Unit: m3

Mesh2D_su:

  • Name: Wet surface area
  • Unit: m2

Mesh2D_ucx:

  • Name: Flow velocity in x direction in cell center
  • Unit: m/s

This is an interpolated velocity value that is based on the velocities on cell faces.

Mesh2D_ucy:

  • Name: Flow velocity in y direction in cell center
  • Unit: m/s

This is an interpolated velocity value that is based on the velocities on cell faces.

Mesh2D_rain:

  • Name: Rain
  • Unit: m3/s

Mesh2D_q_lat:

  • Name: Lateral discharge
  • Unit: m3/s

Mesh2D_infiltration_rate_simple:

  • Name: Infiltration rate
  • Unit: m3/s

This variable only exist in cases where groundwater is not taken into account.

Mesh2D_leak:

  • Name: Leakage rate
  • Unit: m3/s

This variable only exist in cases where groundwater is taken into account.

Mesh2D_intercepted_volume:

  • Name: intercepted_volume
  • Unit: m3

3.1.2. 2D Mesh Line variables:

This concerns the meta information that defines the connections between the computational cells.

3.1.2.1. Coordinates:

Mesh2DLine_xcc:

  • Name: Flow line 2D center x coordinate.
  • Unit = m

Mesh2DLine_ycc:

  • Name: Flow line 2D center y coordinate.
  • Unit = m

Mesh2DLine_zcc:

  • Flow line 2D center z coordinate.
  • Unit = m

3.1.2.2. Attributes:

Mesh2DLine_type:

  • Name: Type of Cell edge
  • Types: open_water_2d, open_water_obstacles_2d, vertical_infiltration_2d, groundwater_2d, open_water_boundary_2d, groundwater_boundary_2d

3.1.2.3. Dimensions:

nMesh2D_lines:

  • Name: Number of 2D Mesh lines.

3.1.2.4. Flow variables:

Mesh2D_u1:

  • Name: Flow velocity on 2D flow line
  • Unit: m/s

This variable, in case of Horton-based infiltration and groundwater flow, also consists of the vertical flow and the groundwater flow. This depends on the line number. This also yields for most of the other line variables.

Mesh2D_q:

  • Name: Discharge on flow line
  • Unit: m3/s

Mesh2D_au:

  • Name: Wet cross-sectional area
  • Unit: m

Mesh2D_up1:

  • Name: Flow velocity in interflow layer
  • Unit: m/s

Mesh2D_qp:

  • Name: Discharge in interflow layer
  • Unit: m/s

3.1.3. 1D Mesh Node variables:

The results for the 1D variables are structured in a similar way. Note that embedded nodes do not have a 1D water level, volume etc information. This information can be found in the 2D results.

3.1.3.1. Coordinates:

Mesh1DNode_xcc:

  • Name: Node 1D x coordinate
  • Unit: m

Mesh1DNode_ycc:

  • Name: Node 1D y coordinate
  • Unit: m

Mesh1DNode_zcc:

  • Name: Node 1D z coordinate
  • Unit: m MSL

3.1.3.2. Attributes:

Mesh1DNode_id:

  • Name: Node Identifier

Mesh1DNode_sumax:

  • Name: Total cell surface
  • Unit: m2

Mesh1DNode_type:

  • Types = node_without_storage_1d, open_water_with_storage_1d, open_water_boundary_1d

3.1.3.3. Dimensions:

nMesh1D_nodes:

  • Name: Number of 1D mesh nodes

3.1.3.4. Flow variables:

Mesh1D_s1:

  • Name: Waterlevel in 1D Node
  • Unit: m MSL

Mesh1D_vol:

  • Name: Water volume in 1D Node
  • Unit: m3

Mesh1D_su:

  • Name: Wet surface of 1D Node
  • Unit: m2

Mesh1D_rain:

  • Name: Inflow in 1D from rain
  • Unit = m3/s

Mesh1D_q_lat:

  • Name: Lateral discharge in/from 1D cell
  • Unit = m3/s

3.1.4. 1D Mesh Line variables:

3.1.4.1. Coordinates:

Mesh1DLine_xcc:

  • Name: Flow line 1D x center coordinate
  • Unit: m

Mesh1DLine_ycc:

  • Name: Flow line 1D center y coordinate
  • Unit: m

Mesh1DLine_zcc:

  • Name: Flow line 1D z center coordinate
  • Unit = m MSL

3.1.4.2. Attributes:

Mesh1DLine_id:

  • Name: Line identifier

Mesh1DLine_type:

  • Types: embedded_1d, isolated_1d, connected_1d, long_crested_structure_1d, short_crested_structure_1d, double_connected_1d, from_node_with_storage_1d2d, from_node_without_storage_1d2d, potential_breach_1d2d, groundwater_1d2d, boundary_1d

3.1.4.3. Dimensions:

nMesh1D_lines:

  • Name: Number of 1D Mesh lines

3.1.4.4. Flow variables:

Mesh1D_u1:

  • Name: Flow velocity on 1D flow line
  • Unit: m/s

Mesh1D_q:

  • Name: Discharge on 1D flow line
  • Unit: m3/s

Mesh1D_au:

  • Name: Wet cross-sectional area
  • Unit: m

Mesh1D_breach_depth:

  • Name: Breach depth on 1D2D connection)
  • Unit: m

Mesh1D_breach_width:

  • Name: Breach width on 1D2D connection)
  • Unit: m

3.1.5. Pump variables:

3.1.5.1. Coordinates:

Mesh1DPump_xcc:

  • Name: Start point Pump 1D x-coordinate
  • Unit: m

Mesh1DPump_ycc:

  • Name: Start point Pump 1D y-coordinate
  • Unit: m

3.1.5.2. Attributes:

Mesh1DPump_id:

  • Name: Pump identifier

3.1.5.3. Dimensions:

nPumps:

  • Name: Number of 1D pumps

3.1.5.4. Flow variables:

Mesh1D_q_pump:

  • Name: Pump discharge
  • Unit: m3/s

3.2. Data format subgrid_map.nc

In the file called: subgrid_map.nc exists the following information:

  • X-coordinates of the 2D computational cell corner points (FlowElemContour_x)

    • size[4,n2dtot]
    • dimension [m]
  • Y-coordinates of the 2D computational cell corner points (FlowElemContour_y)

    • size [4,n2dtot]
    • dimension [m]
  • X-coordinates 1D en 2D computational cell center point (FlowElem_xcc)

    • size [number of computational nodes]
    • dimension [m]
  • y-coordinates 1D en 2D computational cell center point (FlowElem_ycc)

    • size [number of computational nodes]
    • dimension [m]
  • Maximum surface area computational cell (sumax)

    • size [number of computational nodes]
    • dimension [m2]
  • Connections between computational points in 1D network (FlowLine_connections)

    • size [2,number of flow lines]
    • dimension [-]
  • Connections by a pump (PumpLine_connections)

    • size [2,number of pumps]
    • dimension [-]
  • (projected_coordinate_system (projected_coordinate_system)

    • size [1]
    • dimension [-]
  • Deepest point of a computational cell (bath)

    • size [number of computational nodes]
    • dimension [m MSL]
  • Potential breaches

    • size [number of potential breaches]
    • dimension [-]
  • Mapping of input and out put of connection nodes (node_mapping)

    • size [2,number of connection nodes]
    • dimension [-]
  • Mapping of input and out put of connection lines (channel_mapping)

    • size [2,number of flow lines]
    • dimension [-]
  • Time (time)

    • size [number of time steps]
    • dimension [s]
  • Water level (s1)

    • size [number of computational nodes]
    • dimension [m MSL]
  • Volume in a computational cell (vol)

    • size [number of computational nodes]
    • dimension [m3]
  • Wet surface areas computational cell (su)

    • size [number of computational nodes]
    • dimension [m2]
  • Velocity interpolated in cell centre in x-direction (ucx)

    • size [number of computational nodes]
    • dimension [m/s]
  • Velocity interpolated in cell centre in y-direction (ucy)

    • size [number of computational nodes]
    • dimension [m/s]
  • Rain per computational cell (rain)

    • size [number of computational nodes]
    • dimension [m3/s]
  • Lateralen per computational cell (qlat)

    • size [number of computational nodes]
    • dimension [m3/s]
  • Infiltration per computational cell (infiltration)

    • size [n2dtot]
    • dimension [m3/s]
  • Velocity (u1)

    • size [number of flow lines]
    • dimension [m/s]
  • Discharge (q)

    • size [number of flow lines]
    • dimension [m3/s]
  • Wet Cross-Sectional area (au)

    • size [number of flow lines]
    • dimension [m2]
  • Velocity in interflow layer (up1) (if defined)

    • size [number of flow lines]
    • dimension [m/s]
  • Discharge in interflow layer (qp) (if defined)

    • size [number of flow lines]
    • dimension [m3/s]
  • Discharge (q_pump)
  • size [Number of pumps]
  • dimension [m3/s]
  • computational cells in 2D (nFlowElem2D)
    • [n2dtot]
  • computational cells in 1D (nFlowElem1D)
    • [n1dtot]
  • computational cells concerning 2D boundary conditions (nFlowElemBound2d)
    • [n2dobc]
  • computational cells concerning 1D boundary conditions (nFlowElemBound1d)
    • [n1dobc]
  • total computational cells (nFlowElem)
    • [number of computational nodes]
  • Flowlines in 2D Domain (nFlowline2D)
    • [l2dtot of liutot+livtot]
  • Flowlines in 1D Domain (nFlowline(1D)
    • [l1dtot]
  • 1D2D Connections (nFlowline1D2D)
    • [infl1d]
  • Flowlines concerning 2D boundary conditions (nFlowline2DBound)
    • [n2dobc]
  • Flowlines concerning 1D boundary (nFlowline1DBound)
    • [nodobc-n2dobc]
  • Total number of flowlines (nFlowline)
    • [number of flow lines]
  • Number of Pumps (nPumps)
    • [jap1d]
  • Number of potential breaches (nBreaches)
    • [levnms]