EvaTRiP Pro User’s Manual
Release 2.0.0

Public Works Research InstituteMay 11, 2023

CONTENTS

1 Introduction

1

2 Workﬂow

3

3 Functions
3.1 Common Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.2 Riﬄe and pool analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.3 Statistics Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.4 Threshold Classiﬁcation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.5 Composition tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.6 Response function Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.7 Evaluation of Terrestrial plant growth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5
5
8
10
15
16
25
28

4 Examples

33

5 License

35

Bibliography

37

iCHAPTERONEINTRODUCTION

EvaTRiP Pro is an analysis tool for calculation result of rive channgel ﬂows, that is developed to provide a useful toolthat can be used for wide variety of purposes, based on functions of EvaTRiP.
It can be used to analyse calculation results of arbitrary river channel solvers, including Nays2DH.
EvaTRiP Pro is the solver developed with Python, and the source code is available with license that allows users tomodify it.
If users want to execute advanced analysis than in EvaTRiP Pro, users can edit source code of EvaTRiP pro, to add theirown functions, and use them.
We hope that many users will use EvaTRiP Pro in their researches, educations, and businesses, and that will leads to
the river designs considering for better environments.
Please refer to License (page 35) for the detail of license.

1

CHAPTERTWOWORKFLOW

The workﬂow to use EvaTRiP pro, to analyse calculation result is as follows:
1. Run a river channel ﬂow solver, like Nays2DH, to get calculation result.
2. Create a project for EvaTRiP Pro, and setup setting for analysis, using Pre-processing window and Calculation
Condition dialog.
3. Run EvaTRiP Pro, with menu [Simulation] –> [Run].
4. Visualize analysis result using [2D Post-processing Window] and [Graph Window].
Please refer to Functions (page 5) for detail about how to use each function.

3

CHAPTER

THREE

FUNCTIONS

The list of functions of EvaTRiP Pro is shown in Table 3.1.
Table 3.1: The functions EvaTRiP Pro
Function

Description

Riﬄe and pool analysis

Analyze the area of riﬄe, pool and rapid, based on depth, velocity and Froudenumber.
Calculate statistics, like average, stddev etc for regions.
Classiﬁcate calculation result values with threshold values.
Calculate Froude number, move critical diameter etc.
General purpose analysis tool based on PHABSIM.
Tool to evaluate the region where terrestrial plants can grow.

Region statistics analysis
Threshold Classiﬁcation
Composition tool
Response function tool
Evaluation of Terrestrial plant
growth

3.1 Common Operation
3.1.1 How to use
Importing grid
When you start a project in EvaTRiP Pro, The dialog shown in Figure 3.1 will appear.
Select the CGNS ﬁle containing the calculation results to be analyzed and press theOKbutton.

The message Do you want to import a lattice from a CGNS ﬁle? Press the Yes button. The preprocessor willappear with the lattice imported, The preprocessor will appear with the lattice imported, as shown in Figure 3.2.

5

EvaTRiP Pro User’s Manual, Release 2.0.0

Figure 3.1: Select CGNS ﬁle for input dialog

Figure 3.2: [Pre-processing Window] just after importing a grid

6

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing calculation condition

Figure 3.3: [Calculation Condition] dialog [Basic Setting] page
On [Basic Setting] page of [Calculation Condition] dialog, setup setting like below:• CGNS File Name: Select the CGNS ﬁle, that contains calculation result to analyze.
• Result Setting Elevation: Select the calculation result that contains elevation values.
• Result Setting Depth: Select the calculation result that contains depth values.
• Result Setting Water Surface Elevation: Select the calculation result that contains water surface elevation
values.
• Result Setting Velocity(X): Select the calculation result that contains x component of velocity values.
3.1. Common Operation

7

EvaTRiP Pro User’s Manual, Release 2.0.0• Result Setting Velocity(Y): Select the calculation result that contains y component of velocity values.
• Functions: Check on checkbox next to the functions to use.

3.2 Riﬄe and pool analysis
Analyze the area of riﬄe, pool and rapid, based on depth, velocity and Froude number.

