Special names for grid attributes and calculation results¶
In iRIC, some special names for grid attribute and calculation results are defined for certain purposes. Use those names when the solver uses the grid attributes or calculation results that match the purposes.
Grid attributes¶
Table 1874 shows the special names defined for grid attributes.
Name |
Description |
---|---|
Elevation |
Grid attribute that contains elevation of grid nodes (Unit: meter). Define "Elevation" attribute as an attribute defined at grid node, with real number type. |
When you use "Elevation" for grid attribute, define an Item element as a child of GridRelatedCondition element, like List 179. You can change caption attribute value to an arbitrary value.
<Item name="Elevation" caption="Elevation">
<Definition position="node" valueType="real" default="max" />
</Item>
When you create a grid generating program and want to output elevation value, use name "Elevation". iRIC will automatically load "Elevation" value.
List 180 shows an example of code written in Fortran.
cg_iric_write_grid_real_node(fid, "Elevation", elevation, ier);
Calculation results¶
Table 1875 shows the special names defined for calculation results. Specify these names as arguments of subroutines defined in iRIClib.
List 181 shows an example of solver source code that outputs all special calculation result.
Name |
Description |
Required |
Elevation |
Outputs bed elevation (unit: meter). Output the value as real number calculation result. You can add unit in the tail as the part of the name, like "Elevation(m)". |
Yes |
WaterSurfaceElevation |
Outputs water surface elevation (unit: meter). Output the value as real number calculation result. You can add unit in the tail, like "WaterSurfaceElevation(m)". |
|
IBC |
Valid/invalid flag. At invalid region (i. e. dry region), the value is 0, and at valid region (i. e. wet region), the value is 1. |
call cg_iric_write_sol_node_real(fid, 'Elevation(m)', elevation_values, ier)
call cg_iric_write_sol_node_real(fid, 'WaterSurfaceElevation(m)', surface_values, ier)
call cg_iric_write_sol_node_integer(fid, 'IBC', IBC_values, ier)