iRIC Software

Changing River Science

Nays2D
Examples

Last Update:2012.5.21
Release Date: 2012.5.25
Copyright 2011 iRIC Project All Right Reserved.
 contents

CHAPTER 1 USING NAYS2D ...................................................... 1-1

1. Nays2D basic operating procedures ..................................................................................................1-1
2. Launching Nays2D ............................................................................................................................1-2
3. About the sample data .......................................................................................................................1-5
4. Simulation conditions of Nays2D .....................................................................................................1-5

CHAPTER 2 STEADY FLOW SIMULATION: EXAMPLE OF AN

ACTUAL RIVER ....................................................... 2-1
1. Creating the calculation grids ............................................................................................................2-2
1. Importing cross-sectional river survey data .......................................................................... 2-2
2. Selecting an algorithm for creating the grid .......................................................................... 2-4
3. Setting the “division points” ................................................................................................. 2-5
4. Creating a grid .................................................................................................................... 2-10
2. Setting the calculation conditions....................................................................................................2-12
1. Setting the Manning’s roughness coefficient ...................................................................... 2-12
2. Opening [Calculation Conditions] ...................................................................................... 2-14
3. Setting the solver type ......................................................................................................... 2-14
4. Setting the boundary conditions .......................................................................................... 2-15
5. Setting the time ................................................................................................................... 2-17
6. Setting the initial water surface profile ............................................................................... 2-18
3. Making a simulation ........................................................................................................................2-19
4. Visualizing the calculation results ...................................................................................................2-21
1. Opening the 2D Post-processing Window .......................................................................... 2-21
2. Visualizing the water depth................................................................................................. 2-22
3. Visualizing the flow velocity .............................................................................................. 2-25

CHAPTER 3 EXAMPLE OF SIMULATION FOR A MEANDERING

RIVER CHANNEL .................................................... 3-1
1. Creating the calculation grid .............................................................................................................3-2
1. Creating a grid for calculation of a meandering channel ...................................................... 3-2
2. Setting the calculation conditions......................................................................................................3-8
1. Setting the Manning’s roughness coefficient ........................................................................ 3-8
2. Open [Calculation Condition] ............................................................................................. 3-10
3. Setting the solver type ......................................................................................................... 3-10
4. Setting the boundary conditions .......................................................................................... 3-11
5. Setting the time ................................................................................................................... 3-13
6. Setting the initial water surface profile ............................................................................... 3-14
7. Setting Bed material ............................................................................................................ 3-15
3. Making a simulation ........................................................................................................................3-16
4. Visualizing the calculation results ...................................................................................................3-18
1. Open the 2D Post-processing window ................................................................................ 3-18
2. Visualizing the bed deformation ......................................................................................... 3-19
3. Visualizing the flow field.................................................................................................... 3-21

1
 Chapter 1
Using Nays2D

This tutorial explains the basic operations and startup procedures of Nays2D, which is compiled
with iRIC. (Nays2D simulates two-dimensional plane river flow and riverbed deformation. It was
developed by Professor Yasuyuki Shimizu of Hokkaido University.) The following explanation is
based on the assumption that you have installed the iRIC software on your computer. If you have not
installed the iRIC software, download it from the following URL and install it on your computer.

URL: http://i-ric.org/downloads
Software: iRIC version2.0

1. Nays2D basic operating

procedures
The following are the basic procedures for operating Nays2D with iRIC:

Launching Nays2D
Prepare to use Nays2D with iRIC.

Creating calculation grids

Create a grid for calculation using river survey data and/or Digital Elevation
Model (DEM) data.

Setting calculation conditions

Set simulation discharge, boundary conditions, roughness and other items.

Making simulations
Use Nays2D to run the simulation.

Visualizing the calculation results

Visualize the simulation results, such as flow velocity, water depth and
riverbed elevation, by using a contour map and/or vector map to see whether
the simulation has successfully run.

1-1
2. Launching Nays2D
The following is the procedure for launching Nays2D on iRIC.