3.2.1 Description of functions
Riﬄe and pool analysis tool provides the two functions below:• Classify area based on value of Froude number (Entwistle et al., 2018)• Manual deﬁnition
Classify area based on value of Froude number (Entwistle et al., 2018)
Based on Froude number value calculated from depth and velocity, river channel area is classiﬁed to 5 types, including
Pool, Glide etc. Detail is shown in Table 3.2.
Table 3.2: Classes based on Froude number
Class

Range of Froude number

Pool
Glide
Run
Riﬄe
Cascade / rapid

F r < 0.04
0.04 ≦ F r < 0.15
0.15 ≦ F r < 0.245
0.245 ≦ F r < 0.49
0.49 ≦ F r

Manual deﬁnition
Classify area to pool, riﬄe, rapid using the threshold value of depth and velocity.

3.2.2 How to use

8

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing calculation condition

Figure 3.4: [Calculation Condition] dialog [Riﬄe and Pool Analysis] page
On [Riﬄe and Pool Analysis] page of [Calculation Condition] dialog, setup setting like below:

3.2. Riﬄe and pool analysis

9

EvaTRiP Pro User’s Manual, Release 2.0.0

Classify area based on value of Froude number (Entwistle et al., 2018)• Classes (HABITAT_Fr_Classes): Check on to output results.
Manual Deﬁnition• D1 [m]: Specify the threshold value of depth, refering the ﬁgure.
• V1 [m/s]: Specify the threshold value of velocity, refering the ﬁgure.
• V2 [m/s]: Specify the threshold value of velocity, refering the ﬁgure.
• Outputs: Check on to output results.
Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The list of output values are shown in below.
HABITAT_Fr_Classes
Pool = 1, Glide = 2, Run = 3, Riﬄe = 4, Cascade / rapid = 5
HABITAT_Manual
1 for Pool, 2 for Riﬄe, 3 for Rapid, 0 for others

3.3 Statistics Analysis
Calculate statistics, like average, stddev etc.

3.3.1 Description of functions
Calculate the statistics below:• Maximum• Minimum• Average• Standard deviation• Coeﬃcient of Variation
Statistics Analysis function provides the two functions below:• Calculates statistics at each grid node
• Calculates statistics for regions

10

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Calculates statistics at each grid nodeCalculates statistics at each grid node, in the time range speciﬁed.
Calculates statistics for regions
If user deﬁnes [Areas for Statistics Analysis] in Pre-processing window, statistics for each region for each time step is
output to CSV ﬁle.
If regions are not deﬁned, statistics for whole region is calculated.

3.3.2 How to use
Deﬁne areas for Statistics Analysis
User needs to execute this step only when they wants to use [Calculates statistics for regions] multiple regions.
The steps are shown below:
1. Deﬁning groups
2. Deﬁning polygons
3. Mapping groups to gridDeﬁning groups
Select [Geographic Data] / [Area for Statistics Analysis], and Select [Edit Groups…] from right-clicking menu.
Dialog in Figure 3.5 is shown, so deﬁne the groups you need.

Figure 3.5: [Group Setting] dialog

3.3. Statistics Analysis

11

EvaTRiP Pro User’s Manual, Release 2.0.0

Deﬁning polygons
Select [Geographic Data] / [Area for Statistics Analysis], and Select [Add] –> [Polygons…] from right-clicking menu.
New polygon data is added, so deﬁne polygons, and link them to the groups. When you ﬁnish deﬁning polygons bydouble-clicking, a dialog to select a group is shown.
Figure 3.6 shows an example of [Pre-processing Window] after deﬁning polygons.

Figure 3.6: Example of deﬁned polygons

Mapping groups to grid
Select [Grid] –> [Attribute Mapping] –> [Execute] from menu. [Attribute Mapping] dialog is shown, so check on [Areafor Statistics Analysis] and click on [OK] button.
Note: When a grid node is included in multiple polygons, the group linked to the polygon on the top is mapped to thenode.
Please note that it is not possible to map multiple groups to a grid node.

Note: Please note that you need to execute this step, even when you do not deﬁne groups, and calculates statistics forwhole region.

