iRIC Software User's Manual¶
Introduction¶
The International River Interface Cooperative (iRIC) software application provides an integrated river simulation environment.
iRIC provides a comprehensive, unified environment in which data that are necessary for river analysis solvers (hereafter: solvers) can be compiled, rivers can be simulated and analytical results can be visualized.
The highly flexible iRIC interface allows various solvers to be imported, or you can use one of the iRIC solvers. Upon selecting the solver, iRIC selects functions suitable for the solver and prepares the optimal simulation environment.
Because the iRIC functions vary depending on the solver, the method of using the iRIC application depends on the solver. To determine which functions are usable for each solver, refer to Solver Tutorials.
This user's manual explains general methods for using all the iRIC functions.
Installation¶
This page explains how to install iRIC, and related topics.
How to Install¶
Download the installer of iRIC from the iRIC web site. Please access https://i-ric.org/download/.
Execute the installer that you’ve downloaded.
Warning about installing Miniconda¶
iRIC 3.0 can run solvers developed with Python.
To run solver developed with python, iRIC installer bundles Miniconda as Python runtime environment. Please refer to the following URL about the detail of Miniconda.
https://docs.conda.io/en/latest/miniconda.html
When you install Miniconda using iRIC installer, Miniconda is installed to “Miniconda3” folder under the iRIC install target folder.
Note that when you have an environement where Miniconda is already installed, if you install Miniconda additionally using iRIC installer, it cause bad dffects to the Miniconda environment that already exists.
So, in that case, DO NOT install Miniconda using iRIC installer, and follow the steps described in Preparing iRIC solver runtime environment using Miniconda that is already installed.
If you accidently installed Miniconda additionally, follow the steps in How to recover in case you’ve overwritten the original Miniconda environement accidently, to rescue the environment.
Preparing iRIC solver runtime environment using Miniconda that is already installed¶
You can prepare iRIC solver runtime environment using Miniconda that is already installed. The steps can be applied for Anaconda too.
Do not install Miniconda¶
When installing iRIC, please make sure that the check boxes for the items below are checked off. For safety, they are checked off in the default state.
Miniconda
iriclib for Miniconda
Create virutal environment for iRIC¶
Launch “Anaconda Prompt (miniconda3)” from start menu, and execute the command below:
conda create -n iric python=3.8
conda activate iric
conda install numpy
The commands creates virtual environment named “iric”, and installs Python 3.8 and numpy to that.
For example when you’ve installed Miniconda to D:\Miniconda3, make sure that now you have Python.exe in D:\Miniconda\Envs\iric.
Install iriclib for Python¶
Install iriclib for Python to the virtual environment you’ve created.
For example, when you’ve installed Miniconda to D:\Miniconda3, please copy the files below to D:\Miniconda\Envs\iric\Lib\site-packages.
IRICROOT\guis\prepost\sdk\python\iric.py
IRICROOT\guis\prepost\sdk\python\_iric_python38.pyd –> rename to _iric.pyd after copying
IRICROOT\guis\prepost\iriclib.dll
IRICROOT\guis\prepost\cgnsdll.dll
IRICROOT\guis\prepost\hdf5.dll
IRICROOT\guis\prepost\szip.dll
IRICROOT\guis\prepost\zlib.dll
In the list above, iRICROOT means the install target folder of iRIC (For example C:\Users\user1\iRIC).
Testing iriclib¶
Launch “Anaconda Prompt (miniconda3)” from start menu, and execute the following commands.
conda activate iric
python
import iric
When no error message is shown, iriclib is installed correctly.
Setup Python path setting on iRIC¶
Setup iRIC so that it can run solvers using the environment that you’ve created. Please follow the steps below:
Launch iRIC, by double clicking the iRIC icon on your desktop.
Select [Option] -> [Preference] from menu.
Input the path of Python to [Python path]. For example, in the case above, it should be “D:\Miniconda\Envs\iric\Python.exe”.
How to recover in case you’ve overwritten the original Miniconda environement accidently¶
When you install Miniconda with iRIC installer, the following problem occurs for the Miniconda environment that you’ve installed in advance.
“Anaconda Prompt (miniconda3)” and “Anaconda Powershell Prompt (miniconda3)” that you can launch from start menu refers the new environment that you’ve installed using iRIC installer.
You can recover the problem above, with the following steps:
Right-click on “Anaconda Prompt (miniconda3)” in start menu, and select “Other” -> “Open the file location”.
A new explorer window opens, and the shortcut “Anaconda Prompt (miniconda3)” is shown. Right-click on the shortcut, and select “Property”.
“Make sure that the “link target” value is like below:
%windir%System32cmd.exe “/K” (iRIC install target)\Miniconda3\Scripts\activate.bat (iRIC install target)\Miniconda3
Replace (iRIC install target) with the path that you’ve installed Miniconda, and click on [OK] button.
You can recover “Anaconda Powershell Prompt (miniconda3)” shortcut with the same steps too.
Overview¶
Operation procedure¶
Figure 1 shows the general operations for iRIC simulations, and the window for each process. Details of each window are explained in Windows
iRIC Operations¶
Windows¶
Figure 2 shows the iRIC main window.
It uses a standard interface, with a menu bar and a toolbar. Menu bar and tool bar are explained in Menu bar and Toolbar.
When using iRIC, you can open various subwindows that meet your needs inside the main window. The [Pre-processing Window] opens as soon as you make a new project.
Subwindows are explained in [Pre-processing Window] to [Scattered Chart Window].
A [Pre-processing Window] opens when a project starts. Other subwindows are not opened at first. You can open them manually when you need to.
iRIC main window¶
Menu bar and Toolbar¶
The menu bar and the toolbar have the characters explained below.
Toolbars¶
The following three toolbars are available:
Main Toolbar
Operation Toolbar
Animation Toolbar
For the functions of each toolbar, refer to Table 2.
Item |
Functions |
Displayed when |
|---|---|---|
Main Toolbar |
Handling of files, canvas display, solver launching and window display |
Always |
Operation Toolbar |
Operations that are possible for items selected in [Object Browser] |
When the [Pre-processing Window] is active |
Animation Toolbar |
Moving between timesteps of simulation results |
When the Post-processing Window or the Graph Window is active |
Main Toolbar¶
Operation Toolbar¶
Animation Toolbar¶
[Pre-processing Window]¶
Figure 6 shows an example of the [Pre-processing Window].
[Pre-processing Window]¶
The [Pre-processing Window] handles the following operations:
Importing geographic data
Editing geographic data
Creating a grid
Editing the grid
Setting calculation conditions
You can activate [Pre-Processing Window] with either of the following actions:
Menu bar: [View] (V) –> [Pre-processing Window]
Operation Toolbar: 
Refer to [Pre-processing Window] for detail.
[Solver Console]¶
Figure 7 shows an example of the [Solver Console].
[Solver Console]¶
The [Solver Console] displays the messages that the solver outputs to "Standard Output" or "Standard Error" during calculation. When you start running a solver, the [Solver Console] window is automatically activated.
You can activate [Solver Console] manually, with either of the following actions:
Menu bar: [View] (V) –> [Solver Console]
Operation Toolbar: 
The window title of the [Solver Console] indicates the name and status of the solver. Figure 8 shows an example of the [Solver Console] window title.
[Solver Console] window title¶
Refer to [Simulation] (S) for detail.
[2D Post-processing Window]¶
Figure 9 shows an example of the [2D Post-processing Window].
[2D Post-processing Window]¶
The [2D Post-processing Window] visualizes the two-dimensional simulation results.
You can open a new [2D Post-processing Window] with either of the following actions:
Menu bar: [Calculation Results] (R) –> [Open New 2D Post-processing Window]
Operation Toolbar: 
You can activate a [2D Post-processing Window] that already exists, with the following action:
Menu bar: [View] (V) –> The title of window you want to activate; for example “Post-processing (2D): 1”
Refer to 2D visualization functions for detail.
[Bird’s-Eye 2D Post-processing Window]¶
Figure 10 shows an example of the [Bird’s-Eye 2D Post-processing Window].
[Bird’s-Eye 2D Post-processing Window]¶
The [Bird’s Eye 2D Post-processing Window] visualizes the two-dimensional simulation results in bird’s-eye view.
You can open a new [Bird’s-Eye 2D Post-processing Window] with either of the following actions:
Menu bar: [Calculation Results] (R) –> [Open New Bird’s-Eye 2D Post-processing Window]
Operation Toolbar: 
You can activate a [Bird’s-Eye 2D Post-processing Window] that already exists, with the following action:
Menu bar: [View] (V) –> The title of window you want to activate; for example “Bird’s-Eye Post-processing (2D): 1”
Refer to Bird’s-Eye View 2D Visualization Functions for detail.
[3D Post-processing Window]¶
Figure 11 shows an example of the [3D Post-processing Window].
[3D Post-processing Window]¶
The [3D Post-processing Window] visualizes the three-dimensional simulation results.
You can open a new [3D Post-processing Window] with either of the following actions:
Menu bar: [Calculation Results] (R) –> [Open New 3D Post-processing Window]
Operation Toolbar: 
You can activate a [3D Post-processing Window] that already exists, with the following action:
Menu bar: [View] (V) –> The title of window you want to activate; for example “Post-processing (3D): 1”
Refer to 3D visualization functions for detail.
[Graph Window]¶
Figure 12 shows an example of the [Graph Window].
[Graph Window]¶
The [Graph Window] makes a graph of simulation results whose X-axis is eigher of position (I, J or K) or time. You can change the target data to make graph easily using the slide bars shown below the graph.
You can open a new [Graph Window] with either of the following actions:
Menu bar: [Calculation Results] (R) –> [Open New Graph Window]
Operation Toolbar: 
You can activate a [Graph Window] that already exists, with the following action:
Menu bar: [View] (V) –> The title of window you want to activate; for example “Graph Window: 1”
Refer to [Graph Window] for detail.
[Scattered Chart Window]¶
Figure 13 shows an example of the [Scattered Chart Window].
[Scattered Chart Window]¶
The [Scattered Chart Window] makes a chart of simulation results whose X-axis is either of calculation results, X coordinates or Y coordinates.
You can open a new [Scattered Chart Window] with either of the following actions:
Menu bar: [Calculation Results] (R) –> [Open New Graph Window]
Operation Toolbar: 
You can activate a [Scattered Chart Window] that already exists, with the following action:
Menu bar: [View] (V) –> The title of window you want to activate; for example “Scattered Chart Window: 1”
Refer to [Scattered Chart Window] for detail.
Basic operations¶
The basic operations of iRIC are explained below.
[iRIC Start Page]¶
When iRIC is launched, the [iRIC Start Page] opens. Figure 14 shows the [iRIC Start Page].
On the [iRIC Start Page], the [Start Simulation Project] tab is active at first. The following are the items on the [Start Simulation Project] tab.
[New Project] (N)¶
Starts a new project. Refer to [New Project] (N).
[Recent Solvers]¶
To start a new project for a certain solver, click on the name of the solver you want to use.
[Open a project file]¶
Open a project file. Refer to [Open] (O).
[Recent projects]¶
To open a project, click on the name of the project.
[iRIC Start Page] ([Start Simulation Project] tab)¶
To open the [Support] tab, click on [Support]. Figure 15 shows an example. The [Support] tab provides links to iRIC web pages. To access the web pages, click on the link to open the web browser.
[iRIC Start Page] ([Support] tab)¶
Operations in [Object Browser]¶
iRIC uses [Object Browser] for all subwindows except [Solver Console] and [Graph Window]. Figure 16 shows example of the [Object Browser] of the [Pre-processing Window].
[Object Browser] of the [Pre-processing Window]¶
In [Object Browser], the following operations can be made:
Selecting an operation target¶
Left click on the item to select which item to edit. When the selection status changed, the menu items available to the selected item is shown in the menu bar.
Switching between “show” and “hide”¶
Make a check mark in the box left of the item, to make it shown on the canvas. For items in hierarchical trees, if the check mark for the upper-level item is removed, the item and all the lower-level items are hidden.
Changing the order of items¶
An item can be moved up and down to change order. This operation is
available only for [Geographic Data] and [Background Images] on
[Pre-processing Window]. Select 
/ 
on
the Operation Toolbar to change order of items.
Changing a display setting in [Property] dialog.¶
Open right-clicking menu and click on [Property] to open a dialog and modify settings. Some items do not have [Property] dialog.
Importing / exporting data¶
Open right-clicking menu on an item to facilitate data import or export. Some items do not have import / export feature.
View changing operations on the canvas¶
View changing operations can be made with Ctrl key and mouse operations. See Table 3 for details.
Operation |
Action |
Cursor |
|---|---|---|
Pan |
Ctrl + Left dragging |
|
Zoom in / out |
Ctrl + Dragging the scroll wheel |
|
Rotate |
Ctrl + Right dragging |
|
Rubber band zoom |
Ctrl + Shift +Right dragging |
|
You can open a [Mouse Hint] dialog with either of the following actions:
Menu bar: [Help] (H) –> [Mouse Hints] (M)
Operation Toolbar: 
Figure 17 shows the [Mouse Hint] dialog.
The [Mouse Hint] dialog¶
You can change view setting of canvas with the Main Toolbar too. (Refer to [Main Toolbar])
iRIC functions¶
iRIC functions can be categorized into the seven groups below:
Editing geographic data
Creating grids
Editing grids
Loading measured data
Setting calculation conditions
Lunching a solver
Visualizing the calculation results
Making a graph
The abstract of each function groups are explained in the following sections.
Editing geographic data¶
Geographic data handles coordinates of data and the attributes at that coordinates, such as elevation, vegetation type, vegetation density, land use. You can import and edit geographic data with iRIC.
Geographic data are used to determine the attributes at each node or cell by interpolation. You can use cross-section data also for creating a grid.
The attributes that you need to input differ by the solver you use.
iRIC can import and edit four types of geographic data:
Point cloud data
Cross-section data
Raster data
Time series raster data
Polygons
Lines
Points
Figure 18, Figure 19, Figure 20, Figure 21, Figure 22 and Figure 23 show example of [Point Cloud Data], [Cross-Section Data], [Raster Data], [Polygons], [Lines] and [Points] respectively.
Example of [Point Cloud Data]¶
Example of [Cross-Section Data]¶
Example of [Raster Data]¶
Example of [Polygons]¶
Example of [Lines]¶
Example of [Points]¶
Refer to [Geographic Data] for detail.
Creating a grid¶
You can create the grid that the solver uses. A grid can be created in two steps:
Determine the grid shape (coordinates of each node).
Determine the node/cell attributes by interpolating geographic data.
In step 1., you select one of the algorithms that can produce the grid that the solver requires, and then, you create a grid by specifying grid creating condition.
Step 2. is automatically done. iRIC does this step automatically by recognizing the type of geographic data, and selecting the appropriate algorithm for interpolation for that type.
iRIC can create grids of the following types:
Two-dimensional structured grid
Two-dimensional unstructured grid
One-dimensional structured grid (Each node holds sectional data.)
Refer to Grid creating functions for details.
Editing the grid¶
You can edit the grid. You can do the following operations:
Editing the grid shape (the coordinates of each node)
Editing the attributes of each node or cell
Refer to Editing the grid for the details.
Loading measured data¶
You can load measured data from text files, to use it as background data for creating data, or to compare with calculation results. You can do the following operations:
Importing measured data from text files
Editing display settings of measured data
Refer to [Measured Data] (M) for the details.
Setting the calculation conditions¶
You can set the calculation conditions. The calculation conditions differ by the solver selected.
Refer to [Calculation Conditions] for the details.
Launching the solver¶
You can launch the solver and monitors the simulation status using [Solver Console]. You can stop calculations when you want to. Figure 24 shows an example of the [Solver Console] that displays solver outputs.
[Solver Console]¶
Refer to [Simulation] (S) for details.
Post-processing¶
You can visualize the calculation results that the solver output. You can use [2D Post-processing Window] (Figure 25), [Bird’s-Eye 2D Post-processing Window] (Figure 26), and [3D Post-processing Window] (Figure 27) for that purpose.
Refer to Visualization functions for details.
[2D Post-processing Window]¶
[Bird’s-Eye 2D Post-processing Window]¶
[3D Post-processing Window]¶
Making a graph¶
You can display graphs with the calculation results that the solver output, using [Graph Window] (Figure 28) and [Scattered Chart Window] (Figure 29).
Refer to Making a graph for details.
[Graph Window]¶
[Scattered Chart Window]¶
Common functions¶
This chapter describes the functions always available regardless of active subwindow.
Toolbars¶
[Main Toolbar]¶
[Main Toolbar] handles file I/O, view setting operations for canvas, solver launching and opening subwindows. Figure 30 shows the [Main Toolbar].
The [Main Toolbar]¶
Table 5 describes the functions of the items on the [Main Toolbar].
Icon |
Name |
Description |
|---|---|---|
|
[Open] |
Opens a project file |
|
[Save] |
Saves the project. |
|
[Save Snapshot] (N) |
Saves a snapshot of the active window. |
|
[Copy Snapshot to Clipboard] |
Copy a snapshot of the active window to Clipboard. |
|
[Continuous Snapshots / Google Earth Export] |
Saves images of each timestep produced by the Post-processing Window/Graph Window into image files, and outputs a KML file for Google Earth. |
|
Undo |
Undoes the most recent action. |
|
Redo |
Redoes the most recent undoed action. |
|
Fit |
Zooms out such that everything is displayed in the window. |
|
Reset Rotation |
Rotates the graphic such that the X-axis is pointing rightward (in the positive direction) and the Y-axis is pointing upward (in the positive direction). |
|
90-Degree Rotation |
Rotates 90 degrees counterclockwise. |
|
XY-plane |
Rotates the graphic such that the X-axis is pointing rightward (in the positive direction) and the Y-axis is pointing upward (in the positive direction). |
|
YZ-plane |
Rotates the graphic such that the Y-axis is pointing rightward (in the positive direction) and the Z-axis is pointing upward (in the positive direction). |
|
XZ-plane |
Rotates the graphic such that the Z-axis is pointing rightward (in the positive direction) and the X-axis is pointing upward (in the positive direction). |
|
Moves to the left |
Shifts the viewpoint to the left. |
|
Moves to the right |
Shifts the viewpoint to the right. |
|
Moves to the top |
Shifts the viewpoint to the top. |
|
Moves to the bottom |
Shifts the viewpoint to the bottom. |
|
[Zoom in] |
Zooms in on the display. |
|
[Zoom out] |
Zooms out from the display. |
|
Extension in the X-axis direction |
Extends only in the X-axis direction. |
|
Shortening in the X-axis direction |
Shortens only in the X-axis direction. |
|
Extension in the Y-axis direction |
Extends only in the Y-axis direction. |
|
Shortening in the Y-axis direction |
Shortens only in the Y-axis direction. |
|
[Run] |
Starts the solver. |
|
[Stop] |
Stops the solver. |
|
Display Pre-processor |
Opens [Pre-processor Window]. |
|
Display [Solver Console] |
Displays [Solver Console]. |
|
[Open New 2D Post-processing Window] |
Opens a new [2D Post-processing Window]. |
|
[Open New Bird’s Eye 2D Post-processing Window] |
Opens a new [Bied’s Eye Post-processing Window]. |
|
[Open New 3D Post-processing Window] |
Opens a new [3D Post-processing Window]. |
|
[Open New Graph Window] |
Opens a new [Graph Window]. |
|
[Open New Scattered Chart Window] |
Opens a new [Scattered Chart Window] |
|
[Compare with measured values] |
Opens a dialog to compare calculation results with measured values |
|
[Reload Calculation Result] |
Reloads calculation result. |
|
[Mouse Hints] |
Displays the [Mouse Hints] dialog. |
[Operation Toolbar]¶
The [Operation Toolbar] is displayed only when the [Pre-processing Window] is active.
The [Operation Toolbar] shows buttons for operations available for the currently selected item in [Object Browser]. Figure 31 shows the [Operation Toolbar].
The [Operation Toolbar]¶
Table 6 describes the functions of the items on the [Operation Toolbar].
Icon |
Name |
Description |
|---|---|---|
|
[Move Up] |
Exchanges priorities with the item that is immediately higher in priority |
|
[Move Down] |
Exchanges priorities with the item that is immediately lower in priority |
|
[Delete] |
Deletes the selected item. |
[Animation Toolbar]¶
The [Animation Toolbar] is displayed only when a Post-processing Window or Graph Window is active.
The [Animation Toolbar] items control movements between timesteps of calculation results. Figure 32 shows the [Animation Toolbar].
The [Animation Toolbar]¶
Table 7 describes the functions of the items on the [Animation Toolbar].
Icon |
Name |
Description |
|---|---|---|
|
[Reset] |
Moves to the first timestep. |
|
[Step Backward] |
Moves to the previous timestep. |
|
[Start/Stop Animation] |
Starts or stops the animation. |
|
[Step Forward] |
Moves to the next timestep. |
|
[Step Last] |
Moves to the last timestep. |
|
[Toggle Following Last Step] |
Automatically moves to the most recent timestep. |
|
[Edit Slow Motion Animation Speed] |
Sets the speed for animation. |
When you click on 
button,
the [Animation Speed Setting]
dialog (Figure 33) will open.
Input the intervals between timesteps and click on [OK].
The [Animation Speed Dialog]¶
[File] (F)¶
The functions of items under the [File] menu are explained in the following sections.
[New Project] (N)¶
Description: Starts a new project.
When you select [New Project], the [Select Solver] dialog (Figure 34) will open. Select the solver you want to use for the project, and click on [OK].
When the current project is modified, a warning dialog will open to ask whether you want to save the current project.
The [Pre-processing Window] opens when you create a new project. Figure 35 shows an example of iRIC window just after starting a new project.
The [Select Solver] dialog¶
iRIC window just after starting a new project¶
[Open] (O)¶
Description: Opens a project file.
When you select [Open], the [Open iRIC project file] dialog (Figure 36) will open. Select the file you want to open and click on [Open].
When the current project is modified, a warning dialog will open to ask whether you want to save the current project.
When you open a project, the subwindows will be restored to the configuration of when you saved the project.
The [Open iRIC project file] dialog¶
[Save] (S)¶
Description: Saves a project.
If the project is opened from a project file, or it was saved already, the project file is overwritten.
If you save the project for the first time, the [Select How to save Project] (Figure 37) dialog will open. Select how to save project, and click on [OK]. Refer to [Save as File (*.ipro)] (A) and [Save as Project] (P) for the operation after selecting how to save.
When the project is saved successfully, the message shown in Figure 38 will appear on [Status Bar].
The [Select How to save Project] dialog¶
The [Status Bar] after saving a project file.¶
[Save as File (*.ipro)] (A)¶
Description: Names and saves a project file.
When you select [Save as File (*.ipro)], the [Save iRIC project file] dialog (Figure 39) will open. Input the file name you want to save and click on [Save].
When the project is successfully saved, the message in Figure 38 will appear on [Status Bar].
The [Save iRIC project file] dialog¶
[Save as Project] (P)¶
Description: Names and saves the project into a folder.
When you select [Save as Project], the [Browse For Folder] dialog (Figure 40) will open. Select the folder you want to save and click on [OK].
When the project is successfully saved, the message in Figure 38 will appear on [Status Bar].
When you want to open the folder, select project.xml inside that folder.
The [Browse For Folder] dialog¶
[Property] (P)¶
Description: Shows the property dialog of the current project. Figure 41 shows an example of the [Project Property] dialog.
You can specify the followings from this dialog.
Coordinate system
Offset
Date for t = 0
The [Project Property] dialog¶
[Coordinate System]¶
When you click on [Edit] button next to [Coordinate System], the dialog in Figure 42 appears, and you can choose the coordinate system for your geographic data and grid.
The [Select Coordinate System] dialog¶
[Offset]¶
When you click on [Edit] button next to [Coordinate Offset], the dialog in Figure 43 appears, and you can input the offset for the coordinates.
When you want to use geographic data and grids very far from the origin point of the coordinate system (for example, using UTM coordinate System and handles geographic data far from equator), inputting offset will reduce the truncation error. In such cases, please input the x and y for some point near to your geographic data (or grid).
The [Offset Setting] dialog¶
[Date for t = 0]¶
When you click on [Edit] button next to [Date for t = 0], the dialog in Figure 44 appears, and you can edit the date for t = 0, and format to show time.
When date for t = 0 and format is specified, the setting is applied to [Animation Toolbar] ([Animation Toolbar]), [2D Post-processing Window] ([2D Post-processing Window]) and [3D Post-processing Window] ([3D Post-processing Window]).
[Date for t = 0 setting] dialog¶
[Save Snapshot] (N)¶
Description: Saves a snapshot of the active window as an image file.
Snapshot can be saved to the following file formats.
PNG file (*.png)
JPEG file (*.jpg)
Windows bitmap file (*.bmp)
EPS file(*.eps)
PDF file (*.pdf)
SVG file (*.svg)
When you select [Save Snapshot], the [Save Snapshot] dialog (Figure 45) will open. Input the file name and click on [Save].
The [Save Snapshot] dialog¶
Note
When you save snapshot to EPS file, PDF file or SVG file, you can get hight quality image, because they are vector file format. We recommend you to use these file formats when you use iRIC snapshots for reasearch papers or reports.
Copy Snapshot to Clipboard¶
Description: Copies a snapshot of the active window to clipboard.
When the snapshot is copied to clipboard successfully, message in Figure 46 is shown in the status bar.
Message for copying snapshot to clipboard¶
[Continuous Snapshots / Movie / Google Earth Export]¶
Description: Saves a time series of snapshots of the Post-processing Window and Graph Window as image files. Movie file, KML file that can be read by Google Earth can be output at the same time. Figure 47 to Figure 53 show examples of each page of the [Continuous Snapshot Wizard].
When the settings in the wizard are completed, the [Continuous Snapshot] dialog (Figure 54) opens and saving snapshots starts.
The first screen of the [Continuous Snapshot Wizard]¶
The second screen of the [Continuous Snapshot Wizard]¶
The third screen of the [Continuous Snapshot Wizard]¶
The forth screen of the [Continuous Snapshot Wizard]¶
The fifth screen of the [Continuous Snapshot Wizard]¶
The sixth screen of the [Continuous Snapshot Wizard]¶
The seventh screen of the [Continuous Snapshot Wizard]¶
The [Continuous Snapshot] dialog¶
[Import] (I)¶
The functions of the items under the [Import] menu are explained in the following sections.
[Geographic Data] (E)¶
Description: Imports geographic data.
Geographic data can be imported from file formats in Table 8.
Type |
Format |
|---|---|
Point Cloud data |
Topography file (*.tpo) |
Text file (*.csv, *.txt, *.xyz) |
|
STL file (*.stl) |
|
LandXML file (*.xml) |
|
Cross-section data |
Cross-section data (*.riv) |
Japan MLIT Cross-secion data (*.csv) |
|
Raster data |
GeoTIFF file (*.tif) |
Arc/Info ASCII file (*.asc) |
|
16bit grayscale PNG file (*.png) |
|
NetCDF file (*.nc) |
|
Time series raster data |
GeoTIFF file (*.tif) |
Arc/Info ASCII file (*.asc) |
|
NetCDF file (*.nc) |
|
X band MP rader data (*.*) |
|
Polygons |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
|
Lines |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
|
Points |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
When you select [Geographic Data], a list of importable geographic data is shown as submenus. Select the geographic data you want to import and the [Select file to import] dialog (Figure 55) will open. Select the file to import the geographic data.
You can see the imported geographic data in [Object Browser]. Figure 56 shows an example of the iRIC window after importing a river survey data.
The [Select file to import] dialog¶
iRIC window after importing a river survey data¶
Additional operations dependent on file formats are explained below.
Topography file (*.tpo)¶
When the file to import is selected, [Filtering Setting] dialog (Figure 57) is shown.
Please edit Filter value when needed, and click on [OK] button to proceed.
[Filtering Setting] dialog¶
Text file (*.csv, *.txt, *.xyz)¶
When you select a file, [Import Setting] dialog (Figure 58) is shown.
Please specify appropriate setting, checking [Preview] region, and click on [OK] button to proceed.
[Import Setting] dialog¶
Cross-section data (*.riv)¶
When you import cross-section data, the selected file is checked for errors. If problems are found, [Problems Found in Data] dialog (Figure 59) is shown.
After that, [Cross-Section Data Import Setting] dialog (Figure 60) will open. Specify the import setting and click on [OK].
[Problems Found in Data] dialog¶
The [Cross-Section Data Import Setting] dialog¶
Japan MLIT Cross-section data (*.csv)¶
At first, please select the CSV file that contains distance marker data. Then [Select folder where cross section data exists] dialog is shown, so select the folder and click on [Select Folder] button.
When importing from Japan MLIT Cross-section data, the file is checked for errors. If problems are found, [Prolems Found in Data] dialog () is shown.
After that, just like Cross-section data (*.riv), [Cross-Section Data Import Setting] dialog (Figure 60) will open. Specify the import setting and click on [OK].
[Problems Found in Data] dialog¶
GeoTIFF file (*.tif), Arc/Info ASCII file (*.asc) (Raster data)¶
When you import GeoTIFF file (*.tif), Arc/Info ASCII file (*.asc) to import raster data, if information about coordinate system is not included in the file, [Warning] dialog (Figure 62) is shown, and [Select Coordinate System] dialog (Figure 63) is shown.
When importing aGeoTIFF file, the coordinate system information included in the file is imported. When importing an Arc/Info ASCII file, the coordinate system information included in *.prj file is imported, if it exists.
[Warning] dialog¶
[Select Coordinate System] dialog¶
GeoTIFF file (*.tif), Arc/Info ASCII file (*.asc) (Time series raster data)¶
When you import GeoTIFF file (*.tif), Arc/Info ASCII file (*.asc) to import time series raster data, time of date included in each file is recognized from file names.
When the file name matches one of the following patterns, the files will be imported automatically.
YYYY-MM-DD_hh:mm:ss
YYYY_MM_DD_hh:mm:ss
YYYYMMDD-hhmmss
YYYYMMDD_hhmmss
YYYYMMDD-hhmm
YYYYMMDD_hhmm
If the file name matches none of them, [File name pattern setting] dialog (Figure 64) is shown. Please input the pattern to correctly recognize time values from file names.
[File name pattern setting] dialog¶
NetCDF file (*.nc)¶
When you import NetCDF file into geographic data that has dimensions other than position, the [Dimension Mapping Setting] dialog (Figure 65) will open. Setup the mapping setting about the dimensions, and click on [OK].
The [Dimension Mapping Setting] dialog¶
X band MP rader data (*.*)¶
When you import XRAIN rainfall data as geographic data, save XRAIN rainfall data files into one foler, and select one of them in the dialog. The, all rainfall data in that folder are loaded and imported.
ESRI Shapefile (*.shp)¶
When importing polygons or polylines from ESRI shape files, [Polygon (or Polyline) Import Setting] dialog (Figure 66) is shown. Specify the setting for importing name and value, and click on [OK] to proceed.
[Polygon Import Setting] dialog¶
[Geographic Data (from web)]¶
Description: Imports geographic data from web services
When you select [Geographic Data], a list of importable geographic data is shown as submenus. Currently only Elevation data can be imported from web.
Please follow the steps below, to import geographic data from web.
Select the geographic data.
If you’ve not specified the coordinate system for the project, the [Select Coordinate System] dialog (Figure 42) is shown. Please select coordinate system and click on [OK] button.
[Select Region] dialog (Figure 67) is shown. Use the following operations to select the region, and click on [Next]:
Ctrl + Left-dragging to Pan the map.
Ctrl + Middle-dragging to Zoom in/out the map. You also can use [Zoom In] and [Zoom Out] buttons.
Left-dragging to select region. The selected region is shown as a box with black line.
Click on [Next] button, and the [Zoom Level Setting] dialog is shown. In this dialog, you can change the setting like below:
You can select [Zoom level]. If you change the setting, you can review the abstract resolution and the size of data you are going to download, with [Resolution] and [Data size]. The default value of the [Zoom level] is the maximum value, so that user usually use the data with the highest resolution.
You can select [Source]. Usually SRTM data distributed by USGS is used, but for example in Japan, you can choose geographic data distributed by GSI.
Click on [OK], iRIC starts downloading, dialog in Figure 69 is shown.
When the downloading finishes, the dialog disappears, and the downloaded geographic data is shown like Figure 70.
The [Select Region] dialog¶
The [Zoom Level Setting] dialog¶
The [Please wait] dialog¶
Example of imported geographic data¶
[Hydraulic Data] (H)¶
Description: Imports a hydraulic data.
The list of hydraulic data that iRIC can import is as follows:
Water Elevation
Hydraulic data can be imported from the file formats below:
CSV file (*.csv)
Text file (*.txt)
Water Elevation is data that contains water elevations for each crosssection in river survey data. You have to import river survey data before importing water elevation.
Please refer to Water Elevation data file (*.csv) for the file format of Water elevation data files.
[Grid Creating Condition] (I)¶
Description: Imports a grid creating condition.
Grid creating condition can be imported from the file formats below:
iRIC grid creating condition file (*.igcc)
iRIC grid creating condition file (*.igcc) is a special binary format that is defined for iRIC.
When you select [Grid Creating Condition], the [Select file to import] dialog (Figure 71) will open. Select the file you want to import and click on [Open]. Figure 72 shows the iRIC window after importing a grid creating condition.
The [Select file to import] dialog¶
The iRIC window after importing a grid creating condition¶
[Grid] (G)¶
Description: Imports a grid.
Grid can be imported from the file formats in Table 9.
Type |
Format |
|---|---|
Structured grid |
iRIC project file (*.ipro) |
CGNS file (*.cgn) |
|
iRIC Grid CSV file (*.csv) |
|
RIC-Nays grid file (*.grid) |
|
Unstructured grid |
iRIC project file (*.ipro) |
CGNS file (*.cgn) |
|
TRIANGLE node file (*.node) |
When you select [Grid], the [Select file to import] dialog (Figure 73) will open. Select the file you want to import and click on [Open]. Figure 74 shows the iRIC window after importing a grid.
The [Select file to import] dialog¶
The iRIC window after importing a grid¶
[Calculation Conditions] (C)¶
Description: Imports the calculation conditions.
Calculation condition can be imported from the file formats below:
iRIC project file (*.ipro)
CGNS file (*.cgn)
YAML file (*.yml)
When you select [Calculation Conditions], the [Select file to import] dialog (Figure 75) will open. Select the file you want to import and click on [Open].
When the calculation conditions are imported successfully, the message “calculation conditions is successfully imported from the specified file” will appear.
The [Select file to import] dialog¶
[Calucation Result] (R)¶
Description: Imports the calculation result.
Calculation result can be imported from the file formats below:
CGNS file (*.cgn)
When you select [Calculation Result], the [Open Calculation result] dialog (Figure 76) will open. Select the file you want to import and click on [Open].
The [Open Calculation result] dialog¶
When importing a calculation result succeeded, a new project is started with the imported CGNS file.
[Measured Data] (M)¶
Description: Imports the measured data.
Measured data can be imported from the file formats below:
Text file (*.csv, *.txt)
When you select [Measured Data], the [Open Measured Data File] dialog (Figure 77) will open. Select the file you want to open and click on [Open]. When the file is successfully imported, the imported data will appear under “Measured Data” in [Object Browser]. Refer to Measured data text file (*.csv) for the file format of measured data text file.
The [Open Measured Data File] dialog¶
[Background Image] (B)¶
Description: Imports the background image.
Background image can be imported from the file formats below:
JPEG file (*.jpg, *.jpeg)
PNG file (*.png)
TIFF file (*.tif)
When you select [Background Image], the [Open Image file] dialog (Figure 78) will open. Select the file you want to open and click on [Open]. When the file is successfully imported, the image will appear in [Object Browser].
The [Open Image file] dialog¶
[Visualization/Graph Settings] (V)¶
Description: Imports the settings of visualization windows and graph windows.
Visualization/Graph Settings can be imported from the file formats below:
Setting file (*.vgsetting)
When you select [Visualization/Graph Settings], the [Import Visualization/Graph Settings] dialog (Figure 79) will open. Select the file you want to open and click on [Open]. When the file is successfully imported, visualization windows and graph windows will open.
The [Import Visualization/Graph Settings] dialog¶
[Export] (E)¶
The functions of the items under the [Export] menu are explained in the following sections.
[Geographic Data] (E)¶
Description: Exports geographic data.
Geographic data can be exported to the file formats in Table 10.
Type |
Format |
|---|---|
Point cloud data |
Topography file (*.tpo) |
LandXML file (*.xml) |
|
STL file (*.stl) |
|
VTK file (*.vtk) |
|
Cross-section data |
River Survey data (*.riv) |
Text file (*.txt) |
|
CSV file (*.csv) |
|
LandXML file (*.xml) |
|
Raster data |
GeoTIFF file (*.tif) |
Arc/Info ASCII file (*.asc) |
|
16bit grayscale PNG file (*.png) |
|
NetCDF file (*.nc) |
|
Time series raster data |
NetCDF file (*.nc) |
Polygons |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
|
Lines |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
|
Points |
ESRI Shapefile (*.shp) |
CSV file (*.csv) |
When you select [Geographic Data], a list of exportable geographic data is shown as submenus. Select the geographic data you want to export and the [Select file to export] dialog (Figure 80) will open. Input the file name to export and click on [Save].
The [Select file to export] dialog¶
[Grid Creating Condition] (I)¶
Description: Exports a grid creating condition.
Grid creating condition can be exported to the file formats below:
iRIC grid creating condition file (*.igcc)
iRIC grid creating condition file (*.igcc) is a special binary format that is defined for iRIC.
When you select [Grid Creating Condition], the [Select file to export] dialog (Figure 81) will open. Input the file name you want to export and click on [Save].
The [Select file to export] dialog¶
[Grid] (G)¶
Description: Exports a grid.
Grid can be exported to the file formats in Table 11.
Type |
Format |
|---|---|
Structured grid |
CGNS file (*.cgn) |
iRIC grid CSV file (*.csv) |
|
RIC-Nays grid file (*.grid) |
|
LandXML file (*.xml) |
|
VTK file (*.vtk) |
|
Unstructured grid |
CGNS file (*.cgn) |
LandXML file (*.xml) |
|
VTK file (*.vtk) |
When you select [Grid], the [Select file to export] dialog (Figure 82) will open. Input the file name you want to export and click on [Save].
The [Select file to export] dialog¶
[Calculation Conditions] (C)¶
Description: Exports the calculation conditions.
Calculation condition can be exported to the file formats below:
CGNS file (*.cgn)
YAML file (*.yml)
When you select [Calculation Conditions], the [Select file to export] dialog (Figure 83) will open. Input the file name you want to export and click on [Save].
The [Select file to export] dialog¶
[Solver Console Log]¶
Description: Exports the solver console log.
Solver console log can be exported to the file formats below:
Text file (*.txt)
When you select [Solver Console Log], the [Select file to export] dialog (Figure 84) will open. Input the file name you want to export and click on [Save].
The [Select file to export] dialog¶
[Calculation Result] (R)¶
Description: Exports the calculation result.
Calculation result can be exported to the file formats below:
VTK files (ASCII) (*.vtk)
VTK files (Binary) (*.vtk)
CSV files (*.csv)
Topography Files (*.tpo)
ESRI Shape files (*.shp)
When you select [Calculation Result], the [Export Calcutation Result] dialog (Figure 85) will open. Edit the setting and click on [OK] to start exporting. File names of exported files will be “(Prefix) + (Number) + (“.vtk” or “.csv”)”.
When you want to export partial data, remove the check on [All timesteps] and specify the range of timesteps by editing [Start] and [End], and [Skip rate].
When you want to export partial region of the data, click [Show Detail], remove the check on [Full region], and specify the range to export (Figure 86).
The [Export Calculation Result] dialog¶
The [Export Calculation Result] dialog after clicking [Show Detail]¶
[Contour figure as ESRI Shape files] (C)¶
Exports Contour figures drawn on [2D Post-processing Window] to ESRI Shape files as polygons.
To use this function, you have to satisfy the following requirements first:
Open and activate a [2D Post-processing Window]
Draw [Scalar (node)] for a calculation result value
Setup property for [Scalar (node)] to make [Discrete Mode], not [Gradation Mode].
After satisfying the requirments, launch [Contour figure as ESRI Shape files] menu, and dialog in Figure 87 will be shown.
[Select Result] dialog¶
Select the calculation result value that you want to export, and click on [OK]. Then, dialog in Figure 88 is shown.
Note
If there is one [Scalar (node)] drawn in [Discrete mode], a dialog like Figure 87 will not be displayed, and the drawn scalar (lattice point) will be selected for export.
[Export contour figure to ESRI Shape files] dialog¶
When you click on [OK], Contour Figure polygons are saved into ESRI shape files based on the setting.
[Particles] (P)¶
Description: Exports the particles.
Particles can be exported to the file formats below:
VTK files (*.vtk)
This item is active only when a [2D Post-processing Window] or [3D Post-processing Window] is active.
Wyen you select [Particles], the [Export Particles] dialog (Figure 89) will open. Edit the setting and click on [OK] to start exporting. File names of exported files will be “(Prefix) + (Number) + (“.vtk”)”.
When you want to export partial data, remove the check on [All timesteps] and specify the range of timesteps by editing [Start] and [End], and [Skip rate].
The [Export Particles] dialog¶
[Google Earth KMZ for street view] (G)¶
Description: Export Google Earth KMZ file with which we can visualize the water Depth on street view.
To use this function, you have to satisfy the following requirements first:
Open and activate a [2D Post-processing Window]
Draw [Scalar (node)] for calculation result value [Depth].
Setup property for [Scalar (node)] to make [Display Setting] to [Contour Figure], not [Color Fringe] or [Isolines], and check off [Automatic] Check box in [Value range] group box.
Figure 90 shows an example of iRIC GUI after satisfying the requirements.
When you launch [Google Earth KMZ for street view] menu, the dialog in Figure 91 is shown. Please specify the name of file, and select the timesteps you want to export, and click on [OK]. Then, the KMZ file is exported.
[2D Post-processing window] with [Contour Figure] for depth¶
[Google Earth KMZ for street view export] dialog¶
Figure 92 shows an example of Google Earth after loading the exported KMZ. When you show street view for regions where polygons for depth values exist, the polygons are shown in the street view so that we can easily see that the depth, like in Figure 93.
Example of [Google Earth] after loading a KMZ file¶
Example of [Google Earth] showing street view after loading a KMZ file¶
[Visualization/Graph Settings]¶
Description: Exports the settings of visualization windows and graph windows.
Visualization/Graph Settings can be exported to the file formats below:
Setting file (*.vgsetting)
When you select [Visualization/Graph Settings], the [Export Visualization/Graph Settings] dialog (Figure 94) will open. Input the file name you want to export and click on [Save].
The [Export Visualization/Graph Settings] dialog¶
[Recent Projects] (R)¶
Description: Opens recently used projects.
When you select [Recent Projects], a list of recent projects (Figure 95) will be shown as sub menus. Select the file you want to open.
The [Recent Projects] sub menus¶
[Show iRIC Start Page]¶
Description: Opens [iRIC Start Page].
The [iRIC Start Page] is the dialog that is shown just after iRIC is launched. Refer to [iRIC Start Page] for [iRIC Start Page].
[Exit] (X)¶
Description: Exits iRIC.
If the current project is modified, the warning dialog will open to ask whether you want to save the current project.
[Import] (I)¶
The functions of the items under the [Import] menu are explained in the following sections.
[Geographic Data] (E)¶
Description: Imports geographic data.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Geographic Data] (E).
[Geographic Data (from web)]¶
Description: Imports geographic data from web.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Geographic Data (from web)].
[Hydraulic Data] (H)¶
Description: Imports a hydraulic data.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Hydraulic Data] (H).
[Grid Creating Condition] (I)¶
Description: Imports a grid creating condition.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Grid Creating Condition] (I).
[Grid] (G)¶
Description: Imports a grid.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Grid] (G).
[Calculation Conditions] (C)¶
Description: Imports the calculation conditions.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Calculation Conditions] (C).
[Calculation Result] (R)¶
Description: Imports the calculation result.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Calucation Result] (R).
[Measured Data] (M)¶
Description: Imports measured data.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Measured Data] (M).
[Background Image] (B)¶
Description: Imports the background image.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Background Image] (B).
[Visualization/Graph Settings] (V)¶
Description: Imports the settings of visualization windows and graph windows.
The function of this item is the same to that under [Import] menu under [File] menu. Refer to [Visualization/Graph Settings] (V).
[Simulation] (S)¶
The functions of the items under the [Simulation] menu are explained in the following sections.
[Run] (R)¶
Description: Starts the solver.
When you select [Run], a warning dialog will open to ask whether you want to save the current project. When you have already run solver before, a dialog will open to ask if you agree to delete the previous calculation results.
When the solver starts running, the [Solver Console] will open. The solver console displays real-time output messages to the “Standard output” or to the “Standard error”. Figure 96 shows an example of the [Solver Console].
The [Solver Console]¶
[Stop] (S)¶
Description: Stops the solver.
When you select [Stop], the [Confirm Solver Termination] dialog (Figure 97) will open. Select [Yes] (Y) to stop running solver. When the solver has stopped, the [Solver Console] title changes. Figure 98 shows an example of the [Solver Console] window title after stopping the solver.
The [Confirm Solver Termination] dialog¶
The [Solver Console] window title¶
[Solver Information] (S)¶
Description: Displays information of the solver that is used for the current project. An example of the dialog is shown in Figure 99.
The [Solver information] dialog¶
[Export solver console log] (E)¶
Description: Exports the solver console log.
The function of this item is the same to [Solver Console Log] under [Export] menu under [File] menu. Refer to [Solver Console Log].
[Calculation Result] (R)¶
The functions of the items under the [Calculation Results] menu are explained in the following sections.
[Open New 2D Post-processing Window]¶
Description: Opens a new [2D Post-processing Window].
Refer to 2D visualization functions for operations related to [2D Post-processing Window].
[Open New Bird’s Eye 2D Post-processing Window]¶
Description: Opens a new [Bird’s Eye 2D Post-processing Window].
Refer to Bird’s-Eye View 2D Visualization Functions for operations related to [Bird’s Eye 2D Post-processing Window].
[Open New 3D Post-processing Window]¶
Description: Opens a new 3D Post-processing Window.
Refer to 3D visualization functions for operations related to [3D Post-processing Window].
[Open New Graph Window]¶
Description: Opens a new [Graph Window].
Refer to [Graph Window] for operations related to [Graph Window].
[Open New Scattered Chart Window]¶
Description: Opens a new [Scattered Chart Window].
Refer to [Scattered Chart Window] for operations related to [Scattered Chart Window].
[Compare with measured values]¶
Description: Opens a dialog to compare measured values with calculation result.
Refer to [Compare with measured values] for operations related to [Compare with measured values].
[Reload] (R)¶
Description: Reload calculation result.
When you select [Reload], the calculation result is reloaded, and if new calculation results are output by the solver, the timesteps on [Animation Toolbar] is updated.
[Delete] (D)¶
Description: Delete calculation result.
When you select [Delete], a dialog to confirm whether you really want to delete the calculation results opens. Click on [Yes] to delete calculation result.
[Manage simple operation results] (M)¶
Description: Manage simple operation results.
Simple operation results are values defined as results of simple numerical operations between calculation results.
“Simple Operation Result List” dialog ( Figure 100) is shown, and you can manage simple operation result list on this dialog.
“Simple Operation Result List” dialog¶
Adding and editing simple operation results¶
On “Simple Operation Result List” dialog, you can open “Edit Simple Operation Result” dialog (Figure 101) by clicking on “Add” or “Edit” button.
Name: Please input the name of the simple operation result
Calculation results for input: You can add or delete calculation results for input by clicking on “Add” or “Delete” button below. Please refer to Table 12 for detail on the items in the table.
Definition of variable: Please describe how to calculate the simple operation result value, by JavaScript language. Please refer to Examples of definition of simple operation result for examples of how to describe the definition. You can use the variables defined in “Calculation results for input” as input of the definition.
When you click on “Test” button, the value of simple operation result is calculated from the content of “Definition of variable” and the values of “Value for testing” in “Calculation results for input”. If the definition contains problems, an error message is shown.
“Edit Simple Operation Result” dialog¶
Item name |
Description |
|---|---|
Result name |
The name of calculation result for input. You can select from combobox |
Variable name |
The name of variable that you can use to refer the value in “Definition of variable” |
Value for testing |
The value that is input into the variable when the “Test” button is clicked |
Examples of definition of simple operation result¶
Examples of simple operation result definitions is shown here.
You can define simple operation results by using functions like below:
Simple operators (List 3)
JavaScript built-in functions (List 4)
Control syntaxes like if, while (List 5)
User defined functions (List 6)
Please refer to web pages for detail of JavaScript language, like the link below:
https://developer.mozilla.org/en/docs/Web/JavaScript
return D * D;
return Math.sqrt(D);
var d2 = D;
while (d2 < 1000) {
d2 = d2 * 2;
}
if (d2 > 1500) {
d2 = 1500;
}
return d2;
function f1(d) {
return d * d;
}
function f2(d, e) {
if (d < e) {
return e;
} else {
return d;
}
}
return f1(D) * f2(D, E);
[Import] (I)¶
Description: Imports calculation result.
The function of this item is the same to [Calculation Result] under [Import] menu under [File] menu. Refer to [Calucation Result] (R).
[Export] (E)¶
Description: Exports the calculation result. Calculation result is exported to VTK files or CSV files.
The function of this item is the same to [Calculation Result] under [Export] menu under [File] menu. Refer to [Calculation Result] (R).
[Import Visualization/Graph Settings]¶
Description: Imports the settings of visualization windows and graph windows.
The function of this item is the same to [Visualization/Graph Settings] under [Import] menu under [File] menu. Refer to [Visualization/Graph Settings] (V).
[Export Visualization/Graph Settings]¶
Description: Exports the settings of visualization windows and graph windows.
The function of this item is the same to [Visualization/Graph Settings] under [Export] menu under [File] menu. Refer to [Visualization/Graph Settings].
[View] (V)¶
The functions of the items under the [View] menu are explained in the following sections.
[Toolbar] (T)¶
Description: Shows/hides the Toolbar.
When the Toolbar is shown, the item is checked.
[Object Browser] (O)¶
Description: Shows/hides [Object Browser] in the active subwindow.
When the [Object Browser] is shown, the item is checked.
You can also hide the [Object Browser] by clicking on X button in label of [Object Browser] (Figure 102).
The [Object Browser] window of the [Pre-processing Window]¶
[Attribute Browser]¶
Description: Shows/hides [Attribute Browser] in the active subwindow.
When the [Attribute Browser] is shown, the item is checked.
You can also hide the [Attribute Browser] by clicking on X button in label of [Attribute Browser] (Figure 103).
The [Attribute Browser] window of the [Pre-processing Window]¶
[Status Bar] (S)¶
Description: Shows/hides [Status Bar].
When the [Status Bar] is shown, the item is checked.
When iRIC is launched, the [Status Bar] is shown as default. Figure 104 shows iRIC window after hiding [Status Bar].
iRIC window after hiding [Status Bar]¶
[Background Color] (B)¶
Description: Changes the background color of the currently active subwindow’s canvas region.
When you select [Background Color], the [Background Color] dialog (Figure 105) will open. Select the color you want to use for background and click on [OK].
The [Background Color] dialog¶
[Z-direction scale] (Z)¶
Description: Changes the scale factor in the Z-direction.
This function is available only when the active subwindow is either of [Bird’s Eye Grid Window], [Bird’s eye 2D Post-processing Window], or [3D Post-processing Window].
When you select [Z-direction scale], the [Z-direction Scale] dialog (Figure 106) will open. Input new Z-direction scale, and click on [OK].
Example of [Bird’s Eye 2D Post-processing Window] before and after changing Z-direction scale is shown in Figure 107.
The [Z-direction Scale] Dialog¶
Example of editing Z-direction scale in [Bird’s Eye 2D Post-processing Window]¶
Set Projection to (P)¶
Switch Projection between Parallel projection and Perspective projection.
This function is available only when the active subwindow is either of [Bird’s Eye Grid Window], [Bird’s eye 2D Post-processing Window], or [3D Post-processing Window].
[Tile Windows] (T)¶
Description: Tiles subwindows.
The most recently activated window is at the top left.
Figure 108 shows an example of iRIC window after the subwindows are tiled.
iRIC window after the subwindows are tiled¶
[Cascade Windows] (C)¶
Description: Cascades subwindows.
The most recently activated window is at the top left.
Figure 109 shows an example of iRIC window after the windows are cascaded.
iRIC window after the subwindows are cascaded¶
[Option] (O)¶
The functions of the items under the [Option] menu are explained in the following sections.
[Preferences] (P)¶
Description: Displays the [Preferences] dialog (Figure 110 to Figure 117). Set the preference settings and click on [OK].
[General] Tab¶
General settings about iRIC GUI is specified in this tab.
If you check on “Check for update periodically”, a dialog to ask you to check for iRIC online update is shown, with the specified interval.
The [Preferences] dialog [General] tab¶
[Graphics Default] tab¶
Default settings about graphics is specified in this tab. Settings in this tab is used for pre-processor window and visualization windows.
The [Preferences] dialog [Graphics Default] tab¶
[Grid Checking] tab¶
Setting about grid checking is specified in this tab.
As shown on the dialog, grid checking is applied only to structured grids.
The [Preferences] dialog [Grid Checking] tab¶
[River Survey Data] tab¶
Setting about editing [River Survey Data] is specified in this tab.
You can edit the list of gradient fractions used while editing cross section of river survey data.
Please refer to [Edit cross section from the selected point] for the detail of cross section edit function of river survey data.
Then [Preferences] dialog [River Survey Data] tab¶
[Network Proxy] tab¶
Setting about Network Proxy is specified in this tab. The setting is used when iRIC GUI tries to access internet, for example to get background images from web, and download and import elevation data from web.
If you need to use proxy server to access Internet, please specify setting here.
When [Use system proxy setting] is selected, The settings used by your PC’s system is used.
The [Preferences] dialog [Network Proxy] tab¶
[Background Images (Internet)] tab¶
Setting about Background Images (Internet) can be specified here.
When you edit the setting, the new setting is applied to Pre-processing Window and 2D Post-processing Windows.
The [Preferences] dialog [Background Images (Internet)] tab¶
In 2018, Google migrated Google Maps into Google Maps Platform, and now we need to input API key to use Google Maps images as Backgound Images on iRIC. Input API key from “Input Google Maps API key” button.
Please refer the following URL to know how to get a API key:
[Web Elevation Data] tab¶
Setting about importing Geographic data from web is specified here.
When you edit the setting, the new setting is applied to the [Source] combo box on the [Zoom Level Setting] dialog for [Geographic Data (from web)].
Please refer to [Geographic Data (from web)] for detail.
The [Preferences] dialog [Web Elevation Data] tab¶
[Background Grid] tab¶
Setting about Background Grid is specified here.
The setting here is applied when you use River survey data as geographic data, and create grids and map the elevation from the river survey data, with grid creating algorithm other than [Create grid from river survey data].
The [Preferences] dialog [Background Grid] tab¶
[Maintainance] (M)¶
Shows Maintainance menu about iRIC GUI and Solvers launched from iRIC.
When you select [Maintainance], dialog in Figure 118 is shown. 「iRICを閉じて iRIC Maintainance を起動」ボタンを押すと、 iRIC GUI が終了して、 Figure 119 に示す iRIC メンテナンスが起動します。
[Warning] dialog about launching [iRIC Maintainance]¶
iRIC Maintainance main dialog¶
Function about iRIC Maintainance is described in the following subsections.
[Add or Remove components]¶
Add or remove components like iRIC GUI, solvers launched from iRIC GUI, etc.
When you check on the radio button next to [Add or Remove components] and click on [Next], page in Figure 120 is shown.
Check on the checkbox next to the component you want to add
Check off the checkbox next to the component you want to remove
After doing the operation above, click on [Next], then [Update] button, to add or remove components.
Page to select components to add or remove¶
[Update components]¶
Update components like iRIC GUI, solvers launched from iRIC GUI, etc.
When you check on the radio button next to [Update components] and click on [Next], downloading the information about component updates starts.
If there is not update, message is shown like in image_maintainance_update_nodata.
Page with message when there is no component update¶
If there are updates available, dialog in Figure 122 is shown. Check on the checkboxes next to components you want to update, click on [Next], then [Update] button, to update components.
Page to select components to update¶
Remove all components¶
Remove all the components related to iRIC.
Dialog in Figure 123 is shown. When you click on [Uninstall] button, all components are removed.
Page to uninstall¶
Settings¶
Edit settings about iRIC Maintainance.
Dialog in Figure 124 is shown. Edit the setting to match your environment, and click on [OK].
[Setting] dialog¶
[Create/Update Translation Files] (C)¶
Description: Displays the [Definition File Translation Update Wizard] dialog (Figure 125 to Figure 127).
This function is for the solver developers. It makes/update dictionary files for solvers. Using this function, solver developers can create dictionary files that can be used for solver internationalization.
[Introduction] page¶
[Select Program and Languages] page¶
[Confirm the result] page¶
The dictionary created by this Wizard can be edited using Linguist. Linguist is a program bundled with Qt. Qt is a program library that is distributed for free as open source product. Download it at the following URL:
[Help] (H)¶
The functions of the items under the [Help] menu are explained in the following sections.
[Help] (H)¶
Description: Displays the [Help] window.
When you select [Help], the PDF help document will open.
[Solver List] (S)¶
Description: Displays the list of solvers bundled with iRIC.
When you select [Solver List], the [Solver List] dialog (Figure 128) will open. When you select solver name and click on [Show Detail], the [Solver Information] dialog (Figure 129) will open.
The [Solver List] dialog¶
The [Solver Information] dialog¶
[Mouse Hint] (M)¶
Description: Displays the [Mouse Hint] dialog (Figure 130), that explains how the mouse can be used to change view setting in the canvas area.
The [Mouse Hint] dialog¶
[About] (A)¶
Description: Displays the [About iRIC] (Figure 131).
The [About iRIC] dialog¶
[Pre-processing Window]¶
The functions of the [Pre-processing Window] are explained in this chapter.
The [Pre-processing Window] opens just after a new project is started. It is used to create input information that is necessary for the solver.
The Pre-processor handles the following operations:
Importing geographic data
Editing geographic data
Creating grids
Editing grids
Setting calculation conditions
The additional menu items for [Pre-processing Window] and the tree structure of [Object Browser] are explained in the following sections.
[Object Browser]¶
Figure 132 shows an example of the [Object Browser] of [Pre-processing Window].
The [Object Browser] of the [Pre-processing Window]¶
Operations related to elements shown in object browser are explained in the following sections.
[Geographic Data]¶
[Geographic Data] is used when importing or editing geographic data that is used for grid attribute interpolation. Refer to [Geographic Data] for operations on [Geographic Data].
[Grid Creating Condition]¶
[Grid Creating Condition] is used when selecting and edit setting on grid creating condition. Refer to Grid creating functions for operations on [Grid Creating Condition].
[Grid]¶
[Grid] is used when editing grid. Refer to Grid for operations on [Grid].
[Measured Values]¶
[Measured Values] is used when importing measured values. Refer to [Measured Data] (M) for operations on [Measured Values].
[Background Images]¶
[Background Images] is used when importing background images. Refer to Background Image for operations on [Background Images].
[Background Images (Internet)]¶
[Background Images (Internet)] is used to show images got from internet and shows as background images.
When you check on the child item, like [Google Maps (Road)], the map is shown as background images.
When you want to use this function, you have to specify the coordinate system used in the project. Please refer to [Property] (P) about the way to specify the coordinate system.
You can add or remove the maps to show. When you want to use Google Maps images as background images, you need to create an account on Google, and input the API Key you’ve created. Please refer to [Background Images (Internet)] tab about the detail.
Note
Latitude and longtude coordinate systems
In iRIC 3.0.3 or later, you can use this function for Latitude and longitude coordinate systems, e. g. EPSG:4326 WGS 84.
[Axes]¶
Shows X-Y axes in the drawing region. Figure 133 shows the example of axes.
When [Axes] is selected in the [Object browser], you can change the position and size of the axes by mouse dragging operation in the drawing region.
Example of axes¶
[Distance Measures]¶
Shows lines that is used to measure the distance in the drawing region.
You can add measures, by selecting [Distance Measures] in the [Object Browser], and selecting [Add Measure] in the right-clicking menu.
By selecting measure element (the child elements of [Distance Measures]), and left-dragging operation in the drawing region, you can draw a line that represents the distance between the drag start point and the drag end point. Figure 134 shows the example of the distance measure line.
Example of the distance measure line¶
Line color, start position, and end position etc. of the distance measure line can be edited from the [Property] dialog. Figure 135 shows the example of [Distance Measure] property dialog.
[Distance Measure] property dialog¶
Basic operations¶
Selecting an object in a canvas¶
Select an object (i.e., a river transverse line or nodes of the grid that is displayed in the canvas) as follows:
Left click: Selects the object that is pointed at.
Left drag: Selects all objects in the rectangle made by the drag start and finish points.
Note that not all type objects support multiple selecting by left dragging. For details, refer to the description of each function.
[Geographic Data]¶
The functions for editing [Geographic Data] are explained in the following sections. Refer to Editing geographic data for the abstract of [Geographic Data].
Operations related to [Geographic Data] are available from [Geographic Data] menu when the [Pre-processing Window] is active.
[Geographic Data] types that users can import and edit depend depends on the solver.
There is an exception: the [Reference Information] group. For projects for every solver, this group is shown. This is a special group that is not for mapping attributes to grid, but just for showing data as reference information.
For example, add poly lines for road center lines, area border lines as [Reference Information].
Curently, iRIC supports the following three types of [Geographic Data].
Point Cloud Data
Cross-Section Data
Raster Data
Time Series Raster Data
Polygon
Polyline
Points data
The common operations available for all of these types are explained in Common functions. Operations specific to the data types are explained in Editing [Point Cloud Data] to Editing [Points].
For importing and exporting [Geographic Data], refer to [Geographic Data] (E) and [Geographic Data] (E).
Common functions¶
The functions available commonly for all types of [Geographic Data] are explained in the following sections.
[Color Setting]¶
Description: Edits the colormap for each type of geographic data.
When you select [Color Setting], the [Color Setting] dialog will open. Change the setting and click on [OK]. The content of the dialog varies depending on whether the geographic information is a real or integer(selected from multiple candidate values).
For Real Values¶
The dialog shown in Figure 136 will appear.
The [Color Setting] dialog¶
For Integer Values¶
The dialog shown in Figure 137 will appear.
The [Color Setting] dialog¶
Note
In iRIC ver4, geographic data added in the preprocessor window can also be viewed in the Post-processing window. The main specifications of the color settings are as follows.
The color settings for geographic information in the Post-processing window are inherited from the settings in the preprocessor window at the time the Post-processing window is opened.
If the Post-processing window is already opened, color settings for post-processing window will not be changed even if the color settings are changed in the preprocessor window.
When changing the color settings in the post-processing window, the color settings for preprocessor window will not be changed.
[Edit Name] (N)¶
Description: Edits the name of [Geographic Data].
Select the geographic data in [Object Browser] that you want edit name, and perform the following:
Menu bar: [Geographic Data] (E) –> (Type of geographic data selected) –> [Edit Name] (N)
[Object Browser] changes and now you can edit the name of the selected geographic data (Figure 138). Input the new name and press Enter key.
The [Object Browser] while the name of [Geographic Data] is being edited¶
[Delete] (D)¶
Description: Deletes geographic data.
Select the geographic data in [Object Browser] you want to delete, and perform the following:
Menu bar: [Geographic Data] (E) –> (Type of geographic data selected) –> [Delete] (D)
The [Delete item] dialog (Figure 139) will open. Select [Yes].
The [Delete item] dialog¶
[Import] (I)¶
Description: Imports [Geographic Data].
The function of this item is the same to [Geographic Data] under [Import] menu under [File] menu. Refer to [Geographic Data] (E).
[Export] (E)¶
Description: Exports geographic data.
The function of this item is the same to [Geographic Data] under [Export] menu under [File] menu. Refer to [Geographic Data] (E)
[Delete Selected] (S)¶
Description: Deletes multiple geographic data at once.
In [Object Browser], select the geographic data group that contains the data you want to delete, and perform the following:
(Selected geograhic data) –> Right-clicking menu –> [Delete Selected] (S)
The [Delete selected geographic data] dialog (Figure 140) will open. Check on the items that you want to delete, and click on [OK] button.
The [Delete Selected item] dialog¶
[Delete All] (A)¶
Description: Deletes all geographic data in the group.
Select the geographic data (including more than 2 items) in [Object Browser] you want to delete, and perform the following:
Menu bar: [Geographic Data] (E) –> [Delete All] (A)
The [Delete All item] dialog (Figure 141) will open. Select [Yes].
The [Delete All item] dialog¶
[Export All Polygons]¶
Description: Exports geographic data (including more than 2 polygons).
Select the geographic data (including more than 2 items) in [Object Browser] you want to export, and perform the following:
Menu bar: [Geographic Data] (E) –> [Export All Polygons]
The [Export Polygons] dialog (Figure 142) will open. Input file name and click on [Save].
The [Export Polygons] dialog¶
Editing [Point Cloud Data]¶
[Point Cloud Data] consist of coordinates and attribute at that point. Figure 143 shows an example of the [Point Cloud Data].
The [Point Cloud Data]¶
[Select Points With Polygon] (P)¶
Description: Defines a polygon region, and select points within that polygon.
Click on canvas region to specify polygon vertices positions sequentially. By double-clicking or pressing Enter key, the polygon is defined and the points within that polygon are selected. Figure 144 shows an example of the [Pre-processing Window] while defining a polygon region. Figure 145 shows an example of the [Pre-processing Window] after selecting.
The [Pre-processing Window] while defining a polygon region¶
The [Pre-processing Window] after selecting points within the polygon region¶
In normal status, points can be selected with left-dragging.
[Edit Selected Points] (E)¶
Description: Edits the selected points.
When you select [Edit Selected Points], the [Edit Points] dialog (Figure 146) will open. Input new Value at the selected points, and click on [OK].
The [Edit Points] dialog¶
[Export Selected Points] (X)¶
Description: Exports the selected points to an external file.
When you select [Export Selected Points], the [Select file to export] dialog (Figure 147) will open. Input the file name to export and click on [Save].
The [Select file to export] dialog¶
[Add New Point] (A)¶
Description: Adds new points.
When you select [Add New Point], select a point that already exists first. The value at that point will be the default value at the points you are going to add. Then, click on the canvas where you want to add new points. Finish by double-clicking or by pressing Enter key. The [Add Points] dialog (Figure 148) will open, so input the Value at new points and click on [OK].
Figure 149 shows an example of [Pre-processing Window] while adding new point.
The [Add Points] dialog¶
Example of adding new points¶
[Interpolate Points] (I)¶
Description: Adds new points between points that already exists.
After you select [Interpolate Points], click on multiple points that already exists, between which you want to interpolate points. Finish by double-clicking or pressing Enter key. The [Dialog] (Figure 150) will open, so edit the setting and click on [OK] to interpolate points.
Figure 151 shows an operation of interpolating points.
The [Dialog]¶
Example of interpolating points¶
[Delete Selected Points] (O)¶
Description: Deletes the selected points. Figure 152 shows an example.
Example of deleting selected points.¶
[Delete Selected Points Less Than Value] (L)¶
Description: Deletes the points that are selected, and have value less than that you specify.
When you select [Delete Selected Points Less Than Value], the [Delete Points] dialog (Figure 153) will open. Input the value and click on [OK]. Figure 154 shows an example.
The [Delete Points] dialog¶
Example of deleting selected points less than the specified value.¶
[Delete Selected Points Greater Than Value] (G)¶
Description: Deletes the points that are selected, and have value greater than that you specify.
When you select [Delete Selected Points Greater Than Value], the [Delete Points] dialog (Figure 155) will open. Input the value and click on [OK]. Figure 156 shows an example.
The [Delete points] dialog¶
Example of deleting selected points greater than the specified value.¶
[Add Break Line] (B)¶
Description: Adds break line.
After you select [Add Break Line], click on the points sequently between which you want to add break line. Finish by double-clicking of pressing Enter key.
When you [Remesh TINs], break lines will be used as TIN boundary lines. Figure 157 shows an example.
Example of TIN boundarys after adding break line¶
[Remove Break Line] (R)¶
Description: Removes break line.
After you select [Remove Break Line], click on the break line you want to remove. The [Warning] dialog (Figure 158) will open, so click on [Yes] to remove the break line.
The [Warning] dialog¶
[Remove All Break Lines] (O)¶
Description: Removes all break lines.
When you select [Remove All Break Lines], the [Warning] dialog (Figure 159) will open. Click on [Yes].
The [Warning] dialog¶
[Remesh TINs] (T)¶
Description: Remesh TINs that are used for interpolation.
Remeshing TINs will be necessary when points are added or removed, and/or break lines are added or removed. Figure 160 shows an example of remeshing TINs.
Example of remeshing TINs¶
[Remove triangles with long edge] (W)¶
Description: Remove triangles with long edge from TIN.
When TIN is generated, triangles with long edge are sometimes generated in area in which there is not points. Using this function, you can remove such needless triangles.
When you select [Remove triangles with long edge], dialog (Figure 161) will open. Specify the Limit edge length, and click on [Apply].
You’ll see that the triangles with edges longer than limit edge length are shown as gray area. If you need to, you can change limit edge length, and click on [Apply] again. If it seems OK, click on [OK] button to finish the operation.
Figure 162 shows an example of [Point Cloud Data] before removing triangles, Figure 163 shows an example of [Point Cloud Data] after clicking [Apply] button, and Figure 163 shows an example of [Point Cloud Data] after removing triangles, for each.
[Remove triangles with long edge] dialog¶
[Point Cloud Data] before removing triangles¶
[Point Cloud Data] display example after clicking [Apply] button¶
[Point Cloud Data] after removing triangles¶
[Merge]¶
Description: Merge points in other [Point Cloud Data] to this data.
When you select [Merge], the [Select data to merge] dialog (Figure 165) will open. Select the data to merge, and click on [OK] button. Them, the [Point Cloud Data] is merged, and the [Remesh TINs] is executed.
When you’ve imported [Point Cloud Data] for neighbor regions as separate data, it happens that when the [Point Cloud Data] is mapped to grid attributes, values are not mapped correctly to nodes (or cells) in the boundary region of those data. In such cases, executing mapping after merging the data will solve the problem.
[Select data to merge] dialog¶
[Display Setting] (S)¶
Description: Changes display setting of [Point Cloud Data].
[Point Cloud Data] can be visualized in the three methods: [Points], [Wireframe], and [Surface]. Figure 166 shows the three methods.
[Point Cloud Data] display methods¶
When you select [Display Setting], the [Display Setting] dialog (Figure 167) will open. Change settings and click on [OK]. [Transparent] is active only when you select [Surface] for [Display Method].
The [Display Setting] dialog¶
Editing [Cross-Section Data]¶
[Cross-Section Data] is a type of Geographic Data] that is based on cross-sectional survey data of a river. [Cross-Section Data] is used as the elevation information for a river and its environs.
Figure 168 shows an example of [Cross-Section Data].
[Cross-Section Data]¶
[Cross-Section Data] has two modes shown in Table 15.
Mode |
Description |
|---|---|
[Create Mode] |
Mode to create a new [Cross-Section Data] |
[Edit Mode] |
Mode to edit existing [Cross-Section Data] |
When you select [Add] –> [Cross-Section Data] in [Object Browser], new [Cross-Section Data] is created with [Create Mode]. When you import [Cross-Section Data] using function explained in [Geographic Data] (E), [Cross-Section Data] is imported and [Edit Mode] is activated.
The sections below explains the functions for each mode.
[Create Mode]¶
Create [Cross-Section Data] to region which is defined by [Center line], [Left bank line], and [Right bank line].
After [Create Mode] is started, click on the canvas to specify a few points on the centerline of the [Cross-Section Data]. To finish, press the Enter key or double click. Figure 169 shows an example of the display when the centerline has been set.
Example of display after the centerline has been set¶
Next, please generate left bank line and right bank line. Select [Build Left bank and Right bank lines] from menu. [Build Bank Lines] dialog (Figure 170) will be shown. When you input the distance on the dialog and click on [OK], Left bank line and Right bank line are generated, and shown like in Figure 171.
You can edit left bank line and right bank line, by dragging the points or by adding or removing points.
[Build Bank Lines] dialog¶
Example of generated Left bank line and Right bank line¶
At last, select [Create Cross-Section Data] from menu. [Generate Cross-Section Data] dialog (Figure 172) will be shown.
When you input the number of cross sections etc. and click on [OK], a new [Cross-Section Data] is generated.
An example of generated [Cross-Section Data] is shown in Figure 173.
When [Cross-Section Data] is generated, mode is switched to [Edit Mode].
[Generate Cross-Section Data] dialog¶
Example of generated [Cross-Section Data]¶
[Generate Cross-Section Data]¶
Description: Generate [Cross-Section Data].
[Generate Cross-Section Data] dialog (Figure 172) will be shown.
When you input the number of cross sections etc. and click on [OK], a new [Cross-Section Data] is generated.
An example of generated [Cross-Section Data] is shown in Figure 173.
[Build Left bank and Right bank lines]¶
Description: Generate Left bank and Right bank lines.
Dialog in Figure 170 is shown, so specify the distance values and click on [OK].
Figure 171 shows an example of generated [Left Bank Line] and [Right Bank Line].
You can modify the lines by dragging the vertices.
[Add Vertex] (A)¶
Description: Add vertices to lines
When you move the mouse cursor to hover on [Center line], [Left Bank Line], or [Right Bank Line] after selecting this menu, The mouse cursor changes to the shape in Figure 174.
Left click on the line and drag it to add a new vertex. The vertex is placed wherever you release the left click button.
The mouse cursor display when adding a vertex is possible¶
[Remove Vertex] (R)¶
Description: Deletes the vertex of lines.
When this is selected and you move the cursor onto the vertex of the lines, the cursor shape will change (Figure 175). Left clicking will remove the vertex.
The mouse cursor when removing the vertex is possible¶
[Import Center Line] (I)¶
Description: Import [Center Line] from Shape files or CSV files.
The dialog in Figure 176 is shown, so please select the file you want to import, and click on [Open] button.
[Select file to import] dialog¶
[Export Center Line] (E)¶
Description: Export [Center Line] to Shape files or CSV files.
The dialog in Figure 177 is shown, so please specify the name of file you want to export, and click on [Save] button.
[Select file to export] dialog¶
[Edit Mode]¶
Menu items¶
When the [Pre-processing Window] is active and [Cross-Section Data] is selected in [Object Browser], you can access menu items related to operations on [Cross-Section Data] under the following:
Menu bar: [Geographic Data] (E) –> [Cross-Section Data] (R)
Table 17 shows the menu items under [Cross-Section Data] (R).
Menu item |
Description |
|---|---|
[Edit Name] (N) |
Edits the name shown in [Object Browser]. |
[Display Cross-section] (C) |
Opens a new river cross-section window. |
[Insert Upstream Side] (B) |
Inserts a new river transverse line on the upstream side. |
[Insert Downstream Side] (A) |
Insert a new river transverse line on the downstream side. |
[Move] (M) |
Moves the river transverse line. |
[Rotate] (R) |
Rotates the river transverse line. |
[Shift Center] (H) |
Shifts the center point of the transverse line. |
[Extend Horizontally] (X) |
Extends or shortens the river transverse line to the left/right. |
[Delete Cross Section] (T) |
Deletes the river transverse line. |
[Rename Cross Section] (E) |
Renames the river transverse line. |
[Add Extension Line] (L) |
Adds a left bank extension line to the river transverse line. |
[Add Extension Line] (R) |
Adds a river bank extension line to the river transverse line. |
[Remove Left Bank Extension Line] (V) |
Removes the left bank extension line from the river transverse line. |
[Remove Right Bank Extension Line] (O) |
Removes the right bank extension line from the river transverse line. |
[Display Setting] (S) |
Displays elevation colormap based on Cross-Section Data. |
[Interpolation Mode] |
Switch interpolation mode between river transverse lines. |
[Map geographic data to cross sections] |
Map geographic data to river transverse line. |
[Generate point cloud data] |
Generate [Point Cloud Data] using the background grid of the [Cross-Section Data] |
[Delete] (D) |
Deletes Cross-Section Data. |
Selecting the river transverse line¶
The river transverse lines need to be selected prior to any operations explained in the following sections, except for displaying elevation colormap. In this section, the operation to select the river transverse line is explained.
To select river transverse lines, left drag on the canvas to make a rectangle (black line) (Figure 178). When you releasing the mouse left button, the river transverse lines whose river center point (blue dot) is in the rectangle (Figure 179) are selected. The selected river transverse lines are drawn with thicker line.
The [Pre-processing Window] when a user is left dragging¶
The [Pre-processing Window] after selecting river transverse lines¶
[Display Cross-section] (C)¶
Description: Displays the cross-section window.
Prior to this operation, you need to select the river transverse line for which you want to open cross-section window. Figure 180 shows an example of the cross-section window.
The river cross-section window¶
For operations in the cross-section window, refer to Operation in the River Cross-section Window.
[Insert Upstream Side] (B) / [Insert Downstream Side] (A)¶
Description: Inserts a new river transverse line upstream (or downstream) from the selected river transverse line.
Prior to this operation, you need to select a river transverse line.
When you select one of these, the [Insert Transverse Line] dialog (Figure 181) will open. Set [River Center Point Coordinates] and [Cross-section Information] and click on [OK].
[Center Point Coordinates]:
If you have chosen [Mouse Click], click on the canvas to set the coordinates.
If you have chosen [Coordinate Values], input the coordinate values in the boxes.
If you have chosen [Ratio between Back and (0-1)], set the ratio between 0 and 1 to locate the center point on the spline curve. The curve is made by smoothly linking the points before and after the added point.
[Cross-section Information]:
If you have chosen [Insert Three Points of Elevation 0], then input the cross-section data of the center, left bank and right bank while securing sufficient distance between each.
If you have chosen [Copy Next River Transverse Line], copy the cross-section data of the river transverse line specified in the combo box.
If you have chosen [Create Cross-section of Back and Forth], the cross-section data are made by interpolating the cross-section data of transverse lines immediately upstream/downstream from the transverse line that is to be inserted.
The [Insert Transverse Line] dialog¶
[Move] (M)¶
Description: Moves the selected river transverse lines. Figure 182 shows an example.
You can do this operation against multiple transverse lines at a time.
Example of moving a river transverse line¶
When you select [Move], the [Move Transverse Line] dialog (Figure 183) will open. Select either [Center Point Coordinates] or [Transfer Quantity] and click on [OK].
The [Move Transverse Line] dialog¶
You can also move the river transverse lines with mouse operation. When the mouse cursor is near the center point of the selected river transverse line, the cursor changes to that in Figure 184. Now you can move the selected river transverse lines by left dragging.
Mouse cursor you can move river transverse lines¶
[Rotate] (R)¶
Description: Rotates the selected river transverse line. Figure 185 shows an example.
You can do this operation against only one transverse line at a time.
Example of rotating a river transverse line¶
When you select [Rotate], the [Rotate Transverse Line] (Figure 186) dialog will open. Set either [Relative Angle] or [Increment Angle] and click on [OK]. (Positive direction: counterclockwise; unit: degree)
You can also rotate the river transverse lines with mouse operation. When the mouse cursor is near to the left (or right) bank of the selected river transverse line, the cursor changes to that in Figure 187. Now you can rotate the selected river transverse lines by left dragging.
The [Rotate Transverse Line] dialog¶
Mouse cursor shape when you can rotate a river transverse line¶
[Shift Center] (H)¶
Description: Shifts the selected center point of the river transverse line to the left (or right) bank side. By this operation, the location of the center point shifts but the cross-section data do not change. Figure 188 shows an example.
You can do this operation against multiple transverse lines at a time.
Example of operation to shift the center point¶
When you select [Shift Center], the [Shift River Center] dialog (Figure 189) will open. Set [Transfer Quantity] and click on [OK].
You can also shift the center point of the river transverse line on canvas with mouse operation. When the mouse cursor is near the center point of the selected river transverse line while the Shift key is held down, the cursor changes to that in Figure 190. Now, you can shift the selected center point of the river transverse line with left dragging.
The [Shift River Center] dialog¶
Mouse cursor shape when you can shift the center point of the river transverse line¶
[Extend Horizontally] (X)¶
Description: Extends/Shortens the river transverse lines. Figure 191 shows an example.
You can do this operation against multiple transverse lines at a time.
Example of extending the river transverse lines¶
When you select [Extend Horizontally], the [Extend Transverse Line] dialog will open (Figure 192). Select from among [Set Distance between River Center and Left Bank], [Increment] and [Extension Ratio], set the value and click on [OK].
The [Extend Transverse Line] dialog¶
[Delete Cross Section] (T)¶
Description: Deletes the selected river transverse lines. Figure 193 shows an example.
You can do this operation against multiple transverse lines at a time.
Example of deleting a river transverse line¶
[Rename Cross Section] (E)¶
Description: Renames the selected river transverse line.
You can do this operation against only one transverse line at a time.
When you select this, the [Rename Transverse Line] dialog (Figure 194) will open. Set a new name and click on [OK].
Example of [Rename Transverse Line] dialog¶
[Add Extension Line] (L) / [Add Extension Line] (R)¶
Description: Adds a Left Bank Extension Line or Right Bank Extension Line to the selected river transverse line. Figure 195 shows an example.
You can do this operation against only one transverse line at a time.
Example of adding a Extension Line to the selected river transverse line¶
When you select [Add Left Bank Extension Line], the [Add Extension Line] dialog (Figure 196) will open. When you select [Mouse Click], click on the point to which you want to extend the river transverse line, or when you select [Coordinates], input the coordinates of the point to which you want to extend the river transverse line. Then click on [OK].
The [Add Extension Line] dialog¶
[Remove Left Bank Extension Line] (V) / [Remove Right Bank Extension Line] (O)¶
Description: Deletes a Left Bank Extension Line/Right Bank Extension Line from the selected river transverse line. Figure 197 shows an example.
You can do this operation against only one transverse line at a time. This operation is possible against a river transverse line which has been added the Left Bank Extension Line or Right Bank Extension Line.
Example of the operation for deleting a Extension Line¶
[Display Setting]¶
Description: Edits display setting of [Cross-Section Data]. Figure 198 shows an example.
Example of changing [Cross-Section Data] display setting¶
When you select [Display Setting], the [Display Setting] dialog (Figure 199) will open. When [Visible] check box inside [Background Color] group box is checked, [Cross-Section Data] region background is painted. When [Visible] check box inside [Crosssection Lines] group box is checked, the cross-section lines are drawn just below the transverse line, with the Z-scale and color in that group box.
The [Display Setting] dialog¶
[Interpolation Mode]¶
Description: Switches the Interpolation Mode (“Spline” or “Linear Curve”).
Figure 200 shows an example of Spline Interpolation Mode. Figure 201 shows an example of Linear Curve Interpolation Mode.
Example of the [Interpolation Mode (Spline)]¶
Example of the [Interpolation Mode (Linear Curve)]¶
[Map geographic data to cross sections]¶
Description: Map geographic data to the selected [Cross-Section Data].
When you select this, the [Map geographic data to cross sections] dialog (Figure 202) will open. Input distance between elevation points etc. and click on [OK].
[Map geographic data to cross sections] dialog¶
Note
Until iRIC 4.0, only [Point Cloud Data] could be mapped. In 4.1 and later, [Raster Data] also can be mapped.
[Generate point cloud data]¶
Description: Generate [Point Cloud Data] using the background grid of the [Cross-Section Data].
When you select this a new [Point Cloud Data] is generated, and the dialog in Figure 203 is shown.
Figure 204 shows an example of [Point Cloud Data] generated using this function.
[Information] dialog¶
Example of [Point Cloud Data] generated from [Cross-Section Data]¶
Note
The density of points generated with this function can be changed by editing the setting about [Background Grid]. Please refer to [Background Grid] tab about how to edit setting about [Background Grid].
Note
You can generate [Point Cloud Data] from [Cross-Section Data], by generating a grid from [Cross-Section Data], and then generating [Point Cloud Data] from the attribute of generated grid. Please refer to [Create grid from Cross-Section Data] (2-D structured grid) for detail.
Operation in the River Cross-section Window¶
Description: Displays the cross-section of a river transverse line. The window is used to edit elevation information. Figure 205 shows an example of the River Cross-section Window.
Example of the River Cross-section Window display¶
Menu items¶
Table 18 shows the additional menu items for the River Cross-section Window. The additional menu items are shown between [Import] and [Simulation] when River Cross-section Window is active.
Menu item |
Description |
|
|---|---|---|
Elevation Point (A) |
[Activate] (A) |
Activates the selected elevation point. |
[Inactivate] (I) |
Inactivates the selected elevation point. |
|
[Inactivate using water elevation] |
Inactivate points that are outside of the positions where the elevation exceed water elevation for the first time. |
|
[Edit cross section from the selected point] |
Edit cross section shape from the selected point. |
|
[Move] (M) |
Moves the selected elevation point. |
|
[Delete] (D) |
Deletes the selected elevation point. |
Toolbar functions¶
Table 19 shows the toolbar items for River Cross-section Window.
Item |
Description |
|---|---|
Crosssection |
Switches the cross-section to show |
Reference |
Shows reference cross-section. You can switch the cross-section to show with combobox. |
Auto rescale |
If it is checked, when user switches the cross-section to show, automatic rescale is executed, so that new cross-section is shown in the center. |
Aspect ratio |
Current aspect ratio is shown. You can also edit the value to change setting. |
Fix aspect ratio |
If it is checked, Ctrl + Middle-drag changes to zoom-in/zoom out without changing aspect ratio. |
Fix retion |
If it is checked, Ctrl + Middle-drag and Ctrl + Left-drag operations are disabled. |
Grid |
You can switch on/off background grid |
Scale |
You can switch on/off scales shown at left edge and top edge. |
Left/right bank markers |
You can switch on/off “Left Bank Side”, “Right Bank Side” markers shown at top edge. |
Aspect ratio |
You can switch on/off Aspect ratio shown at right bottom. |
Display Setting |
Shows Display Setting dialog (see Figure 206). |
Cross-section Window Display Setting dialog¶
[Activate] (A)¶
Description: Activates the selected elevation point. Figure 207 shows an example.
Example of activating elevation point¶
[Inactivate] (I)¶
Description: Inactivates the selected elevation point. Figure 208 shows an example.
Example of the inactivating an elevation point¶
[Inactivate using water elevation]¶
Description: Inactivate points that are outside of the positions where the elevation exceed water elevation for the first time.
When multiple water elevation data is loaded, a dialog to select the water elevation is shown.
Example of the operation for inactivate using water elevation¶
[Edit cross section from the selected point]¶
Edit the cross section shape from the selected point.
When you want to use this function, please select only one point on the cross section first.
After activating this function, when you move the mouse cursor, The line to preview the geometry shape after editing will be shown like in Figure 210. While editing, the horizontal and vertical length of the line, and the gradient will be shown for the line that is going to be created.
You can define the end point of the line by moving the mouse cursor, and execute the editing operation by left clicking.
You can finish editing operation by double clicking, or pressing Enter key.
The gradient values used in this function is selected from the values defined on [River Survey Data] tab.
Example of cross section editing operation by mouse¶
When you right click on the canvas while activating this function, [Edit from Dialog] menu will be shown. When you select this menu, the dialog in Figure 211 will be shown.
On this dialog, you can edit the cross section shape by inputting the distance and gradient etc.
By pressing [Apply] button, you can preview the cross section shape after editing.
By pressing [Edit Next] button, you can execute the editing operation, select the new point added by the operation, and continue editing. This function is useful when you want to edit the cross section shape continuously.
Example of [Edit Cross Section From Selected Point] dialog¶
Using this function, you can easily create cross section shapes that is composed of line. Figure 212 shows an example.
Example of editing operation of cross section¶
[Move] (M)¶
Description: Moves the selected elevation point. Figure 213 shows an example.
When you select [Move], the [Move Elevation Point] dialog (Figure 214) will open. Set horizontal/vertical offset and click on [OK].
Example of the operation for moving an elevation point¶
The [Move Elevation Point] dialog¶
You can also move the elevation point on the canvas with a mouse operation. When the mouse cursor is near the selected elevation point, the cursor changes to an “open hand” cursor. Now you can move the selected elevation point by left dragging.
[Delete] (D)¶
Description: Deletes the selected elevation point. Figure 215 shows an example.
Example of deleting an elevation point¶
Editing [Raster Data] and [Time Series Raster Data]¶
Description: Sets the values of geographic data defined in each cell of raster data.
[Raster Data] with [Time] dimension is called [Time Series Raster Data]. For example, rainfal data is [Time Series Raster Data].
Figure 216 shows an example of the [Raster Data].
Example of the [Raster Data]¶
Currently, Function to edit [Raster Data] is not implemented yet.
Note
Limitation about importing [Time Series Raster Data]
When importing [Time Series Raster Data], user can import only one data.
Editing [Polygons]¶
Description: Sets the values of geographic data within the area of the Polygon. Figure 217 shows an example of the [Polygon].
Example of [Polygons]¶
[Polygons Attribute Browser]¶
When [Polygons] data is selected in the [Object Browser], [Polygons Attribute Browser] is shown. Figure 218 shows an example of [Polygons Attribute Browser]. The list of columns in [Polygons Attribute Browser] is shown in Table 20 .
Example of [Polygons Attribute Browser]¶
Column name |
Description |
|---|---|
Name |
The name of polygons. You can edit the values. |
Value |
the valud of polygons. You can edit the values. |
Show |
When clicked, the clicked polygon is shown in the center of the drawing area. |
Selecting operation¶
For [Polygons], user can select multiple polygons at the same time. the selected polygons can be deleted or sorted with one operation.
User can select polygons with the two ways below:
Mouse operation: Draw boundary box by left-dragging, and all polygons sorrounded by the box are selected.
Attribute browser operation: Click on items in [Polygons Attribute Browser], and the clicked item is selected. You can select multiple items, by clicking with pressing Ctrl key.
[Add New Polygons]¶
The procedure to add a new [Polygons] is as follows:
In [Object Browser] ,select the group of [Geographic data] to which you want to add [Polygons] data (Figure 219) Please note that the list of groups of [Geographic Data] differs depending on the solver you are using.
Do the following operation. Then, a new [Polygons] data is added and selected in the object browser.
Menu bar: Geographic Data (E) –> Polygons (P) –> Add New Polygons
In the drawing area, define the nodes of the polygon, by left-clicking. (Figure 220)
Finish defining the shape of polygon, by double-clicking or pressing Enter key. Then the dialog to specify the value at the defined polygon is shown (Figure 221), so input the value and click on [OK]. Please note that the widget to edit value differs depending on the type of [Geographic Data].
Example of [Object Browser]¶
Example of [Pre-processing Window] while defining a polygon¶
Example of dialog to edit value of polygon¶
[Add New Polygon]¶
Description: Adds a new Polygon to [Polygons] data.
[Add New Polygons] adds a new [Polygons] data. On the other hand, this function add an new Polygon to the [Polygons] data that already exists.
The steps to define a polygon is the same to [Add New Polygons].
[Edit Value] (V)¶
Description: Edits data value within the Polygon.
When you select [Edit Value], the [Edit Elevation value] dialog (Figure 222) will open. Input a new value and click on [OK].
The [Edit Elevation value] dialog¶
[Add Vertex] (A)¶
Description: Adds a vertex to the [Polygon].
When you select [Add Vertex] and move the cursor to the edge of [Polygon], the cursor changes to that shown in Figure 223. Left click on the line and drag it to add a new vertex. The vertex is placed where you release the left button.
Mouse cursor when possible to add a vertex¶
[Remove Vertex] (R)¶
Description: Deletes a vertex from the [Polygon].
When you select [Remove Vertex] and move the cursor onto the vertex you want to remove, the cursor changes to that shown in Figure 224. Left clicking will remove the vertex.
Mouse cursor when possible to removing the vertex¶
[Edit Coordinates] (C)¶
Description: Edits the coordinates of the vertices of the [Polygon].
When you select [Edit Coordinates], the [Polygon Coordinates] dialog (Figure 225) will open. Edit the coordinates and click on [OK].
The [Polygon Coordinates] dialog¶
[Add Hole Region] (H)¶
Description: Adds the Hole Region to the [Polygon].
When you select [Add Hole Region], the [Information] dialog (Figure 226) will open. Click on [OK].
On the canvas, add vertexes to the Hole Region by left clicking (Figure 227).
Double click or press the Enter key to complete defining the Hole Region.
The [Add Hole Region] Information dialog¶
Example of the [Add Hole Region] Result¶
[Delete Hole Region] (D)¶
Description: Deletes the Hole Region from the [Polygon].
When you select [Delete Hole Region], the [Warning] dialog (Figure 228) will open. Click on [Yes].
On the canvas, the Hole Region will be deleted. (Figure 229).
The [Warning] dialog¶
Example of the [Delete Hole Region] Result¶
[Merge]¶
Description: Merge polygons in other [Polygons] to this data.
[Select data to merge] dialog (Figure 230) is shown. Select the data to merge, and click on [OK] button.
[Select data to merge] dialog¶
[Copy]¶
Description: Copy the data to other [Geographic Data] group.
[Select Graographic Data] dialog (Figure 231) is shown. Select the [Geographic Data] group to which you want to copy the data.
Then, [Copy Setting] dialog (Figure 232) is shown. Specify the values of the polygons, and click on [OK] button, to finish copying the [Polygons] data.
[Select Geographic Data] dialog¶
[Copy Setting] dialog¶
[Color Setting] (S)¶
Description: Edits the color of the [Polygon].
When you select [Color Setting], the [Polygon Color] dialog (Figure 233) will open. Set it and click on [OK].
The [Polygon color] dialog¶
Editing [Lines]¶
Description: Define geographic data defined as Lines. Figure 234 shows an example of [Lines].
Example of the [Lines]¶
Note
Geographic data group in which [Polyline] can be defined
[Polyline] can be added only to Geographic Data group [Reference Information].
Note
[Polyline] on [River Cross-section Window]
On [River Cross-section Window], the intersection points between [Cross-section] and [Polyline] are displayed.
Using this function, you can add [Polyline] as reference information on [Pre-Processing Window] first, and you can edit the cross-section shape, considering the [Polylines] that corresponds to roads, for example.
Figure 235 shows an example of [Polyline] shown on [River Cross-section Windo].
Please refer to Operation in the River Cross-section Window for the detail of [River Cross-section Window].
Example of the [Polyline] displayed on [River Cross-section Window]¶
Note
Drawing charts with calculation result interpolated on polylines
iRIC 1.0.14 and later can draw charts with calculation result interpolated on polylines. Please refer to [Graph Window] for detail.
[Lines Attribute Browser]¶
When [Lines] data is selected in the [Object Browser], [Lines Attribute Browser] is shown. Figure 236 shows an example of [Lines Attribute Browser]. The list of columns in [Lines Attribute Browser] is shown in Table 22.
Example of [Lines Attribute Browser]¶
Column name |
Description |
|---|---|
Name |
The name of lines. You can edit the values. |
Value |
the valud of lines. You can edit the values. |
Show |
When clicked, the clicked line is shown in the center of the drawing area. |
Selecting operation¶
For [Lines], user can select multiple lines at the same time. the selected lines can be deleted or sorted with one operation.
User can select line with the two ways below:
Mouse operation: Draw boundary box by left-dragging, and all lines sorrounded by the box are selected.
Attribute browser operation: Click on items in [Lines Attribute Browser], and the clicked item is selected. You can select multiple items, by clicking with pressing Ctrl key.
[Add New Polyline]¶
The procedure to add a new Polyline is as follows:
Select the [Reference Information] under [Geographic Data] in [Object Browser] (Figure 237).
The operation below adds a new Polyline to [Object Browser], and that Polyline is selected.
Menu bar: [Geographic Data] (E) –> [Polyline] (L) –> [Add New Lines]
On the canvas, add vertices to the line by left clicking (Figure 238).
Double click or press the Enter key to complete defining the Polyline.
Example of the [Object Browser] display¶
[Pre-processing Window] when the [Polyline] is being defined¶
[Add New Line]¶
Description: Adds a new line to [Lines] data.
[Add New Polyline] adds a new [Lines] data. On the other hand, this function add an new Line to the [Lines] data that already exists.
The steps to define a line is the same to [Add New Polyline].
[Edit Value] (V)¶
Description: Edits data value on the Line.
When you select [Edit Value], the [Edit Elevation value] dialog (Figure 239) will open. Input a new value and click on [OK].
The [Edit Elevation value] dialog¶
[Add Vertex] (A)¶
Description: Adds a vertex to the [Polyline].
When you select [Add Vertex] and move the cursor to the edge of [Polyline], the cursor changes to that shown in Figure 240. Left click on the line and drag it to add a new vertex. The vertex is placed where you release the left button.
Mouse cursor when possible to add a vertex¶
[Remove Vertex] (R)¶
Description: Deletes a vertex from the [Polyline].
When you select [Remove Vertex] and move the cursor onto the vertex you want to remove, the cursor changes to that shown in Figure 241. Left clicking will remove the vertex.
Mouse cursor when possible to removing the vertex¶
[Edit Coordinates] (C)¶
Description: Edits the coordinates of the vertices of the [Lines].
When you select [Edit Coordinates], the [Polyline Coordinates] dialog (Figure 242) will open. Edit the coordinates and click on [OK].
The [Polyline Coordinates] dialog¶
[Merge]¶
Description: Merge lines in other [Lines] to this data.
[Select data to merge] dialog (Figure 243) is shown. Select the data to merge, and click on [OK] button.
[Select data to merge] dialog¶
[Copy]¶
Description: Copy the data to other [Geographic Data] group.
[Select Graographic Data] dialog (Figure 244) is shown. Select the [Geographic Data] group to which you want to copy the data.
Then, [Copy Setting] dialog (Figure 245) is shown. Specify the values of the lines, and click on [OK] button, to finish copying the [Lines] data.
[Select Geographic Data] dialog¶
[Copy Setting] dialog¶
[Color Setting] (S)¶
Description: Edits the color of the [Polyline].
When you select [Color Setting], the [Polyline Color] dialog (Figure 246) will open. Set it and click on [OK].
The [Polyline color] dialog¶
Editing [Points]¶
Description: Define geographic data defined as Points. Figure 247 shows an example of [Points].
Example of the [Points]¶
Note
[Points] data can be created only to [Reference Information] group.
[Points Attribute Browser]¶
When [Points] data is selected in the [Object Browser], [Points Attribute Browser] is shown. Figure 248 shows an example of [Points Attribute Browser]. The list of columns in [Points Attribute Browser] is shown in Table 24.
Example of [Points Attribute Browser]¶
Column name |
Description |
|---|---|
Name |
The name of points. You can edit the values. |
Show |
When clicked, the clicked point is shown in the center of the drawing area. |
Selecting operation¶
For [Points], user can select multiple points at the same time. the selected points can be deleted or sorted with one operation.
User can select points with the two ways below:
Mouse operation: Draw boundary box by left-dragging, and all points sorrounded by the box are selected.
Attribute browser operation: Click on items in [Points Attribute Browser], and the clicked item is selected. You can select multiple items, by clicking with pressing Ctrl key.
[Add New Points]¶
The procedure to add a new point is as follows:
Select the [Reference Information] under [Geographic Data] in [Object Browser] (Figure 249).
The operation below adds a new [Points] to [Object Browser], and that data is selected. (Figure 250)
Menu bar: [Geographic Data] (E) –> [Points] (I) –> [Add New Points]
On the canvas, define a point by left clicking.
Example of the [Object Browser] display¶
[Pre-processing Window] when the [Point] is defined¶
[Add New Point]¶
Description: Adds a new point to [Points] data.
[Add New Points] adds a new [Points] data. On the other hand, this function add an new point to the [Points] data that already exists.
The step to define a point is the same to [Add New Points].
[Edit Coordinates] (C)¶
Description: Edits the coordinates of the the [Points].
When you select [Edit Coordinates], the [Point Coordinates] dialog (Figure 251) will open. Edit the coordinates and click on [OK].
The [Point Coordinates] dialog¶
[Merge]¶
Description: Merge points in other [Points] to this data.
[Select data to merge] dialog (Figure 252) is shown. Select the data to merge, and click on [OK] button.
[Select data to merge] dialog¶
[Color Setting] (S)¶
Description: Edits the color of the [Points].
When you select [Color Setting], the [Points Color] dialog (Figure 253) will open. Edit setting and click on [OK].
The [Color Setting] dialog¶
Grid¶
Grid creating functions¶
The grid creating functions is explained in this section. Refer to Creating a grid for an overview of grid creation.
When the [Pre-processing Window] is active, grids can be created by using the menu items in [Grid] menu. Grids can be created in the following procedure:
Select an algorithm for creating a grid.
Set grid creating condition necessary for the algorithm using.
Create a grid.
Operations for 2. and 3. differ by algorithm.
Table 26 shows the grid creating algorithms that can be used for iRIC.
Grid type |
Item |
Description |
|---|---|---|
Two-dimensioinal structured grid |
[Create grid from polygonal lines and width] |
Creates a grid that smoothly follows a polygonal line. |
[Create grid from cross-section data] |
Creates a grid from [Cross-Section Data]. In addition to transverse lines being set, division points are set on the transverse lines the river centerline and left / right bank lines. |
|
[Create grid by dividing rectangular region] |
Creates a rectangular grid that is evenly divided in the x and y directions. |
|
[Create compound channel grid] |
Creates a grid that has lower channel, by defining grid creating region and lower channel region. |
|
[Create grid shape solving Poisson equation] |
By solving Poisson equation, generate grid whose cell shape are similar to squares. |
|
[General purpose grid generation tool] |
By solving convergence calculation, generate grid whose cell edge length changes smoothly. |
|
Two-dimensional unstructured grid |
[Create grid from polygon shape] |
Creates an unstructured grid from polygon shape. Grid region, refinement regions, hole regions are defined as polygons. |
One-dimensional structured grid (Each node holds the cross-section data.) |
[Create grid from River Survey Data] |
Creates grid from River Survey Data. In addition to transverse lines being set, division points are set on the transverse lines, the river centerline and left/right bank lines. |
The common operations available for all of these algorithms are explained in Common functions. Operations specific to the algorithms are explained in [Create grid from Polygonal line and width] to [Create grid from polygon shape].
Operations available for each algorithm are accessible as sub menu item of the following:
Menu bar: [Grid] (G) –> [Grid Creating Conditions] (C)
Common functions¶
Common functions available regardless of grid creating algorithm are explained in the following sections.
[Select Algorithm to Create Grid]¶
Description: Selects an algorithm for creating a grid.
When you select [Select Algorithm to Create Grid], the [Selecting grid creating algorithm] dialog (Figure 254) will open. Select the Algorithm to use from the list and click on [OK].
[Selecting Grid Creating Algorithm] dialog¶
When you’ve e already selected an algorithm a dialog will open and ask whether you really want to discard the grid creating conditions that have created. Click on [OK].
[Create grid from Polygonal line and width]¶
Description: Creates a grid that smoothly follows a Polygonal line. Figure 255 shows an example of a grid created by this algorithm.
Example of grid created from Polygonal lines and widths¶
After selecting this algorithm, click on the canvas to specify a few points on the centerline of the grid. To finish, press the Enter key or double click. Figure 256 shows an example of the display when the grid centerline has been set.
After the centerline has been set, select [Create Grid] from [Grid] on the menu. The [Grid Creation] dialog (Figure 257) will open. Click on [Apply] to see the resulting grid, adjust the input data and click on [OK].
Example of display after the grid centerline has been set¶
Example of the [Grid Creation] dialog¶
To edit the vertexes of the centerline, select from the menu shown in Table 27.
[Add Vertex] (A)¶
Description: Adds vertices to the centerline.
While selecting it, move the mouse onto the centerline. The mouse cursor changes shape as shown in Figure 258. Left clicking adds a new vertex.
Mouse cursor display when adding a vertex is possible¶
[Remove Vertex] (R)¶
Description: Removes a vertex from the centerline.
While selecting it, move the mouse onto the centerline. The mouse cursor changes shape as shown in Figure 259. Left clicking removes the selected vertex.
Mouse cursor shape when removing the vertex is possible¶
[Edit Vertices Coordinates] (O)¶
Description: Edits the coordinates of the vertex of centerline.
When you select this, the [Polyline Coordinates] dialog (Figure 260) will open. Edit the coordinates and click on [OK].
[Centerline Coordinates] dialog¶
[Line Direction] (E)¶
Description: Reverce the center line direction. Figure 261 shows an example. Note that the “Upstream” and “Downstream” are reversed.
Example of Center line before and after reversing¶
[Remove Centerline] (C)¶
Description: Removes the centerline and restores the condition immediately after the algorithm was selected.
After removing the centerline, click on the canvas to define the centerline in the same way as the first centerline was defined after selecting the algorithm.
[Create grid from Cross-Section Data] (2-D structured grid)¶
Description: Creates a grid from Cross-Section Data. In addition to transverse lines being set, division points are set on the transverse lines, the river centerline and left/right bank lines. Figure 262 shows an example of a grid created by this algorithm.
Before using this algorithm, you need to import Cross-Section Data.
Example of a grid created from Cross-Section Data¶
The following lines of Cross-Section Data are used as grid lines. In addition, division points added by the user are used to create a grid.
River transverse line
River centerline: the curve made by linking the center point of each river transverse line
Left bank end line: the curve made by linking the left bank end of each river transverse line
Right bank end line: the curve made by linking the right bank end of each river transverse line
Figure 263 shows an example of grid division points and the grid made from these division points.
Example of grid division points and the grid made from these division points¶
Select [Grid Creation] from the menu. The [Grid Creation] dialog (Figure 264) will open. Specify the region where the grid is to be made and click on [OK]. The grid is generated according to the division points. Operations related to the division points are done from the menu shown in Menu items.
[Grid Creating] dialog¶
[Add Division Points] (A)¶
Description: Adds division points to the selected line.
Select the line to which you want to add division points (e.g., river centerline, left bank end line, right bank end line, river transverse line) by clicking on it. Figure 265 shows an example of a display after selecting a line. Then, select [Add Division Points] from the menu. The [Add Division Point] dialog (Figure 266) will open. Input number of divisions and select division method, and click on [OK]. Division points are added to the line (Figure 267).
Example of a selected line¶
[Add Division Points] dialog¶
Example of a display after division points have been added¶
[Add Division Points Regionally] (R)¶
Description: Simultaneously adds division points to the river centerline and left/right bank lines.
The [Add Division Points Regionally] dialog (Figure 268) will open. Specify the region where division points are to be added and number of divisions, and click on [OK].
[Add Division Points Regionally] dialog¶
[Delete Division Points] (D)¶
Description: Deletes the selected division points.
Figure 269 shows an example.
Example of deleting a division point¶
[Move Division Points] (M)¶
Description: Moves the selected division points. This is possible when selecting continuous division points on the same line.
When you select [Move Division Points], the [Move Division Points] dialog (Figure 270) will open. Set [Transfer Quantity] and click on [OK].
[Move Division Points] dialog¶
[Reposition Division Points] (P)¶
Description: Relocates the selected division points. This is possible when selecting continuous division points on the same line.
When this is selected, the [Reposition Division Points] dialog (Figure 271) will open. Edit the coordinates and click on [OK].
[Reposition Division Points] dialog¶
Reset to default (R)¶
Description: Discard the modifications of grid creating condition, and restore to the state just after selecting the grid creating algorithm.
[Create grid by dividing rectangular region]¶
Description: Specifies a rectangular region and creates a grid by equally dividing the region in the x and y directions. Figure 272 shows an example of a grid created by this algorithm.
Example of a grid created by dividing the rectangular region¶
After selecting this algorithm, click on the canvas to specify the region where you want to create a grid. Figure 273 shows an example of the display immediately after a region has been specified. Select [Grid Creation] from the menu. The [Grid Creation] dialog (Figure 274) will open.
The region specified by the left drag is shown in the input boxes of the [Grid Creation] dialog. Click on [Apply] and adjust the input boxes. Click on [OK] to create the grid.
Example of the display immediately after a region is specified¶
Example of the [Grid Creation] dialog¶
[Create compound channel grid]¶
Description: Creates a grid that has lower channel, by defining grid creating region and lower channel region. Figure 275 shows an example of created grig.
Example of grid created by [Create compound channel grid]¶
After selecting this algorithm, define grid creating region as a polygon in canvas, by mouse-clicking. Finish defining by double-clicking or by pressing Enter key. Next, define low lower channel as a polygon in the same way. Next, define center line of grid as polygonal line. Figure 276, Figure 277, and Figure 278 show examples.
When the center line is defined, the [Grid Creation] dialog (Figure 279) will open. Input the grid creating condition and click on [OK] to create a grid.
Center line has to be inside low water channel region, and low water channel region have to be inside grid creating region. If this condition is not matched, a warning dialog will be shown, and you’ll have to modify conditions before creating a grid.
[Pre-processing Window] after defining grid creating region¶
[Pre-processing Window] after defining lower channel region¶
[Pre-processing Window] after defining grid center line¶
[Grid Creation] dialog¶
Regions and center lines can be edited using the menu items explained in Menu items.
[Add Vertex] (A)¶
Description: Adds a vertex to the region (or center line) that is currently selected.
When you select [Add Vertex] and move the cursor to the edge of region (or center line), the cursor changes to that shown in Figure 280. Left click on the line and drag it to add a new vertex. The vertex is placed where you release the left button.
Mouse cursor when possible to add a vertex¶
[Remove Vertex] (R)¶
Description: Deletes a vertex from the region (or center line) that is currently selected..
When you select [Remove Vertex] and move the cursor onto the vertex you want to remove, the cursor changes to that shown in Figure 281. Left clicking will remove the vertex.
Mouse cursor when possible to remove a vertex¶
[Edit coordinates] (C)¶
Description: Edits the coordinates of the vertices of the region (or center line) that is currently selected.
When you select [Edit Coordinates], the [Polygon Coordinates] dialog (Figure 282) will open. Edit the coordinates and click on [OK].
[Polygon Coordinates] dialog¶
[Reverce Center Line Direction] (E)¶
Description: Reverce the center line direction. Figure 283 shows an example. Note that the “Upstream” and “Downstream” are reversed.
Example of center line before and after reversing¶
[Reset to Default] (D)¶
Description: Discard the grid creating condition and reset to the default status.
[Create grid shape solving Poisson equation]¶
Create grids by solving poisson equation to region which is defined by [Center line], [Left bank line], and [Right bank line].
Grids generated by this algorithm consists of cells that are similar to square, so it helps solvers do stable simulations.
Figure 284 shows an example of a grid created by this algorithm.
Example of a grid created by solving Poisson equation¶
When this algorithm is selected, if a river survey data is imported, The dialog in Figure 285 is shown.
When you specify the number of Control Cross Sections and click on [OK] button, center line is defined by using the river center lines of river survey data, as shown in Figure 286.
[Specify the Number of Control Cross Sections] dialog¶
Example of center line¶
Next, please generate left bank line and right bank line. Select [Build Left bank and Right bank lines] from menu. [Build Bank Lines] dialog (Figure 287) will be shown. When you input the distance on the dialog and click on [OK], Left bank line and Right bank line are generated, and shown like in Figure 288.
[Build Bank Lines] dialog¶
Example of generated Left bank line and Right bank line¶
Center line, Left bank line, Right bank line can be imported from Shape files or CSV files.
At last, select [Create Grid] from menu. [Grid Creation] dialog (Figure 289) will be shown.
When you input the number of division, and Maximum number of iteration on the dialog, and click on [OK], the grid is generated.
An example of generated grid is shown in Figure 290.
[Grid Creation] dialog¶
Example of generated grid¶
Attention
When you specify a small [Max number of iteration] value, Poisson equation will not converge enough.
Attention
When you create grids using this algorithm for strongly curved rivers, it sometimes occurs that grid cells get inverted. When you get grids like this, please try again with different values of nI and nJ, to change rate between them.
Generally speaking, this kind of problem seldom happens when you input nI and nJ value to make dI and dJ values almost the same.
[Build Left bank and Right bank lines]¶
Description: Generate Left bank and Right bank lines.
Dialog in Figure 287 is shown, so specify the distance values and click on [OK].
Figure 288 shows an example of generated [Left Bank Line] and [Right Bank Line].
You can modify the lines by dragging the vertices.
[Add Vertex] (A)¶
Description: Add vertices to lines
When you move the mouse cursor to hover on [Center line], [Left Bank Line], or [Right Bank Line] after selecting this menu, The mouse cursor changes to the shape in Figure 291.
Left click on the line and drag it to add a new vertex. The vertex is placed wherever you release the left click button.
The mouse cursor display when adding a vertex is possible¶
[Remove Vertex] (R)¶
Description: Deletes the vertex of lines.
When this is selected and you move the cursor onto the vertex of the lines, the cursor shape will change (Figure 292). Left clicking will remove the vertex.
The mouse cursor when removing the vertex is possible¶
[Edit Center Line Coordinates] (T)¶
Description: Edits the coordinates of [Center Line].
When you select the menu , the [Center Line Coordinates] dialog (Figure 293) will open. Edit the coordinates and click on [OK].
[Center Line Coordinates] dialog¶
[Edit Left Bank Line Coordinates] (C)¶
Description: Edits the coordinates of [Left Bank Line].
The procedure is the same to [Edit Center Line Coordinates] (T).
[Edit Right Bank Line Coordinates] (H)¶
Description: Edits the coordinates of [Right Bank Line].
The procedure is the same to [Edit Center Line Coordinates] (T).
[Reset to Default] (R)¶
Description: Discards the grid creating conditions and restores the default state.
[Import Center Line] (E)¶
Description: Import [Center Line] from Shape files or CSV files.
The dialog in Figure 294 is shown, so please select the file you want to import, and click on [Open] button.
[Select file to import] dialog¶
[Import Left Bank Line] (L)¶
Description: Import [Left Bank Line] from Shape files or CSV files.
The procedure is the same to [Import Center Line] (E).
[Import Right Bank Line] (I)¶
Description: Import [Right Bank Line] from Shape files or CSV files.
The procedure is the same to [Import Center Line] (E).
[Export Center Line] (N)¶
Description: Export [Center Line] to Shape files or CSV files.
The dialog in Figure 295 is shown, so please specify the name of file you want to export, and click on [Save] button.
[Select file to export] dialog¶
[Export Left Bank Line] (F)¶
Description: Export [Left Bank Line] to Shape files or CSV files.
The procedure is the same to [Export Center Line] (N).
[Export Right Bank Line] (G)¶
Description: Export [Right Bank Line] to Shape files or CSV files.
The procedure is the same to [Export Center Line] (N).
[General purpose grid generation tool]¶
Create grids by solving convergence calculation.
Grids generated by this alogrithm consists of cells whose edge lengths changes smoothly, so it helps solvers do stable simulations.
An advantage of this tool is that there is no limitation about the number of division lines in streamwise and cross section directions. Because of this feature, user can use this algorithm to define grids with low-water channels, or for junctions of rivers.
Figure 296 to Figure 299 shows examples of grids generated with the algorithm.
Example of a grid created by general purpose grid generation tool (1)¶
Example of a grid created by general purpose grid generation tool (2)¶
Example of a grid created by general purpose grid generation tool (3)¶
Example of a grid created by general purpose grid generation tool (4)¶
When this algorithm is selected, if a river survey data is imported, The dialog in Figure 300 is shown.
When you specify the number of Control Cross Sections and click on [OK] button, center line is defined by using the river center lines of river survey data, as shown in Figure 301.
If a river survey data is not imported, user can define the center line with mouse operations.
[Specify the Number of Control Cross Sections] dialog¶
Example of center line¶
Next, please generate left bank line and right bank line. Select [Build Left bank and Right bank lines] from menu. [Build Bank Lines] dialog (Figure 302) will be shown. When you input the distance on the dialog and click on [OK], Left bank line and Right bank line are generated, and shown like in Figure 303.
[Build Bank Lines] dialog¶
Example of generated Left bank line and Right bank line¶
After you defined left bank and right bank lines, you can edit the points, or divide the region, if you need to.
When you’ve finished defining the region to generate grid, select the following:
Menu: [Grid] (G) –> [Create Grid] (C)
[Division Setting for Whole Region] dialog (Figure 304) will be shown, so imput the numbers of divisions for streamwise direction and cross section direction, and click on [OK] button, to generate grid like Figure 305.
[Grid generation] dialog¶
Example of generated grid¶
In cases you wan to generate simple grids, the workflow is simple as above, but general purpose grid generating tool allow you to control the cell edge lengths and grid node positions more precisely. Please refer to the following sections to know how to do that.
[Build Left bank and Right bank lines] (B)¶
Description: Generate Left bank and Right bank lines.
Dialog in Figure 302 is shown, so specify the distance values and click on [OK].
Figure 303 shows an example of generated [Left Bank Line] and [Right Bank Line].
You can modify the lines by dragging the vertices.
[Add Vertex] (A)¶
Description: Add vertices to lines
When you move the mouse cursor to hover on lines after selecting this menu, the mouse cursor changes to the shape in Figure 306.
Left click on the line and drag it to add a new vertex. The vertex is placed wherever you release the left click button.
The mouse cursor display when adding a vertex is possible¶
[Remove Vertex] (R)¶
Description: Deletes the vertex of lines.
When this is selected and you move the cursor onto the vertex of the lines, the cursor shape will change (Figure 307). Left clicking will remove the vertex.
The mouse cursor when removing the vertex is possible¶
[Edit Coordinates] (E)¶
Description: Edits the coordinates of the line currently selected.
When you select the menu, the [Line Coordinates] dialog (Figure 308) will open. Edit the coordinates and click on [OK].
[Line Coordinates] dialog¶
[Create Grid] (C)¶
Description: Crreate grid by inputting division setting.
[Division Setting for Whole Region] dialog (Figure 304) is shown, so input the number of divisions, and click on [OK] button. In [dI] and [dJ], the average cell width in I-direction and J-direction are displayed.
When you’ve specified division settings for lines, using [Division Setting for selected line], the dialog is not shown, and grid is generated based on the settings.
When you select [Clear division Setting], division settings on all lines are removed, and the dialog will be shown again, when selecting the menu.
[Add Division line] (D)¶
Description: Add a division line inside the region.
When in the mode to add division line, when user moves the mouse cursor to the outer edge line of the region, the mouse cursor changes to the shape in Figure 306. When user clicks the left mouse button, a new point is created on the line, and user can start defining new division line.
User can add points to define a poly line, and when user moved the mouse cursor to the edge on the other side, the mouse cursor changes to the shape in Figure 306 again. When user click the left mouse button, the definition of the new line is finished, and the region is devided.
You can divide the region with arbitrary number of lines, both in streamwise direction and cross section direction.
An example of before and after dividing a region is shown in Figure 309 and Figure 310.
Example of display before adding division line¶
Example of display after adding division line¶
[Remove Division line] (I)¶
Description: Remove the division line currently selected, to join the two regions separated by that line.
To select this menu, user have to select a division line inside the region first.
When user selec the menu, [Warning] dialog (Figure 311) is shown. When user click on [Yes] button, removing the division line is executed.
An example of before and after removing division line is shown in Figure 312 and Figure 313.
[Warning] dialog¶
Example of display before removing a division line¶
Example of display after removing a division line¶
[Division Setting for selected line] (D)¶
Description: Edit the division setting for the line currently selected.
Please select the line on which you want to edit division setting, by clicking it. The selected line is shown as a bold line.
[Division Setting] dialog (Figure 314) is shown, so edit the setting and click on [OK] button.
[Division Setting] dialog¶
Note
About [Auto] setting in [Deploy Setting]
When you select [Auto] in [Deploy Setting], the division points are deployed on the line like below:
The points are deployed on the line with [Geometric division] setting.
The [Common ratio] value is calculated by solving convergence calculation, to make the ratio between the cell widths at the region boundaries near to 1.
Using [Auto] setting, you can generate grids in which the grid cell widths changes smoothly on grid edges. But in cases you’ve specified extreme settings as division numbers, the [Common ratio] values are calculated to be big value. In such cases the grid generated are not appropriate for calculation.
In such cases, please specify the [Deploy Setting] manually, by selecting [Equally divided] or [Geometric division].
Note
About [Deploy Setting Target]
[Deploy Setting Target] is [This line only] in default, but you can select [This line and lines in parallel positions].
When you select [This line and lines in parallel positions], for example when you’ve selected a line with streamwise direction, the same setting is applied to the lines that exists on the left bank side and right bank side.
[Deploying Setting for selected area] (D)¶
Description: Edit the points deploying setting for the area currently selected.
Before selecting the menu, select the area you want to edit deploying setting, by clicking on the region. The selected area is painted gray.
[Points Deploying Setting] dialog (Figure 315) is shown, so edit the points deploying setting, and click on [OK] button.
As shown on the dialog, the points deploying setting cah be selected from the followings:
[Ratio]
[Poisson]
[Points Deploying Setting] dialog¶
Note
About [Deploying Setting]
For each setting, the points are deployed with the algorithms below:
[Ratio]: The point positions are calculated by solving convergence calculation, so that the grid cell edge lengths changes smoothly.
[Poisson]: The point positions are calculated by solving poisson equation. By moving the sliders with labels [Streamwise direction] and [Cross section direction], you can control the position of points precisely, to move the points to left bank side or right bank side, for example.
[Clear Division Setting] (C)¶
Description: Clear the division setting all lines.
[Create grid from River Survey Data] (1-D structured grid)¶
Description: Creates a grid from River Survey Data. In addition to the center point of transverse lines being set, division points are set on the transverse lines, the river centerline and left/right bank lines. Each node holds cross-sectional information. Figure 316 shows an example of a grid created by this algorithm.
Before using this algorithm, you need to import River Survey Data.
Example of a grid created from River Survey Data¶
When you select this, in River Survey Data, the nodes are made on the river center points and on the division points that have been added to the river centerline. When division points are added, the cross-sectional shape data of nodes created on the division points are automatically created from adjoining river transverse line data.
Select [Grid Creation] from the menu. The [Grid Creation] dialog (Figure 317) will open. Specify the region where the grid is to be made and click on [OK]. The grid is generated according to the division points. Manipulation of division points is done from the menu shown in Menu items.
The [Grid Creation] dialog¶
[Add Division Points] (A)¶
Description: Adds division points to the selected line.
Select the line to which you want to add division points (e.g., river centerline) by clicking on it. Figure 318 shows an example of the display after selecting a line. Then, select [Add Division Points] from the menu. The [Add Division Point] dialog (Figure 319) will open. Input the number of divisions, select the division method, and click on [OK]. Division points are added to the line (Figure 320).
Example of a selected line¶
The [Add Division Points] dialog¶
Example of the display after division points have been added¶
[Add Division Points Regionally] (R)¶
Description: Simultaneously adds division points on several river centerlines.
When this is selected, the [Add Division Point Regionally] dialog (Figure 321) will open. Set the area where division points are added to centerlines and the number of divisions, and click on [OK].
The [Add Division Points Regionally] dialog¶
[Remove Division Points] (D)¶
Description: Deletes the selected division points. Figure 322 shows an example.
Example of deleting division points¶
[Move Division Points] (M)¶
Description: Moves the selected division point. This is possible when selecting continuous division points on the same line.
When this is selected, the [Move Division Points] dialog (Figure 323) will open. Set [Transfer Quality] and click on [OK].
The [Move Division Points] dialog¶
[Reposition Division Points] (P)¶
Description: Relocates the selected division points. This is possible when selecting continuous division points on the same line.
When this is selected, the [Reposition Division Point] dialog (Figure 324) will open. Select [Reposition Method] and click on [OK].
[Reposition Division Point] dialog¶
[Create grid from polygon shape]¶
Description: Specifies the Polygonal area where the grid is to be created, and generates an unstructured grid. You can also specify a re-division area and an obstacle area within the area as grid creating condition. Figure 325 shows an example of a grid created by this algorithm.
Example of a grid created based on the shape of the Polygon¶
After selecting this algorithm, click on the canvas to specify an area for creating the grid by Polygon. To finish, press the Enter key or double click. Figure 326 shows an example of the display after specifying the grid creation area.
After setting the center line, select [Create Grid] from [Grid] in the menu.
The [Grid Creation] dialog (Figure 327) will open. Specify the area where the grid is to be made and click on [OK]. The grid is generated according to the division points.
Example of the display when an area for grid creation has been specified¶
[Grid Creation] dialog¶
[Add Refinement Region] (R)¶
Description: Adds a refinement region to the grid creation area. The maximum area of cells can be set for the refined region. It is possible to set a fine (or coarse) grid exclusively in the refinement region. The refinement region is displayed as a red polygon.
After you select [Add Refinement Region], click on the canvas to define a refinement region as polygon. Finish defining by double-clicking or by pressing Enter key. The [Refinement maximum area] dialog (Figure 328) will open. Set the maximum area of the cell and click on [OK].
Figure 329 shows an example of the refinement region, and Figure 330 shows the grid created under this setting.
From iRIC 3.0, it is now possible to define refinement Regions inside a refinement region. There is no limit about the number of recursion. Figure 331 shows an example.
[Refinement maximum area] dialog¶
iRIC window after defining refinement region¶
Example of a created grid¶
Example of defining refinement region inside refinement region¶
[Add Hole Region] (H)¶
Description: Adds a hole region to the grid creation area. The hole region is displayed as a blue polygon.
After you select [Add Hole Region], click on the canvas to define a hole region as polygon. Finish defining by double-clicking or by pressing Enter key.
Figure 332 shows an example of the hole region, and Figure 333 shows the grid created under this setting.
iRIC window after defining hole region¶
Example of a created grid¶
[Add Break Line] (B)¶
Description: Adds a break line to the grid creation area. The break line is displayed as a bold line
After you select [Add Break Line], click on the canvas to define a break line as polygonal line. Finish defining by double-clicking or by pressing Enter key.
Figure 334 shows the grid created with a break line.
With iRIC 3.0, it is now possible to define a break line that run over the grid region. Figure 335 shows an example of such a case.
Example of a created grid with a break line¶
Example of a created grid with a break line, that run over the grid region¶
[Add Vertex] (A)¶
Description: Adds vertices to the selected region or break line.
Select this and move the cursor to the Polygon line. The cursor changes to the graphic shown in Figure 336. Left click on the line and drag it to add a new vertex. The vertex is placed wherever you release the left click button.
The mouse cursor display when adding a vertex is possible¶
[Remove Vertex] (R)¶
Description: Deletes the vertex of the selected break line.
When this is selected and you move the cursor onto the vertex of the Polygon, the cursor shape will change (Figure 337). Left clicking will remove the vertex.
The mouse cursor when removing the vertex is possible¶
[Edit Coordinates] (C)¶
Description: Edits the coordinates of the selected region or break line.
When you select [Edit Coordinates], the [Polygon Coordinates] dialog (Figure 338) will open. Edit the coordinates and click on [OK].
[Polygon Coordinates] dialog¶
[Edit Maximum Area for Cells] (M)¶
Description: Edits the maximum area of the cell in the selected, refinement region.
When you select [Edit Maximum Area for Cells], the [Refinement Maximum Area] dialog (Figure 339) will open. Edit the maximum area and click on [OK].
[Refinement maximum area] dialog¶
[Redivide Break Line] (R)¶
Description: Redivide break line to control the grid cell length on the break line.
When you select [Redivide Break Line], the [Input divide number] dialog (Figure 340) will open. Edit the divide number and click on [OK].
Figure 341 shows an example of redividing a break line.
[Input divide number] dialog¶
Example of redividing break line¶
[Delete Region or Break Line] (D)¶
Description: Deletes the selected Region or Break Line.
When deleting a Polygon in an area where a grid has been created, a new grid creation area can be specified.
[Reset to Default] (R)¶
Description: Discards the grid creating conditions and restores the default state.
[Attribute Mapping]¶
Attribute Mapping function is described in this page.
In iRIC, grid can have attributes. Attributes can be defined at the following positions. Solver developer can decide the character of the grid attributes: the position and the value type.
Nodes
Cells
Grid attributes can be mapped from geographic data. If multiple geographic data exists in the geographic data folder, the data in the upper side has higher priority.
Grid attribute mapping is executed automatically after the grid is generated. Users can manually execute attribute mapping, after editing geographic data, for example.
[Execute]¶
Description: Execute grid attribute mapping.
You can execute grid attribute mapping with the following action:
Menu bar: [Grid] (G) –> [Attributes Mapping] (A) –> [Execute] (E)
“Attribute Mapping” dialog (Figure 342) is shown, so check on the grid attribute you want to execute mapping, and click on [OK] button.
[Attribute Mapping] dialog¶
[Setting] (S)¶
Description: Edit the setting about grid attribute mapping
You can edit grid attribute mapping setting with the following action:
Menu bar: [Grid] (G) –> [Attributes Mapping] (A) –> [Setting] (S)
[Grid Attribute Mapping Setting] dialog is shown, so edit setting, and click on [OK] button.
[Grid Attribute Mapping Setting] dialog¶
About mapping geographic data¶
In this section, the algorithm to map geographic data to grid attributes is described.
[Point Cloud Data]¶
[Node attribute]
[Pointset Data] is mapped using TIN, as default. When a triangle that contains the grid node is found, the weighted averaged value that is calculated from the values at triangle nodes are mapped.
[Cell attribute]
[Pointset Data] is mapped using TIN. When a triangle that contains the cell center is found, the weighted averaged value that is calculated from the values at triangle nodes are mapped.
[Cross-Section Data]¶
[Node attribute]
[Node attribute] values are mapped with the values calculated from the cross section elevation data. The calculation is executed like below:
Cross sections are linked with cubic spline lines. The cubic spline lines links the corresponding points of each cross section, like left bank, right bank, river center line, etc.
Value at grid nodes are calculated from the values defined at cross sections on the spline line, that passes the grid nodes. The value is a weighted average value calculated from the values at upstream side cross section and downstream side cross section.
[Cell attribute]
[Cross-Section Data] does not support mapping to [Cell attribute].
[Raster Data]¶
[Node attribute]
Find the pixel (quadrangle) that contains the grid node, and map the value defined at the pixel.
[Cell attribute]
Find the pixel (quadrangle) that contains the grid cell center, and map the value defined at the pixel.
[Polygons]¶
[Node attribute]
When the node is included in the polygon, the value of polygon is mapped.
[Cell attribute]
When the cell center is included in the polygon, the value of polygon is mapped.
Note
Specification changelog
Until iRIC 3.0.3, [Polygon] value was mapped to grid cells when all the nodes of the grid cell are inside the polygon.
[Lines]¶
[Node attribute]
When line crosses an edge of grid, line data is mapped to the nodes of the edge.
[Cell attribute]
When line crosses a cell, line data is mapped to the cell.
Editing the grid¶
The following is an explanation of the grid creating functions.
When the Pre-processor is active, grids can be created by using the menu in [Grid] (G). The following manipulations are possible: - [Edit] - [Delete]
[Edit] has the following three functions:
Edits the node coordinates
Edits the node attributes
Edits the cell attributes
These editing manipulations are carried out as follows:
In [Object Browser], select [Grid].
Select the node you want to edit.
Edit the coordinates or attributes of the selected node.
Regarding 1. and 3., refer to Edit the node coordinates to Edit the Cell Attributes. Regarding 2., the operation is common, so refer to Select the node.
Regarding the import and export of a grid, refer to [Grid] (G) and [Grid] (G) respectively.
Select the node¶
Description: Selects the node.
This is enabled only when one of the following items has been selected in [Object Browser].
[Grid shape] under [Grid]
Any item under [Node attributes], which is under [Grid]
Any item under [Cell attributes], which is under [Grid]
Left drag on the canvas and make a square (Figure 344). When the mouse is released to complete dragging, all the nodes in the square are selected and they become large black squares.
Example of iRIC display while dragging on the canvas is being done¶
Example of iRIC display when nodes are selected¶
Edit the node coordinates¶
Description: Edits the coordinates of the node.
This is used when you want to adjust the coordinates of the created grid or to edit the coordinates of a grid whose data are read from an external file.
Grid coordinates are edited as follows:
In [Object Browser], select [Grid] - [Grid shape] (Figure 346).
Select the node whose coordinates you want to edit. (Refer to Select the node)
Edit the coordinates of the selected node.
Example of the [Object Browser] window when [Grid shape] is selected¶
Edits the selected node (3) as follow:
Menu bar: [Grid] (G) –> [Edit] (E) –> [Grid Coordinates] (V)
When two or more nodes are selected, the [Edit grid coordinates] dialog (Figure 347) will open. When only one node is selected, the [Grid coordinates edit dialog] (Figure 348) will open.
Input the quantity of movement of the node in the [Edit Grid Coordinates] dialog (Figure 347) and the new coordinate of the node in the [Grid coordinates edit dialog] dialog (Figure 348). The [Grid Coordinates Edit] (Figure 348) dialog also displays the index of the selected node. (Index numbers start from 1.)
The [Edit grid coordinates] dialog (shown when editing two or more nodes)¶
The [Grid coordinates edit dialog]¶
The node coordinates can be edited by mouse. When the mouse cursor is on a node, the cursor shape changes to an “open hand”. Left drag the node to move it.
Edit the Node Attributes¶
Description: Edits node attributes
Node attributes are edited as follows:
In [Object Browser], select [Grid] - [Node Attributes]. Then select the node attribute you want to edit (Figure 349).
Select the node whose attributes you want to edit. (Refer to Select the node)
Edit the attributes of the selected node.
Example of the [Object Browser] display when [Node Attributes] is selected¶
Edit the node attributes in (3) as follows:
Menu bar: [Grid] (G) –> [Edit] (E) –> [Node Attributes] (N)
Then a dialog to edit the node attributes (Figure 350) will open. Set it and click on [OK]. The dialog to edit the node attributes varies depending on the attribute you want to edit.
[Topographic Aspect edit dialog]¶
Edit the Cell Attributes¶
Description: Edits the cell attributes
Cell attributes are edited in the following procedure:
Select the cell attribute you want to edit in [Object Browser] (Figure 351).
Select all nodes that are on the grid lines which enclose the cell you want edit. (Refer to Select the node)
Edit the attributes of the cell which is enclosed by the grid lines that link the selected nodes.
Example of the [Object Browser] display when [Cell Attributes] is selected¶
Edits the selected node (3) as follows:
Menu bar: [Grid] (G) –> [Edit] (E) –> [Cell Attributes] (C)
Then a dialog to edit the cell attributes (Figure 352) will open. Set it and click on [OK]. The dialog to edit the cell attributes varies depending on the attribute you want to edit.
[Topographic Aspect edit dialog]¶
Edit Boundary Conditions¶
Description: Edits the boundary conditions.
Boundary conditions are edited in the following procedure:
Select the boundary condition you want to edit in [Object Browser] (Figure 353). Select [Add (Condition Name)] in the right-clicking menu, and the [Boundary Condition] dialog will open (Figure 354).
Click [OK] in [Boundary Condition] dialog, a boundary condition will be added.
Select the boundary condition you want to edit in [Object Browser] (Figure 355).
Select the grid nodes (or grid cells) you want to set boundary condition (Refer to Select the node).
Set boundary condition to the selected grid nodes (or grid cells).
[Object Browser] when selecting Boundary Condition¶
Example of the [Boundary Condition] dialog¶
[Object Browser] when selecting a boundary condition item¶
You can set (or unset) boundary condition as follows:
Menu bar: [Grid] (G) –> [Boundary Condition] (B) –> [Assign Condition] (A) / [Release Condition] (R)
When you want to add or remove boundary condition, use sub menus under the following sub menu. The items in this submenu differ depending on the solver you use.
Menu bar: [Grid] (G) –> [Boundary Condition] (B)
Delete (D)¶
Description: Deletes the grid.
When this is selected, the [Warning] dialog (Figure 356) to ask whether you want to discard the grid data will open. Select [Yes] (Y).
The [Warning] dialog¶
Display Settings¶
Description: Sets grid diplay settings. Sub items of this menu are shown in Table 35.
Menu |
Description |
|---|---|
[Grid Shape] (S) |
Edits display settings on grid shape. |
[Node Attribute] (N) |
Edits display settings on grid node attribute. |
[Cell Attribute] (C) |
Edits display settings on grid cell attribute. |
[Set Up Scalarbar (U) |
Edits display settings on colorbar. |
[Grid Shape] (S)¶
Description: Set up display setting of grid shape.
When you select [Grid Shape], the [Grid Shape Display] dialog (Figure 357). Modify the setting and click on [OK]. Figure 358 shows an example of grid shape with Grid lines setting [Outline Only] and [All] respectively.
[Visible] checkbox in [Grid indices] group box is enabled only when [All] is selected in [Grid lines] group box.
The [Grid Shape Display] dialog¶
Example of grid shapes¶
Node Attribute (N)¶
Description: Sets up display setting of grid node attribute. This item is enabled only when a grid node attribute is selected in [Object Browser] of [Pre-processing Window].
When you select [Node Attribute], the [Grid Node Attribute Display Setting] dialog (Figure 359) will open. Modify the setting and click on [OK].
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting…] button.
Figure 360 shows examples for [Contour setting] with [Color Fringe], [Contour Figure], and [Isolines] for each.
The [Grid Node Attribute Display Setting] dialog¶
Examples of grid node attribute displays¶
Cell Attribute (C)¶
Description: Sets up display setting of grid cell attribute. This item is enabled only when a grid cell attribute is selected in [Object Browser] of [Pre-processing Window].
When you select [Cell Attribute], the [Grid Cell Attribute Display Setting] dialog (Figure 361) will open. Modify the setting and click on [OK].
The [Grid Cell Attribute Display Setting] dialog¶
Set Up Scalarbar (U)¶
Description: Sets up color bar setting. Figure 362 shows an example of color bar.
Example of scalar bar¶
When you select [Set Up Scalarbar], the [Scalarbar Setting] dialog (Figure 363) will open. When you want to show color bar, check on the [Visible] check box and select the attribute, and click on [OK].
If you click on [Edit], the [Color legend Setting] dialog (Figure 364) will open.
The [Scalarbar Setting] dialog¶
The [Color Legend Setting] dialog¶
Functions related to grid attributes¶
To use the functions explained in this page, please follow the steps below:
In [Object Browser] of Pre-processing window, select the item under [Grid] / [Node attributes] or [Grid] / [Cell attributes], like [Elevation (m)].
Launch the function from the right-clicking menu on the item.
[Generate point cloud data]¶
Description: Generate [Point Cloud Data] from the values of the selected grid attribute.
A [Point Cloud Data] is generated in the [Geographic Data] group that corresponds to the grid attributes.
When the points are generated, the coordinates of the points are as below:
[Node attributes]: The coordinates of grid nodes
[Cell attributes]: The coordinates of the center of grid cells
[Export]¶
Description: Generate [Point Cloud Data] from the values of the selected grid attributes, and save it to Topography file (*.tpo).
Refer to Elevation data file (*.tpo) for the file format of Topography file.
[Show Attribute Browser]¶
Description: Show attribute browser.
When the menu is selected, [Attribute Browser] is shown under [Object Browser].
Figure 365 shows an example of [Attribute Browser].
Example of [Attribute Browser]¶
While [Attribute Browser] is shown, you can use it with the following operations:
When mouse cursor hovers on grid, the list of attribute values at the node (or cell) under the cursor is shown in [Attribute Browser].
When the mouse left button is clicked, the target to show attributes is fixed.
When the mouse left button is clicked when the cursor is out if grid region, the target to show attributes is cleared.
[Open Bird’s-Eye View Window] (B)¶
Description: Opens a [Grid Bird’s-Eye View Window] (Figure 366).
Table 36 shows the additional menu items for [Grid Bird’s-Eye View Window]. The additional menu items are shown between [Import] and [Simulation] when the [Grid Bird’s-Eye View Window] is active.
The [Grid Bird’s-Eye View Window]¶
Menu |
Description |
|
|---|---|---|
[Draw] (D) |
[Display Setting] (D) |
Sets display setting of grid |
[Background Color] (B) |
Edits background color setting. |
|
[Z-direction Scale] (Z) |
Edits scale for Z-direction. |
[Display Setting] (D)¶
Description: Edits display setting of grid color.
When you select [Display Setting], the [Display Setting] dialog (Figure 367) will open. Edit settings and click on [OK].
The [Display Setting] dialog¶
[Background Color] (B)¶
Description: Changes the background color of the [Grid Bird’s-Eye View Window].
The function of this item is the same to that under [View] menu. Refer to [Background Color] (B).
[Z-direction Scale] (Z)¶
Description: Changes the scale factor in the Z-direction.
The function of this item is the same to that under [View] menu. Refer to [Z-direction scale] (Z).
The [Z-direction Scale] dialog (Figure 368) will open. Input new Z-direction scale value and click on [OK]. Figure 369 shows an example of before and after changing Z-direction scale.
The [Z-direction Scale] dialog¶
Example of changing Z-direction scale¶
[Import (I)]¶
Description: Imports a grid.
The function of this item is the same to [Grid] under [Import] menu under [File] menu. Refer to [Grid] (G).
[Export (E)]¶
Description: Exports a grid.
The function of this item is the same to [Grid] under [Export] menu under [File] menu. Refer to [Grid] (G).
[Measured Data] (M)¶
The functions for importing and displaying [Measured Data] are explained in the following sections. Refer to Loading measured data for the abstract of [Measured Data].
Operations related to [Measured Data] are available from [Measured Data] menu when the [Pre-processing Window] or [Post-Processing (2D)] Window is active.
Measured Data consists of the positions of measured data, and measured values (scalar values and vector values). Figure 370 shows an example of measured data shown in [Object Browser].
Refer to [Scalar] (S) for display setting of scalar values, [Arrows] (A) for vector values.
For importing [Measured Data], refer to [Measured Data] (M).
Example of imported Measured Values on [Object Browser]¶
[Scalar] (S)¶
Description: Sets the display setting of scalar values
When you select this, the [Scalar Setting] dialog (Figure 371) will open. Set the display setting of scalar values and click on [OK].
Example of [Scalar Setting] dialog¶
[Arrows] (A)¶
Description: Sets the display setting of arrows for vector values
When you select this, the [Arrow Setting] dialog (Figure 372) will open. Set the arrow display setting and click on [OK].
Example of [Arrow Setting] dialog¶
[Import] (I)¶
Description: Imports measured data from CSV file.
The function of this item is the same to [Measure Data] under [Import] menu under [File] menu. Refer to [Measured Data] (M).
[Calculation Conditions]¶
Below are the functions of items under the [Calculation Conditions] menu.
When the Pre-processor is active, calculation conditions can be set by using the menu in [Calculation Conditions] (C). The function of each menu item is explained here.
[Setting] (S)¶
Description: Sets the calculation conditions.
When you select this, the [Calculation Conditions] dialog (Figure 373) will open. Set the calculation conditions and click on [Save and Close]. To restore the default calculation conditions, click on [Reset].
The calculation conditions that require setting depends on the solver user uses.
The [Calculation Conditions] dialog¶
[Import] (I)¶
Description: Imports the calculation conditions.
The function of this item is the same to [Calculation Condition] under [Import] menu under [File] menu. Refer to [Calculation Conditions] (C).
[Export] (E)¶
Description: Exports the calculation conditions.
The function of this item is the same to [Calculation Condition] under [Export] menu under [File] menu. Refer to [Calculation Conditions] (C).
Background Image¶
Below are the functions for editing the background image.
A background image means an imported image file. An imported aerial photograph of the area to be analyzed can be used to edit the geographic data and grid information.
The following types of image files can be imported for the iRIC background image:
jpeg
png
tiff
When a geographic reference file (refer to the iRIC Related File Manual) is in the same folder as an image file, the file is automatically read and used to adjust the positions.
When there is no geographic reference file, the position of the imported background image is automatically adjusted such that it is displayed in the same area as the already imported geographic data and grid. After that, the user can manually adjust the image.
Functions related to the background image are available only when the Pre-processor is active. The function of each menu item is explained here.
[Import] (I)¶
Description: Imports the background image. A background image can be imported by either of the following operations:
Menu bar: [File] (F) –> [Import] (I) –> Background image (B)
Menu bar: [Import] (I) –> Background image (B)
Then, the [Open Image File] dialog (Figure 374) will open. Select the image data file you want to import and click on [OK].
Then, the background image is imported and the item is added to [Object Browser]. Figure 375 shows an example of the iRIC display after a background image has been imported.
[Open Image File] dialog¶
Example of the iRIC display after a background image has been imported¶
Georeference¶
Description: Adjusts the background image locations by specifying corresponding points (GCPs).
In [Object Browser], select the background image whose position you want to adjust. Select [Georeference] from right-clicking menu to open [Georeference] dialog. (Figure 376).
[Georeference] dialog¶
Click on the image in the [Georeference] dialog to add a point.
Then, click on the [Pre-processor Window] to add a corresponding point.
Repeat clicking to add as many points as you want. Figure 377 shows an example of the iRIC display after five pairs of points have been selected.
Example of the iRIC display after specifying points for georeference¶
By clicking on [Apply], you can see a preview of georeference.
When you click on [OK], the image position will be modified and dialog will be closed.
You can revert the image position by clicking on [Cancel].
Figure 378 shows an example of the iRIC display after [Apply] is clicked.
Example of the iRIC display after applying georeference¶
You can modify the position of points by mouse operation, or by editing coordinate values in the table.
You can delete selected points from right-clicking menu.
Adjusting Positions¶
Description: Adjusts the background image locations.
In [Object Browser], select the background image whose position you want to adjust. Perform the procedure explained in Table 37 on the canvas to adjust the position of the background image.
Adjusting operation |
Action |
Cursor |
|---|---|---|
Rotate |
Left drag |
|
Zoom in/out |
Drag or scroll up/down the mouse wheel |
|
Translate |
Right drag |
|
To fix the position of the background image, select 
in the
Operation Toolbar (the icon changes to 
). When the position of
the background image is at a fixed point, the adjusting operation is
disabled, even if [Background Image] is selected in [Object Browser].
Click again to make the background image movable.
By selecting [Property] from right-clicking menu, you can open [Background Image Position] dialog (Figure 379) and specify the position by editing values.
The [Background Image Position] dialog¶
Post-processor¶
Visualization functions¶
The visualization functions are explained in this section.
2D visualization functions¶
The functions for visualizing the 2D calculation results are explained.
Use [2D Post-processing Window] for 2D visualization of simulation results as explained below.
[Open New 2D Post-processing Window]¶
Either of the following actions opens a new [2D Post-processing Window].
Menu bar: [Calculation Results] (R) –> [Open New 2D Post-processing Window]
Operation Toolbar: 
The new [2D Post-processing Window] (Figure 380) will open.
[2D Post-processing Window]¶
[Object Browser]¶
Figure 381 shows an example of the [Object Browser] of [2D Post-processing Window].
The [Object Browser] of the [2D Post-processing Window]¶
Settings on the elements shown in the [Object Browser] of [2D Post-processing Window] can be edited mainly from [Draw] menu and [Measured Data] menu. For operations on [Axes] and [Distance Measures], refer to [Axes] and [Distance Measures] respectively.
[Attribute Browser]¶
You can use [Attribute Browser] to see the values of attributes defined at grid nodes.
Figure 382 shows an example of [Attribute Browser].
You can open [Attribute Browser] with the following operations:
Menu bar: [View] (V) -> [Attribute Browser] (A)
Right-clicking menu: Select [Scalar (node)] etc. in [Object Browser], and select [Show Attribute Browser] from right-clicking menu.
While [Attribute Browser] is shown, you can do the following operations using mouse:
When no point is selected, you can see the values of attributes defined at the grid node, by moving the mouse cursor. The attribute values defined at the point nearest to the mouse cursor is shown continuously. The grid node which is selected to show attributes is highlighted with a big black square.
If you left-click on grid node when values are shown in [Attribute Browser], the grid node is selected, and values at that point is shown, until you select another point or clear selection. When you left-click on another grid node, the new node is selected.
If you left-click on point which is outside or the region where calculation result is defined, selection is cleared.
Example of [Attribute Browser]¶
[Grid Shape] (G)¶
Description: Sets the grid shape settings.
When you select [Grid Shape], the [Grid Shape Setting] dialog (Figure 383) will open. Set it and click on [OK]. Figure 384 shows examples of the display when the setting is for [Wireframe] and [Grid line], respectively.
[Grid Shape] dialog¶
Examples of graphics displayed by the [Grid Shape] setting¶
[Contour (nodes)] (C)¶
Description: Sets the contour settings for calculation results defined at grid nodes.
When you select [Contour], the [Contour Setting] dialog (Figure 385) will open. Set it and click on [OK].
When you click on [Region Setting] button, [Region Setting] dialog (Figure 386 or Figure 387) will open.
When you click on [Color Bar Setting] button, [Color Legend Setting] dialog (Figure 388) will open.
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting] button.
Figure 389 shows an example of displayed contours for each [Display Setting] setting.
With iRIC 3.0, it is now possible to visualize contours for multiple calculation results at the same time. To visualize multiple contours, please check on the check boxes for multiple items in the object browser.
[Contour Setting] dialog¶
[Region Setting] dialog (Structured grid)¶
[Region Setting] dialog (Unstructured grid)¶
[Color Legend Setting] dialog¶
Examples of the contour display by the [Display Setting] setting¶
[Contour (Cell center)] (L)¶
Description: Sets the contour settings for calculation Results defined at cell centers.
When you select [Contour], the [Contour Setting] dialog (Figure 390) will open. Set it and click on [OK].
When you click on [Region Setting] button, [Region Setting] dialog (Figure 391 or Figure 392) will open.
When you click on [Color Bar Setting] button, [Color Legend Setting] dialog (Figure 393) will open.
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting] button.
Figure 394 shows an example of displayed contours for each [Display Setting] setting.
With iRIC 3.0, it is now possible to visualize contours for multiple calculation results at the same time. To visualize multiple contours, please check on the check boxes for multiple items in the object browser.
[Contour Setting] dialog¶
[Region Setting] dialog (Structured grid)¶
[Region Setting] dialog (Unstructured grid)¶
[Color Legend Setting] dialog¶
Examples of the contour display by the [Display Setting] setting¶
[Contour (edgeI)], [Contour (edgeJ)]¶
Description: Sets the contour settings for calculation Results defined at i-direction edges and j-direction edges.
From the values defined at grid edges, values at grid nodes are calculated by interpolation, and contour is drawn with values at grid nodes.
The function to edit setting of contours is the same to the contour function for grid nodes. Refer to [Contour (nodes)] (C) for detail.
[Arrow] (A)¶
Description: Sets the [Arrow] display.
When you select [Arrow], the [Arrow Setting] dialog (Figure 395 or Figure 396) will open. Set it and click on [OK]. Figure 399 shows an example of the [Arrow] display.
[Arrow Setting] dialog (structured)¶
[Arrow Setting] dialog (unstructured)¶
[Region Setting] dialog (Structured grid)¶
[Region Setting] dialog (Unstructured grid)¶
Example of the [Arrow] display¶
[Streamline] (S)¶
Description: Sets the streamline settings.
When you select [Streamline], the [Streamline Setting] dialog (Figure 400 or Figure 401) will open. Set it and click on [OK]. Figure 402 shows an example of the streamline display.
[Streamline Setting] dialog (Structured)¶
[Streamline Setting] dialog (Unstructured)¶
Example of the [Streamline] display¶
[Particles (auto)] (P)¶
Description: Sets the particle settings.
[Particles (auto)] is the function to generate particles in GUI, and simulate where where the particles will move to, using velocity in calculation result, and visualize the particles.
When you select [Particles], the [Particle Setting] dialog (Figure 403 or Figure 404) will open. Set it and click on [OK]. Figure 405 shows an example of the [Particles] display.
[Particle Setting] dialog (Structured)¶
[Particle Setting] dialog (Unstructured)¶
Example of the [Particles] display¶
[Particles] (R)¶
Description: Sets the particle settings.
[Particles] is the function to load particles output by solber, and visualize the particles.
When scalar attributes are output, user can change particle colors. When vector attributes are output, user can show arrows.
When you select [Property] menu in right-clicking menu of [Scalar] and [Vector] Folder under [Particles], the dialogs in Figure 406, Figure 407 will be shown. Please edit the setting, and click on [OK] button.
Figure 408 shows an example of the [Particles] display.
[Particle Scalar Setting] dialog¶
[Arrow Setting] dialog¶
Example of the [Particles] display¶
[Polygons] (O)¶
Description: Sets the polygon settings
You can open polygon settings dialog, when user select the folder under “Polygon” folder in the [Object Browser].
When you select [Polygons], the [Polygon Setting] dialog (Figure 409) will open. Update setting and click on [OK]. Figure 410 shows an example of the [Polygons] display.
[Polygon Setting] dialog¶
Example of the [Polygons] display¶
[Cell Attributes] (C)¶
Description: Sets the cell color and the order of display for cell attributes.
When you select [Cell Attributes], the [Cell Attributes] dialog (Figure 411) will open. Set it and click on [OK].
[Cell Attributes] dialog¶
[Label]¶
Description: Show label based on calculation result values.
Label is the function to show label string defined using calculation results at grid nodes, cells, edges, etc.
Figure 412 shows an example of label.
Refer to Label display function for detail.
Example of [Label] display¶
[Background Image]¶
Description: Shows background images.
This function is same to the function implemented on Pre-processor Window. Please refer to Background Image for detail.
[Background Image (Internet)]¶
Description: Shows background images got from Internet.
This function is same to the function implemented on Pre-processor Window. Please refer to [Background Images (Internet)] for detail.
[Title] (T)¶
Description: Sets the title settings.
When you select [Title], the [Title Setting] dialog (Figure 413) will open. Set it and click on [OK].
[Title Setting] dialog¶
[Time] (M)¶
Description: Sets the time settings.
When you select [Time], the [Time Setting] dialog (Figure 414) will open. Set it and click on [OK].
[Time Setting] dialog¶
[Measured Data] (M)¶
The functions related to [Measured Data] that are available in [2D Post-processing Window] are the same to those in [Pre-processing Window]. Refer to [Measured Data] (M).
Bird’s-Eye View 2D Visualization Functions¶
The functions for visualizing the 2D calculation results in Bird’s-eye view are explained.
Use [Bird’s Eye 2D Post-processing Window] for bird’s eye view 2D visualization of simulation result as explained below.
[Open new 2D Bird’s Eye Post-processing Window]¶
Either of the following actions opens a new [Bird’s-Eye Post-Processing Window].
Menu bar: [Calculation Results] (R) –> [Open New Bird’s Eye 2D Post-processing Window]
Operation Toolbar: 
When you select [Open new 2D Bird’s Eye Post-processing Window], the new [Bird’s-Eye 2D Post-processing Window] (Figure 415) will open.
[Bird’s Eye 2D Post-processing Window]¶
[Object Browser]¶
An example of the [Object Browser] of [Bird’s-Eye 2D Post-processing Window] is shown in Figure 416.
[Object Browser] of the [Bird’s-Eye 2D Post-processing Window]¶
Settings on the elements shown in the [Object Browser] of [Bird’s Eye 2D Post-processing Window] can be edited mainly from [Draw] menu. For operations on [Axes], refer to [Axes].
[Grid Shape] (G)¶
Description: Sets the grid shape settings.
When you select [Grid Shape], the [Grid Shape Setting] dialog (Figure 417) will open. Set it and click on [OK]. Figure 418 shows examples of the display when the setting is for [Outline] and [All] respectively.
[Grid Shape] dialog¶
Examples of graphics displayed by the [Grid Shape] setting¶
[Contours (node)] (C)¶
Description: Sets the contour settings for calculation results defined at grid nodes.
When you select [Contour], the [Contour Setting] dialog (Figure 419) will open. Set it and click on [OK].
When you click on [Region Setting] button, [Region Setting] dialog (Figure 420 or Figure 421) will open.
When you click on [Color Bar Setting] button, [Color Legend Setting] dialog (Figure 422) will open.
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting] button.
Figure 423 shows an example of displayed contours for each [Display Setting] setting.
With iRIC 4.0, it is now possible to visualize contours for multiple calculation results at the same time. For example, you can visualize bed elevation and water surface elevation at the same time.
To show multiple contours, select “Scalar (node)” and select “Add” from right-clicking menu.
[Contour Setting] dialog¶
[Region Setting] dialog (Structured grid)¶
[Region Setting] dialog (Unstructured grid)¶
[Color Legend Setting] dialog¶
Examples of the contour display by the [Display Setting] setting¶
[Contour (Cell center)] (L)¶
Description: Sets the contour settings for calculation Results defined at cell centers.
When you select [Contour], the [Contour Setting] dialog (Figure 424) will open. Set it and click on [OK].
When you click on [Region Setting] button, [Region Setting] dialog (Figure 425 or Figure 426) will open.
When you click on [Color Bar Setting] button, [Color Legend Setting] dialog (Figure 427) will open.
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting] button.
Figure 428 shows an example of displayed contours for each [Display Setting] setting.
It is possible to visualize contours for multiple calculation results at the same time. To visualize multiple contours, please check on the check boxes for multiple items in the object browser.
[Contour Setting] dialog¶
[Region Setting] dialog (Structured grid)¶
[Region Setting] dialog (Unstructured grid)¶
[Color Legend Setting] dialog¶
Examples of the contour display by the [Display Setting] setting¶
[Title] (T)¶
Description: Sets the title settings.
When you select [Title], the [Title Setting] dialog (Figure 429) will open. Set it and click on [OK].
[Title Setting] dialog¶
[Time] (M)¶
Description: Sets the time settings.
When you select [Time], the [Time Setting] dialog (Figure 430) will open. Set it and click on [OK].
[Time Setting] dialog¶
[Background Color] (B)¶
Description: Changes the background color of the [Bird’s-Eye 2D Post-processing Window].
The function of this item is the same to that under [View] menu. Refer to [Background Color] (B).
[Z-direction Scale] (Z)¶
Description: Changes the scale factor in the Z-direction.
The function of this item is the same to that under [View] menu. Refer to [Z-direction scale] (Z).
Figure 432 shows an example of before and after changing Z-direction scale.
[Z-direction Scale] dialog¶
Example of changing Z-direction scalr¶
3D visualization functions¶
Below are the functions for visualizing the 3D calculation results.
Use [3D Post-processing Window] for 3D visualization of simulation results as explained below.
[Open New 3D Post-processing Window]¶
Either of the following actions opens a new [3D Post-processing Window].
Menu bar: [Calculation Results] (R) –> [Open New 3D Post-processing Window]
Operation Toolbar: Select 
The new [3D Post-processing Window] (Figure 433) will open.
[3D Post-processing Window]¶
[Object Browser]¶
Figure 434 shows an example of the [Object Browser] of [3D Post-processing Window].
The [Object Browser] of the [3D Post-processing Window]¶
Settings on the elements shown in the [Object Browser] of [3D Post-processing Window] can be edited mainly from [Draw] menu. For operations on [Axes], refer to [Axes].
[Grid Shape] (G)¶
Description: Setup the grid shape settings.
When you select [Grid Shape], the [Grid Shape Setting] dialog (Figure 435) will open. Set it and click on [OK]. Figure 436 shows examples of the display when the setting is for [Wireframe] and [Grid line], respectively.
[Grid Shape] dialog¶
Examples of graphics displayed by the [Grid Shape] setting¶
[Contours] (C)¶
Description: Setup the contour settings.
When you select [Contour], the [Contour Group Setting] dialog (Figure 437) will open. Setup the setting, and click on [OK]. Figure 439 shows examples of the contour display for the [Counter] setting.
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting…] button.
[Contour Group Setting] dialog¶
[Color Legend Setting] dialog¶
Examples of the contour display by the [Display Setting] setting¶
[Iso Surface]¶
Description: Setup the iso-surface settings.
When you select [Iso Surface], the [Iso Surface Setting] dialog (Figure 440) will open. Set it and click on [OK]. Figure 441 shows examples of the iso surface display.
[Iso Surface Setting] dialog¶
The Isosurface example¶
[Contours (cell center)]¶
Description: Setup the contour setting for values output at cell centers.
When you select [Contours (cell center)], the [Contour Setting (cell center)] dialog (Figure 442) will open. Setup the setting, and click on [OK].
Please refer to [Color Setting] about the dialog that is shown when you select [Custom] as [Colormap] and click on [Setting…] button.
Figure 443 shows an exampl.
[Contour Setting (cell center)] dialog¶
Example of [Contours (cell center)]¶
[Arrows] (A)¶
Description: Setup the arrow (or vector) group settings.
When you select [Arrow], the [Arrow Group Setting] dialog (Figure 444) will open. Set it and click on [OK]. Figure 445 shows an example of the [Arrow] display.
[Arrow Group Setting] dialog¶
Example of the [Arrow] display¶
[Streamlines] (S)¶
Description: Setup the streamline settings.
When you select [Streamline], the [Streamline Setting] dialog (Figure 446) will open. Set it and click on [OK]. Figure 447 shows an example of the streamline display.
[Streamline Setting] dialog¶
Example of the [Streamline] display¶
[Particles (auto)] (P)¶
Description: Setup the particle settings.
[Particles (auto)] is the function to generate particles in GUI, and simulate where where the particles will move to, using velocity in calculation result, and visualize the particles.
When you select [Particles], the [Particle Setting] dialog (Figure 448) will open. Set it and click on [OK]. Figure 449 shows an example of the [Particles] display.
[Particle Setting] dialog¶
Example of the [Particles] display¶
[Particles] (R)¶
Description: Setup the particle settings.
[Particles] is the function to load particles output by solber, and visualize the particles.
When scalar attributes are output, user can change particle colors. When vector attributes are output, user can show arrows.
When you select [Property] menu in right-clicking menu of [Scalar] and [Vector] Folder under [Particles], the dialogs in Figure 450, Figure 451 will be shown. Please edit the setting, and click on [OK] button.
Figure 452 shows an example of the [Particles] display.
[Particle Scalar Setting] dialog¶
[Arrow Setting] dialog¶
Example of the [Particles] display¶
[Label]¶
Description: Show label based on calculation result values.
Label is the function to show label string defined using calculation results at grid nodes, cells, edges, etc.
Figure 453 shows an example of label.
Refer to Label display function for detail.
Example of [Label] display¶
[Title] (T)¶
Description: Setup the title settings.
When you select [Title], the [Title Setting] dialog (Figure 454) will open. Set it and click on [OK].
[Title Setting] dialog¶
[Time] (M)¶
Description: Setup the time settings.
When you select [Time], the [Time Setting] dialog (Figure 455) will open. Set it and click on [OK].
[Time Setting] dialog¶
Label display function¶
Label display function is the function to visualize calculation result values defined at grid nodes, cells, edges etc. as string on visualization windows.
You can use the function on [2D Post-processing Window] and [3D Post-processing Window].
When you select [Property] menu from right-clicking menu of [Label] dialog in Figure 456 is shown.
[Label Setting] dialog¶
You can define the label with the following steps:
Add [Calculation results for input]
Define [Definition of output]
Edit settings of position, size, fonts etc.
Please refer to next sections for detail.
Add [Calculation results for input]¶
When you click on [Add] or [Edit] button in [Calculation results for input] group box, the dialog in Figure 457 is shown, and you can add or edit calculation results for input of labels.
The details of each item on the dialog is described in Table 41.
[Edit String Result Argument] dialog¶
Item name |
Description |
|---|---|
Position |
The position where the calculation result is defined. You can select from [Global], [Node], etc. |
Result Name |
The name of calculation result. You can select from combo box. |
Variable Name |
The name to refer to this value, to use in [Definition of output]. |
I, J, K, Index |
Enabled when [Position] is not [Global]. You can use these to select the grid node (or cells etc.) |
Value for testing |
When user click on “Test” button on [Label Setting] dialog, value defined here is input to the variable. |
[Definition of output]¶
Please describe how to generate the label string, in [Definition of output]. You can describe by JavaScript language. Please refer to Examples of [Definition of output] for example.
Please use the [Variable Name] you’ve input in [Edit String Result Argument] dialog, to define label strings.
When you click on [Test] button, from the [Value for testing] for each variable, and from [Definition of output], the label string is generated, and displayed. If there are problems in the definition in [Definition of output], error meesage is shown.
In [Definition of output], you should input the definition, that return string at last.
Edit settings of position, size, fonts etc.¶
You can edit settings of position, size, fonts etc. using the widgets in [Position and Size] group box and [Font and Color] group box.
You can also edit the position and size by dragging the label on visualization windows, when [Label] is selected in the [Object Browser].
Examples of [Definition of output]¶
Basic informations and examples of [Definition of output] is described here.
Newline character¶
When you want to output multiple lines as labels, you can use “\n” as Newline character. List 7 shows an example of definition that uses Newline character, and List 8 shows the example of output.
var line1 = "This is the label at first line";
var line2 = "This is the label at second line";
return line1 + "\n" + line2;
This is the label at first line
This is the label at second line
Output numerical values specifying format¶
When you want to output numerical values specifying format, you can use the following functions.
Fixed-point notation: toFixed()
Exponential notation: toExponential()
With both functions, you can give decimal places as the argument.
List 9 and List 10 shows the example of Definition that uses toFixed() and the output. List 11 and List 12 shows the example of Definition that uses toExponential() and the output. With both examples, Discharge should be defined as variable name in [Calculation results for input].
return "Discharge: " + Discharge.toFixed(3);
Discharge: 23.321
return "Discharge: " + Discharge.toExponential(3);
Discharge: 2.332e+1
Output with control syntaxes¶
JavaScript language has control syntaxes, like if statement, for statement etc. You can use these syntaxes to define the [Definition of output].
List 13 and List 14 shows the example of Definition that uses if statement and the output.
var title = "Flood simulation";
var wl = "Normal";
if (Discharge > 2000) {
wl = "Over Limit";
}
return title + "\n" + "Discharge: " + Discharge.toFixed(3) + " (" + wl + ")";
Flood simulation
Discharge: 23.321 (Normal)
Making a graph¶
The functions for making a graph is explained in this section.
[Graph Window]¶
The functions for opening a graph window that supports both “Time” and “Position” as X-axis, and easy to switch between them, are explained in this section.
[Open new Graph Window]¶
Either of the following actions opens a new graph window.
Menu bar: [Calculation Results] (R) –> [Open New Graph Window]
Operation Toolbar: 
The [Data Source Setting] dialog (Figure 458) will open, so select the data to draw graph and click on [OK]. A new [Graph Window] window (Figure 460) will open that draws a graph for the data you selected.
When you select [Setting] on [Data Source Setting] dialog, the [Data Setting] dialog (Figure 459) is shown for the currently selected data, so modify the setting and click on [OK].
[Data Source Setting] dialog¶
[Data Setting] dialog¶
[Graph Window]¶
Note
Supporting calculation result defined at cell centers and cell edges
iRIC 3.0.11 and later supports drawing charts for calculation result defined at cell centers.
iRIC 3.0.18 and later supports drawing charts for calculation result defined at cell edges.
If calculation result defind at cell centers (or edges) exists, Combo box with label “Grid Location” is displayed, like in Figure 461, and you can draw charts for calculation result defined at cell centers or cell edges by selecting “CellCenter”, “EdgeI”, “EdgeJ”.
“Grid Location” selecting function¶
Note
Supporting drawing charts with calculation result interpolated to polylines
iRIC 3.0.14 and later supports drawing charts with calculation result interpolated to polylines.
Using this new feature, user can use chart windows to draw chart like followings:
Drawing chart for cross sections for solvers that uses unstructured grids
Drawing chart for arbitrary cross sections (not I or J lines of grids) for solvers that uses structured grids
To draw charts with calculation results interpolataed to polylines, on “Data source Setting” dialog, please select “Polyline” in “X Axis” combo box like in Figure 462, and in combo box “Polyline”, select the polyline on which you want to interpolate calculation result values and draw chart.
Please refer to Editing [Lines] for how to define polylines.
Example of setting up drawing charts for a polyline¶
[Data Source Setting] (D)¶
Description: Set data source setting.
When you select this, the [Data Source Setting] dialog (Figure 458) will open. Modify setting and click on [OK].
On the [Data Source Setting] dialog, you can import CSV files from [External] tab. Refer to Graph window external data file (*.csv) for the format of the CSV file to import.
[Axis Setting] (A)¶
Description: Set axis setting.
When you select this, the [Axis Setting] dialog (Figure 463) will open. Modify setting and click on [OK]. A new graph will be made according to the settings.
[Axis Setting] dialog¶
[Draw Setting] (D)¶
Description: Set the draw settings
When you select this, the [Draw Setting] dialog (Figure 464) will open. Modify setting and click on [OK]. A new graph will be made according to the settings.
[Display Setting] dialog¶
[Marker Setting] (M)¶
Description: Set the marker settings
When you select this, the [Marker Setting] dialog (Figure 465) will open. Modify setting and click on [OK]. A new graph will be made according to the settings. Figure 466 shows an example of a [Graph Window] after setting up a marker.
[Marker Setting] dialog¶
Example of the [Graph Window] after setting up a marker.¶
[Add KP Markers] (K)¶
Description: Add KP Markers for river survey data.
This function is available only when the following conditions are satisfied:
Graph for two-dimensional structured grid result is drawn.
X-axis is I-direction in the grid.
The grid is created using the algorithm “Create grid from river survey data”.
When you select this, the [Marker Setting] dialog (Figure 465) will open. Modify setting and click on [OK]. A new graph will be made according to the settings. Figure 467 shows an example of a [Graph Window] after setting up a marker.
Example of the [Graph Window] after adding KP markers¶
[Copy] (C)¶
Description: Copy the calculation result. The copied data is fixed when the user changes time step or the setting on the controller.
Figure 468 shows an example of a [Graph Window] after copying data.
Example of the [Graph Window] after copying data¶
[Snapshot] (S)¶
Description: Save graph snapshots to image files.
When you select this, the [Snapshot Setting] dialog (Figure 469) will open. Setup setting, and click on [OK]. Saving snapshots will be started.
[Snapshot Setting] dialog¶
[CSV Export] (E)¶
Description: Save data to CSV files.
When you select this, the [CSV Export Setting] dialog (Figure 470) will open. Setup setting, and click on [OK]. Saving CSV files will be started.
[CSV Export Setting] dialog¶
[Scattered Chart Window]¶
The functions for opening a scattered chart window are explained in this section.
[Open new Scattered Chart Window]¶
Either of the following actions opens a new graph window.
Menu bar: [Calculation Results] (R) –> [Open New Scattered Chart Window]
Operation Toolbar: 
The [Data Source Setting] dialog (Figure 471) will open, so select the data to draw graph and click on [OK]. A new [Scattered Chart Window] window (Figure 472) will open that draws a scattered chart for the data you selected.
[Data Source Setting] dialog¶
[Scattered Chart Window]¶
[Data Source Setting] (D)¶
Description: Set data source setting.
When you select this, the [Data Source Setting] dialog (Figure 471) will open. Modify setting and click on [OK].
[Axis Setting] (A)¶
Description: Set axis setting.
When you select this, the [Axis Setting] dialog (Figure 473) will open. Modify setting and click on [OK]. A new graph will be made according to the settings.
[Axis Setting] dialog¶
[Draw Setting] (D)¶
Description: Set the draw settings
When you select this, the [Draw Setting] dialog (Figure 474) will open. Modify setting and click on [OK]. A new graph will be made according to the settings.
[Draw Setting] dialog¶
[Compare with measured values]¶
Description: Show dialog to compare calculation results with measured values.
To use this function you have to import measured data first. Refer to [Measured Data] (M) for importing measured data.
Either of the following actions opens a dialog to compare calculation results with measured values.
Menu bar: [Calculation Results] (R) –> [Compare with measured values].
Operation Toolbar: 
The [Verification Setting] dialog (Figure 475) will open. Select data to be used for verification, and click on [OK]. The [Verification] dialog (Figure 476) will be shown.
[Verification Setting] dialog¶
[Verification] dialog¶
Related files¶
Cross-Section File (*.riv)¶
Overview¶
The Cross-Section Data (*.riv) contains transverse data (x and y coordinates of left/right banks) and cross-section data (distance from left bank and riverbed elevation).
Cross-Section Data should be ASCII files. Figure 477 and Figure 6‑1 show the structure and concept, respectively.
Break points of input data (for example, cross-section identification number and x-coordinate value) are identified by “space”, “tab” or “enter” characters. When break points are properly identified, iRIC automatically recognizes the data. Please note that cross-section identification number must be a real number.
Rows after the “#survey” row are recognized as cross-section data.
Each row contains data for one cross-section.
Data row: (Cross-section identification number) (x-coordinate value of the left bank) (y-coordinate value of the left bank) (x-coordinate value of the right bank) (y-coordinate value of the right bank)
Rows after the “#x-section” row are recognized as cross-section data (consisting of the “header line” and “data lines”).
Header line: (Cross-section identification number) (No. of coordinates) (Index 1) (Index 2) (Index 3) (Index 4)
Indexes 1 to 4 specify points on a cross-sectional coordinate system by sequential integer numbers. (The top is 1.) Data prior to Index 1 and after Index 4 are discarded. The point specified by Index 1 is set as the left bank and the point specified by Index 4 is set as the right bank. The points specified by Indexes 2 and 3 are to be the division points (or nodes) of the automatically created grid. The Center Point of the river is set at the point midway between Indexes 2 and 3.
You can omit Index data. In such case, all the coordinate cross-section data are read and the first point of the coordinate cross-section data is set as the left bank and the last point is set as the right bank. The Center Point of the river is set at the mid-point between the left and right banks.
When Index data are not set for every cross-section data, the index data of all cross-sections are ignored.
Data line: (Distance from left bank) (Riverbed elevation) Continue to create rows of data until there are as many rows as there are cross-sections.
Each row describes up to five sets of combinations of (Distance from left bank) and (Riverbed elevation) data.
Structure of Cross-Section Data¶
Concept of Cross-Section Data¶
Figure 478 shows the concept of the Cross-Section Data. iRIC does not display the four dots (data of Indexes 1 to 4).
The coordinates in the cross-sectional direction displayed in the [Cross-section] window have been converted as follows; note that they are different from [Distance from left bank] in the cross-section data of the Cross-Section Data.
The coordinates of the Center Point of the river have been calculated from the longitudinal data and the cross-section data.
The distance from the Center Point along the cross-sectional line has been calculated.
Note
“#x-section” line and thereafter may be omitted.
If you omit the “x-section” line and after and read only the coordinates of the left and right banks, the data will be read as cross-section data with an elevation of 0. This function is used, for example, when [Map geographic data to cross sections] is used to calculate the cross-sectional profile by interpolation from point cloud data.
CSV files for importing river center line¶
When importing Cross-Section Data, river center line can be imported from CSV files. Refer to Points CSV file (*.csv) for the file format.
Scheduled driver longitudinal/cross-section data creation guideline and cross-sectional Cross-Section Data¶
The Ministry of Land, Infrastructure, Transport and Tourism () publishes guidelines for creating the scheduled river longitudinal/cross-section data
*http://www.mlit.go.jp/river/shishin_guideline/kasen/gis/pdf_docs/juoudan/guideline0805.pdf*
Table 44 shows how to convert the Guideline data items to the River Survey Data items.
Cross-Section Data item |
How to convert the guideline data (surveyed cross-sectional numerical data) to Cross-Section Data items |
|---|---|
Coordinates of left/right banks |
Specify the coordinates of the left/right bank distance posts. |
Cross-section data |
Specify the distance of the cross-sectional coordinate data for the distance from the left bank.
Specify the elevation of the cross-sectional coordinate data.
|
Index data |
Set as follows:
Index 1: Number that corresponds to the left bank distance post
Index 2: Number that corresponds to the left bank shoreline post
Index 3: Number that corresponds to the right bank shoreline post
Index 4: Number that corresponds to the right bank distance post
|
Elevation data file (*.tpo)¶
An Elevation data file (*.tpo) is a file type for saving the x-, y- and z- coordinate values of a point.
You can use the characters below for delimiters.
Space
Tab
Comma
The columns in the files are as follows:
X coordinate
Y Coordinate
Z coordinate (Elavation etc.)
Lines with less than three values are skipped.
1123.65625 2077.0625 846.35
1125.65625 2077.0625 845.72
1127.65625 2077.0625 845.34
1129.65625 2077.0625 845.76
1131.65625 2077.0625 845.62
1133.65625 2077.0625 845.49
1135.65625 2077.0625 845.5
1113.65625 2075.0625 846.17
1115.65625 2075.0625 845.71
1117.65625 2075.0625 846.25
1119.65625 2075.0625 846.43
1121.65625 2075.0625 846.29
1123.65625 2075.0625 845.94
1125.65625 2075.0625 845.34
1127.65625 2075.0625 845.28
1129.65625 2075.0625 845.13
1131.65625 2075.0625 844.99
1133.65625 2075.0625 844.91
1135.65625 2075.0625 844.94
1137.65625 2075.0625 844.78
1139.65625 2075.0625 844.67
1141.65625 2075.0625 844.77
1143.65625 2075.0625 844.85
1145.65625 2075.0625 844.86
1147.65625 2075.0625 845.02
X Band MP RADER (XRAIN) rainfall data¶
File format to containr X Band MP Rader (XRAIN) rainfall data. Each file contains rainfall data at a certain time.
In iRIC, when XRAIN rainfall data files are stored in the same folders, all of them are imported as time dependent geographic data.
XRAIN rainfall data file is a binary file format. Please refer to the PDF file in the following URL, on page 30, if you want to know the detailed file format.
NetCDF file（*.nc）¶
NetCDF is a file format to contain multi dimension raster data file. It can be used to contain rainfall data at multiple times.
NetCDF is a binary file format.
Please refer to the following URL, to know detail about NetCDF.
iRIC grid CSV file (*.csv)¶
The iRIC grid CSV file (*.csv) is a text file that stores grid shapes and grid attributes of single-block BFC grid.
In columns with header X, Y, and Z grid node coordinates are stored. In the following columnd, grid attributes values are stored. In the header row, Grid attribute names are stored with prefix “N_” (in case of attribute defined at nodes) or “C_” (in case of attribute defined at cells).
For attributes defined at cells, value 0 is stored at rows for I = IMax and J = Jmax, as dummy data.
List 16 shows an example of iRIC grid CSV file.
IMAX,JMAX,KMAX
11,5,1
I,J,K,X,Y,Z,N_Elevation,N_Elevation_zb,C_Obstacle,C_Fix_movable,C_vege_density,C_vege_height,C_roughness_cell,C_mix_cell
0,0,0,0.00000000e+00,-1.00000000e-01,0,0.00000000e+00,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
1,0,0,3.00000000e-01,-1.00000000e-01,0,-3.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
2,0,0,6.00000000e-01,-1.00000000e-01,0,-6.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
3,0,0,9.00000000e-01,-1.00000000e-01,0,-9.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
4,0,0,1.20000000e+00,-1.00000000e-01,0,-1.20000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
5,0,0,1.50000000e+00,-1.00000000e-01,0,-1.50000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
6,0,0,1.80000000e+00,-1.00000000e-01,0,-1.80000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
7,0,0,2.10000000e+00,-1.00000000e-01,0,-2.10000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
8,0,0,2.40000000e+00,-1.00000000e-01,0,-2.40000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
9,0,0,2.70000000e+00,-1.00000000e-01,0,-2.70000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
10,0,0,3.00000000e+00,-1.00000000e-01,0,-3.00000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
0,1,0,0.00000000e+00,-5.00000000e-02,0,0.00000000e+00,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
1,1,0,3.00000000e-01,-5.00000000e-02,0,-3.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
2,1,0,6.00000000e-01,-5.00000000e-02,0,-6.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
3,1,0,9.00000000e-01,-5.00000000e-02,0,-9.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
4,1,0,1.20000000e+00,-5.00000000e-02,0,-1.20000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
5,1,0,1.50000000e+00,-5.00000000e-02,0,-1.50000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
6,1,0,1.80000000e+00,-5.00000000e-02,0,-1.80000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
7,1,0,2.10000000e+00,-5.00000000e-02,0,-2.10000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
8,1,0,2.40000000e+00,-5.00000000e-02,0,-2.40000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
9,1,0,2.70000000e+00,-5.00000000e-02,0,-2.70000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
10,1,0,3.00000000e+00,-5.00000000e-02,0,-3.00000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
0,2,0,0.00000000e+00,0.00000000e+00,0,0.00000000e+00,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
1,2,0,3.00000000e-01,0.00000000e+00,0,-3.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
2,2,0,6.00000000e-01,0.00000000e+00,0,-6.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
3,2,0,9.00000000e-01,0.00000000e+00,0,-9.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
4,2,0,1.20000000e+00,0.00000000e+00,0,-1.20000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
5,2,0,1.50000000e+00,0.00000000e+00,0,-1.50000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
6,2,0,1.80000000e+00,0.00000000e+00,0,-1.80000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
7,2,0,2.10000000e+00,0.00000000e+00,0,-2.10000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
8,2,0,2.40000000e+00,0.00000000e+00,0,-2.40000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
9,2,0,2.70000000e+00,0.00000000e+00,0,-2.70000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
10,2,0,3.00000000e+00,0.00000000e+00,0,-3.00000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
0,3,0,0.00000000e+00,5.00000000e-02,0,0.00000000e+00,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
1,3,0,3.00000000e-01,5.00000000e-02,0,-3.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
2,3,0,6.00000000e-01,5.00000000e-02,0,-6.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
3,3,0,9.00000000e-01,5.00000000e-02,0,-9.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
4,3,0,1.20000000e+00,5.00000000e-02,0,-1.20000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
5,3,0,1.50000000e+00,5.00000000e-02,0,-1.50000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
6,3,0,1.80000000e+00,5.00000000e-02,0,-1.80000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
7,3,0,2.10000000e+00,5.00000000e-02,0,-2.10000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
8,3,0,2.40000000e+00,5.00000000e-02,0,-2.40000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
9,3,0,2.70000000e+00,5.00000000e-02,0,-2.70000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
10,3,0,3.00000000e+00,5.00000000e-02,0,-3.00000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
0,4,0,0.00000000e+00,1.00000000e-01,0,0.00000000e+00,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
1,4,0,3.00000000e-01,1.00000000e-01,0,-3.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
2,4,0,6.00000000e-01,1.00000000e-01,0,-6.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
3,4,0,9.00000000e-01,1.00000000e-01,0,-9.00000000e-04,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
4,4,0,1.20000000e+00,1.00000000e-01,0,-1.20000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
5,4,0,1.50000000e+00,1.00000000e-01,0,-1.50000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
6,4,0,1.80000000e+00,1.00000000e-01,0,-1.80000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
7,4,0,2.10000000e+00,1.00000000e-01,0,-2.10000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
8,4,0,2.40000000e+00,1.00000000e-01,0,-2.40000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
9,4,0,2.70000000e+00,1.00000000e-01,0,-2.70000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
10,4,0,3.00000000e+00,1.00000000e-01,0,-3.00000000e-03,0.00000000e+00,0,0,0.00000000e+00,0.00000000e+00,0.00000000e+00,0
CGNS file (*.cgn)¶
CGNS file is a file format that iRIC uses for importing and exporting the grid and calculation conditions.
For the details of CGNS files, refer to Section 3.6 of the Solver Developer’s Manual.
World file (*.jgw, etc.)¶
World file gives coordinate data to an image to overlap an image with a grid. The following is an example of a world file. Words in parentheses ( ) are remarks and are not included in the actual file.
2.5 (a: increment of x-coordinate per pixel)
0.0 (b: rotation condition)
0.0 (c: rotation condition)
-2.5 (d: increment of y-coordinate per pixel)
-131.82 (e: x-coordinate of the pixel at top left of the image)
223.57 (f: y-coordinate of the pixel at top left of the image)
“a” expresses an increment of x-coordinate per 1 pixel movement from left to right. “d” expresses an increment of y-coordinate per 1 pixel movement from top to bottom.
Coordinates (e, f) express the coordinates of the pixel of top left image.
“b” and “c” express rotation. However, iRIC does not read “b” and “c” because it does not accommodate “rotation.”
Table 45 shows the relationship between an image file and the extension of georeferenced file.
Image file |
Georeferenced file |
|---|---|
*.jpg, *.jpeg |
*.jgw |
*.png |
*.pgw |
*.bmp |
*.bpw |
*.tif |
*.tfw |
When a world file that has the same base name with image file exists in the same directory, the world file is read for and used to adjust the alignment of the image data.
Measured data text file (*.csv)¶
Measured data text file contains the positions of measured data and the measured values (scalar values and vector values). List 18 shows an example of measured data text file.
X,Y,Elevation,VecX,VecY
100,120,5.12,3,4
100,140,7.2,1,-3.2
0,120,8.12,-2,1
0,140,9.2,4,-6.2
Measured data text file must have a header line. The header line defines the data contained in each column. The header line has to stick to the following rules:
First column must be “X” (the x-coordinate of the measured point), and the second column must be “Y” (the y-coordinate of the measured point). The following column names are arbitrary.
Columns names must consist of only alphabets and numbers.
When there are column names that end with “X” and “Y” (for example, “VecX”, “VecY”), those columns are regarded as X component and Y component of a vector value.
On the second line and the following lines, the coordinates of measured points and measured data are stored. The values have to be real numbers.
Water Elevation data file (*.csv)¶
Water Elevation data file contains the water surface elevation of river cross-sections in river survey data. List 19 shows an example of water elevation data file.
Point,Normal,H27,H29
27.00,2,7,10.5
27.50,2.2,7.2,10.7
28.00,2.3,7.3,10.8
28.50,2.4,7.4,10.9
29.00,2.45,7.45,10.95
29.50,2.48,7.48,10.98
30.00,2.5,7.5,11
Water Elevation data file is a Comma-delimited text file. Each column has the following meaning:
1st column: The name of cross-section
2nd column and the followings: Water elevation
The first line is recognized as a header line.
Note
Importing multiple water elevation data
iRIC 3.0 and later versions can import multiple water elevation data from one file.
iRIC 2.x just skipped the header line, but iRIC 3.0 and later load the names of water elevation data from the 2nd column and the followings, from the header line. For example, in case of List 19, “Normal”, “H27”, “H29” are loaded as names.
Graph window external data file (*.csv)¶
Graph window external data file contains the data to be displayed on graph windows. List 20 shows an example of graph window external data file.
X,Elevation,Depth
0,120,5.12
30,140,7.2,1
35,120,8.12
42,140,9.2,4
Graph window external data file must have a header line. The header line defines the data contained in each column. The header line has to stick to the following rules:
First column must be “X” (the x-axis values on the graph). The following column names are arbitrary.
Columns names must consist of only alphabets and numbers.
On the second line and the following lines, the X values and Y values are stored. The values have to be real numbers.
Polygons CSV file (*.csv)¶
Polygons CSV file (*.csv) is a text file to import or export [Polygons].
Table 46 shows the list of columns in CSV file, and List 21 shows an example, respectively.
The encoding of Polygons CSV file is UTF-8.
Column number |
Name |
Description |
|---|---|---|
1 |
pid |
Polygon ID. The value should be the same for the vertices in the same polygon. |
2 |
vid |
Vertex ID. For vertices in the same polygon, the values should be 1, 2, … |
3 |
x |
X coordinate |
4 |
y |
Y coordinate |
5 |
name |
Name of polygon |
6 |
value |
Value of polygon |
pid,vid,x,y,name,value
1,1,0.187,-1.072,Polygon3,3
1,2,-0.234,-1.398,Polygon3,3
1,3,-0.202,-2.113,Polygon3,3
1,4,0.471,-2.218,Polygon3,3
1,5,1.449,-2.123,Polygon3,3
1,6,2.311,-1.587,Polygon3,3
1,7,2.248,-1.366,Polygon3,3
1,8,1.838,-1.261,Polygon3,3
1,9,0.965,-1.461,Polygon3,3
1,10,0.65,-1.156,Polygon3,3
1,11,0.187,-1.072,Polygon3,3
2,1,0.503,0.641,Polygon2,2
2,2,0.334,-0.189,Polygon2,2
2,3,1.228,-0.557,Polygon2,2
2,4,2.448,-0.557,Polygon2,2
2,5,2.669,0.011,Polygon2,2
2,6,2.69,0.379,Polygon2,2
2,7,2.017,0.179,Polygon2,2
2,8,1.365,0.179,Polygon2,2
2,9,0.986,0.242,Polygon2,2
2,10,0.745,0.589,Polygon2,2
2,11,0.503,0.641,Polygon2,2
3,1,-0.765,0.707,Polygon1,1
3,2,-0.765,-0.098,Polygon1,1
3,3,-0.003,-0.591,Polygon1,1
3,4,0.034,-0.317,Polygon1,1
3,5,-0.168,0.14,Polygon1,1
3,6,-0.326,0.799,Polygon1,1
3,7,-0.424,1.042,Polygon1,1
3,8,-0.765,0.707,Polygon1,1
Lines CSV file (*.csv)¶
Lines CSV file (*.csv) is a text file to import or export [Lines].
Table 47 shows the list of columns in CSV file, and List 22 shows an example, respectively.
The encoding of Lines CSV file is UTF-8.
Column number |
Name |
Description |
|---|---|---|
1 |
lid |
Line ID. The value should be the same for the vertices in the same line. |
2 |
vid |
Vertex ID. For vertices in the same line, the values should be 1, 2, … |
3 |
x |
X coordinate |
4 |
y |
Y coordinate |
5 |
name |
Name of line |
6 |
value |
Value of line |
lid,vid,x,y,name,value
1,1,-1.93,0.117,Line4,4
1,2,-2.191,1.632,Line4,4
1,3,-2.096,3.005,Line4,4
1,4,-0.77,4.047,Line4,4
1,5,0.722,4.355,Line4,4
1,6,2.758,4.094,Line4,4
2,1,2.498,-1.422,Line3,3
2,2,3.469,-2.89,Line3,3
2,3,4.321,-4.69,Line3,3
2,4,2.285,-5.305,Line3,3
2,5,0.248,-4.642,Line3,3
2,6,-0.675,-3.766,Line3,3
2,7,-1.031,-2.985,Line3,3
3,1,-0.746,2.224,Line2,2
3,2,2.048,2.911,Line2,2
3,3,3.232,1.774,Line2,2
3,4,4.416,-0.594,Line2,2
3,5,4.534,-2.346,Line2,2
3,6,4.392,-2.866,Line2,2
4,1,-0.949,1.167,Line1,1
4,2,-0.869,-0.571,Line1,1
4,3,-0.174,-1.867,Line1,1
4,4,1.266,-3.482,Line1,1
4,5,2.569,-3.814,Line1,1
4,6,2.829,-3.979,Line1,1
Points CSV file (*.csv)¶
Lines CSV file (*.csv) is a text file to import or export [Points].
Table 48 shows the list of columns in CSV file, and List 23 shows an example, respectively.
The encoding of Points CSV file is UTF-8.
Column number |
Name |
Description |
|---|---|---|
1 |
x |
X coordinate |
2 |
y |
Y coordinate |
3 |
name |
Name of point |
x,y,name
5.086,-5.509,Point10
3.443,-5.447,Point9
1.946,-4.610,Point8
1.007,-3.722,Point7
-0.084,-2.454,Point6
1.210,-1.388,Point5
-0.871,-1.312,Point4
1.616,-0.247,Point3
-0.998,2.493,Point2
-3.104,0.083,Point1
Grayscale 16bit PNG file (*.png)¶
iRIC can import raster elevation data from grayscale 16bit PNG files.
It is expected that user use this function to import elevation data prepared for game engine Unreal Engine 4.
When you import grayscale 16bit PNG file, please prepare the files in Table 49.
File |
Description |
|---|---|
*.png |
The data that stores raster elevation data |
*.pgw |
The world file that stores the horizontal position of raster data |
*.png.meta |
The meta data file that stores the vertical offset and scale |
*.png¶
Grayscale 16bit PNG file that stores raster elevation data. Refer to the follwing URL about the detail of PNG file format.
*.pgw¶
The world file that stores the horizontal position of raster data. Refet to World file (*.jgw, etc.) about the detail of world file.
*.png.meta¶
The metadata file that contains vertical offset and scale about values stored in *.png.
In grayscale 16bit PNG files, Each pixel stores value between 0 and 65535. 0 corresponds to black, 65535 corresponds to white.
iRIC reads offset (\(o\)) and scale (\(s\)) from *.png.meta file, and calculate the elevation value \(h\) from color value \(c\) with the following equation.
*.png.meta is a YAML format text file. Offset and scale values should be specified with name “base” and “resolution”, respectively.
List 24 shows an example of *.png.meta.
base: 312.5
resolution: 0.1
RiTER3D project file (*.ertr)¶
RiTER3D project files are project files for the RiTER3D terrain editing software. iRIC can import edited terrain data as a TIN from a RiTER3D project file.
After importing a RiTER3D project file, with iRIC running when you edit the terrain in RiTER3D and overwrite the project file, iRIC will detect the change and re-import the TIN from the new project file. This allows for smooth data integration between RiTER3D and iRIC.
Tips and FAQ¶
HDF5 library DLL outputs error¶
iRIC uses HDF5 library.
When you install programs that bundles HDF5 library DLL whose version is different from that bundled with iRIC, for example Anaconda, it occurs that HDF5 library output error message like below:
Warning! ***HDF5 library version mismatched error***
In such cases, you can solve the problem, by adding (iRIC Install target)\guis\prepost to PATH environmental variable with higher priority than the folders that contains other HDF5 library.
Or, you can disable the warning, by defining environmental variable HDF5_DISABLE_VERSION_CHECK with value 1. Please note that as the warning suggests, using HDF5 library with different version can cause problems, so please fix the problem with the way above, if possible.
To Readers¶
Please indicate that using the iRIC software, if you publish a paper with the results using the iRIC software.
The datasets provided at the Web site are sample data. Please use them only for test computation.
Let us know your suggestions, comments and concerns at http://i-ric.org.