When launching iRIC, the [iRIC Start Page] window will open.
 Click on [New Project] in the [iRIC Start Page] window.

1-2
 The [Select Solver] window will open.
 Select [Nays2D 4.0] in the [Select Solver] window, and click on [OK].

1-3
 A window with the title bar "Untitled-iRIC[Nays2D]" will appear.

Nays2D is ready for use.

1-4
3. About the sample data
The sample data used for the sample simulations explained in this manual are available at

URL: http://i-ric.org/downloads
Examples of simulation: Nays2D

To run Nays2D according to this tutorial, data should be downloaded from the above site.

4. Simulation conditions of
Nays2D
This tutorial teaches how Nays2D is used to simulate river flow and riverbed deformation.
Because this is the objective, there are some omissions in the explanations of the physical and
calculation aspects of the simulation conditions that are to be set. Nays2D has functions (setting
conditions) additional to those explained by this tutorial. For details, please refer to Nays2D Solver
Manual.

1-5
 Chapter 2
Steady Flow Simulation:
Example of an Actual River

Objectives:
Simulate the flow regime (water depth and flow velocity) by using Nays2D for an actual
river with a certain discharge, and verify the simulation results.

Outline:
1 Creating the calculation grid
Using cross-sectional river survey data of an actual river, create calculation grids: 11 division
points in the transverse direction, and 216 division points in the longitudinal direction.

2 Setting the calculation conditions

Set simulation conditions for a steady flow discharge of 300 m3/s for 1 hour or 3,600 sec. Set
various other conditions necessary for simulation.

3 Making a simulation

4 Visualizing the calculation results

Here, we introduce a method to display a water depth contour map and a flow velocity vector
map.

2-1
1. Creating the calculation grids
1. Importing cross-sectional river survey data

 On the menu bar, select [Import] - [Geographical Data] - [Elevation].

 Open [¥SampleData_for_Examples¥Ex02], select [ori.riv], and click on [Open].

2-2
If the [Pre-processing] window shows the shape of the river that you are simulating, the data
have been successfully imported.

2-3
 2. Selecting an algorithm for creating the grid

 On the menu bar, select [Grid] - [Select algorithm to create grid].

The [Select algorithm to create grid] window will open.

 Select [Create grid from river survey data] from the list in the [Select Grid Creating
Algorithm] window, and click on [OK].
Now, you can create grids from river survey data.

2-4
 3. Setting the “division points”
① Setting "division points" in the transverse
direction

Each river "transverse line" is divided into two sections.

 Click on a transverse line.
The color and width of the selected line change. You can select any section.
 Click on [Add Division Points] from the right click menu.
The [Add Division Points] window will open.

Use the mouse wheel to

zoom.
Zoom in/out so that you can
easily click on a
transverse line.

 In the [Add Division Points] window, set [Number of Divisions] and [Division Method] as
follows, and click on [OK].

- "Division Number": 5
- "Division Method": "Divide
Equally"

2-5
 Division points are in yellow.

 Then, click on the other section of the transverse line.

The color and width of the selected line will change.
 Click on [Add Division Points] from the right click menu.
The [Add Division Points] window will open.

2-6
 On the [Add Division Points] window, set [Number of Divisions] and [Division Method] as
follows, and click on [OK].

- "Division Number": 5
- "Division Method": "Divide
Equally"

Division points are displayed as follows.

Now, you have completed setting the grid division points in the transverse direction.

The number of division

points in the transverse
direction is 11 (i.e.,10
transverse sections).

2-7
② Setting "division points" in the longitudinal
direction

 In the menu bar, select [Grid] - [Grid Creating Condition] - [Add Division Points
Regionally].

 In the [Add Division Points Regionally] window, make the following settings and click on
[OK].

- "Start Transverse Line":

22.148
- "End Transverse Line":
13.8
- "ndiv": 5

The river section is divided

by transverse lines into 5
longitudinal reaches.

2-8
Division points are displayed as follows.
Now, you have completed setting the grid division points in the longitudinal direction.