12

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing Calculation Condition

Figure 3.7: [Calculation Condition] dialog [Statistics Analysis] page
On [Statistics Analysis] page of [Calculation Condition] dialog, setup setting like below:

3.3. Statistics Analysis

13

EvaTRiP Pro User’s Manual, Release 2.0.0

Common• Target Result: Select the calculation result of which to calculate statistics.
• Values to output: Check on checkboxes that you want to output.
Statistics for each grid node
• Target Time Range: Specify the time range to calculate statistics.
Statics for each area
• Dry Area Processing: Specify setting about if the tool should use values at area with depth smaller than threshold,to calculate statistics.
• Output: Check on checkbox to output values.
• CSV ﬁle name: Specify the CSV ﬁle name to output.
Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The statistics for each grid node is output at the last time step.
The list of output values are shown below.
STAT_Max
Maximum
STAT_Min
Minimum
STAT_Avg
Average
STAT_Stddev
Standard deviation
STAT_CV
Coeﬃcient of variation
Checking the CSV ﬁle output
Statistics for each area is output to CSV ﬁle.
The list of output values to CSV ﬁle are shown below.
Count
The number of nodes included in the area
Max
Maximum
Min
Minimum

14

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Avg
Average
StddevStandard deviationCV
Coeﬃcient of variation

3.4 Threshold Classiﬁcation
Classiﬁcate calculation result values with threshold values.

3.4.1 How to use
Editing Calculation Condition

Figure 3.8: [Calculation Condition] dialog [Threshold Classiﬁcation] page
On [Threshold Classiﬁcation] page of [Calculation Condition] dialog, setup setting like below:• Target Result: Select the calculation result to classify.
• Class deﬁnitions: Deﬁne the classiﬁcation. Refer to Figure 3.9 for example.
• Threshold value handling: Select from if threshold value is included to left range or right range. if "<" isselected, threshold value is included to left range.
• Result (CLASS_result): Check on the check box to output the analysis result.

3.4. Threshold Classiﬁcation

15

EvaTRiP Pro User’s Manual, Release 2.0.0

Figure 3.9: Example of classiﬁcation deﬁnition

Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The list of output values are shown below.
CLASS_result
Classiﬁcation result

3.5 Composition toolCalculate Froude number, move critical diameter etc.

3.5.1 Description of functions
Composition tool provides the following ﬁve functions:• Froude number calculation• Move critical diameter calculation• Fluid force calculation• Manual formula calculation

16

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Froude number calculation
Calculates Froude number from depth h, velocity v. Froud number is calculated with the formula below. g is thegravitational acceleration.
v
Fr = √
gh
Move critical diameter calculation
Calculates move critical diameter values with the following steps:
1. Calculates water level gradient I from water surface elevation. Calculate water level gradient for both I-direction
and J-direction, and then use the maximum value of them as I for each grid node.
Level gradient in I direction Ii is calculated with formula below. x, y are coordinates of grid.
• i=1
I1 = √

w(2,j) − w(1,j)(x(2,j) − x(1,j) )2 + (y(2,j) − y(1,j) )2• i = imax
Imax = √• else
1
Ii =
2

(
√

w(imax ,j) − w(imax −1,j)(x(imax ,j) − x(imax −1,j) )2 + (y(imax ,j) − y(imax −1,j) )2

w(i+1,j) − w(i,j)

w(i,j) − w(i−1,j)(x(i+1,j) − x(i,j) )2 + (y(i+1,j) − y(i,j) )2)+√(x(i,j) − x(i−1,j) )2 + (y(i,j) − y(i−1,j) )2

Similar formulas are used to calculate level gradient in J direction.
2. Calculates friction speed u∗ from depth h and water level gradient I. g is the gravitational acceleration.
√u∗ = ghI
3. Calculates move critical diameter using Iwagaki s formula [Iwagaki], from u∗ . The formulas are shown in Table
3.3. Please note that the unit of u∗ is centimeter per second, and the unit of move critical diameter is centimeter. The
unit of critical diameter values output is milimeter.
Table 3.3: Formulas to calculate move critical diameter
Condition

Formula24.5127 ≦ u2∗
6.49 ≦ u2∗ < 24.5127
3.1075 ≦ u2∗ < 6.49
1.469 ≦ u2∗ < 3.1075
u2∗ < 1.469

dmax = u2∗ /80.9
dmax = (u2∗ /134.6)22/31
dmax = u2∗ /55.0
dmax = (u2∗ /8.41)32/11
dmax = u2∗ /226.0

Note: Because water level gradient is needed, this function can be used for calculation results of solvers that uses
structured grids.

3.5. Composition tool17

EvaTRiP Pro User’s Manual, Release 2.0.0

Fluid force calculation
Calculates Fluid force F from depth h and velocity v, with the formula below:
F = hv 2
Manual formula calculation
Calculates value with formula manually deﬁned.
You can describe formulas with Python notations. Refer to [Manual Deﬁnition] (page 20) for examples.
You can use the variables in Table 3.4 for Manual deﬁnition.
Table 3.4: The list of variables available in manual deﬁnition
Value

Variable nameElevation
Depth
Water surface elevation
Velocity (X)Velocity (Y)Velocity (magnitude)
Arbitrary Variable 1
Arbitrary Variable 2

elevation
depth
wse
vx
vy
v
val1
val2

3.5.2 How to use

18

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing calculation condition

Figure 3.10: [Calculation Condition] dialog [Composition Tool] page
[Composition Tool] page of [Calculation Condition] dialog, setup setting like below:• Arbitrary Variable 1, 2: Select the variable to use in [Manual Deﬁnition].
• Manual Deﬁnition: Deﬁne the manually deﬁned formula• Outputs: Check on values to output.

3.5. Composition tool

19

EvaTRiP Pro User’s Manual, Release 2.0.0

Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The list of output values are shown in below.
COMP_Froude
Froud number
COMP_CriticalDiameter
Move critical diameter
COMP_FluidForce
Fluid ForceCOMP_Manual
Calculation result of manually deﬁned formula3.5.3 [Manual Deﬁnition]
Users can deﬁne formula with Python notations.
Please refer to the hints below:• Variables like depth, wse are loaded as numpy.ndarray.
• Please use four spaces for indenting.
• numpy is already imported as np.
• You can use arbitrary modules, using import statement.
• You can use print() to output calculation result to [Solver Console Window].
• You can use only ASCII characters.
In [Manual Deﬁnition], deﬁne a function with name, f, that has arguments shown in Table 3.4.
Predeﬁned examples
EvaTRiP Pro bundles several predeﬁned examples.
You can import the predeﬁned examples, using the combo box with message(Select template to import) .

Default
The deﬁnition of template

Default

is shown in List 3.1.
List 3.1: Predeﬁned example

1
2

Default

def f(elevation, depth, wse, vx, vy, val1, val2, v):
return depth
The function of template

Default

returns depth simply.

Please use the template in case you want to deﬁne your own function from scratch, by edit the part "return depth".

20

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Riﬄe and Pool (custom thresholds)
The deﬁnition of templateRiﬄe and Pool (custom thresholds)

List 3.2: Predeﬁned example
1

is shown in List 3.2.

Riﬄe and Pool (custom thresholds)

import numpy as np

2
3
4
5
6

THRESHOLD_RIFFLE_DEPTH1 = 0.5
THRESHOLD_RIFFLE_DEPTH2 = 0.8
THRESHOLD_POOL_V1 = 0.5
THRESHOLD_POOL_V2 = 0.9

7
8
9
10

def f(elevation, depth, wse, vx, vy, val1, val2, v):"""Calculate riffle and pool from depth, v (velocity)"""

11
12
13
14
15
16
17
18
19

ret = np.zeros(depth.shape, dtype=np.uint8)# THRESHOLD_RIFFLE_DEPTH1 <= depth < THRESHOLD_RIFFLE_DEPTH2 and# v <= THRESHOLD_POOL_V1# -> ret = 1
ret = np.where((depth >= THRESHOLD_RIFFLE_DEPTH1) &(depth < THRESHOLD_RIFFLE_DEPTH2) &(v <= THRESHOLD_POOL_V1), 1, ret)