2-9
 4. Creating a grid

 On the menu bar, select [Grid] - [Create Grid].

 Click on [OK] on the [Grid Creation] window.

You do not need to change

the values of "Start
Transverse Line" and
"End Transverse Line."

The [Confirmation] window will open, asking whether you want to map geographical data to
grid attributes.
 Click on [Yes].

The elevations of
cross-sectional river
survey data are converted
into an elevation for each
grid point.

2-10
When division points and grids for calculation are displayed as follows, the creation of grids for
calculation is complete.

2-11
2. Setting the calculation
conditions
1. Setting the Manning’s roughness coefficient
 In the Object Browser, select [Geographical Data] - [Manning’s roughness coefficient].
The color of the grid shows the value of Manning’s roughness coefficient.

The user can find [Properties] by

right clicking on the one of cell
attributes ([Obstacle], [Manning’s
roughness coefficient] etc). You
can change the contour range and
color etc in the properties dialog.

 The user can select an area, which you want to set the roughness value, by the mouse.
This example selects all area of the computational grid.

2-12
 Select [Edit value] by right clicking on the grid.
The window to set [Manning’s roughness coefficient] will open.

 The user can input Manning’s roughness coefficient in below window.

This example uses 0.03 for Manning’s roughness coefficient.

The user has to set this value

over zero.

2-13
 2. Opening [Calculation Conditions]
 On the menu bar, select [Calculation Conditions] - [Setting].
The [Calculation Conditions] window will open.

3. Setting the solver type

 Click on [Solver Type] from the [Group] list to make the following settings:

- "Select solver type":

"Standard"
- "Bed deformation":
"Disabled"
-"Finite difference method of
advection terms": "CIP
method"

2-14
 4. Setting the boundary conditions
① Setting the boundary conditions

 Click on [Boundary Condition] from the [Group] list to make the following settings:

- "Periodic boundary
condition": "Disabled"
- "Water surface elevation at
downstream end":
"Uniform flow"
- "Slope gradient for uniform
flow simulation":
"Calculated from
geographical data"
- "Flow velocity distribution at
the upstream end":
"Uniform flow"
- "Slope gradient for uniform
flow simulation":
"Calculated from
geographical data"
- "Time unit of
discharge/water surface
file": "Second"

2-15
② Setting the discharge

 Select [Time unit of discharge at upstream and water level at downstream] - [Edit].
The window for setting the discharge and water level will open.
 Click on [Add] and make the following settings.
 Click on [OK] when the settings are complete.

- "Time": 0 – 3,000 sec

3
- "Discharge": 300 (m /s)

- The user need not to input

the water level in this
dialog, because this case
uses [Uniform flow] for the
boundary condition at
downstream end.

2-16
 5. Setting the time

 Click on [Time] from the [Group] list to make the following settings:

- "Output time interval (sec)":

10
- "Calculation time step
(sec)": 1
- "Start time of output (sec)":
30
- "Maximum number of
iterations of water surface
calculation": 10
- "Relaxation coefficient for
water surface calculation":
0.8

2-17
 6. Setting the initial water surface profile

 Click on [Initial Water Surface Profile] from the [Group] list to make the following settings:

- "Initial water surface

profile": "Uniform flow"

Many other conditions can be set; however, they do not need to be set for this simulation.
After making the settings above, click on [Save and Close] to close the window.

2-18
3. Making a simulation
 On the menu bar, select [Simulation] - [Run].

 Click on [OK].

 Select [Save as File].

- [Save as File (*.ipro)] : the

computational project is saved
as one file in format .ipro.
- [Save as Project] : The
computational project is saved
as project file which consist of
some files.
- The user should select [Save
as Project], if project size
becomes over 2 GB.

2-19
 The [Solver Console [Nays2D] (running)] window will open to start the simulation.

The output on the solver

console means 1. time
3
(sec), 2. discharge (m /s)
and 3. water level at
downstream end (m) from
left to right. ‘out’ denotes
that the solver is writing the
result to the project file.

Upon completion of the simulation, the [Solver Finished] window will open.
 Click on [OK].