20
21
22
23
24
25
26

# THRESHOLD_RIFFLE_DEPTH2 <= depth and# v <= THRESHOLD_POOL_V1# -> ret = 2
ret = np.where((depth >= THRESHOLD_RIFFLE_DEPTH2) &(v <= THRESHOLD_POOL_V1), 2, ret)

27
28
29
30
31
32
33
34

# depth <= THRESHOLD_RIFFLE_DEPTH1 and# THRESHOLD_POOL_V1 <= v < THRESHOLD_POOL_V2# -> ret = 3
ret = np.where((depth <= THRESHOLD_RIFFLE_DEPTH1) &(v >= THRESHOLD_POOL_V1) &(v < THRESHOLD_POOL_V2), 3, ret)

35
36
37
38
39
40
41

# depth <= THRESHOLD_RIFFLE_DEPTH1 and# THRESHOLD_POOL_V2 <= v
# -> ret = 4
ret = np.where((depth <= THRESHOLD_RIFFLE_DEPTH1) &(v >= THRESHOLD_POOL_V2), 4, ret)42
43

return ret
This example is the extended version of
deﬁnition (page 8).

Manual Deﬁnitionof Riﬄe and Pool analysis that is introduced in Manual

The output value is as follows:
3.5. Composition tool21

EvaTRiP Pro User’s Manual, Release 2.0.0• Depth is greater than THRESHOLD_RIFFLE_DEPTH1 and less than THRESHOLD_RIFFLE_DEPTH2 andvelocity is less than THRESHOLD_POOL_V1 –> 1
• Depth is greater than THRESHOLD_RIFFLE_DEPTH2 and velocity is less than THRESHOLD_POOL_V1 –>2• Depth is less than THRESHOLD_RIFFLE_DEPTH1 and ﬂow velocity is greater than THRESHOLD_POOL_V1
and less than THRESHOLD_POOL_V2 –> 3
• Depth is less than THRESHOLD_RIFFLE_DEPTH1 and ﬂow velocity is greater than THRESHOLD_POOL_V2–> 4• Other -> 0
A diagram representing the relationship between threshold values and values is shown in Figure 3.11.

Figure 3.11: Riﬄe and Pool (custom thresholds) diagram
If you want to perform a complex riﬄe and pool analysis, please use this template and change the threshold values orincrease the number of conditions.
Riﬄe and Pool (Hauer et al. 2009)
Riﬄe and Pool (Hauer et al. 2009) is based on the paper [Hauer]. The deﬁnition of template
et al. 2009) is shown in List 3.3.
List 3.3: Predeﬁned example
1

Riﬄe and Pool (Hauer

Riﬄe and Pool (Hauer et al. 2009)

import numpy as np

2
3
4
5
6
7
8

def decisionNCv(vv):ret = np.zeros(vv.shape, dtype=np.uint8)
ret = np.where(vv <= 0.1, 1, ret)
ret = np.where((vv <= 0.25) & (ret == 0), 2, ret)
ret = np.where((vv <= 0.40) & (ret == 0), 3, ret)(continues on next page)

22

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0(continued from previous page)91011

ret = np.where((vv <= 0.75) & (ret == 0), 4, ret)
ret = np.where((ret == 0), 5, ret)
return ret

12
13
14
15
16
17
18
19
20
21

def decisionNCd(dd):ret = np.zeros(dd.shape, dtype=np.uint8)
ret = np.where((dd >= 0.01) & (dd <= 0.4), 5, ret)
ret = np.where((dd <= 0.8) & (ret == 0), 4, ret)
ret = np.where((dd <= 1.2) & (ret == 0), 3, ret)
ret = np.where((dd <= 1.5) & (ret == 0), 2, ret)
ret = np.where(ret == 0, 1, ret)
return ret

22
23
24
25
26
27
28
29

def decisionNCval1(tt):ret = np.zeros(tt.shape, dtype=np.uint8)
ret[:] = 2 # default value
ret = np.where(tt <= 2.0, 0, ret)
ret = np.where(tt <= 20, 1, ret)
return ret

30
31
32
33
34
35
36

37
38
39
40

def decisionHC(mmh, dd):
habitat = np.zeros(mmh.shape)
habitat[:] = 2 # backwater
habitat = np.where(mmh == 20, 6, habitat) # riffle
habitat = np.where((mmh >= 10) & (mmh <= 18) & (habitat == 2), 5, habitat) # fast␣,→runhabitat = np.where((mmh >= 5) & (mmh <= 9) & (habitat == 2), 4, habitat) # runhabitat = np.where((mmh >= 2) & (mmh <= 4) & (habitat == 2), 3, habitat) # pool
habitat = np.where((dd <= 0.01) & (habitat == 2), 0, habitat) # drywater
habitat = np.where((dd <= 0.8) & (habitat == 2), 1, habitat) # shallow

41
42

return habitat

43
44
45
46

def f(elevation, depth, wse, vx, vy, val1, val2, v):"""Calculate riffle and pool from depth, v (velocity), val1"""

47
48
49
50

ncv = decisionNCv(v)ncd = decisionNCd(depth)
ncval1 = decisionNCval1(val1)

51
52
53

mh = (ncd + ncv) * ncval1
mh = np.where(depth <= 0.01, 0, mh)54
55

return decisionHC(mh, depth)
The process details are shown below.
1. Calculates N Cv based on the ﬂow velocity v with the following conditions:3.5. Composition tool23

EvaTRiP Pro User’s Manual, Release 2.0.0• v ≤ 0.1 –> 1
• 0.1 < v ≤ 0.25 –> 2
• 0.25 < v ≤ 0.4 –> 3
• 0.4 < v ≤ 0.75 –> 4
• 0.75 < v –> 5
2. Calculates N Cd based on the water depth d with the following conditions:• d ≤ 0.01 –> 1
• 0.01 ≤ d ≤ 0.4 –> 5
• 0.4 < d ≤ 0.8 –> 4
• 0.8 < d ≤ 1.2 –> 3
• 1.2 < d ≤ 1.5 –> 2
• 1.5 < d –> 1
3. Calculates N Cval1 based on arbitrary variable1 val1 with the following conditions:• val1 ≤ 2.0 –> 0
• 2.0 < val1 ≤ 20 –> 1
• 20 < val1 –> 2
4. Calculates mh = (N Cd + N Cv) × N Cval1.
5. If d ≤ 0.01, overwrite mh to 0.
6. Based on the mh obtained above, the decision is made as follows:• mh = 20 –> riﬄe
• 10 ≤ mh ≤ 18 –> fast run• 5 ≤ mh ≤ 9 –> run• 2 ≤ mh ≤ 4 –> pool
• None of the above conditions apply, and d ≤ 0.01 –> drywater• None of the above conditions apply, and 0.01 < d ≤ 0.8 –> shallow• None of the above conditions apply –> backwater
Note: val1 should be ShearStress by default.

Adding template of Manual Deﬁnition
You can register the function you ve created to EvaTRiP, so that you can import the template using the combo box
with message (Import template to import) .
The steps are as follows:
1. Save ﬁle that contains the function you created, in the folder that stores the source code of EvaTRiP Pro. We
recommend that you name the ﬁle manual_xxxxxxx.py or something similar.

24

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

2. Modify deﬁnition.xml and add a <Source> entry the the the item named comp_manual . An example is shownin List 3.4, where line 6 is the line added, that make it possible to load the contents of manual_myfunction.py
by selecting the My function entry.
List 3.4: Example of deﬁnition.xml (excerpt)
1
2
3
4

5
6
7
8
9
10
11
12

<Item name="comp_manual"><Definition valueType="string" multiline="true"><Source caption="Default" filename="manual_default.py" default="true"/><Source caption="Riffle and Pool (custom thresholds)" filename="manual_rp_custom.py"␣
,→/><Source caption="Riffle and Pool (Hauer et al. 2009)" filename="manual_rp_hauer.py"/><Source caption="My function" filename="manual_myfunction.py"/><Condition type="and"><Condition type="isEqual" target="comp_output_manual" value="1" /><Condition type="isEqual" target="f_composition" value="1" /></Condition></Definition></Item>

3.6 Response function Tool
General purpose analysis tool based on PHABSIM.

3.6.1 How to use

3.6. Response function Tool

25

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing Calculation Condition

Figure 3.12: [Calculation Condition] dialog [Response function Tool] page
On [Response function Tool] page of [Calculation Condition] dialog, setup setting like below:• Function 1 Output (RESP_F1) etc.: Check on the check box to output.
• Function 1 Target Result etc.: Select the calculation result to input to the function.
• Function 1 Response Function etc.: Deﬁne the fujnction. Refer to Figure 3.13 for example.
• Sum (RESP_Sum): Check on check box to output the sum of functions.
• Arighmetic mean (RESP_A_Mean): Check on check box to output the arighmetic mean of functions.
• Geometric mean (RESP_G_Mean): Check on check box to output the geometric mean of functions.

26

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0

Figure 3.13: Example of function deﬁnition

Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The list of output values are shown in below.
RESP_F1
Function 1
RESP_F2
Function 2
RESP_F3
Function 3
RESP_SumSum
RESP_A_Mean
Arighmetic mean
RESP_G_Mean
Geometric mean

3.6. Response function Tool

27

EvaTRiP Pro User’s Manual, Release 2.0.0

3.7 Evaluation of Terrestrial plant growth
The water depth h(m) and depth-averaged velocity V(m/s) obtained from the ﬂow calculations are used to evaluate theconditions for terrestrial plant growth.

3.7.1 Description of functions
Three kinds of methods to evaluate terrestrial plant growth are implemented in this tool.
Using the duration averaged depth
In this method, the duration averaged depth: (h) is used to evaluate the region where the terrestrial plants grow or not,with the formula in Table 3.5.
Table 3.5: Evaluation formula by depth
Condition

Evaluationh < 0.2
0.2 < h ≤ 0.3
0.3 < h ≤ 0.4
0.4 < hProbability of terrestrial plant growth is very highProbability of terrestrial plant growth is highProbability of terrestrial plant growth is low
Probability of terrestrial plant growth is very low

Using the relationship between depth and velocity
A relationship formula between depth and velocity as follow is used to evaluate terrestrial plant growth in this tool.
hV D_est is the threshold depth whether terrestrial plants can grow or not. Terrestrial plant growth can be evaluatedcomparing hV D_est (m) and h (m), as shown in Table 3.6
hV D_est = −0.1 log V + 0.05

(3.1)

Table 3.6: Evaluation formula by relationship between depth and velocity
Condition

Evaluationh < hV D_est
h > hV D_est

Terrestrial plants cannot grow
Terrestrial plants can grow

Using the Wash-Out Index (WOI)
WOI (Wash-Out Index) is used to evaluate terrestrial plant growth in this tool. WOI is deﬁned by (3.2).
W OI =

τ∗c90
τ∗90

(3.2)

Where τ∗90 and τ∗c90 are non-dimensional shear stress and non-dimensional critical shear stress for d90 respectively,that are deﬁned by equations below.
tau_{*90} and τ∗c90 are deﬁned by Eqs (3.3) and (3.4) respectively.
τ∗90 =
28

hIe
sd90

(3.3)
Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0
[
]2
τ∗c90
log10 19=τ∗c50
log10 19(d90 /d50 )(3.4)

Where d50 and d90 are the grain diameters (unit: meter) at which 50% and 90% volume passes through the sieve
respectively, s is the speciﬁc gravity of river bed material (=1.65), h is the water depth (m), Ie is the energy gradient,dc∗50 is the non-dimensional critical shear stress of d50 (=0.06).
Table 3.7: Evaluation formyla by WOI (Wash-Out Index)
Condition

Evaluation

W OI < 1
W OI ≥ 1

Terrestrial plants can grow
Terrestrial plants cannot grow

3.7.2 How to use
Setting grid attributes
Setup grid attributes as follows:• d50 (m): d50 used in (3.4)• d90 (m): d90 used in (3.4)

3.7. Evaluation of Terrestrial plant growth29

EvaTRiP Pro User’s Manual, Release 2.0.0

Editing calculation condition

Figure 3.14: [Calculation Condition] dialog [Plants Growth Evaluation] pageIn thePlants Growth Evaluation

page of the [Calculation Conditions] dialog, setup the setting like below:• DLimit 1 (DL1): Specify the threshold depth: H1 to evaluate the region of terrestrial plant growth.
• DLimit 2 (DL2): Specify the threshold depth: H2 to evaluate the region of terrestrial plant growth.
• DLimit 3 (DL3): Specify the threshold depth: H3 to evaluate the region of terrestrial plant growth.
• Estimated Depth: Coeﬃcient for Eq. (3.1)• Time Average Time Start[s]: Specify the starting time for calculating the average depth, average velocity, maximum depth, and maximum velocity, that is used in the evaluation of terrestrial plant grow. When the value is -1,
it means the ﬁrst time step.
30

Chapter 3. Functions

EvaTRiP Pro User’s Manual, Release 2.0.0• Time Average Time End[s]: Specify the ending time for calculating the average depth, average velocity, maximum depth, and maximum velocity, that is used in the evaluation of terrestrial plant grow. When the value is -1,
it means the last time step.
Visualization of analysis result
Visualize the analysis result that EvaTRiP pro outputs.
The list of output values are shown below.
pla_DepEstimate
Values mean followings, calculated from depth:• In case of3, h(m) is more than 0.4m.

• In case of2, h(m) is between 0.3m and 0.4m.

• In case of1, h(m) is between 0.3m and 0.3m.

• In case of0, h(m) is less than 0.2m

pla_VelDepEstimate
This parameter means the result of comparing depth h (m) and hV D_est which is estimated by (3.1) from velocity.
Values mean followings.
• h < hV D_est : 0• h > hV D_est : 1
pla_WOIEstimate
This parameter means the result of comparing τ∗90 and τ∗c90 which are estimated by (3.2), calculated from depth
and velocity. Values mean followings.
• W OI < 1: 0
• W OI ≥ 1: 1
AVG_pla_DepEstimate
Values mean followings, calculated from average depth:• In case of3, h(m) is more than 0.4m.

• In case of2, h(m) is between 0.3m and 0.4m.

• In case of1, h(m) is between 0.3m and 0.3m.

• In case of0, h(m) is less than 0.2m

AVG_pla_VelDepEstimate
This parameter means the result of comparing average depth h (m) and hV D_est which is estimated by (3.1) fromaverage velocity. Values mean followings.
• h < hV D_est : 0• h > hV D_est : 1
MAX_pla_WOIEstimate
This parameter means the result of comparing τ∗90 and τ∗c90 which are estimated by (3.2), calculated frommaximum depth and maximum velocity. Values mean followings.
• W OI < 1: 0
• W OI ≥ 1: 1

3.7. Evaluation of Terrestrial plant growth

31

CHAPTER

FOUR

EXAMPLES

A YouTube movie about how to use EvaTRiP is published. The movie is in Japanese.
The URL of the movie is as below.
https://www.youtube.com/watch?v=2xCdC9DmVLA&list=PLjUrUSvJNya_qvwCimGJ7EgzidDF2o4aO

33

CHAPTER

FIVE

LICENSE• This software is distributed by Public Works Research Institute Aqua Restoration Research Center.
• This software is licensed under a Creative Commons Attribution 4.0 International License CC BY . When
you copy, distribute this software, or you use this software for showcase or demonstration, please display that you
used the software distributed by Public Works Research Institute Aqua Restoration Research Center.
(Refer to: https://creativecommons.jp/licenses/)35

BIBLIOGRAPHY[Iwagaki] Yuichi Iwagaki: Hydrodynamical study on critical tractive force, Trans. of JSCE, No. 41, pp 1-21, December,
1956[Hauer]C. Hauer, G. Mandlburger, H. Habersack : Hydraulically related hydro-morphological units: description
based on a new conceptual mesohabitat evaluation model (MEM) using LiDAR data as geometric input,
River Research and Applications, Volume25, Issue1, Pages 29-47, 2009.

37