2-20
4. Visualizing the calculation
results
1. Opening the 2D Post-processing Window

 On the menu bar, select [Calculation Results] - [Open New 2D Post-processing

Window].

The [2D Post-processing Window] will open.

2-21
 2. Visualizing the water depth

 In the Object Browser, select [Nays2D Grids] - [iRICZone] - [Scalar] - [Depth (m)].
A contour map of water depth will open.

 In the Object Browser, select [Nays2D Grids] - [iRICZone] - [Scalar]. Right click on
[Contour] to select [Property].
The [Scalar Setting] window will open.

2-22
 In the [Contour Setting] window, make the following settings and click on [OK]:

- "Contour Setting": "Color

Fringe"
- "Divisions Number ": 15

- "Value range":
-: Remove ☑ from
"Automatic."
Max: 3
Min: 0
-"Transparent."
: Remove ☑ from
"Transparent."

 In the [Region Setting] window, make the following settings and click on [OK]:

- "Region Setting Setting":

: Full Region

2-23
 In the [Color Legend Setting] window, make the following settings and click on [OK]:

- "Scalar Bar Setting":

- ☑ display
- "Orientation": Do not
change any settings.
- "Title": select "auto"
- "Number of labels": 8
- "Size (rate)":
"Width": 0.10
"Height": 0.30

- "Position (rate)":
X: 0.80
Y: 0.05

The contour map is easier to see now.

2-24
 3. Visualizing the flow velocity

 In the Object Browser, select [Nays2D Grids] - [iRICZone] - [Arrow] - [Velocity].

The generated vector map is difficult to understand.

Use the mouse to expand the map. The map will be much easier to see.

2-25
 In the Object Browser, select [Nays2DGrids] - [iRICZone] - [Arrow]. Right click on [Arrow]
to select [Property].
The [Arrow Setting] window will open.

 In the [Arrow Setting] window, make the following settings and click on [OK].

- "Length:
-: Remove ☑ from
"Automatic."
- "Standard value":5
- "Length on screen":20
- "Minimum value to draw"
: 0.005
- "Sampling":select "All
vertices"
- "Color": select
"Custom color" black

2-26
The contour map is easier to see.

2-27
 Chapter 3
Example of Simulation
for a Meandering River Channel

Objectives:
Create a meandering channel with iRIC and simulate the flow regime (water depth and flow
velocity) and bed deformation by using Nays2D for a constant discharge, and verify the
simulation results.

Outline:
1 Creating the calculation grid
Using the grid creating algorithm of iRIC, create a grid for calculation of a meandering
channel ("Wave length": 2.2 m, "Meander angle": 40 degrees, "Number of waves": 2, "Bed
slope": 0.01). Create calculation grids: 16 division points in the transverse direction, and 41
division points in the longitudinal direction.

2 Setting the calculation conditions

Set simulation conditions for steady flow with a discharge of 0.002 m3/s and a flow duration
of 0.5 hour (30 min). Set various other conditions necessary for simulation.

3 Making a simulation

4 Visualizing the calculation results

Here we show you a method of visualizing the flow field and riverbed deformation.

3-1
1. Creating the calculation grid
1. Creating a grid for calculation of a
meandering channel

 On the menu bar, select [Grid] - [Select algorithm to create grid].

The [Select algorithm to create grid] window will open.

 Select [Multifunction Grid Genarator] from the list under [Select algorithm to create grid],
and click on [OK].
The [Grid Creation] display will open.

3-2
 Click on [Channel Shape] from the [Group] list to make the following settings:

- "Select Channel Shape ":

"Sine-generated curve"
- "Cross Sectional Shape":
"Single Cross Sedtion"

 Click on [Cross Sectional Shape Parameters] from the [Group] list to make the following
settings:

- "Width(m)": 0.3
- "Number of Grid in Lareral
Direction": 15

3-3
 Click on [Channel Shape Parameters] from the [Group] list to make the following
settings:

- "Meander wave length

(m)": 2.2
- "Number of waves": 2
- "Meander angle (degrees,
zero for a straight channel)":
40.0
- "Number of grids for one
wave length in the
longitudinal direction": 20

 Click on [Bed and Channel Shape] from the [Group] list to make the following settings:

- "Initial Bed Shape"

: "Flat (no bar)"
- "Channel slope": 0.01

3-4
 Click on [Upstream and Downstream Condition] from the [Group] list to make the
following settings:

- "Add straight channel in

upstream and downstream"
: "No Add"

 Click on [Width Variation] from the [Group] list to make the following settings:

- "Width Variation"
:"Constant Width "

3-5
 Click on [Bed Condition] from the [Group] list to make the following settings:
 Click on [Create Grid].

- "Low Water Channel":

- Bed Condition: "Moveable
Bed"
- Roughness Definition:
"Not Specified"

The [Confirmation] window will open, asking whether you want to map geographical data to
grid attributes.
 Click on [Yes].

3-6
 When grids for calculation are displayed as follows, the creation of grids for calculation is
complete.

- Channel shape:
- "Wave length": 2.2 (m)
- "Number of waves": 2
- "Bed slope": 0.01
- "Channel width": 0.3 (m)

- Number of grid division

points:
- "Longitudinal direction": 41
- "Transverse direction": 16

By using the mouse to move

the grid and to zoom in and
out, the grid becomes easier
to see.

 In the Object Browser, select [Grid] - [Node attributes] - [Elevation], and make a check
mark ☑ in these boxes.
The elevation contour map will be displayed.

3-7
2. Setting the calculation
conditions
1. Setting the Manning’s roughness coefficient
 In the Object Browser, select [Geographical Data] - [Manning’s roughness coefficient].

 Select all area

3-8
 Select [Edit value] by right clicking on the grid.
The window to set [Manning’s roughness coefficient] will open.

 The user can input Manning’s roughness coefficient in below window.

The diameter of sediment is

0.3mm in this example. The
Manning’s roughness coefficient
is estimated from the sediment
diameter by using
Manning-Strickler equation.
Please refer the explanation of
this equation in the solver
manual.

3-9
 2. Open [Calculation Condition]

 On the menu bar, select [Calculation Condition] - [Setting].

The [Calculation Condition] window will open.

3. Setting the solver type

 Click on [Solver Type] from the [Group] list to make the following settings:

- "Select solver type":

"Standard"
- "Bed deformation":
"Enabled"
- "Finite difference method of
advection terms": "CIP
method"

3-10
 4. Setting the boundary conditions

 Click on [Boundary Condition] from the [Group] list to make the following settings:

- "Periodic boundary
condition": "Enabled"
- "Water surface elevation at
downstream end": "Uniform
flow"
- "Slope gradient for uniform
flow simulation": "Calculated
from geographical data"
- "Flow velocity distribution at
the upstream end": "Uniform
flow"
- "Slope gradient for uniform
flow simulation": "Calculated
from geographical data"

 Select [Time unit of discharge at upstream and water level at downstream] - [Edit].
The window for setting the discharge and water level will open.
 Click on [Add] and make the following settings.
 Click on [OK] when the settings are complete.

- "Time": 0 – 0.5hour
3
- "Discharge": 0.002 (m /s)
- The user need not to input
the water level in this dialog,
because this case uses
[Periodic boundary
condition].

3-11
 Select [Hour] from the [Time unit of discharge/water surface file] list.

By setting the unit of time

under the ,[Time unit of
discharge/wave surface
elevation file], the unit of time
that was set in the discharge
setting window is confirmed.

Set a constant discharge

3
(0.002 m /s) for the duration
between 0 hours and 0.5
hour (30 min.)

3-12
 5. Setting the time

 Click on [Time] from the [Group] list to make the following settings:

- "Output time interval (sec)":

5
- "Calculation time step
(sec)": 0.01
- "Start time of output (sec)":
10
- "Start time of bed
deformation (sec)": 10
- "Maximum number of
iterations of water surface
calculation": 10
- "Relaxation coefficient for
water surface calculation":
0.8

3-13
 6. Setting the initial water surface profile

 Click on [Initial Water Surface Profile] from the [Group] list to make the following settings:

- "Initial water surface"

profile: "Uniform flow"

3-14
 7. Setting Bed material

 Click on [Bed material] from the [Group] list to make the following settings:

- "Diameter of uniform bed

material (mm)"： 0.3mm

Many other conditions can be set; however, they do not need to be set for this simulation.
After making the settings above, click on [Save and Close] to close the window.

3-15
3. Making a simulation
 On the menu bar, select [Simulation] - [Run].

Before stating the simulation, a window will open to prompt you to save the project.

 Click on [OK].

 Select [Save as File].

- [Save as File (*.ipro)] : the

computational project is
saved as one file in
format .ipro.
- [Save as Project] : The
computational project is
saved as project file which
consist of some files.
- The user should select
[Save as Project], if project
size becomes over 2 GB.

3-16
 The [Solver Console [Nays2D] (running)] window will open to start the simulation.

 If you wish to stop the simulation, select [Simulation] - [Stop] from the menu bar.
The [Confirm Solver Termination] window will open.

 Click on [Yes].

3-17
4. Visualizing the calculation
results
1. Open the 2D Post-processing window

 On the menu bar, select [calculation results] - [Open New 2D Post-processing Window].

The "2D Post-processing Window" will open.

3-18
 2. Visualizing the bed deformation

 In the Object Browser, select [Nays2D Grids] - [iRICZone] - [Contour] - [Elevation

Change (m)] and make a check mark ☑ in these boxes.
The [Elevation Change (m)] window will display a contour map that shows elevation change
(m) from the initial bed elevation, as follows:
The elevation contour map will be displayed.

 Click on the arrow icon [<<] (to the beginning) of the time controller on the toolbar.
t = 10 (t)
 Click on the start icon of the time controller on the toolbar.
The animation will start.

3-19
 To edit the color or value of the contour, in the Object Browser, select [Nays2D Grids] -
[iRICZone] - [Contour]. Right click on [Contour] to select [Property].
The [Contour Setting] window will open.
 Make the following settings in the [Contour Setting] window .

- "Colormap Setting"
- "Value range":
Remove the check mark
from "Automatic."
Max: 0.022
Min: -0.055

-"Transparent."
: Remove ☑ from
"Transparent."

The contour map is easier to see.

3-20
 3. Visualizing the flow field

 In the Object Browser, select [Nays2D Grids] - [iRICZone] - [Arrow] - [Velocity] and make
a check mark ☑ in these boxes.
A vector map is displayed, as follows.

 To edit the length and color of an arrow, select [Nays2D Grids] - [iRICZone] - [Arrow] in
the Object Browser. Right click on [Arrow] to select [Property].
The [Arrow Setting] window will open.

 Make the following settings in the [Arrow Setting] window .

- "Length:
-: Remove ☑ from
"Automatic."
- "Standard value":0.6
- "Length on screen":20
- "Minimum value to draw"
: 0.005
- "Sampling":select "All
vertices"
- "Color": select
"Custom color" black

3-21
The vector map is easier to see.

3-22
To Reader

● 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. Therefore you
can use it for a test computation.

● Let us know your suggestions, comments and concerns at

http://i-ric.org.

iRIC Software
Nays2D Examples
Edited by Yasuyuki Shimizu (Hokkaido University, Japan) All
Kazutake Asahi (RIVER CENTER of Hokkaido, Japan) All
Taro Yamamoto (Hokkaido Gijutsu Consultant Co., Chapter2
Ltd., Japan) Chapter3,4,5,6
Takuya Inoue (Kaihatsu Koei Co.,LTD., Japan) Chapter7, 8
Michihiro Hamaki (Kaihatsu Koei Co.,LTD., Japan) Chapter9, 10
Toshiki Iwasaki (Hokkaido University, Japan)
Collaborator RIVER CENTER of HOKKAIDO