iRIC Software

Changing River Science

Developer’s Manual

Last Update: 2015.3.13

Release: 2011.12.24

Copyright 2011-2015 iRIC Project All Rights Reserved.

 Contents
1. About This Manual ...................................................................................................................................... 1
2. Steps of developing a solver ........................................................................................................................ 2
2.1. Abstract ............................................................................................................................................... 2
2.2. Creating a folder .................................................................................................................................. 5
2.3. Creating a solver definition file ........................................................................................................... 5
2.3.1. Defining basic information .......................................................................................................... 6
2.3.2. Defining calculation conditions ................................................................................................... 8
2.3.3. Defining Grid attributes ............................................................................................................. 12
2.3.4. Defining Boundary Conditions .................................................................................................. 15
2.4. Creating a solver ................................................................................................................................ 17
2.4.1. Creating a scelton ...................................................................................................................... 18
2.4.2. Adding calculation data file opening and closing codes............................................................ 19
2.4.3. Adding codes to load calculation conditions, calculation girds, and boundary conditions ....... 20
2.4.4. Adding codes to output time and calculation results ................................................................. 22
2.5. Creating a solver definition dictionary file ........................................................................................ 24
2.6. Creating a README file .................................................................................................................. 27
2.7. Creating a LICENSE file ................................................................................................................... 28
3. Steps of developing a calculation result analysis program ........................................................................ 29
3.1. Abstract ............................................................................................................................................. 29
4. Steps of developing a grid generating program ......................................................................................... 32
4.1. Abstract ............................................................................................................................................. 32
4.2. Creating a folder ................................................................................................................................ 34
4.3. Creating a grid generating program definition file ............................................................................ 34
4.3.1. Defining basic information ........................................................................................................ 35
4.3.2. Defining grid generating conditions .......................................................................................... 37
4.3.3. Defining error codes .................................................................................................................. 39
4.4. Creating a grid generating program ................................................................................................... 41
4.4.1. Creating a scelton ...................................................................................................................... 42
4.4.2. Adding grid generating data file opening and closing codes ..................................................... 43
4.4.3. Adding codes to output a grid.................................................................................................... 44
4.4.4. Adding codes to load grid generating condition ........................................................................ 47
4.4.5. Adding error handling codes ..................................................................................................... 49
4.5. Creating a grid generating program definition dictionary file ........................................................... 50
4.6. Creating a README file .................................................................................................................. 53
5. About definition files (XML) .................................................................................................................... 54
5.1. Abstract ............................................................................................................................................. 54
5.2. Structure ............................................................................................................................................ 54
5.2.1. Solver definition file .................................................................................................................. 54
5.2.2. Grid generating program definition file ..................................................................................... 57
5.3. Examples ........................................................................................................................................... 58
5.3.1. Examples of calculation conditions, boundary conditions, and grid generating condition ....... 58
5.3.2. Example of condition to activate calculation conditions etc. .................................................... 71
5.3.3. Example of dialog layout definition .......................................................................................... 72
5.4. Elements reference ............................................................................................................................ 78
5.4.1. BoundaryCondition ................................................................................................................... 78
5.4.2. CalculationCondition ................................................................................................................. 78
5.4.3. Condition ................................................................................................................................... 79
5.4.4. Definition (when used under CalculationCondition element or BoundaryCondition element) . 80
5.4.5. Definition (when used under the GridRelatedCondition element) ............................................ 81
5.4.6. Dimension.................................................................................................................................. 82

i
 5.4.7. Enumeration .............................................................................................................................. 82
5.4.8. ErrorCodes................................................................................................................................. 82
5.4.9. ErrorCode .................................................................................................................................. 83
5.4.10. GroupBox .................................................................................................................................. 83
5.4.11. GridGeneratingCondition .......................................................................................................... 84
5.4.12. GridGeneratorDefinition ........................................................................................................... 84
5.4.13. GridLayout ................................................................................................................................ 85
5.4.14. GridTypes .................................................................................................................................. 85
5.4.15. GridType .................................................................................................................................... 85
5.4.16. HBoxLayout .............................................................................................................................. 86
5.4.17. Item ............................................................................................................................................ 86
5.4.18. Label .......................................................................................................................................... 86
5.4.19. Param ......................................................................................................................................... 87
5.4.20. SolverDefinition ........................................................................................................................ 88
5.4.21. Tab ............................................................................................................................................. 89
5.4.22. Value .......................................................................................................................................... 89
5.4.23. VBoxLayout .............................................................................................................................. 90
5.5. Notes on solver version up ................................................................................................................ 91
5.6. XML files basics ................................................................................................................................ 93
5.6.1. Defining Elements ..................................................................................................................... 93
5.6.2. About tabs, spaces, and line breaks ........................................................................................... 94
5.6.3. Comments .................................................................................................................................. 94
6. iRIClib ....................................................................................................................................................... 95
6.1. What is iRIClib? ................................................................................................................................ 95
6.2. How to read this section .................................................................................................................... 95
6.3. Overview ........................................................................................................................................... 96
6.3.1. Processes of the program and iRIClib subroutines .................................................................... 96
6.3.2. Opening a CGNS file................................................................................................................. 97
6.3.3. Initializing iRIClib..................................................................................................................... 97
6.3.4. Reading calculation conditions .................................................................................................. 98
6.3.5. Reading calculation grid information ...................................................................................... 100
6.3.6. Reading boundary conditions .................................................................................................. 104
6.3.7. Reading geographic data ......................................................................................................... 106
6.3.8. Outputting calculation grids (only in cases where grid creation or re-division is performed) 110
6.3.9. Outputting time (or iteration count) information ..................................................................... 112
6.3.10. Outputting calculation grids (only in the case of a moving grid) ............................................ 113
6.3.11. Outputting calculation results .................................................................................................. 115
6.3.12. Reading calculation result ....................................................................................................... 117
6.3.13. Outputting Error code .............................................................................................................. 118
6.3.14. Closing a CGNS file ................................................................................................................ 118
6.4. Reference ......................................................................................................................................... 119
6.4.1. List of subroutines ................................................................................................................... 119
6.4.2. cg_open_f ................................................................................................................................ 125
6.4.3. cg_iric_init_f ........................................................................................................................... 125
6.4.4. cg_iric_initread_f .................................................................................................................... 125
6.4.5. cg_iric_read_integer_f ............................................................................................................. 126
6.4.6. cg_iric_read_real_f .................................................................................................................. 126
6.4.7. cg_iric_read_realsingle_f ........................................................................................................ 126
6.4.8. cg_iric_read_string_f ............................................................................................................... 127
6.4.9. cg_iric_read_functionalsize_f ................................................................................................. 127
6.4.10. cg_iric_read_functional_f ........................................................................................................ 128
6.4.11. cg_iric_read_functional_realsingle_f ...................................................................................... 128
6.4.12. cg_iric_read_functionalwithname_f ........................................................................................ 129
6.4.13. cg_iric_gotogridcoord2d_f ...................................................................................................... 129
6.4.14. cg_iric_gotogridcoord3d_f ...................................................................................................... 129

ii
6.4.15. cg_iric_getgridcoord2d_f ........................................................................................................ 130
6.4.16. cg_iric_getgridcoord3d_f ........................................................................................................ 130
6.4.17. cg_iric_read_grid_integer_node_f........................................................................................... 131
6.4.18. cg_iric_read_grid_real_node_f ................................................................................................ 131
6.4.19. cg_iric_read_grid_integer_cell_f ............................................................................................. 131
6.4.20. cg_iric_read_grid_real_cell_f .................................................................................................. 132
6.4.21. cg_iric_read_complex_count_f ............................................................................................... 132
6.4.22. cg_iric_read_complex_integer_f ............................................................................................. 132
6.4.23. cg_iric_read_complex_real_f .................................................................................................. 133
6.4.24. cg_iric_read_complex_realsingle_f......................................................................................... 133
6.4.25. cg_iric_read_complex_string_f ............................................................................................... 134
6.4.26. cg_iric_read_complex_functionalsize_f .................................................................................. 134
6.4.27. cg_iric_read_complex_functional_f ........................................................................................ 135
6.4.28. cg_iric_read_complex_functionalwithname_f ........................................................................ 135
6.4.29. cg_iric_read_complex_functional_realsingle_f....................................................................... 136
6.4.30. cg_iric_read_grid_complex_node_f ........................................................................................ 136
6.4.31. cg_iric_read_grid_complex_cell_f .......................................................................................... 136
6.4.32. cg_iric_read_grid_functionaltimesize_f .................................................................................. 137
6.4.33. cg_iric_read_grid_functionaltime_f ........................................................................................ 137
6.4.34. cg_iric_read_grid_functionaldimensionsize_f ........................................................................ 137
6.4.35. cg_iric_read_grid_functionaldimension_integer_f .................................................................. 138
6.4.36. cg_iric_read_grid_functionaldimension_real_f ....................................................................... 138
6.4.37. cg_iric_read_grid_functional_integer_node_f......................................................................... 139
6.4.38. cg_iric_read_grid_functional_real_node_f.............................................................................. 139
6.4.39. cg_iric_read_grid_functional_integer_cell_f .......................................................................... 140
6.4.40. cg_iric_read_grid_functional_real_cell_f................................................................................ 140
6.4.41. cg_iric_bc_count_f .................................................................................................................. 140
6.4.42. cg_iric_read_bc_indicessize_f................................................................................................. 141
6.4.43. cg_iric_read_bc_indices_f ....................................................................................................... 142
6.4.44. cg_iric_read_bc_integer_f ....................................................................................................... 143
6.4.45. cg_iric_read_bc_real_f ............................................................................................................ 143
6.4.46. cg_iric_read_bc_realsingle_f................................................................................................... 144
6.4.47. cg_iric_read_bc_string_f ......................................................................................................... 144
6.4.48. cg_iric_read_bc_functionalsize_f ............................................................................................ 145
6.4.49. cg_iric_read_bc_functional_f .................................................................................................. 145
6.4.50. cg_iric_read_bc_functional_realsingle_f ................................................................................ 146
6.4.51. cg_iric_read_bc_functionalwithname_f .................................................................................. 146
6.4.52. cg_iric_read_geo_count_f ....................................................................................................... 147
6.4.53. cg_iric_read_geo_filename_f .................................................................................................. 147
6.4.54. iric_geo_polygon_open_f ........................................................................................................ 148
6.4.55. iric_geo_polygon_read_integervalue_f ................................................................................... 148
6.4.56. iric_geo_polygon_read_realvalue_f ........................................................................................ 148
6.4.57. iric_geo_polygon_read_pointcount_f ...................................................................................... 149
6.4.58. iric_geo_polygon_read_points_f ............................................................................................. 149
6.4.59. iric_geo_polygon_read_holecount_f ....................................................................................... 149
6.4.60. iric_geo_polygon_read_holepointcount_f ............................................................................... 150
6.4.61. iric_geo_polygon_read_holepoints_f ...................................................................................... 150
6.4.62. iric_geo_polygon_close_f ....................................................................................................... 151
6.4.63. iric_geo_riversurvey_open_f ................................................................................................... 151
6.4.64. iric_geo_riversurvey_read_count_f ......................................................................................... 151
6.4.65. iric_geo_riversurvey_read_position_f ..................................................................................... 152
6.4.66. iric_geo_riversurvey_read_direction_f.................................................................................... 152
6.4.67. iric_geo_riversurvey_read_name_f ......................................................................................... 153
6.4.68. iric_geo_riversurvey_read_realname_f ................................................................................... 153
6.4.69. iric_geo_riversurvey_read_leftshift_f ..................................................................................... 153
6.4.70. iric_geo_riversurvey_read_altitudecount_f ............................................................................. 154
iii
 6.4.71. iric_geo_riversurvey_read_altitudes_f .................................................................................... 154
6.4.72. iric_geo_riversurvey_read_fixedpointl_f ................................................................................ 155
6.4.73. iric_geo_riversurvey_read_fixedpointr_f ................................................................................ 155
6.4.74. iric_geo_riversurvey_read_watersurfaceelevation_f ............................................................... 156
6.4.75. iric_geo_riversurvey_close_f .................................................................................................. 156
6.4.76. cg_iric_writegridcoord1d_f ..................................................................................................... 156
6.4.77. cg_iric_writegridcoord2d_f ..................................................................................................... 157
6.4.78. cg_iric_writegridcoord3d_f ..................................................................................................... 157
6.4.79. cg_iric_write_grid_integer_node_f ......................................................................................... 158
6.4.80. cg_iric_write_grid_real_node_f .............................................................................................. 158
6.4.81. cg_iric_write_grid_integer_cell_f ........................................................................................... 158
6.4.82. cg_iric_write_grid_real_cell_f ................................................................................................ 159
6.4.83. cg_iric_write_sol_time_f ......................................................................................................... 159
6.4.84. cg_iric_write_sol_iteration_f................................................................................................... 159
6.4.85. cg_iric_write_sol_gridcoord2d_f ............................................................................................ 160
6.4.86. cg_iric_write_sol_gridcoord3d_f ............................................................................................ 160
6.4.87. cg_iric_write_sol_baseiterative_integer_f ............................................................................... 161
6.4.88. cg_iric_write_sol_baseiterative_real_f .................................................................................... 161
6.4.89. cg_iric_write_sol_integer_f ..................................................................................................... 161
6.4.90. cg_iric_write_sol_real_f .......................................................................................................... 162
6.4.91. cg_iric_write_sol_particle_pos2d_f ........................................................................................ 162
6.4.92. cg_iric_write_sol_particle_pos3d_f ........................................................................................ 163
6.4.93. cg_iric_read_sol_count_f ........................................................................................................ 163
6.4.94. cg_iric_read_sol_time_f .......................................................................................................... 163
6.4.95. cg_iric_read_sol_iteration_f .................................................................................................... 164
6.4.96. cg_iric_read_sol_baseiterative_integer_f ................................................................................ 164
6.4.97. cg_iric_read_sol_baseiterative_real_f ..................................................................................... 164
6.4.98. cg_iric_read_sol_gridcoord2d_f .............................................................................................. 165
6.4.99. cg_iric_read_sol_gridcoord3d_f .............................................................................................. 165
6.4.100. cg_iric_read_sol_integer_f ...................................................................................................... 166
6.4.101. cg_iric_read_sol_real_f ........................................................................................................... 166
6.4.102. cg_iric_write_errorcode_f ....................................................................................................... 166
6.4.103. cg_close_f ................................................................................................................................ 167
7. Other Informations .................................................................................................................................. 168
7.1. Handling command line arguments in Fortran programs ................................................................ 168
7.1.1. Intel Fortran Compiler ............................................................................................................. 168
7.1.2. GNU Fortran, G95 ................................................................................................................... 168
7.2. Linking iRIClib, cgnslib using Fortran ............................................................................................ 169
7.2.1. Intel Fortran Compiler (Windows) .......................................................................................... 169
7.2.2. GNU Fortran ............................................................................................................................ 169
7.3. Special names for grid attributes and calculation results ................................................................. 170
7.3.1. Grid attributes .......................................................................................................................... 170
7.3.2. Calculation results ................................................................................................................... 171
7.4. Information on CGNS file and CGNS library ................................................................................. 172
7.4.1. General concept of CGNS file format ..................................................................................... 172
7.4.2. How to view a CGNS file ........................................................................................................ 172
7.4.3. Reference URLs ...................................................................................................................... 175

iv
1. About This Manual

This manual provides information necessary for the following people:

Developers of solvers that run on iRIC.
Developers of grid generating programs that run on iRIC

Developers of solvers should read Chapter 2 first, to understand the steps of developing a solver. After that,
please read Chapter 5, 6, 7 when you need to.

Developers of grid generating programs should read Chapter 4 first, to understand the steps of developing a
grid generating program. After that, please read Chapter 5, 6, 7 when you need to.

1
2. Steps of developing a solver

2.1. Abstract

Solver is a program that load grid and calculation conditions, execute a river simulation, and output
calculation results.
To add a solver to iRIC, it is necessary to make and deploy files shown in Table 2-1.
“iRIC 2.0” folder and “solvers” folder in Table 2-1 have been already created when you installed iRIC. Solver
developers have to create a new folder under “solvers” folder, and deploy files related to the new solver under
that.

Table 2-1 Files and folders related to Solvers

Item Description Refer to
iRIC 2.0 Installation folder of iRIC 2.0 (e.g.: C:¥Program Files¥iRIC 2.0)

solvers Folder for storing solvers

(solver folder) Create one folder for each solver. Give the folder any name. 2.2

definition.xml Solver definition file. 2.3

solver.exe Executable module of the solver. Developers can select any name. 2.4

translation_ja_JP.ts etc Dictionary files for a solver definition file 2.5

README File explaining the solver 2.6

LICENSE License information file for the solver 2.7

Abstracts of each file are as follows:

definition.xml
File that defines the following information of solvers:
• Basic Information
• Calculation Conditions
• Grid Attributes
iRIC loads definition xml, and provides interface for creating calculation conditions and grids that can be used
by the solver. Solver definition file should be written in English.

Solver
Executable module of a river simulation solver. It loads calculation condition and grids created using iRIC,
executes river simulation, and outputs result.
Solvers use calculation data files created by iRIC, for loading and writing calculation condition, grids, and
calculation results. Solvers can also use arbitrary files for data I/O that cannot be loaded from or written into
calculation data files.
Solvers can be developed using FORTRAN, C or C++. In this chapter, a sample solver is developed in
FORTRAN.

2
translation_ja_JP.ts etc.
Dictionary files for a solver definition file. It provides translation information for texts shown on dialogs or
object browser in iRIC. Dictionary files are created as separate files for each language. For example,
“translation_ja_JP.ts” for Japanese, “translation_ka_KR.ts” for Korean.

README
README is a text file that describes about the solver. The content of README is shown in the
“Description” tab in the [Select Solver] dialog.

LICENSE
LICENSE is a text file that describes about the license of the solver. The content of LICENSE is shown in the
“License” tab in the [Select Solver] dialog.

Figure 2-1 shows the relationships of iRIC, solver and related files.

3
 Solver Definition File Dictionary File README LICENSE

iRIC

Calculation Condition, Grid Calculation Result

Provide Interface to create

calculation condition and Calculatioin Data File

grid

Calculation Condition, Grid Calculation Result

Arbitrary File
I/O library (iRIClib)

Solver

Arbitrary File

凡例

Program

Library that iRIC provide

File

Figure 2-1 Relationships between iRIC, solvers, and related files

This chapter explains the steps to create the files described in this section.

4
2.2. Creating a folder

Create a special folder for the solver you develop under the “solvers” folder under the installation folder of
iRIC (The default place is “C:¥Program Files¥iRIC 2.0”). This time, please create “example” folder.

2.3. Creating a solver definition file

Create a solver definition file.

In solver definition file, you are going to define the information shown in Table 2-2.

Table 2-2 Informations defined in solver definition file

Item Description Required
Basic information The solver name, developer name, release date, Yes

Calculation Calculation condition for solver execution Yes

Condition

Grid Attributes Attributes defined at nodes or cells of calculation Yes

grids

Boundary Conditions Boundary conditions defined at nodes or cells of

calculation grids

Solver definition file is described in XML language. The basic grammer of XML language is explained in
Section 5.6.

In this section, we add definition information of a solver in the order shown in Table 2-2.

5
2.3.1. Defining basic information

Define basic information of a solver. Create a file with the content shown in Table 2-3, and save it with name
“definition.xml” under “example” folder that you created in Section 2.2.

Table 2-3 Example solver definition file that contains basic information
<?xml version="1.0" encoding="UTF-8"?>
<SolverDefinition
name="samplesolver"
caption="Sample Solver 1.0"
version="1.0"
copyright="Example Company"
release="2012.04.01"
homepage="http://example.com/"
executable="solver.exe"
iterationtype="time"
gridtype="structured2d"
>
<CalculationCondition>
</CalculationCondition>
<GridRelatedCondition>
</GridRelatedCondition>
</SolverDefinition>

At this point, the structure of the solver definition file is as shown in Table 2-4.

Table 2-4 Solver definition file structure

Element Note
SolverDefinition Basic information is defined here.
CaｌculationCondition Define calculation conditions here. It is empty now.
GridRelatedCondition Define grid attributes here. It is empty now.

Now make sure the solver definition file is arranged correctly.

Launch iRIC. The [iRIC Start Page] dialog (Figure 2-2) is shown, so please click on [New Project]. The
[Solver Select] dialog (Figure 2-3) will open, so make sure if there is a new item “Sample Solver” in the
solver list. When you find it, select it and make sure that the basic information of the solver you wrote in
solver definition file is shown.
Please note that the following attributes are not shown on this dialog:
• name
• executable
• iterationtype
• gridtype

6
 Press this button

Figure 2-2 The [iRIC Start Page] dialog

This item is added

Basic information you input is shown here.

Figure 2-3 The [Select Solver] dialog

You sould take care about name attribute and version attribute, when you want to update a solver. Please refer
to Section 5.5 for the detail.

7
2.3.2. Defining calculation conditions

Define calculation conditions. Calculation conditions are defined in “CalculationCondition” element. Add
description of calculation condition to the solver definition file you created in Section 2.3.1. Solver definition
file content is now as shown in Table 2-5. The added part is shown with bold style.

Table 2-5 Example of solver definition file that now has calculation condition definition
<?xml version="1.0" encoding="UTF-8"?>
<SolverDefinition
name="samplesolver"
caption="Sample Solver"
version="1.0"
copyright="Example Company"
release="2012.04.01"
homepage="http://example.com/"
executable="solver.exe"
iterationtype="time"
gridtype="structured2d"
>
<CalculationCondition>
<Tab name="basic" caption="Basic Settings">
<Item name="maxIteretions" caption="Maximum number of Iterations">
<Definition valueType="integer" default="10">
</Definition>
</Item>
<Item name=”timeStep” caption=”Time Step”>
<Definition valueType=”real” default=”0.1”>
</Definition>
</Item>
</Tab>
</CalculationCondition>
<GridRelatedCondition>
</GridRelatedCondition>
</SolverDefinition>

At this point, the structure of the solver definition file is as shown in Table 2-6.

Table 2-6 Solver definition file structure

Element Notes
SolverDefinition Basic Information is defined here.
CaｌculationCondition Calculation condition is defined here.
Tab Calculation condition group
Item Calculation condition name
Definition Calculation condition attributes
Item Calculation condition name
Definition Calculation condition attributes
GridRelatedCondition Grid attributes are defined here. It is empty now.

Now make sure that solver definition file is arranged correctly.

Launch iRIC. The [iRIC Start page] dialog (Figure 2-2) will open, so please click on [Create New Project],
select “Sample Solver” from the list, and click on [OK]. The Warning dialog (Figure 2-4) will be open, so
click on [OK].

8
 Figure 2-4 The [Warning] dialog

The [Pre-processing Window] will open, so perform the following:

Menu bar: [Calculation Condition] (C) ► [Setting] (S)

The [Calculation Condition] dialog (Figure 2-5) will open. Now you can see that the calculation condition
items you defined are shown.

Condition items that correspond to the

definition in solver definition file are shown.

Figure 2-5 The [Calculation Condition] dialog

Now add one more group and add calculation condition items. Add “Water Surface Elevation” Tab element
just under “Basic Settings” Tab element. Table 2-7 shows the solver definition file that has definition of
“Water Surface Elevation” Tab. The added part is shown with bold style.

Table 2-7 Example of solver definition file that now has calculation condition definition (abbr.)
(abbr.)
</Tab>
<Tab name=”surfaceElevation” caption=”Water Surface Elevation”>
<Item name=”surfaceType” caption=”Type”>
<Definition valueType=”integer” default=”0”>
<Enumeration caption=”Constant” value=”0” />
<Enumeration caption=”Time Dependent” value=”1” />
</Definition>
</Item>
<Item name=”constantSurface” caption=”Constant Value”>
<Definition valueType=”real” default=”1”>
<Condition type="isEqual" target="surfaceType" value="0"/>
</Definition>
</Item>
<Item name=”variableSurface” caption=”Time Dependent Value”>
<Definition valueType=”functional”>
<Parameter valueType="real" caption="Time(s)"/>

9
 <Value valueType="real" caption="Elevation(m) "/>
<Condition type="isEqual" target="surfaceType" value="1"/>
</Definition>
</Item>
</Tab>
</CalculationCondition>
<GridRelatedCondition>
</GridRelatedCondition>
</SolverDefinition>

At this point, the structure of the solver definition file is as shown in Table 2-8.

Table 2-8 Solver definition file structure

Element Notes
SolverDefinition Basic Information is defined here.
CaｌculationCondition Calculation condition is defined here.
Tab Calculation condition group
(abbr.)
Tab Calculation condition group
Item Calculation condition name
Definition Calculation condition attributes
Enumeration Option to select as conditioin value is defined here.
Enumeration Option to select as conditioin value is defined here.
Item Calculation condition name
Definition Calculation condition attributes
Condition Condition that this condition is enabled is defined here.
Item Calculation condition name
Definition Calculation condition attributes
Parameter Parameter of the functional condition is defined here.
Value Value of the functional condition is defined here.
Condition Condition that the condition is enabled is defined here.
GridRelatedCondition Grid attributes are defined here. It is empty now.

Now make sure that solver definition file is arranged correctly. Do the operation you did again, to open The
[Calculation Condition] dialog (Figure 2-6). Now you can see that the new group “Water Surface Elevation” is
added in the group list. You’ll also notice that the “Constant Value” item is enabled only when “Type” value is
“Constant”, and the “Time Dependent Value” item is enabled only when “Type” value is “Time Dependent”.

10
 Figure 2-6 The [Calculation Condition] dialog

What it comes down to is:

• Calculation condition group is defined with “Tab” element, and calculation condition item is defined
with “Item” element.
• The Structure under “Definition” elements depends on the condition type (i. e. Integer, Real number,
functional etc.). Refer to Section 5.3.1 for examples of calculation condition items for each type.
• Dependenciy between calculation condition items can be defined with “Condition” element. In
“Condition” element, define the condition when that item should be enabled. Refer to Section 5.3.2
for examples of “Condition” element.
• In this example, the calculation condition dialog shows the items as a simple list, but iRIC has feature
to show items with more complex layouts, like layout with group boxes. Refer to 5.3.3 for more
complex layouts.

11
2.3.3. Defining Grid attributes

Define grid attributes. Grid attributes are defined with “GridRelatedCondition” element. Add definition of
grid related condition to the solver definition file you created, as shown in Table 2-9. The added part is shown
with bold style.

Table 2-9 Example of solver definition file that now has grid related condition (abbr.)
(abbr.)
</CalculationCondition>
<GridRelatedCondition>
<Item name="Elevation" caption="Elevation">
<Definition position="node" valueType="real" default="max" />
</Item>
<Item name="Obstacle" caption="Obstacle">
<Definition position="cell" valueType="integer" default="0">
<Enumeration value="0" caption="Normal cell" />
<Enumeration value="1" caption="Obstacle" />
</Definition>
</Item>
<Item name="Rain" caption="Rain">
<Definition position="cell" valueType="real" default="0">
<Dimension name=”Time” caption=”Time” valueType=”real” />
</Definition>
</Item>
</GridRelatedCondition>
</SolverDefinition>

Now make sure that solver definition file is arranged correctly.

Launch iRIC, and starts a new project with solver “Sample Solver”. Now you will see the [Pre-processing
Window] like in Figure 2-7. When you create or import a grid, the [Pre-processing Window] will become like
in Figure 2-8. When you do not know how to create or import a grid, refer to the User Manual.

Geographic Data items that corresponds

to grid attribute names are shown here.

Figure 2-7 The [Pre-processing Window]

12
 Grid node attributes, cell attributes items are
shown here, that correspond to the definition
in solver definition file.

Figure 2-8 The [Pre-processing Window] after creating a grid

When you edit the grid attribute “Elevation” with the following procedure, the [Edit Elevation] dialog (Figure
2-9) will open, and you can check that you can input real number as “Elevation” value.
• Select [Grid] ► [Node attributes] ► [Elevation] in the [Object Browser].
• Select grid nodes with mouse clicking in the canvas area
• Show context menu with right-clicking, and click on [Edit].

Figure 2-9 The [Edit Elevation] dialog

When you do the same operation against attribute “Obstacle” to edit “Obstacle” value, the [Obstacle edit
dialog] (Figure 2-10) will open, and you can check that you can select obstacle values from that you defined
in solver definition file.

Figure 2-10 The [Obstacle edit dialog]

What it comes down to is:

• Grid attribute is defined with “Item” element under “GridRelatedCondition” element.

13
 • The structure under “Item” element is basically the same to that for calculation condition, but there are
different points:

You have to specify “position” attribute to determine whether that attribute is defined
at nodes or cells.

You can not use types “String”, “Functional”, “File name” and “Folder name”.

You can not define dependency.

For grid attributes, iRIC defines some special names. For attributes for certain purposes, you should use those
names. Refer to Section 7.3.1 for the special grid attribute names.

14
2.3.4. Defining Boundary Conditions

Define boundary conditions. You can define boundary conditions with “BoundaryCondition” element.
Boundary conditions are not required.
Add definition of “Boundary Condition” to the solver definition file you created, as shown in Table 2-10. The
added part is shown with bold style.

Table 2-10 Example of solver definition file that now has boundary condition (abbr.)
(前略)
</GridRelatedCondition>
<BoundaryCondition name="inflow" caption="Inflow" position="node">
<Item name="Type" caption="Type">
<Definition valueType="integer" default="0" >
<Enumeration value="0" caption="Constant" />
<Enumeration value="1" caption="Variable" />
</Definition>
</Item>
<Item name="ConstantDischarge" caption="Constant Discharge">
<Definition valueType="real" default="0" >
<Condition type="isEqual" target="Type" value="0"/>
</Definition>
</Item>
<Item name="FunctionalDischarge" caption="Variable Discharge">
<Definition conditionType="functional">
<Parameter valueType="real" caption="Time"/>
<Value valueType="real" caption="Discharge(m3/s)"/>
<Condition type="isEqual" target="Type" value="1"/>
</Definition>
</Item>
</BoundaryCondition>
</SolverDefinition>

Now make sure that solver definition file is arranged correctly.

Launch iRIC, and start a new project with solver “Sample Solver”. When you create or import a grid, the
[Pre-processing Window] will become like Figure 2-11. When you do now know how to create or imprt a grid,
refer to the User Manual.

Right-click on this node, to add boundary

condition from context menu

Figure 2-11 The [Pre-processing Window] after creating a grid

15
Click on [Add new Inflow] on the context menu on [Boundary Condition] node, and The [Boundary
Condition] dialog (Figure 2-12) will open, and you can define boundary condition on this dialog.

Figure 2-12 The [Boundary Condition] dialog

When you have finished defining boundary condition, click on [OK]. Drag around the grid nodes to select
nodes, and click on [Assign Condition] in the context menu. Figure 2-13 shows an example of a grid with
boundary condition.

Grid nodes that a boundary

condition is assigned.

Figure 2-13 Example of a grid with boundary condition

What it comes down to is:

• Boundary condition is defined Grid attribute is defined with “Item” element under
“GridRelatedCondition” element.
• The structure under “Item” element is the same to that for calculation condition.

16
2.4. Creating a solver

Create a solver. In this example we will develop a solver with FORTRAN.

To develop a solver that works together with iRIC, you have to make it use calculation data file that iRIC
generate, for loading calculation conditions and grid and outputting calculation results.
The calculation data file that iRIC generates is a CGNS file. You can use a library called iRIClib to write code
for loading and writing CGNS files.
In this section, the procedure to develop a solver that load calculation data file, that iRIC generates.
Table 2-11 shows the input and output processing that the solver do against the calculation data file.

Table 2-11 The I/O processing flow of solver

Processing Required
Opens calculation data file Yes

Initializes iRIClib Yes

Loads calculatioin condition Yes

Loads calculation grid Yes

Outputs time (or iteration) Yes

Repeated
Outputs calculation result Yes

Closes calculation data file Yes

In this section, we will develop a solver in the following procedure:

• Create a scelton
• Adds calculation data file opening and closing codes
• Adds codes to load calculation conditions, calculation girds, and boundary conditions
• Adds codes to output time and calculation results

17
2.4.1. Creating a scelton

First, create a scelton of a solver. Create a new file with the source code in Table 2-12, and save as
“sample.f90”. At this point, the solver does nothing.
Compile this source code. The way to compile a source code differs by the compiler. Refer to Section 7.2.1 for
the procedure to compile using gfortran and Intel Fortran Compiler.

Table 2-12 Sample solver source code

program SampleProgram
implicit none
include 'cgnslib_f.h'

write(*,*) “Sample Program”

stop
end program SampleProgram

When it was compiled successfully, copy the executable file to the folder you created in Section 2.2, and
rename it into the name you specified as [executable] attribute in Section 2.3.1. This time, rename into
“solver.exe”. Copy the DLL files into that folder, that is needed to run the solver.
Now check whether it can be launched from iRIC successfully.
Starts a new project that uses “Example Solver”, and performs the following:

Menu bar: [Simulationh] (S) ► [Run] (R)

The [Solver Console] opens, and the message “Sample Program” will be shown (Figure 2-14). If the message
is shown, it means that the solver was launched by iRIC successfully.

Figure 2-14 The [Solver Console]

18
2.4.2. Adding calculation data file opening and closing codes

Adds codes for opening and closing calculation data file.

The solver has to open calculation data file in the first step, and close it in the last step.
iRIC will handle the file name of calculation data file as a the first argument, so open that file.
The way to handle the number of arguments and the arguments differs by compilers. Refer to Section 7.1 for
the way to handle them with gfortran and Intel Fortran Compiler. In this chapter we will add codes that can be
compiled using Intel Fortran Compiler.
Table 2-13 shows the source code with the lines to open and close calculation data file. The added lines are
shown with bold style.

Table 2-13 The source code with lines to open and close file
program SampleProgram
implicit none
include 'cgnslib_f.h'
integer:: fin, ier
integer:: icount, istatus
character(200)::condFile

write(*,*) “Sample Program”

icount = nargs()
if ( icount.eq.2 ) then
call getarg(1, condFile, istatus)
else
write(*,*) “Input File not specified.”
stop
endif

! Opens calculation data file.

call cg_open_f(condFile, CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Closes calculation data file.

call cg_close_f(fin, ier)
stop
end program SampleProgram

Compile and deploy the executable file, just like in Section 2.4.1.
Check whether it can be launched from iRIC successfully, just like in Section 2.4.1.
Refer to Section 6.3.2, 6.3.3 and 6.3.12 for the details of the subroutines added in this section.

19
2.4.3. Adding codes to load calculation conditions, calculation girds, and boundary conditions

Adds codes to load calculation conditions, calculation girds, and boundary conditions.
iRIC will output calculation conditions, grids, grid attributes, and boundary condition according to the solver
definition file. So, the solver has to load them to coincide with the description in the solver definition file.
Table 2-14 shows the source code with lines to load calculation condition, grid and boundary condition. The
added lines are shown with bold style.

Table 2-14 The source code with lines to load calculation condition, grid and boundary condition
program SampleProgram
implicit none
include 'cgnslib_f.h'
integer:: fin, ier
integer:: icount, istatus
character(200)::condFile
integer:: maxiterations
double precision:: timestep
integer:: surfacetype
double precision:: constantsurface
integer:: variable_surface_size
double precision, dimension(:), allocatable:: variable_surface_time
double precision, dimension(:), allocatable:: variable_surface_elevation

integer:: isize, jsize

double precision, dimension(:,:), allocatable:: grid_x, grid_y
double precision, dimension(:,:), allocatable:: elevation
integer, dimension(:,:), allocatable:: obstacle

integer:: inflowid
integer:: inflow_count
integer:: inflow_element_max
integer:: discharge_variable_sizemax
integer, dimension(:), allocatable:: inflow_element_count
integer, dimension(:,:,:), allocatable:: inflow_element
integer, dimension(:), allocatable:: discharge_type
double precision, dimension(:), allocatable:: discharge_constant
integer, dimension(:), allocatable:: discharge_variable_size
double precision, dimension(:,:), allocatable:: discharge_variable_time
double precision, dimension(:,:), allocatable:: discharge_variable_value

write(*,*) “Sample Program”

(abbr.)

! Initializes iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Loads calculatioin condition

call cg_iric_read_integer_f("maxIteretions", maxiterations, ier)
call cg_iric_read_real_f("timeStep", timestep, ier)
call cg_iric_read_integer_f("surfaceType", surfacetype, ier)
call cg_iric_read_real_f("constantSurface", constantsurface, ier)

call cg_iric_read_functionalsize_f("variableSurface", variable_surface_size, ier)

allocate(variable_surface_time(variable_surface_size))
allocate(variable_surface_elevation(variable_surface_size))
call cg_iric_read_functional_f("variableSurface", variable_surface_time, variable_surface_elevation, ier)

! Check the grid size

20
 call cg_iric_gotogridcoord2d_f(isize, jsize, ier)

! Allocate the memory to read grid coordinates

allocate(grid_x(isize,jsize), grid_y(isize,jsize))
! Loads grid coordinates
call cg_iric_getgridcoord2d_f(grid_x, grid_y, ier)

! Allocate the memory to load grid attributes defined at grid nodes and grid cells
allocate(elevation(isize, jsize))
allocate(obstacle(isize - 1, jsize - 1))

! Loads grid attributes

call cg_iric_read_grid_real_node_f("Elevation", elevation, ier)
call cg_iric_read_grid_integer_cell_f("Obstacle", obstacle, ier)

! Allocate memory to load boundary conditions (inflow)

allocate(inflow_element_count(inflow_count))
allocate(discharge_type(inflow_count), discharge_constant(inflow_count))
allocate(discharge_variable_size(inflow_count))

! Check the number of grid nodes assigned as inflow, and the size of time-dependent discharge.
inflow_element_max = 0
do inflowid = 1, inflow_count
! Read the number of grid nodes assigned as inflow
call cg_iric_read_bc_indicessize_f('inflow', inflowid, inflow_element_count(inflowid))
if (inflow_element_max < inflow_element_count(inflowid)) then
inflow_element_max = inflow_element_count(inflowid)
end if
! Read the size of time-dependent discharge
call cg_iric_read_bc_functionalsize_f('inflow', inflowid, 'FunctionalDischarge', discharge_variable_size(inflowid),
ier);
if (discharge_variable_sizemax < discharge_variable_size(inflowid)) then
discharge_variable_sizemax = discharge_variable_size(inflowid)
end if
end do

! Allocate the memory to load grid nodes assigned as inflow, and time-dependent discharge.
allocate(inflow_element(inflow_count, 2, inflow_element_max))
allocate(discharge_variable_time(inflow_count, discharge_variable_sizemax))
allocate(discharge_variable_value(inflow_count, discharge_variable_sizemax))

! Loads boundary condition

do inflowid = 1, inflow_count
! Loads the grid nodes assigned as inflow
call cg_iric_read_bc_indices_f('inflow', inflowid, inflow_element(inflowid:inflowid,:,:), ier)
! Loads the inflow type (0 = constant, 1 = time-dependent)
call cg_iric_read_bc_integer_f('inflow', inflowid, 'Type', discharge_type(inflowid:inflowid), ier)
! Loads the discharge (constant)
call cg_iric_read_bc_real_f('inflow', inflowid, 'ConstantDischarge', discharge_constant(inflowid:inflowid), ier)
! Loads the discharge (time-dependent)
call cg_iric_read_bc_functional_f('inflow', inflowid, 'FunctionalDischarge',
discharge_variable_time(inflowid:inflowid,:), discharge_variable_value(inflowid:inflowid,:), ier)
end do

! Closes the calculation data file

call cg_close_f(fin, ier)
stop
end program SampleProgram

Note that the arguments passed to load calculation conditions, grid attributes and boundary conditions are the
same to the [name] attributes of Items defined in Section 2.3.2 , 2.3.3 and 2.3.4.
Refer to 5.3.1 for the relationship between definitions of calculation condition, grid attributes, boundary
conditions and the iRIClib subroutines to load them.

21
Refer to 6.3.4, 6.3.5 and 6.3.6 for the detail of subroutines to load calculation condition, grids, and boundary
conditions.

2.4.4. Adding codes to output time and calculation results

Adds codes to output time and calculation results.

When you develop a solver that is used for time-dependent flow, you have to repeat outputting time and
calculation results for the number of time steps.
In solver definition files, no definition is written about the calculation results the solver output. So, you do not
have to take care about the correspondence relation between solver definition file and the solver code about
them.
Table 2-15 shows the source code with lines to output time and calculations. The added lines are shown with
bold style.

Table 2-15 Source code with lines to output time and calculation results
(abbr.)
integer:: isize, jsize
double precision, dimension(:,:), allocatable:: grid_x, grid_y
double precision, dimension(:,:), allocatable:: elevation
integer, dimension(:,:), allocatable:: obstacle
double precision:: time
integer:: iteration
double precision, dimension(:,:), allocatable:: velocity_x, velocity_y
double precision, dimension(:,:), allocatable:: depth
integer, dimension(:,:), allocatable:: wetflag
double precision:: convergence

(abbr.)
! Loads grid attributes
call cg_iric_read_grid_real_node_f("Elevation", elevation, ier)
call cg_iric_read_grid_integer_cell_f("Obstacle", obstacle, ier)

allocate(velocity_x(isize,jsize), velocity_y(isize,jsize), depth(isize,jsize), wetflag(isize,jsize))

iteration = 0
time = 0
do
time = time + timestep
! (Execute the calculation here. The grid shape changes.)
call cg_iric_write_sol_time_f(time, ier)
! Outputs grid
call cg_iric_write_sol_gridcoord2d_f (grid_x, grid_y, ier)
! Outputs calculation result
call cg_iric_write_sol_real_f ('VelocityX', velocity_x, ier)
call cg_iric_write_sol_real_f ('VelocityY', velocity_y, ier)
call cg_iric_write_sol_real_f ('Depth', depth, ier)
call cg_iric_write_sol_integer_f ('Wet', wetflag, ier)
call cg_iric_write_sol_baseiterative_real_f ('Convergence', convergence, ier)
iteration = iteration + 1
if (iteration > maxiterations) exit
end do

! Closes calculation data file

call cg_close_f(fin, ier)
stop
end program SampleProgram

22
Refer to Section 6.3.9 and 6.3.11 for the details of the subroutines to output time and calculation results. Refer
to Section 6.3.10 for the details of the subroutines to output the grid coordinates in case of moving grid.
For the calculation results, some special names is named in iRIC. You should use that name for calculation
results used for a certain purpose. Refer to Section 7.3 for the special names.

23
2.5. Creating a solver definition dictionary file

Create a solver definition dictionary file that is used to translate the strings used in solver definition files, and
shown on dialogs etc.
First, launch iRIC and perform the following:

Menu bar: [Option] (O) ► [Create/Update Translation Files] (C)

The [Definition File Translation Update Wizard] (Figure 2-15 to Figure 2-17) will open. Following the wizard,
the dictionary files are created or updated.

Click on this

Figure 2-15 The [Definition File Translation Update Wizard] (Page 1)

Select the solver

Check on the language for which you

want to create a dictionary

Click on this

Figure 2-16 The [Definition File Translation Update Wizard] (Page 2)

24
 Check the files which is going to be created
or updated.

Click on this

Figure 2-17 The [Definition File Translation Update Wizard] (Page 3)

The dictionary files are created in the folder that you created in Section 2.2. The files created only include the
texts before translation (i. e. English strings). The dictionary files are text files, so you can use text editors to
edit it. Save the dictionary files with UTF-8 encoding.
Table 2-16 and Table 2-17 show the example of editing a dictionary file. As the example shows, you have to
add translated texts in “translation” element.

Table 2-16 The Dictionary file of solver definition file (before editing)
<message>
<source>Basic Settings</source>
<translation></translation>
</message>

Table 2-17 The Dictionary file of solver definition file (after editing)
<message>
<source> Basic Settings </source>
基本設定</translation>
基本設定
<translation>基本設定
</message>

You can use [Qt Linguist] for translating the dictionary file. [Qt Linguist] is bundled in Qt, and it provides
GUI for editing the dictionary file. Figure 2-18 shows the [Qt Linguist]. Qt can be downloaded from the
following URL:
http://qt.nokia.com/downloads/windows-cpp-vs2008

25
 Select the target source text

The source text

Input translation text here

Figure 2-18 The [Qt Linguist]

When the translation is finished, switch the iRIC language from Preferences dialog, restart iRIC, and check
whether the translation is complete. Figure 2-19 and Figure 2-20 shows examples of [Pre-processing Window]
and [Calculation Condition] dialog after completing transtaion of dictionary.

Shown translated

Figure 2-19 [Pre-processor Window] after completing translation of dictionary (Japanese mode)

Shown translated

Figure 2-20 The [Calculation Condition] dialog after completing translation of dictionary (Japanese mode)

26
2.6. Creating a README file

Creates a text file that explains the abstract of the solver.

Creates a text file with name “README” in the folder you created in Section 2.2. Save the file with UTF-8
encoding.
You should create the README file with the file names like below. When the language-specific README
file does not exists, “README” file (in English) will be used.
• English: “README”
• Japanese: “README_ja_JP”

The postfix (ex. “ja_JP”) is the same to that for dictionary files created in Section 2.5.
The content of “README” will be shown in “Description” area on the [Select Solver] dialog. When you
created “README”, opens the [Select Solver] dialog by starting a new project, and check whether the
content is shown on that dialog.
Figure 2-21 shows an example of the [Select Solver] dialog.

The content of “README” is shown here.

Figure 2-21 The [Select Solver] dialog

27
2.7. Creating a LICENSE file

Creates a text file that explains the license information of the solver.
Creates a text file with name “LICENSE” in the folder you created in Section 2.2. Save the file with UTF-8
encoding.
You should create the LICENSE file with the file names like below. When the language-specific LICENSE
file does not exists, “LICENSE” file (in English) will be used.
• English: “LICENSE”
• Japanese: “LICENSE _ja_JP”

The postfix (ex. “ja_JP”) is the same to that for dictionary files created in Section 2.5.
The content of “LICENSE” will be shown in “License” area on the [Select Solver] dialog. When you created
“LICENSE”, opens the [Select Solver] dialog by starting a new project, and check whether the content is
shown on that dialog.
Figure 2-22 shows an example of the [Select Solver] dialog.

The content of LICENSE is shown here.

Figure 2-22 The [Select Solver] dialog

28
3. Steps of developing a calculation result analysis program

3.1. Abstract

Calculation result analysis program is a program that reads calculation result of a soler from a CGNS file,
execute analysis or modify calculation result. Analysis result or modified calculation results can be output to
another CGNS file.
The steps of developing a calculation result analysis program is basically the same to that of a solver (See
Chapter 2). The difference is that it handles multiple CGNS files.

To handle multiple CGNS files at the same time, you should use different functions thant shoes used in
Chapter 2 (See 6.4.1). The names of functions for handling multiple CGNS files ends with “_mul_f”, and the
first argument is the file ID. You should call “cg_iric_initread_f” instead of “cg_iric_init_f” when initializing
the CGNS file to be used by iRIClib. Table 3-1 shows the source code with lines to output time and
calculations. The added lines are shown with bold style.

Table 3-1 Source code that handles multiple CGNS files (abstract)
(abbr.)
! File opening and initialization
call cg_open_f(cgnsfile, CG_MODE_MODIFY, fin1, ier)
call cg_iric_init_f(fin1, ier)
(abbr.)
! Reading calculation condition etc.
call cg_iric_read_functionalsize_mul_f(fin1, 'func', param_func_size, ier)
(abbr.)

! File opening and initialization for reading calculation result

call cg_open_f(param_inputfile, CG_MODE_READ, fin2, ier)
call cg_iric_initread_f(fin2, ier)
(abbr.)
! Reading calculation result etc.
call cg_iric_read_sol_count_mul_f(fin2, solcount, ier)
(abbr.)

! Calculation result analysis code

(abbr.)

! Outputting analysis result

call cg_iric_write_sol_time_mul_f(fin1, t, ier)
(abbr.)

! Closing files
call cg_close_f(fin1, ier)
call cg_close_f(fin2, ier)

(abbr.)

Table 3-2 shows the source code the analysis program that reads calculation result from CGNS file, and
executes fish habitat analysis.

29
 Table 3-2 Source code that reads calculation result from CGNS file and output analysis result
program SampleProgram2
implicit none
include 'cgnslib_f.h'

integer icount
character(len=300) cgnsfile

integer:: fin1, fin2, ier, istatus

character(len=300) param_inputfile
integer:: param_result
character(len=100) param_resultother
integer:: param_func_size
double precision, dimension(:), allocatable:: param_func_param
double precision, dimension(:), allocatable:: param_func_value
character(len=100) resultname

integer:: isize, jsize

double precision, dimension(:,:), allocatable:: grid_x, grid_y
double precision, dimension(:,:), allocatable:: target_result
double precision, dimension(:,:), allocatable:: analysis_result
double precision:: tmp_target_result
double precision:: tmp_analysis_result

integer:: i, j, f, solid, solcount, iter

double precision:: t

! Code for Intel Fortran

icount = nargs()
if (icount.eq.2) then
call getarg(1, cgnsfile, istatus)
else
write(*,*) "Input File not specified."
stop
end if

! Opening CGNS file

call cg_open_f(cgnsfile, CG_MODE_MODIFY, fin1, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"
! Initializing internal variables
call cg_iric_init_f(fin1, ier)

! Read analysis conditions

call cg_iric_read_string_mul_f(fin1, 'inputfile', param_inputfile, ier)
call cg_iric_read_integer_mul_f(fin1, 'result', param_result, ier)
call cg_iric_read_string_mul_f(fin1, 'resultother', param_resultother, ier)

call cg_iric_read_functionalsize_mul_f(fin1, 'func', param_func_size, ier)

allocate(param_func_param(param_func_size), param_func_value(param_func_size))
call cg_iric_read_functional_mul_f(fin1, 'func', param_func_param, param_func_value, ier)

if (param_result .eq. 0) resultname = 'Depth(m)'

if (param_result .eq. 1) resultname = 'Elevation(m)'
if (param_result .eq. 2) resultname = param_resultother

! Read grid from the specified CGNS file

call cg_open_f(param_inputfile, CG_MODE_READ, fin2, ier)
if (ier /=0) STOP "*** Open error of CGNS file 2 ***"
call cg_iric_initread_f(fin2, ier)

! Reads grid
call cg_iric_gotogridcoord2d_mul_f(fin2, isize, jsize, ier)

30
 allocate(grid_x(isize, jsize), grid_y(isize, jsize))
call cg_iric_getgridcoord2d_mul_f(fin2, grid_x, grid_y, ier)

! Output the grid to CGNS file

call cg_iric_writegridcoord2d_mul_f(fin1, isize, jsize, &
grid_x, grid_y, ier)

! Allocate memory used for analysis

allocate(target_result(isize, jsize), analysis_result(isize, jsize))

! Start analysis of calculation results

call cg_iric_read_sol_count_mul_f(fin2, solcount, ier)

do solid = 1, solcount
! Read calculation result
call cg_iric_read_sol_time_mul_f(fin2, solid, t, ier)
call cg_iric_read_sol_real_mul_f(fin2, solid, resultname, &
target_result, ier)

! Do fish habitat analysis

do i = 1, isize
do j = 1, jsize
tmp_target_result = target_result(i, j)
do f = 1, param_func_size
if ( &
param_func_param(f) .le. tmp_target_result .and. &
param_func_param(f + 1) .gt. tmp_target_result) then
tmp_analysis_result = &
param_func_value(f) + &
(param_func_value(f + 1) - param_func_value(f)) / &
(param_func_param(f + 1) - param_func_param(f)) * &
(tmp_target_result - param_func_param(f))
endif
end do
analysis_result(i, j) = tmp_analysis_result
end do
end do

! Output analysis result

call cg_iric_write_sol_time_mul_f(fin1, t, ier)
call cg_iric_write_sol_real_mul_f(fin1, 'fish_existence', analysis_result, ier)
end do

! Close CGNS files

call cg_close_f(fin1, ier)
call cg_close_f(fin2, ier)
stop
end program SampleProgram2

31
4. Steps of developing a grid generating program

4.1. Abstract

Grid generating program is a program that load grid creating conditions and generate a grid. The program can
be used seamlessly from iRIC as one of the grid generating algorithms.
To add a grid generating program that can be used from iRIC, it is necessary to make and deploy files shown
in Table 4-1.
“iRIC 2.0” folder and “gridcreators” folder in Table 4-1 have been already created when you installed iRIC.
Grid generating program developers have to create a new folder under “gridcreators” folder, and deploy files
related to the new grid generating program under that.

Table 4-1 Files and folders related to grid generating programs

Item Description Refer to
iRIC 2.0 Installation folder of iRIC 2.0 (e.g.: C:¥Program Files¥iRIC 2.0)

gridcreators Folder for storing grid generating programs

(generator folder) Create one folder for each grid generating program. Give the folder any
4.2
name.

definition.xml Grid generating program definition file. 4.3

generator.exe Executable module of the grid generating program. Developers can select
4.4
any name.

translation_ja_JP.ts etc. Dictionary files for a grid generating program definition file. 4.5

README File that explains the grid generating program 4.6

Abstracts of each file are as follows:

definition.xml
File that defines the following information of grid generating programs:
• Basic Information
• Grid generating condition
iRIC loads definition.xml, and provides interface for creating grid generating conditions that can be used by
the grid generating program. iRIC make the grid generating program available only when the solver supports
the grid type that the grid generating program generate.
definition.xml should be written in English.

Grid Generating program

Executable module of a grid generating program. It loads grid generating condition, generate a grid, and
outputs it.
Grid generating programs use grid generating data file created by iRIC, for loading and writing grid
generating condition and grids.

32
Grid generating programs can be developed using FORTRAN, C, or C++. In this chapter, a sample grid
generating program is developed in FORTRAN.

translation_ja_JP.ts etc.
Dictionary files for a grid generating program definition file. It provides translation information for strings
shown on dialogs in iRIC. Dictionary files are created one file for each language. For example,
“translation_ja_JP.ts” for Japanese, “translation_ka_KR.ts” for Korean.

README
README is a text file that describes about the grid generating program. The content of README is shown
in the “Description” area on [Select Grid Creating Algorithm] dialog].

Figure 4-1 shows the relationship between iRIC, grid generating program and related files.

Grid generating program Dictionary File README

definition file

iRIC

Grid generating condition Grid

Provides interface to input grid

generating contidion Grid generating data file

Grid generating condition Grid

I/O Library (iRIClib)

Grid generating program

凡例

Program

Library that iRIC provide

Files

Figure 4-1 The relationships between iRIC, grid generating programs, and related files

This chapter explains the steps to create the files described in this section in order.

33
4.2. Creating a folder

Create a special folder for the grid generating program you develop under “solvers” folder under the
installation folder of iRIC (The default place is “C:¥Program Files¥iRIC 2.0”). This time, please create
“example” folder.

4.3. Creating a grid generating program definition file

Create a grid generating program definition file.

In grid generating program definition file, you are going to define the information shown in Table 4-2

Table 4-2 Information defined in grid generating program definition file

Item Description Required
Basic Information The grid generator name, developer Yes
name,release date etc.

Grid Generating Condition Grid generating condition required for the Yes

argorithmn.

Error Codes Error codes and message that correspond to the

code.

Grid generating program definition file is described in XML language. The basic grammer of XML language
is explained in Section 5.6.
In this section, we add definition information of a grid generating program in the order shown in Table 4-2.

34
4.3.1. Defining basic information

Define basic information of a grid generating program. Create a file with the content shown in Table 2-3, and
save it with name “definition.xml” under “example” folder that you created in section 4.2.

Table 4-3 Example grid generating program definition file that contains basic information
<?xml version="1.0" encoding="UTF-8"?>
<GridGeneratorDefinition
name="samplecreator"
caption="Sample Grid Creator"
version="1.0"
copyright="Example Company"
executable="generator.exe"
gridtype="structured2d"
>
<GridGeneratingCondition>
</GridGeneratingCondition>
</GridGeneratorDefinition>

At this point, the structure of the grid generating program definition file is as shown inTable 4-4.

Table 4-4 Grid generating program definition file structure

Element Note
GridGeneratorDefinition Basic information is defined here.
GridGeneratingCondition Define grid generating conditions here. It is empty now.

Now make sure the grid generating file definition file is arranged correctly.
Launch iRIC. The [iRIC Start Page] dialog (Figure 4-2) is shown, so click on [New Project]. Now the [Solver
Select] dialog (Figure 4-3) will open, so select “Nays2D” in the solver list, and click on [OK]. The new
project will start.
Open the [Select Grid Creating Algorithm] dialog (Figure 4-4) by processing the following action.

Menu bar: Grid(G) ► [Select Algorithm to Create Grid] (S)

Check that the “Sample Grid Creator” is added in the list. When you finish checking, close the dialog by
clicking on [Cancel].

35
 Click on this.

Figure 4-2 The [iRIC Start Page] dialog

Select “Nays2D” here, and

click on [OK].

Figure 4-3 The [Select Solver] dialog

36
 This item is added.

Figure 4-4 The [Select Grid Creating Algorithm] dialog

4.3.2. Defining grid generating conditions

Define grid generating conditions. Grid generating conditions are defined in “GridGeneratingCondition”
element in a grid generating program definition file. Add description of grid generating condition to the grid
generating program definition file you created in Section 4.3.1, and overwrite it. Grid generating program
definition file content is now as shown in Table 4-5. The added part is shown with bold style.

Table 4-5 Example of grid generating program definition file that now has grid generating condition definition
<?xml version="1.0" encoding="UTF-8"?>
<GridGeneratorDefinition
name="samplecreator"
caption="Sample Grid Creator"
version="1.0"
copyright="Example Company"
executable="generator.exe"
gridtype="structured2d"
>
<GridGeneratingCondition>
<Tab name="size" caption="Grid Size">
<Item name="imax" caption="IMax">
<Definition valueType="integer" default="10" max="10000" min="1" />
</Item>
<Item name="jmax" caption="JMax">
<Definition valueType="integer" default="10" max="10000" min="1" />
</Item>
</Tab>
</GridGeneratingCondition>
</GridGeneratorDefinition>

At this point, the structure of the grid generating program definition file is as shown in Table 4-6.

Table 4-6 Grid generating program definition file structure

37
 Element Notes
GridGeneratorDefinition Basic Information is defined here.
GridGeneratingCondition Grid generating condition is defined here.
Tab Grid generating condition group
Item Grid generating condition name
Definition Grid generating condition attributes
Item Grid generating condition name
Definition Grid generating condition attributes

Now make sure that grid generating program definition file is arranged correctly.
Launch iRIC, and opens the [Select Grid Generating Algorithm] dialog with the same procedure in Section
4.3.1. Select “Sample Grid Creator” in the list, and click on [OK].
The [Grid Creation] dialog (Figure 4-5) will open. Now you can see that the grid generating condition items
you defined are shown. When you checked, click on [Cancel] to close the dialog.

Figure 4-5 The [Grid Creation] dialog

Now add one more group and add grid generating condition items. Add “Elevation Output” Tab element just
under “Grid Size” Tab element. The added part is shown with bold style.

Table 4-7 Example of grid generating program definition file that now has grid generating condition definition
(abbr.)
</Tab>
<Tab name="elevation" caption="Elevation Output">
<Item name="elev_on" caption="Output">
<Definition valueType="integer" default="0">
<Enumeration caption="Enabled" value="1" />
<Enumeration caption="Disabled" value="0" />
</Definition>
</Item>
<Item name="elev_value" caption="Value">
<Definition valueType="real" default="0">
<Condition type="isEqual" target="elev_on" value="1" />
</Definition>
</Item>
</Tab>
</GridGeneratingCondition>
</GridGeneratorDefinition>

At this Point, the structure of grid generating program definition file is as shown in Table 4-8.

Table 4-8 Grid generating program definition file structure

38
 Element Notes
GridGeneratorDefinition Basic Information is defined here.
GridGeneratingCondition Grid generating condition is defined here.
Tab Grid generating condition group
(abbr.)
Tab Grid generating condition group
Item Grid generating condition name
Definition Grid generating condition attributes
Enumeration Option to select as condition value
Enumeration Option to select as condition value
Item Grid generating condition name
Definition Grid generating condition attributes
Condition Condition that this condition is enabied

Now make sure that grid generating program definition file is arranged correctly. Do the operation you did
again, to show the [Grid Creation] dialog (Figure 4-6). Now you’ll see that the new group “Elevation Output”
in the group list. You’ll also notice that “Value” item is enabled only when “Output” value is “Enabled”.

This item is added

This item is enabled only

when “Enabled” is selected
as “Output” value.

Figure 4-6 The [Grid Creation] dialog

What it comes down to is:

 Grid generating condition group is defined with “Tab” element, and grid generating condition item is
defined with “Item” element.
 The Structure under “Definition” elements depends on the condition type (i. e. Integer, Real number,
functional etc.). Refer to Section 5.3.1 for examples of grid generating condition items for each type.
 Dependenciy between grid generating condition items can be defined with “Condition” element. In
“Condition” element, define the condition when that item should be enabled. Refer to Section 5.3.2 for
examples of “Condition” element.
 In this example, the calculation condition dialog shows the items as a simple list, but iRIC has feature
to show items with more complex layouts, like layout with group boxes. Refer to Section 5.3.3 for
more complex calculation condition page layouts.

4.3.3. Defining error codes

Define error codes of errors that occurs in grid generating program, and the messages that correspond to them.
Error codes can be defined with ErrorCode elements in grid generating program definition file. Add

39
definitions to the definition file you created, as shown in Table 4-9. The added poart is shown with bold style.

Table 4-9 Example of grid generating program definition file that now has error codes
(前略)
</Item>
</Tab>
</GridGeneratingCondition>
<ErrorCodes>
<ErrorCode value="1" caption="IMax * JMax must be smaller than 100,000." />
</ErrorCodes>
</GridGeneratorDefinition>

At this Point, the structure of grid generating program definition file is as shown in Table 4-10. The
ErrorCodes element is not required.

Table 4-10 The grid generating program definition file structure

Element Notes
GridGeneratorDefinition Basic Information is defined here.
GridGeneratingCondition Grid generating condition is defined here.
(abbr.)
ErrorCodes
ErrorCode Error code is defined here.

You can not check whether ErrorCode element is properly defined until you create a grid generating program.
You are going to check it in Section 4.4.5.

40
4.4. Creating a grid generating program

Create a grid generating program. In this example we will develop a grid generating program with
FORTRAN.
To develop a grid generating program that works together with iRIC, you have to make it use grid generating
data file that iRIC generate, for loading grid generation conditions and outputting a grid.
The grid generating data file that iRIC generates is a CGNS file. You can use a library called iRIClib to write
code for loading and writing CGNS files.
In this section, We’ll explain the procedure to develop a grid generating program that load calculation data file,
that iRIC generates.
Table 2-11 shows the input and output processing that the grid generating program do against the grid
generating data file.

Table 4-11 The I/O processing flow of grid generating program

Processing Required
Opens grid generating data file Yes

Initializes iRIClib Yes

Loads grid generating condition Yes

Outputs grid Yes

Closes grid generating data file Yes

In this section, we will develop a grid generating program in the following procedure:
 Create a scelton
 Adds grid generating data file opening and closing codes
 Adds codes to output grid
 Adds codes to load grid generating conditions
 Adds codes for error handling

41
4.4.1. Creating a scelton

First, create a scelton of a grid generating program. Create a new file with the source code in Table 4-12, and
save as “sample.f90”. At this point, the grid generating program does nothing.
Compile this source code. The way to compile a source code differs by the compiler. Refer to Section 7.2.1 for
the procedure to compile using gfortran and Intel Fortran Compiler.

Table 4-12 Sample grid generating program source code

program SampleProgram
implicit none
include 'cgnslib_f.h'

end program SampleProgram

Make sure that the compilation succeeds.

42
4.4.2. Adding grid generating data file opening and closing codes

Adds codes for opening and closing grid generating data file.
The grid generating program has to open calculation data file in the first step, and close it in the last step.
iRIC will handle the file name of grid generating data file as the first argument, so open that file.
The way to handle the number of arguments and the arguments differs by compilers. Refer to Section 7.1 for
the way to handle them with gfortran and Intel Fortran Compiler. In this chapter we will add codes that can be
compiled using Intel Fortran Compiler.
Table 4-13 shows the source code with the lines to open and close grid generating data file. The added lines
are shown with bold style.

Table 4-13 The source code with lines to open and close file

program SampleProgram
implicit none
include 'cgnslib_f.h'

integer:: fin, ier

integer:: icount, istatus

character(200)::condFile

icount = nargs()
if ( icount.eq.2 ) then
call getarg(1, condFile, istatus)
else
stop "Input File not specified."
endif

! Opens grid generating data file

call cg_open_f(condFile, CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib. ier will be 1, but that is not a problem.

call cg_iric_init_f(fin, ier)

! Closes grid generating data file

call cg_close_f(fin, ier)
end program SampleProgram

Compile the executable file, just like in Section 4.4.1.

Check that the source code can be compiled successfully.
Refer to Section 6.3.2, 6.3.3 and 6.3.12 for the details of the subroutines added in this section.

43
4.4.3. Adding codes to output a grid

Adds codes to output grid.

First, add codes to output a very simple grid, to check whether the program works together with iRIC
successfully.
Table 4-14 shows the source code with lines to output grid. The added lines are shown with bold style.

Table 4-14 The source code with lines to output grid

program SampleProgram
implicit none
include 'cgnslib_f.h'

integer:: fin, ier

integer:: icount, istatus
integer:: imax, jmax
double precision, dimension(:,:), allocatable::grid_x, grid_y
character(200)::condFile

icount = nargs()
if ( icount.eq.2 ) then
call getarg(1, condFile, istatus)
else
stop "Input File not specified."
endif

! Opens grid generating data file.

call cg_open_f(condFile, CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib. ier will be 1, but that is not a problem.

call cg_iric_init_f(fin, ier)

imax = 10
jmax = 10

! Allocate memory for creating grid

allocate(grid_x(imax,jmax), grid_y(imax,jmax)

! Generate grid
do i = 1, imax
do j = 1, jmax
grid_x(i, j) = i
grid_y(i, j) = j
end do
end do

! Outputs grid
cg_iric_writegridcoord2d_f(imax, jmax, grid_x, grid_y, ier)

! Closes grid generating data file.

call cg_close_f(fin, ier)
end program SampleProgram

44
When it was compiled successfully, copy the executable file to the folder you created in Section 4.2, and
rename it into the name you specified as [executable] attribute in Section 4.3.1. This time, rename into
“generator.exe”. Copy the DLL files into that folder, that is need to run the grid generating program.
Now check whether the grid generating program can be launched from iRIC successfully.
Starts a new project with solver “Nays2D”, and select “Sample Grid Creator” as the grid generating algorithm
like in Section 2.3.1. The [Grid Creation] dialog (Table 4-7) will open.

Figure 4-7 The [Grid Creation] dialog

Click on [Create Grid], and a 10 x 10 grid will be created and loaded on the pre-processing window (Table
4-8).

Figure 4-8 The pre-processing window after creating grid

45
Refer to Section 0 for the detail of subroutines to output grids. Note that in Section 0 the subroutines to output
three-dimensional grids are listed, but they can not be used in grid generating programs. In grid generating
programs, only subroutines to output two-dimensional grids can be used.

46
4.4.4. Adding codes to load grid generating condition

Adds codes to load grid generating conditions.

iRIC will output grid generating conditions according to the grid generating program definition file. So, the
grid generating program have to load them to coincide with the description in the grid generating program
definition file.
Table 2-14 shows the source code with lines to load grid generating condition. The added lines are shown with
bold style. Note that the arguments passed to load grid generating conditions are the same to the [name]
attributes of Items defined in Section 4.3.2.
When it is compiled successfully, create a grid from iRIC in the procedure same to Section 4.4.3, and the grid
will be created with the condition you specified on [Grid Creation] dialog.
Refer to 5.3.1 for the relation between definitions of grid generating condition and the iRIClib subroutines to
load them. Refer to 6.3.4 for the detail of subroutines to load grid generating conditions.

47
 Table 4-15 Source codewith lines to load grid generating conditions
program SampleProgram
implicit none
include 'cgnslib_f.h'

integer:: fin, ier

integer:: icount, istatus
integer:: imax, jmax
integer:: elev_on
double precision:: elev_value
double precision, dimension(:,:), allocatable::grid_x, grid_y
double precision, dimension(:,:), elevation

character(200)::condFile

icount = nargs()
if ( icount.eq.2 ) then
call getarg(1, condFile, istatus)
else
stop "Input File not specified."
endif

! Opens grid generating data file.

call cg_open_f(condFile, CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib. ier will be 1, but that is not a problem.

call cg_iric_init_f(fin, ier)

! Loads grid generating condition

! To make it simple, no error handling codes are written.
call cg_iric_read_integer_f("imax", imax, ier)
call cg_iric_read_integer_f("jmax", jmax, ier)
call cg_iric_read_integer_f("elev_on", elev_on, ier)
call cg_iric_read_real_f("elev_value", elev_value, ier)

! Allocate memory for creating grid

allocate(grid_x(imax,jmax), grid_y(imax,jmax)
allocate(elevation(imax,jmax))

! Generate grid
do i = 1, isize
do j = 1, jsize
grid_x(i, j) = i
grid_y(i, j) = j
elevation(i, j) = elev_value
end do
end do

! Outputs grid
cg_iric_writegridcoord2d_f(imax, jmax, grid_x, grid_y, ier)
if (elev_on == 1) then
cg_iric_write_grid_real_node_f("Elevation", elevation, ier);
end if

! Closes grid generating data file.

call cg_close_f(fin, ier)
end program SampleProgram

48
4.4.5. Adding error handling codes

Adds error handling code, to support cases that grid generating conditions have some problems.
Table 5-16 shows the source code with lines to handle errors. The added lines are shown with bold style. With
the lines added, the grid generating program will return error when the number of grid nodes exceeds 100000.
When it is compiled successfully, create a grid with the algorithm in tha same way to Section 4.3.2. Check
that when you specify big imax and jmax values, the [Error] dialog (Figure 4-9) will open.
Refer to Section 6.3.12 for the subroutines to output error codes.

Table 4-16 Source code with lines to handle errors

(abbr.)

! Loads grid generating condition

! To make it simple, no error handling codes are written.
call cg_iric_read_integer_f("imax", imax, ier)
call cg_iric_read_integer_f("jmax", jmax, ier)
call cg_iric_read_integer_f("elev_on", elev_on, ier)
call cg_iric_read_real_f("elev_value", elev_value, ier)

! Error handling
if (imax * jmax > 100000 ) then
! It is now possible to create a grid with more than 100000 nodes
call cg_iric_write_errorcode(1, ier)
cg_close_f(fin, ier)
stop
endif

! Allocate memory for creating grid

allocate(grid_x(imax,jmax), grid_y(imax,jmax)
allocate(elevation(imax,jmax))

(abbr.)

Figure 4-9 The [Error] dialog

49
4.5. Creating a grid generating program definition dictionary file

Create a grid generating program definition dictionary file that is used to translate the strings used in grid
generating program definition files, and shown on dialogs etc.
First, launch iRIC and perform the following:

Menu bar: [Option] (O) ► [Create/Update Translation Files] (C)

The [Definition File Translation Update Wizard] (Figure 2-15 to Figure 2-17) will open. Following the wizard,
the dictionary files are created or updated.

Click on this

Figure 4-10 The [Definition File Translation Update Wizard] (Page 1)

Select a grid generating program

Select the language you want to

generate a dictionary file

Click on this

Figure 4-11 The [Definition File Translation Update Wizard] (Page 2)

50
 Check the files that are going to
generated.

Click on this.

Figure 4-12 The [Definition File Translation Update Wizard] (Page 3)

The dictionary files are created in the folder that you created in Section 4.2. The files created only include the
strings before the translation (i. e. English strings). The dictionary files are text files, so you can use text
editors to edit it. Save the dictionary files with UTF-8 encoding.
Table 4-17 and Table 4-18 show the example of editing a dictionary file. As the example shows, add translated
string in “translation” element.

Table 4-17 The Dictionary file of grid generating program definition file (before editing)
<message>
<source>Sample Grid Creator</source>
<translation></translation>
</message>

Table 4-18 The Dictionary file of grid generating program definition file (after editing)
<message>
<source>Sample Grid Creator</source>
<translation>サンプル格子生成プログラム</translation>
</message>

You can use [Qt Linguist] for translating the dictionary file. [Qt Linguist] is bundled in Qt, and it provides
GUI for editing the dictionary file. Figure 4-13 shows the [Qt Linguist]. Qt can be downloaded from the
following URL:
http://qt.nokia.com/downloads/windows-cpp-vs2008

51
 Select the target source text

The source text

Imput translation here.

Figure 4-13 The [Qt Linguist]

When the translation is finished, switch the iRIC language from Preferences dialog, restart iRIC, and check
whether the translation is complete. Figure 4-14 shows an example of [Grid Creation] dialog after completing
transtaion of dictionary.

Figure 4-14 The [Grid Creation] dialog

52
4.6. Creating a README file

Creates a text file that explains the abstract of the grid generating program.
Creates a text file with name “README” in the folder you created in Section 4.2. Save the file with UTF-8
encoding.
You should create the README file with the file names like below. When the language-specific README
file does not exists, “README” file (in English) will be used.
English: “README”
Japanese: “README_ja_JP”

The postfix (ex. “ja_JP”) is the same to that for dictionary files created in Section 4.5.
The content of “README” will be shown in “Description” area on the [Select Grid Creating Algorithm]
dialog. When you created “README”, opens the [Select Grid Creating Algorithm] dialog, and check whether
the content is shown on that dialog.
Figure 4-15 shows an example of the [Select Grid Creating Algorithm] dialog.

The content of README is shown here.

Figure 4-15 The [Select Grid Creating Algorithm] dialog

53
5. About definition files (XML)

5.1. Abstract

iRIC loads definition files (solver definition files and grid generating program definition files), and provides
graphic interface to create input data for the corresponding programs (solvers and grid generating programs).

5.2. Structure

Structures of solver definition files, grid generating program definition files are described in this section.

5.2.1. Solver definition file

Structure of solver definition files for a solver that uses only one calculation grids is shown in Table 5-1, and
that for a solver that uses multiple types of calculation grids is shown in Table 5-2, respectively.

Table 5-1 Structure of solver definition file

Element Description Required?
SolverDefinition Basic Information Yes
CaｌculationCondition Calculation conditions Yes
Tab Calculation condition group
Item Calculation condition element
Definition Calculation condition definition
Condition Condition when calculation condition is active
Item
Definition
Condition
・・・
Tab
・・・
・・・
GridRelatedCondition Grid attributes at nodes or cells Yes
Item
Item
BoundaryCondition Boundary conditions
Item Boundary condition element
Definition Boundary condition definition
Condition Condition when boundary condition is active
Item
Definition
Condition

54
 Table 5-2 Structure of solver definition files for a solver that uses multiple grid types
Element Description Required?
SolverDefinition Basic Information Yes
CaｌculationCondition Calculation conditions Yes
Tab Calculation condition group
Item Calculation condition element
Definition Calculation condition definition
Condition Condition when calculation condition is active
Item
Definition
Condition
・・・
Tab
・・・
・・・
GridTypes
GridType Grid Type
GridRelatedCondition Grid attributes at nodes or cells Yes
Item
・・・
BoundaryCondition Boundary conditions
Item Boundary condition element
Definition Boundary condition definition
Condition Condition when boundary condition is active
・・・
GridType
GridRelatedCondition Grid attributes at nodes or cells
・・・
BoundaryCondition Boundary conditions
・・・

When the solver uses multiple types of grids, Solver developers should add multiple GridType elements, and
defines grid structure, grid attributes, and boundary conditions at the nodes under each GridType element.
An example of solver definition file for a solver that uses multiple grid types, is shown in Table 5-3. In this
example, boundary condition definition is dropped, because that is not required. Please pay attention that the
following point is different:
 Grid structure (gridtype attribute) is not definied in SolverDefinition elemenet, but in GridType
elements.
When a user creates a new project and selects a solver that bundles the solver definition shown in Table 5-3,
a new pre-processor in Figure 5-1 is shown.

55
Table 5-3 An example of solver definition file for a solver that uses multiple types of grids
<?xml version="1.0" encoding="UTF-8"?>
<SolverDefinition
name="multigridsolver"
caption="Multi Grid Solver"
version="1.0"
copyright="Example Company"
release="2012.04.01"
homepage="http://example.com/"
executable="solver.exe"
iterationtype="time"
>
<CalculationCondition>
<!-- Define calculation conditions here. -->
</CalculationCondition>
<GridTypes>
<GridType name=”river” caption=”River”>
<GridRelatedCondition>
<Item name=”Elevation” caption=”Elevation”>
<Definition valueType=”real” position=”node” />
</Item>
<Item name=”Roughness” caption=”Roughness”>
<Definition valueType=”real” position=”node”/>
</Item>
<Item name=”Obstacle” caption=” Obstacle”>
<Definition valueType=”integer” position=”cell”/>
</Item>
</GridRelatedCondition>
</GridType>
<GridType name=”floodbed” caption=”Flood Bed”>
<GridRelatedCondition>
<Item name=”Elevation” caption=”Elevation”>
<Definition valueType=”real” position=”node” />
</Item>
</GridRelatedCondition>
</GridType>
</GridTypes>
</SolverDefinition>

[Geographic Data], [Grid] nodes

are shown for each grid type.

Figure 5-1 Pre-processor image after loading the solver definition file shown in Table 5-3

56
5.2.2. Grid generating program definition file

Structure of grid generating program definition file is shown in Table 5-4.

Table 5-4 Structure of grid generating program definition file

Element Description Required?
GridGeneratorDefinition Basic information Yes
GridGeneratingConditionGrid generating condition Yes
Tab Grid generating condition group
Item Grid generating condition element
Definition Grid generating condition definition
Condition Condition when grid generatin condition is active
Item Grid generating condition element
Definition
Condition
・・・
Tab
・・・
・・・

57
5.3. Examples

5.3.1. Examples of calculation conditions, boundary conditions, and grid generating condition

Example of definitions of calculating conditions in solver definition files, grid generating condition if grid
generating program definition file is shown in this section. The position to describe the definition differs like
shown in Table 5-5, but the grammers are the same. Refer to 5.2 for the whole structure of each file.

Table 5-5 Position to define definition elements

Item Target file Definition position
Calculation condition Solver definition file Under CalculationCondition element
Grid generating Grid generating program Under GridGeneratingCondition
condition definition file element

The types of items available, are shown in Table 5-6. In this subsection, the followings are described fore each
type:
• Definition example
• Example of the corresponding widget shown on calculation condition edit dialog in iRIC
• Code example to load the values in solvers (or grid generating program).

In code examples to load the values, subroutines in iRIClib are used. Please refer to Chapter 6 to know more
about iRIClib. The examples only show the sample codes for loading, so please refer to Section 2.3, 4.4 to see
examples of whole programs.

58
 Table 5-6 Types of calculation conditions and grid generating conditions
No. Type Description Definition Page
1 String Input string value Specify “string” for valueType 60

2 File name Input file name for reading. Users Specify “filename” for 61

(For reading) can select only files that already valueType

exist.
3 File name Input file name for writing. Users Specify “filename_all” for 62

(For writing) can select any file name, including valueType

those does not exists.
4 Folder name Input folder name. Specify “foldername” for 63

valueType
5 Integer Input arbitrary integer value. Specify “integer” for valueType 64

6 Integer (Choice) Select integer value from choices. Specify “integer” for valueType, 65

and define choises with

Enumeration elements
7 Real number Input arbitrary real number value. Specify “real” for valueType 66

8 Functional Input pairs of (X, Y) values. Specify “functional” for 67

valueType and define variable

and value with a Parameter
element and a Value element.
9 Functional (with Input trinity of (X, Y1, Y2) values. Specify “functional” for 69

multiple values) valueType and define one

Parameter element and two Value
elements.

59
1) String

Table 5-7 Example of a string type condition definition

<Item name=”sampleitem” caption=”Sample Item”>
<Definition valueType="string" />
</Item>

Figure 5-2 Widget example of a string type condition

Table 5-8 Code example to load a string type condition

(for calculation conditions and grid generating conditions)
integer:: ier
character(200):: sampleitem

call cg_iric_read_string_f(”sampleitem”, sampleitem, ier)

Table 5-9 Code example to load a string type condition

(for boundary conditions)
integer:: ier
character(200):: sampleitem

call cg_iric_read_bc_string_f(“inflow”, 1, ”sampleitem”, sampleitem, ier)

60
2) File name (for reading)

Table 5-10 Example of a file name type (for reading) condition definition
<Item name=”flowdatafile” caption=”Flow data file”>
<Definition valueType="filename" default=”flow.dat” />
</Item>

Click on this to show the dialog.

Figure 5-3 Widget example of a file name (for reading) type condition

Table 5-11 Code example to load a file name (for reading) type condition
(for calculation conditions and grid generating conditions)
integer:: ier
character(200):: flowdatafile

call cg_iric_read_string_f(”flowdatafile”, flowdatafile, ier)

Table 5-12 Code example to load a file name (for reading) type condition
(for boundary conditions)
integer:: ier
character(200):: flowdatafile

call cg_iric_read_bc_string_f(“inflow”, 1, ”flowdatafile”, flowdatafile, ier)

61
3) File name (for writing)

Table 5-13 Example of a file name (for writing) type condition definition
<Item name=”flowdatafile” caption=”Flow data file”>
<Definition valueType="filename_all" default=”flow.dat” />
</Item>

Click on this to show the dialog.

Figure 5-4 Widget example of a file name type (for writing) condition

Table 5-14 Code example to load a file name (for writing) type condition
(for calculation conditions and grid generating conditions)
integer:: ier
character(200):: flowdatafile

call cg_iric_read_string_f(”flowdatafile”, flowdatafile, ier)

Table 5-15 Code example to load a file name (for writing) type condition
(for boundary conditions)
integer:: ier
character(200):: flowdatafile

call cg_iric_read_bc_string_f(”inflow”, 1, ”flowdatafile”, flowdatafile, ier)

62
4) Folder name

Table 5-16 Example of a folder name type condition definition

<Item name=”flowdatafolder” caption=”Flow data folder”>
<Definition valueType="foldername" />
</Item>

Click on this to show the dialog.

Figure 5-5 Widget example of a folder name type condition

Table 5-17 Code example to load a folder name type condition

(for calculation conditions and grid generating conditions)
integer:: ier
character(200):: flowdatafolder

call cg_iric_read_string_f(”flowdatafolder”, flowdatafolder, ier)

Table 5-18 Code example to load a folder name type condition

(for boundary conditions)
integer:: ier
character(200):: flowdatafolder

call cg_iric_read_bc_string_f(”inflow”, 1, ”flowdatafolder”, flowdatafolder, ier)

63
5) Integer

Table 5-19 Example of a integer type condition definition

<Item name=”numsteps” caption=”The Number of steps to calculate”>
<Definition valueType="integer" default=”20” min=”1” max=”200”/>
</Item>

Figure 5-6 Widget example of a integer type condition

Table 5-20 Code example to load a integer type condition

(for calculation conditions and grid generating conditions)
integer:: ier, numsteps

call cg_iric_read_integer_f(”numsteps”, numsteps, ier)

Table 5-21 Code example to load a integer type condition

(for boundary conditions)
integer:: ier, numsteps

call cg_iric_read_bc_integer_f(”inflow”, 1, ”numsteps”, numsteps, ier)

64
6) Integer (Choice)

Table 5-22 Example of a integer (choise) type condition definition

<Item name=”flowtype” caption=”Flow type”>
<Definition valueType="integer" default=”0”>
<Enumeration value=”0” caption=”Static Flow”/>
<Enumeration value=”1” caption=”Dynamic Flow”/>
</Definition>
</Item>

Figure 5-7 Widget example of a integer (choice) type condition

Table 5-23 Code example to load a integer (choise) type condition

(for calculation conditions and grid generating conditions)
integer:: ier, flowtype

call cg_iric_read_integer_f(”flowtype”, flowtype, ier)

Table 5-24 Code example to load a integer (choise) type condition

(for boundary conditions)
integer:: ier, flowtype

call cg_iric_read_bc_integer_f(”inflow”, 1, ”flowtype”, flowtype, ier)

65
7) Real number

Table 5-25 Example of a real number type condition definition

<Item name=”g” caption=”Gravity [m/s2]”>
<Definition valueType="real" default=”9.8” />
</Item>

Figure 5-8 Widget example of a real number type condition

Table 5-26 Code example to load a real number type condition

(for calculation conditions and grid generating conditions)
integer:: ier
double precision:: g

call cg_iric_read_real_f(”g”, g, ier)

Table 5-27 Code example to load a real number type condition

(for boundary conditions)
integer:: ier
double precision:: g

call cg_iric_read_bc_real_f(”inflow”, 1, ”g”, g, ier)

66
8) Functional

Table 5-28 Example of a functional type condition definition

<Item name=”discharge” caption=”Discharge time series”>
<Definition valueType="functional" >
<Parameter valueType=”real” caption=”Time” />
<Value valueType=”real” caption=”Discharge” />
</Definition>
</Item>

Click on this to show the dialog.

Figure 5-9 Widget example of a functional type condition

Table 5-29 Code example to functional type condition

(for calculation conditions and grid generating conditions)
integer:: ier, discharge_size
double precision, dimension(:), allocatable:: discharge_time, discharge_value

! Read size
call cg_iric_read_functionalsize_f(“discharge”, discharge_size, ier)
! Allocate memory
allocate(discharge_time(discharge_size))
allocate(discharge_value(discharge_size))
! Load values into the allocated memory
call cg_iric_read_functional_f(“discharge”, discharge_time, discharge_value, ier)

67
 Table 5-30 Code example to functional type condition
(for boundary conditions)
integer:: ier, discharge_size
double precision, dimension(:), allocatable:: discharge_time, discharge_value

! Read size
call cg_iric_read_bc_functionalsize_f(”inflow”, 1, “discharge”, discharge_size, ier)
! Allocate memory
allocate(discharge_time(discharge_size))
allocate(discharge_value(discharge_size))
! Load values into the allocated memory
call cg_iric_read_bc_functional_f(”inflow”, 1, ”discharge”, discharge_time, discharge_value, ier)

68
9) Functional (with multiple values)

Table 5-31 Example of a functional (with multiple values) type condition definition
<Item name=”discharge_and_elev” caption=”Discharge and Water Elevation time series”>
<Definition valueType="functional" >
<Parameter name=”time” valueType=”real” caption=”Time” />
<Value name=”discharge” valueType=”real” caption=”Discharge” />
<Value name=”elevation” valueType=”real” caption=”Water Elevation” />
</Definition>
</Item>

This dialog is shown when the button is clicked.

Figure 5-10 Widget example of a functional (with multiple values) type condition

Table 5-32 Code example to load a functional (with multiple values) type condition
(for calculation conditions and grid generating conditions)
integer:: ier, discharge_size
double precision, dimension(:), allocatable:: time_value
double precision, dimension(:), allocatable:: discharge_value, elevation_value

! Read size
call cg_iric_read_functionalsize_f(“discharge”, discharge_size, ier)
! Allocate memory
allocate(time_value(discharge_size))
allocate(discharge_value(discharge_size), elevation_value(discharge_size))
! Load values into allocated memory
call cg_iric_read_functionalwithname_f(“discharge”, “time”, time_value)
call cg_iric_read_functionalwithname_f(“discharge”, “discharge”, discharge_value)
call cg_iric_read_functionalwithname_f(“discharge”, “elevation”, elevation_value)

69
 Table 5-33 Code example to load a functional (with multiple values) type condition
(for boundary condition)
integer:: ier, discharge_size
double precision, dimension(:), allocatable:: time_value
double precision, dimension(:), allocatable:: discharge_value, elevation_value

! Read size
call cg_iric_read_bc_functionalsize_f(“discharge”, discharge_size, ier)
! Allocate memory
allocate(time_value(discharge_size))
allocate(discharge_value(discharge_size), elevation_value(discharge_size))
! Load values into allocated memory
call cg_iric_read_bc_functionalwithname_f(“discharge”, “time”, time_value)
call cg_iric_read_bc_functionalwithname_f(“discharge”, “discharge”, discharge_value)
call cg_iric_read_bc_functionalwithname_f(“discharge”, “elevation”, elevation_value)

70
5.3.2. Example of condition to activate calculation conditions etc.

Examples of conditions to activate calculation conditions, grid generating conditions, and boundary conditions
are shown in this subsection. As these examples show, complex conditions can be defined using conditions
with types “and” and “or”.

1) var1 = 1
<Condition type=”isEqual” target="var1" value="1" />

2) (var1 = 1) ∪ (var 2 > 3)

<Condition type=”or”>
<Condition type=”isEqual” target="var1" value="1" />
<Condition type="isGreaterThan" target="var2" value="3" />
</Condition>

3) ((var1 = 1) ∪ (var 2 < 5) ) ∩ (var 3 = 100)

<Condition type=”and”>
<Condition type=”or”>
<Condition type=”isEqual” target="var1" value="1" />
<Condition type=”isLessThan” target="var2" value="5" />
</Condition>
<Condition type=”isEqual” target="var3" value="100" />
</Condition>

71
5.3.3. Example of dialog layout definition

1) Simple layout

Simple layout (that only uses Item elements) example definition is shown in Table 5-34, and the
corresponding dialog is shown in Figure 5-11.

Table 5-34 Simple layout definition example

<Tab name="simple" caption="Simple">
<Item name="jrep" caption="Periodic boundary condition">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Disabled"/>
<Enumeration value="1" caption="Enabled"/>
</Definition>
</Item>
<Item name="j_wl" caption="Water surface at downstream">
<Definition valueType="integer" default="1">
<Enumeration value="0" caption="Constant value"/>
<Enumeration value="1" caption="Uniform flow"/>
<Enumeration value="2" caption="Read from file"/>
</Definition>
</Item>
<Item name="h_down" caption=" Constant value (m)">
<Definition valueType="real" default="0" />
</Item>
<Item name="j_slope" caption=" Slope for uniform flow">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Calculated from geographic data"/>
<Enumeration value="1" caption="Constant value"/>
</Definition>
</Item>
<Item name="bh_slope" caption=" Slope value at downstream">
<Definition valueType="real" default="0.001">
</Definition>
</Item>
<Item name="j_upv" caption="Velocity at upstream">
<Definition valueType="integer" default="1">
<Enumeration value="1" caption="Uniform flow"/>
<Enumeration value="2" caption="Calculated from upstream depth"/>
</Definition>
</Item>
<Item name="j_upv_slope" caption=" Slope for uniform flow">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Calculated from geographic data"/>
<Enumeration value="1" caption="Constant value"/>
</Definition>
</Item>
<Item name="upv_slope" caption=" Slope value at upstream">
<Definition valueType="real" default="0.001">
</Definition>
</Item>
</Tab>

72
Figure 5-11 Dialog example that corresponds to the definition in Table 5-34

73
2) Layout that uses Group boxes

Layout example that uses group boxes is shown in ???, and the corresponsing dialog is shown in ???.
GroupBox elements can be used to define groups of items.

Table 5-35 Layout definition example that uses group boxes

<Tab name="grouping" caption="Group">
<Item name="g_jrep" caption="Periodic boundary condition">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Disabled"/>
<Enumeration value="1" caption="Enabled"/>
</Definition>
</Item>
<GroupBox caption="Water surface at downstream">
<Item name="g_j_wl" caption="Basic Setting">
<Definition valueType="integer" default="1">
<Enumeration value="0" caption="Constant value"/>
<Enumeration value="1" caption="Uniform flow"/>
<Enumeration value="2" caption="Read from file"/>
</Definition>
</Item>
<Item name="g_h_down" caption="Constant value (m)">
<Definition valueType="real" default="0" />
</Item>
<Item name="g_j_slope" caption="Slope for uniform flow">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Calculated from geographic data"/>
<Enumeration value="1" caption="Constant value"/>
</Definition>
</Item>
<Item name="g_bh_slope" caption="Slope value at downstream">
<Definition valueType="real" default="0.001">
</Definition>
</Item>
</GroupBox>
<GroupBox caption="Velocity at upstream">
<Item name="g_j_upv" caption="Basic Setting">
<Definition valueType="integer" default="1">
<Enumeration value="1" caption="Uniform flow"/>
<Enumeration value="2" caption="Calculated from upstream depth"/>
</Definition>
</Item>
<Item name="g_j_upv_slope" caption="Slope for uniform flow">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Calculated from geographic data"/>
<Enumeration value="1" caption="Constant value"/>
</Definition>
</Item>
<Item name="g_upv_slope" caption="Slope value at upstream">
<Definition valueType="real" default="0.001">
</Definition>
</Item>
</GroupBox>
</Tab>

74
Figure 5-12 Dialog example that corresponds to the definition in Table 5-35

75
 3) Free layout

Free layout example, that uses GridLayout element, is shown in Table 5-36 and the corresponsing dialog is
shown in Figure 5-13.
GridLayout, HBoxLayout, VBoxLayout can be used to layout widgets freely. When using these elements for
layouting, caption attributes are not used to show labels, but Label elements are used to show labels instead.
GridLayout, HBoxLayout, VBoxLayout elements can be used recursively. GroupBox element can be used
inside these elements freely.

Table 5-36 Free layout definition example

<Tab name="roughness" caption="Roughness">
<Item name="diam" caption="Diameter of uniform bed material (mm)">
<Definition valueType="real" default="0.55" />
</Item>
<Item name="j_drg" caption="Bed roughness">
<Definition valueType="integer" default="0">
<Enumeration value="0" caption="Calculated from bed material"/>
<Enumeration value="1" caption="Constant value"/>
<Enumeration value="2" caption="Read from file"/>
</Definition>
</Item>
<GroupBox caption="Manning's roughness parameter">
<GridLayout>
<Label row="0" col="0" caption="Low water channel" />
<Item row="1" col="0" name="sn_l">
<Definition valueType="real" default="0.01" />
</Item>
<Label row="0" col="1" caption="Flood channel" />
<Item row="1" col="1" name="sn_h">
<Definition valueType="real" default="0.01" />
</Item>
<Label row="0" col="2" caption="Fixed bed" />
<Item row="1" col="2" name="sn_f">
<Definition valueType="real" default="0.01" />
</Item>
</GridLayout>
</GroupBox>
<Item name="snfile" caption="Input file for Manning's roughness">
<Definition valueType="filename" default="Select File" />
</Item>
</Tab>

76
Figure 5-13 Dialog example that corresponds to the definition in Table 5-36

77
5.4. Elements reference

5.4.1. BoundaryCondition

BoundaryCondition element contains boundary condition information.

Table 5-37 Contents of BoundaryCondition element

Item Name Required? Type Meaning of value

Attribute name Yes String Name of element

caption Yes String String to be displayed.

position Yes Selection Definition position. Any one of the following:

• node
• cell
• edge

Element Item Yes Element Definition of element

More than one element can be had.

5.4.2. CalculationCondition

CalculationCondition element contains calculation condition information.

Table 5-38 Contents of CalculationCondition

Item Name Required? Type Meaning of value

Element Tab Tab element An element that contains information on a page (or tab) of the

calculation condition input dialog

More than one element can be had.

78
 5.4.3. Condition

Condition element contains information of a condition that must be met when a certain input item of
calculation conditions become active.

Table 5-39 Contents of Condition

Item Name Required? Type Meaning of value

Attribute conditionType Yes Selection Any one of the following:

• isEqual (is equal to)

• isGreaterEqual (is greater than or equal to)

• isGreaterThan (is greater than)
• isLessEqual (is less than or equal to)

• isLessThan (is less than)

• and
• or

• not

target Depends String Name of the calculation condition to be

compared with
Needs to be specified only if the conditionType

value is none of the following:

• and

• or
• not

value Depends String Value to be compared with

Needs to be specified only if the conditionType

value is none of the following:

• and
• or

• not

Element Condition Element The condition to which the AND, OR or NOT

operator is applied

To be specified only if the conditionType value is

any of the following:

• and
• or
• not

Refer to Section 5.3.2 for examples of Condition element definition.

79
5.4.4. Definition (when used under CalculationCondition element or BoundaryCondition element)

Definition element contains definition information of calculation conditions or grid attributes or boundary
conditions.

Table 5-40 Contents of Definition

Item Name Required? Type Meaning of value
Attribute valueType Yes Selection Any one of the following:
• integer
• real (real number)
• string (character string)
• filename
• filename_all (filename; even a file that currently does
not exist can be specified)
• foldername
• functional (functional type value)
default String Any string that can be recognized as a valid value for the
data type specified with valueType
For example, when valueType is "integer", then "0" or "2"
may be specified.
Element Enumeration Element It should be specified when solver developers wants to limit
the selection of the value.
It can be specified only when valueType is integer or real.
Condition Element The condition that must be met when the element become
active.

Refer to Section 5.3.1 for examples of Definition element definition.

80
5.4.5. Definition (when used under the GridRelatedCondition element)

This element contains definition information of the attributes to be defined for an input grid.

Table 5-41 Contents of Definition (when used under the GridRelatedCondition element)
Item Name Required? Type Meaning of value

Attribute valueType Yes Selection Any one of the following:

• integer
• real (real number)
• complex
position Yes Selection Type of location for which the attribute is defined
Either of the following:

• node (grid node)

• cell

default String Any string that can be recognized as a valid value for the

data type specified with valueType

For example, when valueType is "integer", then "0" or "2"

may be specified.

If "min" or "max" is specified, the minimum value or the

maximum value, respectively, of the input geographical

information will be used for an area devoid of geographical

information.

Element Dimension Element It should be specified when solver developers want to define

a dimension (ex. Time).

More than one element can be had.

Enumerations Depends Element Required only if the option attribute is true

The <Enumerations> element has two or more

<Enumeration> elements as its children.

Item Element Required only if the valueType attribute value is “complex”.

The structure of Item element is the same to that of Item

element under Boundary Condition element.

81
5.4.6. Dimension

Dimension element contains information that defines a dimension of an attributes to be defined for an input
grid.

Table 5-42 Contents of Dimensio

Item Name Required? Type Meaning of value

Attribute name Yes String Name of element

caption Yes String String to be displayed in the [Pre-processor]

valueType Yes Selection Any one of the following:

• integer
• real (real number)

5.4.7. Enumeration

Enumeration element contains information that defines an input option for the input item of calculation
conditions or grid generating condition.

Table 5-43 Contents of Enumeration

Item Name Required? Type Meaning of value

Attribute value Yes Arbitrary A string representing a value that corresponds to

caption

For example, when valueType of Definition is

"integer", then "0" or "1" may be specified.

caption Yes String String to be displayed.

Refer to Section 5.3.1.6) for examples of Enumeration element definitions.

5.4.8. ErrorCodes

ErrorCodes element contains a list of error codes.

Table 5-44 Contents of ErrorCodes

Item Name Required? Type Meaning of value

Element ErrorCode Element ErrorCode

82
5.4.9. ErrorCode

ErrorCode element contains information that defines an error code.

Table 5-45 Contents of ErrorCodes

Item Name Required? Type Meaning of value

Attribute caption Yes String String to be displayed

value Yes Integer Error code

5.4.10. GroupBox

GroupBox element contains information that defines a group box to be displayed in the calculation condition
input dialog or grid generating condition input dialog.

Table 5-46 Contents of GroupBox

Item Name Required? Type Meaning of value

Attribute caption Yes String String to be displayed

Element VBoxLayout, Element

etc.

Refer to Section 5.3.3.2) for an example of GroupBox element definition.

83
5.4.11. GridGeneratingCondition

GridGeneratingCondition element contains information that defines a grid generating condition.

Table 5-47 Contents of GridGeneratingCondition

Item Name Required? Type Meaning of value

Element Tab Tab element An element that contains information on a page

(or tab) of the grid generationg condition input

dialog
More than one element can be had.

5.4.12. GridGeneratorDefinition

GridGeneratorDefinition element contains definition information of the grid generating program.

Table 5-48 Contents of GridGeneratorDefinition

Item Name Required? Type Meaning of value

Attribute name Yes String Identification name of the solver (in

alphanumeric characters only)
caption Yes String Name of the solver (any characters can be used)

version Yes String Version number, in a form such as "1.0" or

"1.3.2"

copyright Yes String Name of copyright owner; basically in English

release Yes String Date of release, in a form such as "2010.01.01"

homepage Yes String URL of the web page that provides information
on the solver

executable Yes String Filename of the executable program. (e.g.,

Solver.exe)

gridType Yes Selection Any one of the following can be specified:

• structured2d (two-dimensional structured

grid)

• unstructured2d (two-dimensional
unstructured grid)

Element GridGeneratingCondition Yes Grid creating Grid creating condition

condition element

ErrorCodes List of error codes

84
5.4.13. GridLayout

GridLayout element contains information that defines the group box to be displayed in the calculation
conditions input dialog or grid generating condition input dialog.

Table 5-49 Contents of GridLayout

Item Name Required? Type Meaning of value

Element VBoxLayout, Element

etc.

Refer to Section 5.3.3.3) for an example of GridLayout element definition.

5.4.14. GridTypes

GridTypes element contains a list of definition information of input grids types.

Table 5-50 Contents of GridTypes

Item Name Required? Type Meaning of value

Element GridType Element Two or more can be defined.

5.4.15. GridType

GridType element contains a list of definition information of input grids.

Table 5-51 Contents of GridTypes

Item Name Required? Type Meaning of value

Attribute gridType Yes Selection Any one of the following:

• 1d (one-dimensional grid)
• 1.5d (one-and-half dimensional grid)
• 1.5d_withcrosssection (one-and-half
dimensional grid having cross-sectional info)

• structured2d (two-dimensional structured grid)

• unstructured2d (two-dimensional unstructured

grid)

multiple Yes Boolean Either of the following:

• true (Two or more grids can be used.)

• false (Only one grid can be used.)

Element GridRelatedConditi Yes Element Information on an attribute to be set to the input grid
on

85
 5.4.16. HBoxLayout

HBoxLayout element contains information that defines layout to arrange elements horizontally in the
calculation condition input dialog or grid generating condition input dialog.

Table 5-52 Contents of HBoxLayout

Item Name Required? Type Meaning of value

Element VBoxLayout, Element

etc.

HBoxLayout element is used to align child item horizontally. HBoxLayout can has Label, Item, GroupBox,
HBoxLayout, VBoxLayout and GridLayout elements as child elements.

5.4.17. Item

Item element contains information that defines an input item of calculation conditions, grid generating
condtions, attributes of the input grid, or .boundary conditions.

Table 5-53 Contents of Item

Item Name Required? Type Meaning of value

Attribute name Yes String Name of element

caption String String to be displayed in the dialog

Element Definition Yes Element Definition of the element

Refer to Section 5.3.1 for examples of Item element definitions.

5.4.18. Label

Label element contains information that defines a label to be displayed in the calculation condition input
dialog or grid creating condition input dialog.

Table 5-54 Contents of Label

Item Name Required? Type Meaning of value

Element caption Yes String String to be displayed

Refer to 5.3.3.3) for Label element definition example.

86
5.4.19. Param

Param element contains information that defines an argument of functional type calculation conditions or grid
creating conditions.

Table 5-55 Contents of Param

Item Name Required? Type Meaning of value

Attribute caption Yes String String to be displayed

valueType Yes Selection Any one of the following:

• integer
• real

axislog Boolean Either of the following:

• true (Horizontal axis is log axis)

• false (Horizontal axis is normal axis)

Refer to 5.3.1.8) for Param element definition example.

87
 5.4.20. SolverDefinition

SolverDefinition element contains definition information of the solver.

Table 5-56 Contents of SolverDefinition

Item Name Required? Type Meaning of value

Attribute name Yes String Identification name of the solver (in alphanumeric
characters only)
caption Yes String Name of the solver (any characters can be used)

version Yes String Version number, in a form such as "1.0" or "1.3.2"

copyright Yes String Name of copyright owner; basically in English

release Yes String Date of release, in a form such as "2010.01.01"

homepage Yes String URL of the web page that provides information on
the solver

executable Yes String Filename of the executable program. (e.g.,

Solver.exe)

iterationtype Yes Selection Either of the following can be specified:

• time (Results are output by time.)

• iteration (Results are output by iteration. This
is to be used by solvers that include

convergent calculation solvers.)

GridType Yes Selection This should be specified only when a single type of
input grid is used.

Any one of the following can be specified:

• 1d (one dimensional grid)

• 1.5d (one-and-half dimensional grid)

• 1.5d_withcrosssection (one-and-half
dimensional grid having cross-sectional info)

• structured2d (two-dimensional structured

grid)

• unstructured2d (two-dimensional
unstructured grid)

multiple Yes Boolean This should be specified only when a single type of
input grid is used.

Element CalculationCondition Yes Calculation Calculation condition

condition element

GridRelatedCondition Grid attribute This should be defined only when a single type of
input grid is used.

GridTypes Grid type This should be defined only when two or more

types of input grids are used.

88
When solver developers want to update solvers, version attribute should be changed. Refer to Section 5.5 for
notes on solver version up.

5.4.21. Tab

Tab element contains the information that defines a page of the calculation condition input dialog.

Table 5-57 Contents of Tab

Item Name Required? Type Meaning of value, and remarks

Attribute name Yes String Identification name (in alphanumeric characters only)

caption Yes String Name (Any characters can be used.)

Element Content Yes Element Only one element should be specified.

Refer to Section 2.3.2 for Tab element definition example.

5.4.22. Value

Value element contains information that defines a value of functional type calculation conditions or grid
creating conditions.

Table 5-58 Contents of Value

Item Name Required? Type Meaning of value

Attribute caption Yes String String to be displayed

valueType Yes Selection Any one of the following:

• integer
• real

name String Identification name (in alphanumeric characters

only). It is required only when the condition has

multiple values.

axis Selection Specify on which side to show Y-axis. One of the

followings can be set. The default value is “left”
for the first Value item, “right” for the second
and the following Value items.

• left

• right

axislog Boolean Either of the following:

• true (Vertical axis is log axis)

• false (Vertical axis is normal axis)

axisreverse Boolean Either of the following:

• true (Vertical axis is upside-down)

89
 • false (Vertical axis is normal axis)

step Boolean Either of the following:

• true (Show as bar chart)

• false (Show as line graph)

hide Boolean Specify whether to hide the line on the chart.

When the value is “true”, it is not drawn on the
chart.

Refer to Section 5.3.1.8), 5.3.1.9) for Value element definition example.

5.4.23. VBoxLayout

VBoxLayout element contains information that defines layout to arrange elements vertically in the calculation
condition input dialog.

Table 5-59 Contents of VBoxLayout

Item Name Required? Type Meaning of value

Element VBoxLayout Element

, etc.

VBoxLayout element is used to align child item horizontally. VBoxLayout can has Label, Item, GroupBox,
HBoxLayout, VBoxLayout and GridLayout elements as child elements.

90
5.5. Notes on solver version up

When you update the solver you developed, you have to modify not only solver source code but also solver
definition file. When you modify solver definition files you have to note the followings:
• You must not edit “name” attribute of SolverDefinition element. When the “name” attribute is
changed, iRIC regard the solver as a completely different solver from the older version, and any
project files that are created for the older version become impossible to open with the new solver.
• You should modify the “caption” attribute of SolverDefinition element. “caption” element is an
arbitrary string that is used to display the solver name and version information, so you should input
“Sample Solver 1.0”, “Sample Solver 3.2 beta”, “Sample Solver 3.0 RC1” as caption value for
example. The caption value can be set independent from “version” attribute.
• You must modify the “version” attribute following the policy in Table 5-60. Refer to Figure 5-14 for
the elements of version number.

Table 5-60 Elements of version number to increment

Element to increment Condition to increment Exmaple

Major number When you changed a big modification so that the grid, calculation 2.1  3.0
condition you created with older version will not be compatible to the

new solver.

Minor number When you changed a small modification to calculation condition and 2.1  2.2
grid. When a old project file that was created for an older solver is

loaded, the default values are used for the new conditions, and that will
cause no problem.

Fix number When you fixed bugs or changed inner algorithm. No modification is 2.1  2.1.1

made to the interface (i. e. grid and calculation condition) is made.

3.1.4
Major number Fix number (optional)
Minor number

Figure 5-14 Elements of version number

In iRIC, project files compatibility is like the following:

• Project files with different major number are not compatible.
• Project files with same major number and smaller minor number are compatible.
• Project files with same major number, same minor number and different fix number are compatible.

91
Table 5-61 shows the examples of compatibility with different solver version numbers.

Table 5-61 Examples of compatibility of project files with various version numbers
Solver version
1.0 2.0 2.1 2.1.1
Project file 1.0 ○ × × ×
version 2.0 × ○ ○ ○
2.1 × × ○ ○
2.1.1 × × ○ ○

The basic policy is shown in Table 5-60, but in the last, solver developers should judge which number to
increment, taking account of compatibility.

When you deploy multiple versions of a same solver in one environment, create multiple folders under
“solvers” folder with different names, and deploy files related to each version under them. Folder names can
be selected independent of solver names. Table 5-62 shows an example of folder structure for deploying
version “1.1” and “2.0” of “Sample Solver”.

Table 5-62 Example of folder structure for deploying “Sample Solver” with version “1.1” and “2.0”
File and folder names Description
iRIC 2.0 iRIC 2.0 install folder (ex. C:¥Program Files¥iRIC 2.0)

solvers Folder to obtain solvers

sample_11 Folder to deploy files related to “Sample Solver 1.1”

definition.xml Solver definition file for “Sample Solver 1.1”. Specify “sample” for name attribute, “1.1”
for version attribute to SolverDefinition element.

(other files abbreviated)

sample_20 Folder to deploy files related to “Sample Solver 2.0”

definition.xml Solver definition file for “Sample Solver 2.0”. Specify “sample” for name attribute, “2.0”
for version attribute to SolverDefinition element

(other files abbreviated)

92
5.6. XML files basics

In this section, the basics of XML file format are described. XML file format is adopted as file format for
solver definition file and grid generating program definitioin file.

5.6.1. Defining Elements

Element start tag is described with “<” and “>”.

Element end tag is described with “</” and “>”.
Table 5-63 shows an example of Item element definition.

Table 5-63 Example of Item element

<Item>
</Item>

An element can have the followings:

• Child element
• Attributes

An element can have multiple child elements that have the same name. On the other hand, an element can
have only one attribute for each name. Table 5-64 shows an example of a definition of Item element with two
“Subitem” child elements and “name” attribute.

Table 5-64 Example of Item element

<Item name=”sample”>
<SubItem>
</SubItem>
<SubItem>
</SubItem>
</Item>

An element that do not have a child element can be delimited with “<” and “/>”. For example, Table 5-65 and
Table 5-66 are processed as the same data by XML parsers.

Table 5-65 Example of item without a child element

<Item name=”sample”>
</Item>

Table 5-66 Example of item without a child element

<Item name=”sample” />

93
5.6.2. About tabs, spaces, and line breaks

In XML files, tabs, spaces, and line breaks are ignored, so you can addthem freely to make XML files easier
to read. Please note that spaces in attribute values are not ignored.
Elements in Table 5-67, Table 5-68, Table 5-69 are processed as the same data by XML parsers.

Table 5-67 Example of element

<Item name=”sample”>
<SubItem>
</SubItem>
</Item>

Table 5-68 Example of element

<Item
name=”sample”
>
<SubItem></SubItem>
</Item>

Table 5-69 Example of element

<Item name=”sample”><SubItem></SubItem></Item>

5.6.3. Comments

In XML files, strings between “<!--” and “-->” are treated as comments. Table 5-70 shows an example of a
comment.

Table 5-70 Example of comment

<!—This is a comment -->
<Item name=”sample”>
<SubItem>
</SubItem>
</Item>

94
6. iRIClib

6.1. What is iRIClib?

iRIClib is a library for interfacing a river simulation solver with iRIC.

iRIC uses a CGNS file for input/output to/from solvers and grid generating programs. Input-output
subroutines for CGNS files are published as an open-source library called cgnslib (see Section 7.4). However,
describing the necessary input-output directly using cgnslib would require complicated processing description.
Therefore, the iRIC project offers iRIClib as a library of wrapper subroutines that makes possible the
abbreviated description of input-output processing which is frequently used by solvers that work together with
iRIC. With these subroutines, input-output processing of a solver that performs calculation using a single
structured grid can be described easily.
Note that iRIClib does not offer subroutines necessary for a solver that uses multiple grids or an unstructured
grid. In case of such solvers, it is necessary to use cgnslib subroutines directly.
This chapter describes the groups of subroutines included in iRIClib, and examples of using them, along with
compilation procedures.

6.2. How to read this section

In this section, first Section 6.3 explains what kinds of information input/output iRIC assumes a solver to
perform, and what subroutines are available for each kind of processing. First, read Section 6.3 to understand
the general concept of iRIClib.
Since Section 6.3 gives only an outline of subroutines, see Section 6.4 for detailed information, such as lists of
arguments for those subroutines.

95
6.3. Overview

This section provides an overview of iRIClib.

6.3.1. Processes of the program and iRIClib subroutines

The I/O processings in solvers and grid generating programs are shown in Table 6-1 and Table 6-2. Refer to
the pages in Table 6-1 and Table 6-2 for the abstract and usage of the subroutines for each processing.

Table 6-1 I/O processings of solvers

Process Page
Opens a CGNS file 97
Initializes iRIClib 97
Reads calculation conditions 98
Reads grids 100
Reads boundary conditions 104
Reads geographic data (only when needed) 106
Outputs grids (only in cases when grid creation or
110
re-division is performed)
Outputs time (or iteration count) 112
Outputs grids (only in cases when grid moves) 113 Repeated
Outputs calculation results 115
Closes a CGNS file 117

Table 6-2 I/O processings of a grid generating program

Process Page
Opens a CGNS file 97
Initializes iRIClib 97
Reads grid generating condition 98
Outputs error code 117
Outputs grid 104
Closes CGNS File 117

96
6.3.2. Opening a CGNS file

[Description]
Open a CGNS file, read it in and make it into a writable state. The subroutine for doing this is defined in
cgnslib.

[Subroutine to use]
Subroutine Remarks
cg_open_f Opens a CGNS file

6.3.3. Initializing iRIClib

[Description]
Prepares the CGNS file that has been opened for use by iRIClib. After the CGNS file is opened, this should be
executed.
When you add calculation result to the CGNS file, open the CGNS file with CG_MODE_MODIFY mode,
and initialize using “cg_iric_init_f”.
When you just read grid and calculation result from CGNS file, open the CGNS file with CG_MODE_READ
mode, and initialize using “cg_iric_initread_f”.

[Subroutine to use]
Subroutine Remarks
cg_iric_init_f Initialize the internal variables that are used for
reading and modifying the opened CGNS file.
cg_iric_initread_f Initialize the internal variables that are used for
reading the opened CGNS file.

97
6.3.4. Reading calculation conditions

[Description]
Reads calculation conditions from the CGNS file.

[Subroutines to use]
Subroutine Remarks
cg_iric_read_integer_f Reads an integer calculation-condition value
cg_iric_read_real_f Reads a double-precision real calculation-condition
value
cg_iric_read_realsingle_f Reads a single-precision real calculation-condition
value
cg_iric_read_string_f Reads a string calculation-condition value
cg_iric_read_functionalsize_f Checks the size of a functional-type calculation
condition
cg_iric_read_functional_f Reads functional calculation condition data in
double-precision real type
cg_iric_read_functional_realsingle_f Reads functional calculation condition data in
single-precision real type
cg_iric_read_functional_withname_f Reads functional calculation condition data (with
multiple values)

For reading calculation condition data other than in functional type, a subroutine reads a single calculation
condition. An example of reading an integer calculation condition value is as follows.

Table 6-3 Example of source code to read calculation conditions

program Sample1
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, i_flow

! Open CGNS file

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

call cg_iric_read_integer_f('i_flow', i_flow, ier)

print *, i_flow;

! Close CGNS file

call cg_close_f(fin, ier)
stop
end program Sample1

98
In contrast, for getting functional-type calculation conditions, it is necessary to use two subroutines:
cg_iric_read_functionalsize_f and cg_iric_read_functional_f. An example of getting functional-type
calculation condition data follows.

Table 6-4 Example of source code to read functional-type calculation conditions

program Sample2
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, discharge_size, i

double precision, dimension(:), allocatable:: discharge_time, discharge_value ! Array for storing discharge time and
discharge value

! Open CGNS file

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! First, check the size of the functional-type input conditions

call cg_iric_read_functionalsize_f('discharge', discharge_size, ier)
! Allocate memory
allocate(discharge_time(discharge_size), discharge_value(discharge_size))
! Read values into the allocated memory
call cg_iric_read_functional_f('discharge', discharge_time, discharge_value, ier)

! (Output)
if (ier ==0) then
print *, 'discharge: discharge_size=', discharge_size
do i = 1, min(discharge_size, 5)
print *, ' i,time,value:', i, discharge_time(i), discharge_value(i)
end do
end if

! Deallocate memory that has been allocated

deallocate(discharge_time, discharge_value)

! Close CGNS file

call cg_close_f(fin, ier)
stop
end program Sample2

Refer to Section 5.3.1 for examples of codes to load calculation conditions (or grid generating conditions).

99
6.3.5. Reading calculation grid information

[Description]
Reads a calculation grid from the CGNS file. iRIClib offers subroutines for reading structured grids only.

[Subroutine to use]
Subroutine Remarks
cg_iric_gotogridcoord2d_f Makes preparations for reading a 2D structured grid
cg_iric_getgridcoord2d_f Reads a 2D structured grid
cg_iric_gotogridcoord3d_f Makes preparations for reading a 3D structured grid
cg_iric_getgridcoord3d_f Reads a 3D structured grid
cg_iric_read_grid_integer_node_f Reads the integer attribute values defined for grid
nodes
cg_iric_read_grid_real_node_f Reads the double-precision attribute values defined for
grid nodes
cg_iric_read_grid_integer_cell_f Reads the integer attribute values defined for cells
cg_iric_read_grid_real_cell_f Reads the double-precision attribute values defined for
cells
cg_iric_read_complex_count_f Reads the number of groups of complex type grid
attribute
cg_iric_read_complex_integer_f Reads the integer attribute values of complex type grid
attribute
cg_iric_read_complex_real_f Reads the double precision attribute values of
complex type grid attribute
cg_iric_read_complex_realsingle_f Reads the single precision attribute values of complex
type grid attribute
cg_iric_read_complex_string_f Reads the string attribute values of complex type grid
attribute
cg_iric_read_complex_functionalsize_f Checks the size of a functional-type attribute of
complex type grid attribute
cg_iric_read_complex_functional_f Reads functional attribute data of complex type grid
attribute
cg_iric_read_complex_functionalwithname_f Reads functional attribute of complex type grid
attribute (with multiple values)
cg_iric_read_complex_functional_realsingle_f Reads functional attribute data of complex type grid
attribute
cg_iric_read_grid_complex_node_f Reads the complex attribute values defined at grid
nodes
cg_iric_read_grid_complex_cell_f Reads the complex attribute values defined at grid
cells

100
 cg_iric_read_grid_functionaltimesize_f Reads the number of values of dimension “Time” for
functional grid attribute
cg_iric_read_grid_functionaltime_f Reads the values of dimension “Time” for functional
grid attribute
cg_iric_read_grid_functionaldimensionsize_f Reads the number of values of dimension for
functional grid attribute
cg_iric_read_grid_functionaldimension_integer_f Reads the values of integer dimension for functional
grid attribute
cg_iric_read_grid_functionaldimension_real_f Reads the values of double-precision dimension for
functional grid attribute
cg_iric_read_grid_functional_integer_node_f Reads the values of functional integer grid attribute
with dimension “Time” definied at grid nodes.
cg_iric_read_grid_functional_real_node_f Reads the values of functional double-precision grid
attribute with dimension “Time” definied at grid
nodes.
cg_iric_read_grid_functional_integer_cell_f Reads the values of functional integer grid attribute
with dimension “Time” definied at grid cells.
cg_iric_read_grid_functional_real_cell_f Reads the values of functional double-precision grid
attribute with dimension “Time” definied at grid cells.

The same subroutines for getting attributes such as cg_iric_read_grid_integer_node_f can be used both for
two-dimensional structured grids and three-dimensional structured grids.

An example description for reading a two-dimensional structured grid is shown below.

Table 6-5 Example of source code to read a grid

program Sample3
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, discharge_size, i, j

integer:: isize, jsize
double precision, dimension(:,:), allocatable:: grid_x, grid_y
double precision, dimension(:,:), allocatable:: elevation
integer, dimension(:,:), allocatable:: obstacle
integer:: rain_timeid
integer:: rain_timesize
double precision, dimension(:), allocatable:: rain_time
double precision, dimension(:,:), allocatable:: rain

! Open CGNS file

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

101
 ! Check the grid size
call cg_iric_gotogridcoord2d_f(isize, jsize, ier)

! Allocate memory for loading the grid

allocate(grid_x(isize,jsize), grid_y(isize,jsize))
! Read the grid into memory
call cg_iric_getgridcoord2d_f(grid_x, grid_y, ier)

if (ier /=0) STOP "*** No grid data ***"

! (Output)
print *, 'grid x,y: isize, jsize=', isize, jsize
do i = 1, min(isize,5)
do j = 1, min(jsize,5)
print *, ' (',i,',',j,')=(',grid_x(i,j),',',grid_y(i,j),')'
end do
end do

! Allocate memory for elevation attribute values that are defined for grid nodes.
allocate(elevation(isize, jsize))
! Read the attribute values.
call cg_iric_read_grid_real_node_f('Elevation', elevation, ier)
print *, 'Elevation: isize, jsize=', isize, jsize
do i = 1, min(isize,5)
do j = 1, min(jsize,5)
print *, ' (',i,',',j,')=(',elevation(i,j),')'
end do
end do

! Allocate memory for the obstacle attribute that is defined for cells. The size is (isize-1) * (jsize-1) since it is cell attribute.
allocate(obstacle(isize-1, jsize-1))
! Read the attribute values in.
call cg_iric_read_grid_integer_cell_f('Obstacle', obstacle, ier)
print *, 'Obstacle: isize -1, jsize-1=', isize-1, jsize-1
do i = 1, min(isize-1,5)
do j = 1, min(jsize-1,5)
print *, ' (',i,',',j,')=(',obstacle(i,j),')'
end do
end do
! Read the number of times for Rain
call cg_iric_read_grid_functionaltimesize_f('Rain', rain_timesize, ier);
! Allocate memory for time values of Rain
allocate(rain_time(rain_timesize))
! Read rain time values
call cg_iric_read_grid_functionaltime_f('Rain', rain_time, ier);

! Allocate memory for the rain attribute that is defined for cells. The size is (isize-1) * (jsize-1) since it is cell attribute.
allocate(rain(isize-1, jsize-1))
! Read the attribute at Time = 1
rain_timeid = 1
call cg_iric_read_grid_functional_real_cell_f('Rain', rain_timeid, rain, ier)
print *, 'Rain: isize -1, jsize-1=', isize-1, jsize-1
do i = 1, min(isize-1,5)
do j = 1, min(jsize-1,5)
print *, ' (',i,',',j,')=(',rain(i,j),')'
end do
end do

! Deallocate memory that has been allocated

deallocate(grid_x, grid_y, elevation, obstacle, rain_time, rain)

! Close CGNS file

call cg_close_f(fin, ier)
stop
end program Sample3

102
Processing for a three-dimensional grid can be described in the same manner.

103
6.3.6. Reading boundary conditions

[Description]
Reads boundary conditions from CGNS file.

[Subroutine to use]
Subroutine Remarks
cg_iric_read_bc_count_f Reads the number of boundary condition
cg_iric_read_bc_indicessize_f Reads the number of nodes (or cells) where
boundary condition is assigned.
cg_iric_read_bc_indices_f Reads the indices of nodes (or cells) where
boundary condition is assigned.
cg_iric_read_bc_integer_f Reads a integer boundary condition value
cg_iric_read_bc_real_f Reads a double-precision real boundary
condition value
cg_iric_read_bc_realsingle_f Reads a single-precision real boundary
condition value
cg_iric_read_bc_string_f Reads a string-type boundary condition value
cg_iric_read_bc_functionalsize_f Reads a functional-type boundary condition
value
cg_iric_read_bc_functional_f Reads a functional-type boundary condition
value
cg_iric_read_bc_functionalwithname_f Reads a functional-type boundary condition
value (with multiple values)

You can define multiple boundary conditions with the same type, to one grid. For example, you can define
multiple inflows to a grid, and set discharge value for them independently.

Table 6-6 shows an example to read boundary conditions. In this example the number of inflows is read by
cg_iric_read_bc_count_f first, memories are allocated, and at last, the values are loaded.

The name of boundary condition user specifys on iRIC GUI can be loaded using cg_iric_read_bc_string_f.
Please refer to 6.4.47 for detail.

Table 6-6 Example of source code to read boundary conditions

program Sample8
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, isize, jsize, ksize, i, j, k, aret

integer:: condid, indexid
integer:: condcount, indexlenmax, funcsizemax
integer:: tmplen

104
 integer, dimension(:), allocatable:: condindexlen
integer, dimension(:,:,:), allocatable:: condindices
integer, dimension(:), allocatable:: intparam
double precision, dimension(:), allocatable:: realparam
character(len=200), dimension(:), allocatable:: stringparam
character(len=200):: tmpstr
integer, dimension(:), allocatable:: func_size
double precision, dimension(:,:), allocatable:: func_param;
double precision, dimension(:,:), allocatable:: func_value;

! Opens CGNS file

call cg_open_f('bctest.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initializes iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Reads the number of inflows

call cg_iric_read_bc_count_f('inflow', condcount)
! Allocate memory to load parameters
allocate(condindexlen(condcount), intparam(condcount), realparam(condcount))
allocate(stringparam(condcount), func_size(condcount))
print *, 'condcount ', condcount

! Reads the number of grid node indices where boundary condition is assigned, and the size of functional-type condition.
indexlenmax = 0
funcsizemax = 0
do condid = 1, condcount
call cg_iric_read_bc_indicessize_f('inflow', condid, condindexlen(condid), ier)
if (indexlenmax < condindexlen(condid)) then
indexlenmax = condindexlen(condid)
end if
call cg_iric_read_bc_functionalsize_f('inflow', condid, 'funcparam', func_size(condid), ier);
if (funcsizemax < func_size(condid)) then
funcsizemax = func_size(condid)
end if
end do

! Allocates memory to load grid node indices and functional-type boundary condition
allocate(condindices(condcount, 2, indexlenmax))
allocate(func_param(condcount, funcsizemax), func_value(condcount, funcsizemax))
! Loads indices and boundary condition
do condid = 1, condcount
call cg_iric_read_bc_indices_f('inflow', condid, condindices(condid:condid,:,:), ier)
call cg_iric_read_bc_integer_f('inflow', condid, 'intparam', intparam(condid:condid), ier)
call cg_iric_read_bc_real_f('inflow', condid, 'realparam', realparam(condid:condid), ier)
call cg_iric_read_bc_string_f('inflow', condid, 'stringparam', tmpstr, ier)
stringparam(condid) = tmpstr
call cg_iric_read_bc_functional_f('inflow', condid, 'funcparam', func_param(condid:condid,:),
func_value(condid:condid,:), ier)
end do

! Displays the boundary condition loaded.

do condid = 1, condcount
do indexid = 1, condindexlen(condid)
print *, 'condindices ', condindices(condid:condid,:,indexid:indexid)
end do
print *, 'intparam ', intparam(condid:condid)
print *, 'realparam ', realparam(condid:condid)
print *, 'stringparam ', stringparam(condid)
print *, 'funcparam X ', func_param(condid:condid, 1:func_size(condid))
print *, 'funcparam Y ', func_value(condid:condid, 1:func_size(condid))
end do

! Closes CGNS file

105
 call cg_close_f(fin, ier)
stop
end program Sample8

6.3.7. Reading geographic data

[Description]
Reads geographic data that was imported into project and used for grid generation.
This function is used when you want to read river survey data or polygon data in solvers directly. The
procedure of reading geographic data is as follows:
1. Reads the number of geographic data, the file name of geographic data etc. from CGNS file.
2. Open geographic data file and read data from that.

[Subroutine to use]
Subroutine Remarks
cg_iric_read_geo_count_f Reads the number of geographic data
cg_iric_read_geo_filename_f Reads the file name and data type of
geographic data
iric_geo_polygon_open_f Opens the geographic data file that contains
polygon data
iric_geo_polygon_read_integervalue_f Reads the value of polygon data as integer
iric_geo_polygon_read_realvalue_f Reads the value of polygon datas double
precision real
iric_geo_polygon_read_pointcount_f Reads the number of polygon vertices
iric_geo_polygon_read_points_f Reads the coorinates of polygon vertices
iric_geo_polygon_read_holecount_f Reads the number of holes in the polygon
iric_geo_polygon_read_holepointcount_f Reads the number of vertices of hole polygon
iric_geo_polygon_read_holepoints_f Reads the coordinates of hole polygon vertices
iric_geo_polygon_close_f Closes the geographic data file
iric_geo_riversurvey_open_f Opens the geographic data file that contains
river survey data
iric_geo_riversurvey_read_count_f Reads the number of the crosssections in river
survey data
iric_geo_riversurvey_read_position_f Reads the coordinates of the crosssection
center point
iric_geo_riversurvey_read_direction_f Reads the direction of the crosssection as
normalized vector
iric_geo_riversurvey_read_name_f Reads the name of the crosssection as string
iric_geo_riversurvey_read_realname_f Reads the name of the crosssection as real
number
iric_geo_riversurvey_read_leftshift_f Reads the shift offset value of the crosssection

106
 iric_geo_riversurvey_read_altitudecount_f Reads the number of altitude data of the
crosssection
iric_geo_riversurvey_read_altitudes_f Reads the altitude data of the crosssection
iric_geo_riversurvey_read_fixedpointl_f Reads the data of left bank extension line of
the crosssection
iric_geo_riversurvey_read_fixedpointr_f Reads the data of right bank extension line of
the crosssection
iric_geo_riversurvey_read_watersurfaceelevation_f Reads the water elevation at the crosssection
iric_geo_riversurvey_close_f Closes the geographic data file

Table 6-7 shows an example of reading polygon. Table 6-8 shows an example of reading river survey data.

Table 6-7 Example source code of reading polygon

program TestPolygon
implicit none
include 'cgnslib_f.h'
include 'iriclib_f.h'
integer:: fin, ier
integer:: icount, istatus

integer:: geoid
integer:: elevation_geo_count
character(len=1000):: filename
integer:: geotype
integer:: polygonid
double precision:: polygon_value
integer:: region_pointcount
double precision, dimension(:), allocatable:: region_pointx
double precision, dimension(:), allocatable:: region_pointy
integer:: hole_id
integer:: hole_count
integer:: hole_pointcount
double precision, dimension(:), allocatable:: hole_pointx
double precision, dimension(:), allocatable:: hole_pointy

! Opens CGNS file

call cg_open_f("test.cgn", CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib
call cg_iric_init_f(fin, ier)

! Reads the number or geographic data

call cg_iric_read_geo_count_f("Elevation", elevation_geo_count, ier)

do geoid = 1, elevation_geo_count
call cg_iric_read_geo_filename_f('Elevation', geoid, &
filename, geotype, ier)
if (geotype .eq. iRIC_GEO_POLYGON) then
call iric_geo_polygon_open_f(filename, polygonid, ier)
call iric_geo_polygon_read_realvalue_f(polygonid, polygon_value, ier)
print *, polygon_value
call iric_geo_polygon_read_pointcount_f(polygonid, region_pointcount, ier)
allocate(region_pointx(region_pointcount))
allocate(region_pointy(region_pointcount))
call iric_geo_polygon_read_points_f(polygonid, region_pointx, region_pointy, ier)

107
 print *, 'region_x: ', region_pointx
print *, 'region_y: ', region_pointy
deallocate(region_pointx)
deallocate(region_pointy)
call iric_geo_polygon_read_holecount_f(polygonid, hole_count, ier)
print *, 'hole count: ', hole_count
do hole_id = 1, hole_count
print *, 'hole ', hole_id
call iric_geo_polygon_read_holepointcount_f(polygonid, hole_id, hole_pointcount, ier)
print *, 'hole pointcount: ', hole_pointcount
allocate(hole_pointx(hole_pointcount))
allocate(hole_pointy(hole_pointcount))
call iric_geo_polygon_read_holepoints_f(polygonid, hole_id, hole_pointx, hole_pointy, ier)
print *, 'hole_x: ', hole_pointx
print *, 'hole_y: ', hole_pointy
deallocate(hole_pointx)
deallocate(hole_pointy)
end do
call iric_geo_polygon_close_f(polygonid, ier)
end if
end do

! Closes CGNS file

call cg_close_f(fin, ier)
stop
end program TestPolygon

Table 6-8 Example source code of reading river survey data

program TestRiverSurvey
implicit none
include 'cgnslib_f.h'
include 'iriclib_f.h'
integer:: fin, ier
integer:: icount, istatus

integer:: geoid
integer:: elevation_geo_count
character(len=1000):: filename
integer:: geotype
integer:: rsid
integer:: xsec_count
integer:: xsec_id
character(len=20):: xsec_name
double precision:: xsec_x
double precision:: xsec_y
integer:: xsec_set
integer:: xsec_index
double precision:: xsec_leftshift
integer:: xsec_altid
integer:: xsec_altcount
double precision, dimension(:), allocatable:: xsec_altpos
double precision, dimension(:), allocatable:: xsec_altheight
integer, dimension(:), allocatable:: xsec_altactive
double precision:: xsec_wse

! Opens CGNS file

call cg_open_f("test.cgn", CG_MODE_MODIFY, fin, ier)
if (ier /=0) stop "*** Open error of CGNS file ***"

! Initializes iRIClib
call cg_iric_init_f(fin, ier)

! Reads the number or geographic data

call cg_iric_read_geo_count_f("Elevation", elevation_geo_count, ier)

108
 do geoid = 1, elevation_geo_count
call cg_iric_read_geo_filename_f('Elevation', geoid, &
filename, geotype, ier)
if (geotype .eq. iRIC_GEO_RIVERSURVEY) then
call iric_geo_riversurvey_open_f(filename, rsid, ier)
call iric_geo_riversurvey_read_count_f(rsid, xsec_count, ier)
do xsec_id = 1, xsec_count
call iric_geo_riversurvey_read_name_f(rsid, xsec_id, xsec_name, ier)
print *, 'xsec ', xsec_name
call iric_geo_riversurvey_read_position_f(rsid, xsec_id, xsec_x, xsec_y, ier)
print *, 'position: ', xsec_x, xsec_y
call iric_geo_riversurvey_read_direction_f(rsid, xsec_id, xsec_x, xsec_y, ier)
print *, 'direction: ', xsec_x, xsec_y
call iric_geo_riversurvey_read_leftshift_f(rsid, xsec_id, xsec_leftshift, ier)
print *, 'leftshift: ', xsec_leftshift
call iric_geo_riversurvey_read_altitudecount_f(rsid, xsec_id, xsec_altcount, ier)
print *, 'altitude count: ', xsec_altcount
allocate(xsec_altpos(xsec_altcount))
allocate(xsec_altheight(xsec_altcount))
allocate(xsec_altactive(xsec_altcount))
call iric_geo_riversurvey_read_altitudes_f( &
rsid, xsec_id, xsec_altpos, xsec_altheight, xsec_altactive, ier)
do xsec_altid = 1, xsec_altcount
print *, 'Altitude ', xsec_altid, ': ', &
xsec_altpos(xsec_altid:xsec_altid), ', ', &
xsec_altheight(xsec_altid:xsec_altid), ', ', &
xsec_altactive(xsec_altid:xsec_altid)
end do
deallocate(xsec_altpos, xsec_altheight, xsec_altactive)
call iric_geo_riversurvey_read_fixedpointl_f( &
rsid, xsec_id, xsec_set, xsec_x, xsec_y, xsec_index, ier)
print *, 'FixedPointL: ', xsec_set, xsec_x, xsec_y, xsec_index
call iric_geo_riversurvey_read_fixedpointr_f( &
rsid, xsec_id, xsec_set, xsec_x, xsec_y, xsec_index, ier)
print *, 'FixedPointR: ', xsec_set, xsec_x, xsec_y, xsec_index
call iric_geo_riversurvey_read_watersurfaceelevation_f( &
rsid, xsec_id, xsec_set, xsec_wse, ier)
print *, 'WaterSurfaceElevation: ', xsec_set, xsec_wse
end do
call iric_geo_riversurvey_close_f(rsid, ier)
end if
end do

! Closes CGNS file

call cg_close_f(fin, ier)
stop
end program TestRiverSurvey

109
6.3.8. Outputting calculation grids (only in cases where grid creation or re-division is performed)

[Description]
Outputs the calculation grid to the CGNS file.
Unlike ordinary solvers that simply read calculation grids from the CGNS file, these subroutines are to be
used in a particular kind of solver in which a grid is created on the solver side or a three-dimensional grid is
generated from a two-dimensional grid.

[Subroutines to use]
Subroutine Remarks
cg_iric_writegridcoord1d_f Outputs a one-dimensional structured grid
cg_iric_writegridcoord2d_f Outputs a two-dimensional structured grid
cg_iric_writegridcoord3d_f Outputs a three-dimensional structured grid
cg_iric_write_grid_real_node_f Outputs a grid node attribute with real number
value
cg_iric_write_grid_integer_node_f Outputs a grid node attribute with integer value
cg_iric_write_grid_real_cell_f Outputs a grid cell attribute with real number
value
cg_iric_write_grid_integer_cell_f Outputs a grid cell attribute with integer value

Table 6-9 shows an example of the procedure of reading a two-dimensional grid, dividing it to generate a
three-dimensional grid, and then outputting the resulting grid.

Table 6-9 Example of source code to output a grid

program Sample7
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, isize, jsize, ksize, i, j, k, aret

double precision:: time
double precision:: convergence
double precision, dimension(:,:), allocatable::grid_x, grid_y, elevation
double precision, dimension(:,:,:), allocatable::grid3d_x, grid3d_y, grid3d_z
double precision, dimension(:,:,:), allocatable:: velocity, density

! Open CGNS file.

call cg_open_f('test3d.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib.
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Check the grid size.

call cg_iric_gotogridcoord2d_f(isize, jsize, ier)
! Allocate memory for loading the grid.
allocate(grid_x(isize,jsize), grid_y(isize,jsize), elevation(isize,jsize))
! Read the grid into memory.

110
 call cg_iric_getgridcoord2d_f(grid_x, grid_y, ier)
call cg_iric_read_grid_real_node_f('Elevation', elevation, ier)

! Generate a 3D grid from the 2D grid that has been read in.
! To obtain a 3D grid, the grid is divided into 5 __________ with a depth of 5.

ksize = 6
allocate(grid3d_x(isize,jsize,ksize), grid3d_y(isize,jsize,ksize), grid3d_z(isize,jsize,ksize))
allocate(velocity(isize,jsize,ksize), STAT = aret)
print *, aret
allocate(density(isize,jsize,ksize), STAT = aret)
print *, aret
do i = 1, isize
do j = 1, jsize
do k = 1, ksize
grid3d_x(i,j,k) = grid_x(i,j)
grid3d_y(i,j,k) = grid_y(i,j)
grid3d_z(i,j,k) = elevation(i,j) + (k - 1)
velocity(i,j,k) = 0
density(i,j,k) = 0
end do
end do
end do
! Output the generated 3D grid
call cg_iric_writegridcoord3d_f(isize, jsize, ksize, grid3d_x, grid3d_y, grid3d_z, ier)

! Output the initial state information

time = 0
convergence = 0.1
call cg_iric_write_sol_time_f(time, ier)
! Output the grid.
call cg_iric_write_sol_gridcoord3d_f(grid3d_x, grid3d_y, grid3d_z, ier)
! Output calculation results.
call cg_iric_write_sol_real_f('Velocity', velocity, ier)
call cg_iric_write_sol_real_f('Density', density, ier)
call cg_iric_write_sol_baseiterative_real_f ('Convergence', convergence, ier)

do
time = time + 10.0
! (Perform calculation here. The grid shape also changes.)
call cg_iric_write_sol_time_f(time, ier)
! Output the grid.
call cg_iric_write_sol_gridcoord3d_f(grid3d_x, grid3d_y, grid3d_z, ier)
! Output calculation results.
call cg_iric_write_sol_real_f('Velocity', velocity, ier)
call cg_iric_write_sol_real_f('Density', density, ier)
call cg_iric_write_sol_baseiterative_real_f ('Convergence', convergence, ier)

If (time > 100) exit

end do

! Close CGNS file.

call cg_close_f(fin, ier)
stop
end program Sample7

111
6.3.9. Outputting time (or iteration count) information

[Description]
Outputs the timestamp information or the iteration count to the CGNS file.
Be sure to perform this before outputting the calculation grid or calculation results.
Also note that the time and iteration-count information cannot be output at the same time. Output either, but
not both.

[Subroutines to use]
Subroutine Remarks
cg_iric_write_sol_time_f Outputs time
cg_iric_write_sol_iteration_f Outputs iteration count

Table 6-10 shows an example of source code to output timestamp information.

Table 6-10 Example of source code to output time

program Sample4
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, i

double precision:: time

! Open CGNS file.

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib.
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Output the initial state information.

time = 0

call cg_iric_write_sol_time_f(time, ier)

! (Here, output initial calculation grid or calculation results.)

do
time = time + 10.0
! (Perform calculation here.)
call cg_iric_write_sol_time_f(time, ier)
! (Here, output calculation grid or calculation results.)
If (time > 1000) exit
end do

! Close CGNS file.

call cg_close_f(fin, ier)
stop
end program Sample4

112
6.3.10. Outputting calculation grids (only in the case of a moving grid)

[Description]
Outputs the calculation grid to the CGNS file.
If the grid shape does not change in the course of the calculation, this output is not necessary.
Before outputting the calculation grid at a specific time, be sure to output the time (or iteration count)
information as described in Section 6.3.9.
The subroutines described in this section should be used for outputting a calculation grid only when the grid
shape is changed in the course of calculation. When outputting a grid in the following cases, use the
subroutines described in Section 0.
• A new grid has been created in the solver.
• A grid of different number of dimensions or a grid having a different grid node count has been created
by performing re-division of the grid or the like.

[Subroutines to use]
Subroutine Remarks
cg_iric_write_sol_gridcoord2d_f Outputs a two-dimensional structured grid
cg_iric_write_sol_gridcoord3d_f Outputs a three-dimensional structured grid

Table 6-11 shows an example of outputting a two-dimensional structured grid after starting calculation.

Table 6-11 Example of source code to output grids after starting calculation

program Sample5
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, isize, jsize

double precision:: time
double precision, dimension(:,:), allocatable:: grid_x, grid_y

! Open CGNS file.

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initialize iRIClib.
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Check the grid size.

call cg_iric_gotogridcoord2d_f(isize, jsize, ier)
! Allocate memory for loading the grid.
allocate(grid_x(isize,jsize), grid_y(isize,jsize))
! Read the grid into memory.
call cg_iric_getgridcoord2d_f(grid_x, grid_y, ier)

! Output the initial state information.

time = 0

call cg_iric_write_sol_time_f(time, ier)

! Output the grid.
call cg_iric_write_sol_gridcoord2d_f (grid_x, grid_y, ier)

113
 do
time = time + 10.0
! (Perform calculation here.)
call cg_iric_write_sol_time_f(time, ier)
call cg_iric_write_sol_gridcoord2d_f (grid_x, grid_y, ier)
If (time > 1000) exit
end do

! Close CGNS file

call cg_close_f(fin, ier)
stop
end program Sample5

114
6.3.11. Outputting calculation results

[Description]
Outputs the calculation results to the CGNS file.
Before outputting the calculation results at a specific time, be sure to output the time (or iteration count)
information as described in Section 6.3.9.
Types of calculation results that can be output with iRIClib are grouped into the followings:
• Calculation results having one value for each time step, without reference to grid nodes
• Calculation results having a value for each grid node

[Subroutines to use for outputting result value that have one value for eacn time step]
Subroutine Remarks
cg_iric_write_sol_baseiterative_integer_f Outputs integer-type calculation results
cg_iric_write_sol_baseiterative_real_f Outputs double-precision real-type calculation results

[Subroutines to use for outputting result value that have value at each grid node for eacn time step]
Subroutine Remarks
cg_iric_write_sol_integer_f Outputs integer-type calculation results, having a value for each
grid node
cg_iric_write_sol_real_f Outputs double-precision real-type calculation results, having a
value for each grid node

[Subroutines to use for outputting particles as calculation result for eacn time step]
Subroutine Remarks
cg_iric_write_sol_particle_pos2d_f Outputs particle positions (two-dimensions)
cg_iric_write_sol_particle_pos3d_f Outputs particle positions (three-dimensions)

Table 6-12 shows an example of the process to output calculation results.

Table 6-12 Example of source code to output calculation results

program Sample6
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, isize, jsize

double precision:: time
double precision:: convergence
double precision, dimension(:,:), allocatable::grid_x, grid_y
double precision, dimension(:,:), allocatable:: velocity_x, velocity_y, depth
integer, dimension(:,:), allocatable:: wetflag
double precision, dimension(:), allocatable:: particlex, particley

! Open CGNS file

call cg_open_f('test.cgn', CG_MODE_MODIFY, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

115
 ! Initialize iRIClib
call cg_iric_init_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Check the grid size.

call cg_iric_gotogridcoord2d_f(isize, jsize, ier)
! Allocate memory for loading the grid.
allocate(grid_x(isize,jsize), grid_y(isize,jsize))
! Allocate memory for storing calculation results.
allocate(velocity_x(isize,jsize), velocity_y(isize,jsize), depth(isize, jsize), wetflag(isize,jsize))
allocate(particlex(10), particley(10))
! Read the grid into memory.
call cg_iric_getgridcoord2d_f (grid_x, grid_y, ier)

! Output the initial state information.

time = 0
convergence = 0.1
call cg_iric_write_sol_time_f(time, ier)
! Output the grid.
call cg_iric_write_sol_gridcoord2d_f (grid_x, grid_y, ier)
! Output calculation results
call cg_iric_write_sol_real_f ('VelocityX', velocity_x, ier)
call cg_iric_write_sol_real_f ('VelocityY', velocity_y, ier)
call cg_iric_write_sol_real_f ('Depth', depth, ier)
call cg_iric_write_sol_integer_f ('Wet', wetflag, ier)
call cg_iric_write_sol_baseiterative_real_f ('Convergence', convergence, ier)
do
time = time + 10.0
! (Perform calculation here. The grid shape also changes.)
call cg_iric_write_sol_time_f(time, ier)
! Output the grid.
call cg_iric_write_sol_gridcoord2d_f (grid_x, grid_y, ier)
! Output calculation results.
call cg_iric_write_sol_real_f ('VelocityX', velocity_x, ier)
call cg_iric_write_sol_real_f ('VelocityY', velocity_y, ier)
call cg_iric_write_sol_real_f ('Depth', depth, ier)
call cg_iric_write_sol_integer_f ('Wet', wetflag, ier)
call cg_iric_write_sol_baseiterative_real_f ('Convergence', convergence, ier)
call cg_iric_write_sol_particle_pos2d_f(10, particlex, particley, ier)
If (time > 1000) exit
end do

! Close CGNS file

call cg_close_f(fin, ier)
stop
end program Sample6

In iRIClib, the same subroutines are used to output vector quantity calculation results and scalar quantity
calculation results. When outputting vector quantity calculation results, output each component with names
like “VelocityX” and “VelocityY”.
For calculation results, iRIC defines special names, and when you want to output calculation result for certain
purposes, you should use those names. Refer to Section 7.3 for those names.

116
6.3.12. Reading calculation result

[Description]
Read calculation result from CGNS files.

[Subroutines to use]
Subroutine Remarks
cg_iric_read_sol_count_f Reads the number of calculation result
cg_iric_read_sol_time_f Reads the time value
cg_iric_read_sol_iteration_f Reads the loop iteration value
cg_iric_read_sol_baseiterative_integer_f Reads the integer-type calculation result value
cg_iric_read_sol_baseiterative_real_f Reads the double-precision real-type calculation
result value
cg_iric_read_sol_gridcoord2d_f Reads the 2D structured grid (for moving grid
calculation)
cg_iric_read_sol_gridcoord3d_f Reads the 3D structured grid (for moving grid
calculation)
cg_iric_read_sol_integer_f Reads the integer-type calculation result, having
a value for each grid node
cg_iric_read_sol_real_f Reads the double-precision real-type calculation
result, having a value for each grid node

Table 6-13 shows an example of reading caluculation result from CGNS file, and output to standard output.

Table 6-13 Example of reading calculation result

program SampleX
implicit none
include 'cgnslib_f.h'

integer:: fin, ier, isize, jsize, solid, solcount, iter, i, j

double precision, dimension(:,:), allocatable::grid_x, grid_y, result_real

! Opening CGNS file

call cg_open_f('test.cgn', CG_MODE_READ, fin, ier)
if (ier /=0) STOP "*** Open error of CGNS file ***"

! Initializing internal variables

call cg_iric_initread_f(fin, ier)
if (ier /=0) STOP "*** Initialize error of CGNS file ***"

! Reads grid size

call cg_iric_gotogridcoord2d_f(isize, jsize, ier)

! Allocate memory for reading calculation result

allocate(grid_x(isize,jsize), grid_y(isize,jsize))
allocate(result_real(isize, jsize))

! Reads calculation result, and output to standard output.

call cg_iric_read_sol_count_f(solcount, ier)
do solid = 1, solcount

117
 call cg_iric_read_sol_iteration_f(solid, iter, ier)
call cg_iric_read_sol_gridcoord2d_f(solid, grid_x, grid_y, ier)
call cg_iric_read_sol_real_f(solid, 'result_real', result_real, ier)

print *, 'iteration: ', iter

print *, 'grid_x, grid_y, result: '
do i = 1, isize
do j = 1, jsize
print *, '(', i, ', ', j, ') = (', grid_x(i, j), ', ', grid_y(i, j), ', ', result_real(i, j), ')'
end do
end do
end do

! Closing CGNS file

call cg_close_f(fin, ier)
stop
end program SampleX

The functions are used in calculation analysis program (See Chapter 3).

6.3.13. Outputting Error code

[Description]
Outputs error code to CGNS files. It is used only in grid generating programs.

[Subroutines to use]
Subroutine Remarks
cg_iric_write_errorcode _f Outputs error code

6.3.14. Closing a CGNS file

[Description]
Closes the CGNS file that has been opened by cg_open_f. The subroutine for doing this is defined in cgnslib.

[Subroutines to use]
Subroutine Remarks
cg_close_f Closes the CGNS file

118
6.4. Reference

6.4.1. List of subroutines

The table below shows a list of subroutines and their classifications

Table 6-14 List of iRIClib subroutines

Classification No. Name Description Multi Page

Opening a CGNS 1 cg_open_f Opens a CGNS file

X 125
file

Initializing iRIClib 2 cg_iric_init_f Initializes the CGNS file for reading and writing X 125
3 cg_iric_initread_f Initializes the CGNS file for reading X 125
Reading the 4 cg_iric_read_integer_f Gets the value of an integer variable O 126

calculation 5 cg_iric_read_real_f Gets the value of a real (double-precision) variable O 126

conditions 6 cg_iric_read_realsingle_f Gets the value of a real (single-precision) variable O 126

7 cg_iric_read_string_f Gets the value of a string-type variable O 127

8 cg_iric_read_functionalsize_f Gets the size of a functional-type variable O 127

9 cg_iric_read_functional_f Gets the value of a functional-type

O 128
double-precision variable
10 cg_iric_read_functional_realsingle_ Gets the value of a functional-type single-precision
O 128
f variable
11 cg_iric_read_functionalwithname Gets the value of a functional-type variable (with
O 129
_f multiple values)
Reading a 12 cg_iric_gotogridcoord2d_f Makes preparations for reading a grid O 129

calculation grid 13 cg_iric_gotogridcoord3d_f Makes preparations for reading a grid O 129

14 cg_iric_getgridcoord2d_f Reads the x and y coordinates of a grid O 130

15 cg_iric_getgridcoord3d_f Reads the x, y and z coordinates of a grid O 130

16 cg_iric_read_grid_integer_node_f Reads the integer attribute values defined for grid

O 131
nodes
17 cg_iric_read_grid_real_node_f Reads double-precision attribute values defined for
O 131
grid nodes

18 cg_iric_read_grid_integer_cell_f Reads the integer attribute values defined for cells O 131

19 cg_iric_read_grid_real_cell_f Reads the double-precision attribute values defined

O 132
for cells
20 cg_iric_read_complex_count_f Reads the number of groups of complex type grid
O 132
attribute
21 cg_iric_read_complex_integer_f Reads the integer attribute values of complex type
O 132
grid attribute
22 cg_iric_read_complex_real_f Reads the double precision attribute values of
O 133
complex type grid attribute
23 cg_iric_read_complex_realsingle Reads the single precision attribute values of
O 133
_f complex type grid attribute
24 cg_iric_read_complex_string_f Reads the string attribute values of complex type
O 134
grid attribute
25 cg_iric_read_complex_functional Checks the size of a functional-type attribute of O 134

119
 size_f complex type grid attribute
26 cg_iric_read_complex_functional Reads functional attribute data of complex type
O 135
_f grid attribute
27 cg_iric_read_complex_functional Reads functional attribute of complex type grid
O 135
withname_f attribute (with multiple values)
28 cg_iric_read_complex_functional Reads functional attribute data of complex type
O 136
_realsingle_f grid attribute
29 cg_iric_read_grid_complex_node Reads the complex attribute values defined for grid
O 136
_f nodes
30 cg_iric_read_grid_complex_cell_ Reads the complex attribute values defined for grid
O 136
f cells
31 cg_iric_read_grid_functionaltime Reads the number of values of dimension “Time”
O 137
size_f for functional grid attribute

32 cg_iric_read_grid_functionaltime Reads the values of dimension “Time” for

O 137
_f functional grid attribute

33 cg_iric_read_grid_functionaldime Reads the number of values of dimension for

O 137
nsionsize_f functional grid attribute

34 cg_iric_read_grid_functionaldime Reads the values of integer dimension for

O 138
nsion_integer_f functional grid attribute

35 cg_iric_read_grid_functionaldime Reads the values of double-precision dimension for

O 138
nsion_real_f functional grid attribute

36 cg_iric_read_grid_functional_inte Reads the values of functional integer grid attribute

O 139
ger_node_f with dimension “Time” definied at grid nodes.

37 cg_iric_read_grid_functional_real Reads the values of functional double-precision

_node_f grid attribute with dimension “Time” definied at O 139

grid nodes.

38 cg_iric_read_grid_functional_inte Reads the values of functional integer grid attribute

O 140
ger_cell_f with dimension “Time” definied at grid cells.

39 cg_iric_read_grid_functional_real Reads the values of functional double-precision

_cell_f grid attribute with dimension “Time” definied at O 140

grid cells.

Reading boundary 40 cg_iric_read_bc_count_f Reads the number of boundary conditions O 140

conditions 41 cg_iric_read_bc_indicessize_f Reads the number of elements (nodes or cells)

O 141
where boundary conditions are assigned.
42 cg_iric_read_bc_indices_f Reads the list of indices of elements (nodes or
O 142
cells) where boundary conditions are assigned.
43 cg_iric_read_bc_integer_f Gets the value of an integer boundary condition O 143

44 cg_iric_read_bc_real_f Gets the value of an real (double-precision)

O 143
boundary condition
45 cg_iric_read_bc_realsingle_f Gets the value of an real (single-precision)
O 144
boundary condition
46 cg_iric_read_bc_string_f Gets the value of an string-type boundary condition O 144

120
Reading boundary 47 cg_iric_read_bc_functionalsize_f Gets the size of an functional-type boundary
O 145
conditions condition
48 cg_iric_read_bc_functional_f Gets the value of an functional-type
O 145
double-precision boundary condition
49 cg_iric_read_bc_functional_realsi Gets the value of an functional-type
O 146
ngle_f single-precision boundary condition
50 cg_iric_read_bc_functionalwithn Gets the value of a functional-type boundary
O 146
ame_f condition (with multiple values)
Reading geographic 51 cg_iric_read_geo_count_f Reads the number of geographic data O 147
data 52 cg_iric_read_geo_filename_f Reads the file name and data type of geographic
O 147
data
53 iric_geo_polygon_open_f Opens the geographic data file that contains
X 148
polygon data
54 iric_geo_polygon_read_integ Reads the value of polygon data as integer
X 148
ervalue_f
55 iric_geo_polygon_read_realv Reads the value of polygon datas double precision
X 148
alue_f real
56 iric_geo_polygon_read_point Reads the number of polygon vertices
X 149
count_f
57 iric_geo_polygon_read_point Reads the coorinates of polygon vertices
X 149
s_f
58 iric_geo_polygon_read_holec Reads the number of holes in the polygon
X 149
ount_f
59 iric_geo_polygon_read_holep Reads the number of vertices of hole polygon
X 150
ointcount_f
60 iric_geo_polygon_read_holep Reads the coordinates of hole polygon vertices
X 150
oints_f
61 iric_geo_polygon_close_f Closes the geographic data file X 151

62 iric_geo_riversurvey_open_f Opens the geographic data file that contains river

X 151
survey data
63 iric_geo_riversurvey_read_co Reads the number of the crosssections in river
X 151
unt_f survey data
64 iric_geo_riversurvey_read_po Reads the coordinates of the crosssection center
X 152
sition_f point
65 iric_geo_riversurvey_read_dir Reads the direction of the crosssection as
X 152
ection_f normalized vector
66 iric_geo_riversurvey_read_na Reads the name of the crosssection as string
X 153
me_f
67 iric_geo_riversurvey_read_re Reads the name of the crosssection as real number
X 153
alname_f
68 iric_geo_riversurvey_read_lef Reads the shift offset value of the crosssection
X 153
tshift_f
69 iric_geo_riversurvey_read_alt Reads the number of altitude data of the
X 154
itudecount_f crosssection
70 iric_geo_riversurvey_read_alt Reads the altitude data of the crosssection
X 154
itudes_f
71 iric_geo_riversurvey_read_fix Reads the data of left bank extension line of the X 155

121
 edpointl_f crosssection
72 iric_geo_riversurvey_read_fix Reads the data of right bank extension line of the
X 155
edpointr_f crosssection
73 iric_geo_riversurvey_read_w Reads the water elevation at the crosssection
X 156
atersurfaceelevation_f
74 iric_geo_riversurvey_close_f Closes the geographic data file X 156

Outputting a 75 cg_iric_writegridcoord1d_f Outputs a one-dimensional structured grid O 156

calculation grid 76 cg_iric_writegridcoord2d_f Outputs a two-dimensional structured grid O 157

77 cg_iric_writegridcoord3d_f Outputs a three-dimensional structured grid O 157

78 cg_iric_write_grid_integer_node_ Outputs a grid attributed defined at grid nodes with

O 158
f integer values.
79 cg_iric_write_grid_real_node_f Outputs a grid attributed defined at grid nodes with
O 158
real number (double-precision) values.
80 cg_iric_write_grid_integer_cell_f Outputs a grid attributed defined at grid cells with
O 158
integer values.
81 cg_iric_write_grid_real_cell_f Outputs a grid attributed defined at grid cells with
O 159
real number (double-precision) values.
Outputting time (or 82 cg_iric_write_sol_time_f Outputs time O 159

iteration count) 83 cg_iric_write_sol_iteration_f Outputs the iteration count

O 159
information

Outputting 84 cg_iric_write_sol_gridcoord2d_f Outputs a two-dimensional structured grid O 160

calculation results 85 cg_iric_write_sol_gridcoord3d_f Outputs a three-dimensional structured grid O 160

86 cg_iric_write_sol_baseiterative_i Outputs integer-type calculation results

O 161
nteger_f
87 cg_iric_write_sol_baseiterative_r Outputs double-precision real-type calculation
O 161
eal_f results
88 cg_iric_write_sol_integer_f Outputs integer-type calculation results, having a
O 161
value for each grid node
89 cg_iric_write_sol_real_f Outputs double-precision real-type calculation
O 162
results, having a value for each grid node
Outputting 90 cg_iric_write_sol_particle_po Outputs particle positions (two-dimensions)
O 162
calculation results s2d_f
91 cg_iric_write_sol_particle_po Outputs particle positions (three-dimensions)
(particles) O 163
s3d_f
Reading calculation 92 cg_iric_read_sol_count_f Reads the number of calculation results O 163

results 93 cg_iric_read_sol_time_f Reads the time value O 163

94 cg_iric_read_sol_iteration_f Reads the loop iteration value O 164

95 cg_iric_read_sol_baseiterative_in Reads the integer-type calculation result value

O 164
teger_f
96 cg_iric_read_sol_baseiterative_re Reads the double-precision real-type calculation
O 164
al_f result value

97 cg_iric_read_sol_gridcoord2d_f Reads the 2D structured grid (for moving grid

O 165
calculation)

122
 98 cg_iric_read_sol_gridcoord3d_f Reads the 3D structured grid (for moving grid
O 165
calculation)
99 cg_iric_read_sol_integer_f Reads the integer-type calculation result, having a
O 166
value for each grid node
100 cg_iric_read_sol_real_f Reads the double-precision real-type calculation
O 166
result, having a value for each grid node
Outputting error 101 cg_iric_write_errorcode_f Outputs error code
O 166
codes

Closing the CGNS 102 cg_close_f Closes a CGNS file

X 167
file

The functions with “O” value for column “Multi” has functions that are used for the same purpose and used
when handling multiple CGNS files. The “Multi” version of the functions end with “_mul_f” instead of “_f”,
and the first argument is file ID.
For example, the functions used for reading integer-type calculation result are as follows:
 Function used when handling single CGNS file
call cg_iric_read_integer_f(label, intvalue, ier)
 Function used when handling multiple CGNS file.
call cg_iric_read_integer_mul_f(fid, label, intvalue, ier)
The difference between single version and multiple version is shown in Table 6-15.

123
 Table 6-15 Differences between functions for handling single or mulitple CGNS file
Item For Single CGNS file For Multiple CGNS file
Name Ends with "_f" Ends with “_mul_f”
Arguments See 6.4.6 and the followings The first argument is File ID. See 6.4.6
and the followings for the lasting
arguments.
Target CGNS file File that is identified by the File ID File that is identified by the File ID that
that was specified as the argument is specified as the first argument.
of “cg_iric_init_f” or
“cg_iric_initread_f”

124
6.4.2. cg_open_f

• Opens a CGNS file.

[Format]
call cg_open_f (filename, mode, fid, ier)
[Arguments]
Type Variable name I/O Description
character(*) filename I Filename
parameter (integer) mode I File Open mode
CG_MODE_MODIFY: read/write
CG_MODE_READ: read only
CG_MODE_WRITE: write only
CG_MODE_CLOSE: close
integer fid O File ID
integer ier O Error code. 0 means success.

6.4.3. cg_iric_init_f

• Initializes the internal variables that are used for reading and writing CGNS file.

[Format]
call cg_iric_init_f (fid, ier)
[Arguments]
Type Variable name I/O Description
integer fid I File ID
integer ier O Error code. 0 means success. In case of grid
generating program, 1 means success.

6.4.4. cg_iric_initread_f

• Initializes the internal variables that are used for reading CGNS file.

[Format]
call cg_iric_initread_f (fid, ier)
[Arguments]
Type Variable name I/O Description
integer fid I File ID
integer ier O Error code. 0 means success.

125
6.4.5. cg_iric_read_integer_f

• Reads the value of a integer-type variable from the CGNS file.

[Format]
call cg_iric_read_integer_f (label, intvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
integer intvalue O Integer read from the CGSN file
integer ier O Error code. 0 means success.

6.4.6. cg_iric_read_real_f

• Reads the value of a double-precision real-type variable from the CGNS file.

[Format]
call cg_iric_read_real_f (label, realvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
double precision realvalue O Real number read from the CGSN file
integer ier O Error code. 0 means success.

6.4.7. cg_iric_read_realsingle_f

• Reads the value of a single-precision real-type variable from the CGNS file.

[Format]
call cg_iric_read_realsingle_f (label, realvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
real realvalue O Real number read from the CGSN file
integer ier O Error code. 0 means success.

126
6.4.8. cg_iric_read_string_f

• Reads the value of a string-type variable from the CGNS file.

[Format]
call cg_iric_read_string_f(label, strvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
character(*) strvalue O Character string read from the CGSN file
integer ier O Error code. 0 means success.

6.4.9. cg_iric_read_functionalsize_f

• Reads the size of a functional-type variable from the CGNS file.

[Format]
call cg_iric_read_functionalsize_f (label, size, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
integer O Length of the array that has been read from the
size
CGSN file
integer ier O Error code. 0 means success.

127
6.4.10. cg_iric_read_functional_f

• Reads the value of a functional-type double-precision real variable from the CGNS file.

[Format]
call cg_iric_read_functional_f (label, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
double precision , x O Array of x values
dimension(:), allocatable
double precision, dimension(:), y O Array of y values
allocatable
integer ier O Error code. 0 means success.

6.4.11. cg_iric_read_functional_realsingle_f

• Reads the value of a functional-type single-precision real variable from the CGNS file.

[Format]
call cg_iric_read_functional_realsingle_f (label, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
real , dimension(:), allocatable x O Array of x values
real, dimension(:), allocatable y O Array of y values
integer ier O Error code. 0 means success.

128
6.4.12. cg_iric_read_functionalwithname_f

• Reads the value of a functional-type real variable from the CGNS file. It is used for functional-type
varianble with one parameter and multiple values.

[Format]
call cg_iric_read_functionalwithname_f (label, name, data, ier)
[Arguments]
Type Variable name I/O Description
character(*) I Name of the variable defined in the solver
label
definition file
character(*) I Name of the variable value name defined in the
name
solver definition file
real , dimension(:), allocatable data O Array of values
integer ier O Error code. 0 means success.

6.4.13. cg_iric_gotogridcoord2d_f

• Makes preparations for reading a two-dimensional structured grid.

[Format]
call cg_iric_gotogridcoord2d_f (nx, ny, ier)
[Arguments]
Type Variable name I/O Description
integer nx O Number of grid nodes in the i direction
integer ny O Number of grid nodes in the j direction
integer ier O Error code. 0 means success.

6.4.14. cg_iric_gotogridcoord3d_f

• Makes preparations for reading a 3D structured grid.

[Format]
call cg_iric_gotogridcoord3d_f(nx, ny, nz, ier)
[Arguments]
Type Variable name I/O Description
integer nx O Number of grid nodes in the i direction
integer ny O Number of grid nodes in the j direction
integer nz O Number of grid nodes in the k direction
integer ier O Error code. 0 means success.

129
6.4.15. cg_iric_getgridcoord2d_f

• Reads a two-dimensional structured grid.

[Format]
call cg_iric_getgridcoord2d_f (x, y, ier)
[Arguments]
Type Variable name I/O Description
double precision, dimension(:), x O x coordinate value of a grid node
allocatable
double precision, dimension(:), y O y coordinate value of a grid node
allocatable
integer ier O Error code. 0 means success.

6.4.16. cg_iric_getgridcoord3d_f

• Subroutine to reads a three-dimensional structured grid

[Format]
call cg_iric_getgridcoord3d_f (x, y, z, ier)
[Arguments]
Type Variable I/O Description
name
double precision, dimension(:), x O x coordinate value of a grid node
allocatable
double precision, dimension(:), y O y coordinate value of a grid node
allocatable
double precision, dimension(:), z O z coordinate value of a grid node
allocatable
integer ier O Error code. 0 means success.

130
6.4.17. cg_iric_read_grid_integer_node_f

• Reads the integer attribute values defined for nodes of a structured grid.

[Format]
call cg_iric_read_grid_integer_node_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

6.4.18. cg_iric_read_grid_real_node_f

• Reads the double-precision real-type attribute values defined for nodes of a structured grid.

[Format]
call cg_iric_read_grid_real_node_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
double precision, dimension(:), values O Attribute value
allocatable
integer ier O Error code. 0 means success.

6.4.19. cg_iric_read_grid_integer_cell_f

• Reads the integer attribute values defined for cells of a structured grid.

[Format]
call cg_iric_read_grid_integer_cell_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

131
6.4.20. cg_iric_read_grid_real_cell_f

• Reads the double-precision real-type attribute values defined for cells of a structured grid.

[Format]
call cg_iric_read_grid_real_cell_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
double precision, dimension(:), values O Attribute value
allocatable
integer ier O Error code. 0 means success.

6.4.21. cg_iric_read_complex_count_f

• Reads the number of groups of complex type grid attribute

[Format]
call cg_iric_read_complex_count_f (type, num, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num O The number of complex type grid attribute
group
integer ier O Error code. 0 means success.

6.4.22. cg_iric_read_complex_integer_f

• Reads the integer attribute values of complex type grid attribute

[Format]
call cg_iric_read_complex_integer_f (type, num, name, value, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
integer value O Attribute value
integer ier O Error code. 0 means success.

132
6.4.23. cg_iric_read_complex_real_f

• Reads the double precision attribute values of complex type grid attribute

[Format]
call cg_iric_read_complex_real_f (type, num, name, value, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
double precision value O Attribute value
integer ier O Error code. 0 means success.

6.4.24. cg_iric_read_complex_realsingle_f

• Reads the single precision attribute values of complex type grid attribute

[Format]
call cg_iric_read_complex_realsingle_f (type, num, name, value, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
Real value O Attribute value
integer ier O Error code. 0 means success.

133
6.4.25. cg_iric_read_complex_string_f

• Reads the string attribute values of complex type grid attribute

[Format]
call cg_iric_read_complex_string_f (type, num, name, value, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
character(*) value O Attribute value
integer ier O Error code. 0 means success.

For variable “name”, specify the value of “name” attribute value of Item element in the solver definition file.
When you want to read “Name” value on the dialog, specify “_caption” as variable “name”.

6.4.26. cg_iric_read_complex_functionalsize_f

• Checks the size of a functional-type attribute of complex type grid attribute

[Format]
call cg_iric_read_complex_functionalsize_f (type, num, name, size, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
integer size O The length of condition value array
integer ier O Error code. 0 means success.

134
6.4.27. cg_iric_read_complex_functional_f

• Reads functional attribute data of complex type grid attribute

[Format]
call cg_iric_read_complex_functional_f (type, num, name, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
double precision, dimension(:), x O x value array
allocatable
double precision, dimension(:), y y value array
allocatable
integer ier O Error code. 0 means success.

6.4.28. cg_iric_read_complex_functionalwithname_f

• Reads functional attribute of complex type grid attribute (with multiple values)

[Format]
call cg_iric_read_complex_functionalwithname_f (type, num, name, paramname, data, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
character(*) paramname I Value name
double precision, dimension(:), data O Value array
allocatable
integer ier O Error code. 0 means success.

135
6.4.29. cg_iric_read_complex_functional_realsingle_f

• Reads functional attribute data of complex type grid attribute

[Format]
call cg_iric_read_complex_functional_realsingle_f (type, num, name, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Attribute name
integer num I Group number
character(*) name I Condition name
real, dimension(:), allocatable x O x value array
real, dimension(:), allocatable y O y value array
integer ier O Error code. 0 means success.

6.4.30. cg_iric_read_grid_complex_node_f

• Reads the complex attribute values defined for grid nodes

[Format]
call cg_iric_read_grid_complex_node_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

6.4.31. cg_iric_read_grid_complex_cell_f

• Reads the complex attribute values defined for grid cells

[Format]
call cg_iric_read_grid_complex_cell_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

136
6.4.32. cg_iric_read_grid_functionaltimesize_f

• Reads the number of values of dimension “Time” for functional grid attribute

[Format]
call cg_iric_read_grid_functionaltimesize_f (label, count, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer count O The number of values of dimension “Time”
integer ier O Error code. 0 means success.

6.4.33. cg_iric_read_grid_functionaltime_f

• Reads the values of dimension “Time” for functional grid attribute

[Format]
call cg_iric_read_grid_functionaltime_f (label, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
double precision, dimension(:), values O The values of dimension “Time”
allocatable
integer ier O Error code. 0 means success.

6.4.34. cg_iric_read_grid_functionaldimensionsize_f

• Reads the number of values of dimension for functional grid attribute

[Format]
call cg_iric_read_grid_functionaldimensionsize_f (label, dimname, count, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
character(*) dimname I Dimension name
integer count O The number of values of dimension “Time”
integer ier O Error code. 0 means success.

137
6.4.35. cg_iric_read_grid_functionaldimension_integer_f

• Reads the values of integer dimension for functional grid attribute

[Format]
call cg_iric_read_grid_functionaldimension_integer_f (label, dimname, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
character(*) dimname I Dimension name
integer, dimension(:), allocatable values O The values of dimension
integer ier O Error code. 0 means success.

6.4.36. cg_iric_read_grid_functionaldimension_real_f

• Reads the values of double-precision dimension for functional grid attribute

[Format]
call cg_iric_read_grid_functionaldimension_real_f (label, dimname, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
character(*) dimname I Dimension name
double precision, dimension(:), values O The values of dimension
allocatable
integer ier O Error code. 0 means success.

138
6.4.37. cg_iric_read_grid_functional_integer_node_f

• Reads the values of functional integer grid attribute with dimension “Time” definied at grid nodes.

[Format]
call cg_iric_read_grid_functional_integer_node_f (label, dimid, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer dimid I ID of “Time” (1 to the number of Time)
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

6.4.38. cg_iric_read_grid_functional_real_node_f

• Reads the values of functional double-precision grid attribute with dimension “Time” definied at grid
nodes.

[Format]
call cg_iric_read_grid_functional_real_node_f (label, dimid, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer dimid I ID of “Time” (1 to the number of Time)
double precision, dimension(:), values O Attribute value
allocatable
integer ier O Error code. 0 means success.

139
6.4.39. cg_iric_read_grid_functional_integer_cell_f

• Reads the values of functional integer grid attribute with dimension “Time” definied at grid cells.

[Format]
call cg_iric_read_grid_functional_integer_cell_f (label, dimid, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer dimid I ID of “Time” (1 to the number of Time)
integer, dimension(:), allocatable values O Attribute value
integer ier O Error code. 0 means success.

6.4.40. cg_iric_read_grid_functional_real_cell_f

• Reads the values of functional double-precision grid attribute with dimension “Time” definied at grid
cells.

[Format]
call cg_iric_read_grid_functional_real_cell_f (label, dimid, values, ier)

[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer dimid I ID of “Time” (1 to the number of Time)
double precision, dimension(:), values O Attribute value
allocatable
integer ier O Error code. 0 means success.

6.4.41. cg_iric_bc_count_f

• Reads the number of boundary condition.

[Format]
call cg_iric_bc_count_f (type, num)
[Arguments]
Type Variable name I/O Description
character(*) type I The type name of boundary condition you want
to know the count.
integer num O The number of boundary condition

140
6.4.42. cg_iric_read_bc_indicessize_f

• Reads the number of elements (nodes or cells) where the boundary condition is set.

[Format]
call cg_iric_bc_indicessize_f (type, num, size, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I The type name of boundary condition you want
to know the indices size
integer num O The boundary condition ID number
integer size O The number of elements (nodes or cells) where
the boundary condition is set.
integer ier O Error code. 0 means success.

The value returned to size differs depending on the position where the boundary condition is defined, as
shown in Table 6-16.

Table 6-16 The relasionship between the boundary condition position and the value returned to size
# Boundary condition Value returned to size
position
1 Node The number of nodes
2 Cell The number of cells
3 Edge The number of edges x 2

141
6.4.43. cg_iric_read_bc_indices_f

• Reads the elements (nodes or cells) where the boundary condition is set.

[Format]
call cg_iric_bc_indices_f (type, num, indices, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I The type name of boundary condition you want
to know the indices size
integer num O The boundary condition ID number
integer, dimension(2,:), indices The list of element ids where boundary
allocatable condition is specified
integer ier O Error code. 0 means success.

The values returned to indices differ depending on the position where the boundary condition is defined, as
shown in Table 6-17. Please note that for nodes and cells, each element is defined with two values, and for
edges, each element is defined with four values.

Table 6-17 The relasionship between the boundary condition position and the value returned to indices
# Boundary condition Value returned
returned to indices
position
1 Node (I of Node1), (J of Node1)
…
(I of NodeN), (J of NodeN)
2 Cell (I of Cell1), (J of Cell1)
…
(I of CellN), (J of CellN)
3 Edge (I of Edge1 start node), (J of Edge1 start node)
(I of Edge1 end node), (J of Edge1 end node)
…
(I of EdgeN start node), (J of EdgeN start node)
(I of EdgeN end node), (J of EdgeN end node)

142
6.4.44. cg_iric_read_bc_integer_f

• Reads the value of a string-type variable from the CGNS file.

[Format]
call cg_iric_read_integer_f (type, num, label, intvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) I Name of the boundary condition variable defined
label
in the solver definition file
integer intvalue O Integer read from the CGSN file
integer ier O Error code. 0 means success.

6.4.45. cg_iric_read_bc_real_f

• Reads the value of a double-precision real-type variable from the CGNS file.

[Format]
call cg_iric_read_bc_real_f (type, num, label, realvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) I Name of the variable defined in the solver
label
definition file
double precision realvalue O Real number read from the CGSN file
integer ier O Error code. 0 means success.

143
6.4.46. cg_iric_read_bc_realsingle_f

• Reads the value of a single-precision real-type variable from the CGNS file.

[Format]
call cg_iric_read_bc_realsingle_f (type, num, label, realvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) I Name of the variable defined in the solver
label
definition file
real realvalue O Real number read from the CGSN file
integer ier O Error code. 0 means success.

6.4.47. cg_iric_read_bc_string_f

• Reads the value of a string-type variable from the CGNS file.

[Format]
call cg_iric_read_bc_string_f(type, num, label, strvalue, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) label I Name of the variable defined in the solver
definition file
character(*) strvalue O Character string read from the CGSN file
integer ier O Error code. 0 means success.

When you want to load the value users specified as “Name” on iRIC GUI, call this function with value
“_caption” for label.

144
6.4.48. cg_iric_read_bc_functionalsize_f

• Reads the size of a functional-type variable from the CGNS file.

[Format]
call cg_iric_read_bc_functionalsize_f (type, num, label, size, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) label I Name of the variable defined in the solver
definition file
integer size O Length of the array that has been read from the
CGSN file
integer ier O Error code. 0 means success.

6.4.49. cg_iric_read_bc_functional_f

• Reads the value of a functional-type double-precision real variable from the CGNS file.

[Format]
call cg_iric_read_bc_functional_f (type, num, label, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) label I Name of the variable defined in the solver
definition file
double precision, dimension(:), x O Array of x values
allocatable
double precision, dimension(:), y O Array of y values
allocatable
integer ier O Error code. 0 means success.

145
6.4.50. cg_iric_read_bc_functional_realsingle_f

• Reads the value of a functional-type single-precision real variable from the CGNS file.

[Format]
call cg_iric_read_bc_functional_realsingle_f (type, num, label, x, y, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) label I Name of the variable defined in the solver
definition file
real , dimension(:), allocatable x O Array of x values
real, dimension(:), allocatable y O Array of y values
integer ier O Error code. 0 means success.

6.4.51. cg_iric_read_bc_functionalwithname_f

• Reads the value of a functional-type real variable from the CGNS file. It is used for functional-type
varianble with one parameter and multiple values.

[Format]
call cg_iric_read_bc_functionalwithname_f (type, num, label, name, data, ier)
[Arguments]
Type Variable name I/O Description
character(*) type I Name of boundary condition
integer num I Boundary condition number
character(*) label I Name of the variable defined in the solver
definition file
character(*) name I Name of the variable value name defined in the
solver definition file
real , dimension(:), allocatable data O Array of values
integer ier O Error code. 0 means success.

146
6.4.52. cg_iric_read_geo_count_f

• Reads the number of geographic data

[Format]
call cg_iric_read_geo_count_f (name, geocount, ier)
[Arguments]
Type Variable name I/O Description
character(*) name I Geographic data group name
integer geocount O The number of geographic data
integer ier O Error code. 0 means success.

6.4.53. cg_iric_read_geo_filename_f

• Reads the file name and data type of geographic data

[Format]
call cg_iric_read_geo_filename_f(name, geoid, geofilename, geotype, ier)
[Arguments]
Type Variable name I/O Description
character(*) name I Geographic data group name
integer geoid I Geographic data number
character(*) geofilename O Filename
integer geotype O Geographic data type
integer ier O Error code. 0 means success.

The retuened value of geo type is one of the values shown in Table 6-18.

Table 6-18 Constant values defined in iriclib_f.h as geographic data type

# Name Value Remarks
1 IRIC_GEO_POLYGON 1 Polygon
2 IRIC_GEO_RIVERSURVEY 2 River survey data

147
6.4.54. iric_geo_polygon_open_f

• Opens the geographic data file that contains polygon data

[Format]
call iric_geo_polygon_open_f(filename, pid, ier)
[Arguments]
Type Variable name I/O Description
character(*) filename I File name
integer pid O Polygon ID for opened file
integer ier O Error code. 0 means success.

6.4.55. iric_geo_polygon_read_integervalue_f

• Reads the value of polygon data as integer

[Format]
call iric_geo_polygon_read_integervalue_f(pid, intval, ier)
[Arguments]
Type Variable name I/O Description
integer Pid I Polygon ID
integer intval O The value of the polygon
integer Ier O Error code. 0 means success.

6.4.56. iric_geo_polygon_read_realvalue_f

• Reads the value of polygon datas double precision real

[Format]
call iric_geo_polygon_read_realvalue_f(pid, realval, ier)
[Arguments]
Type Variable name I/O Description
integer Pid I Polygon ID
double precision realval O The value of the polygon
integer Ier O Error code. 0 means success.

148
6.4.57. iric_geo_polygon_read_pointcount_f

• Reads the number of polygon vertices

[Format]
call iric_geo_polygon_read_pointcount_f(pid, count, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
integer count O The number of vertices of the polygon
integer ier O Error code. 0 means success.

6.4.58. iric_geo_polygon_read_points_f

• Reads the coorinates of polygon vertices

[Format]
call iric_geo_polygon_read_points_f(pid, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
double precision , x O X coordinates of polygon vertices
dimension(:), allocatable
double precision , y O Y coordinates of polygon vertices
dimension(:), allocatable
integer ier O Error code. 0 means success.

6.4.59. iric_geo_polygon_read_holecount_f

• Reads the number of holes in the polygon

[Format]
call iric_geo_polygon_read_holecount_f(pid, holecount, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
integer holecount O The number of holes
integer ier O Error code. 0 means success.

149
6.4.60. iric_geo_polygon_read_holepointcount_f

• Reads the number of vertices of hole polygon

[Format]
call iric_geo_polygon_read_holepointcount_f(pid, holeid, count, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
integer holeid I Hole ID
integer count O The number of vertices of the hole polygon
integer ier O Error code. 0 means success.

6.4.61. iric_geo_polygon_read_holepoints_f

• Reads the coordinates of hole polygon vertices

[Format]
call iric_geo_polygon_read_holepoints_f(pid, holeid, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
integer holeid I Hole ID
double precision , x O X coordinates of hole polygon vertices
dimension(:), allocatable
double precision , y O Y coordinates of hole polygon vertices
dimension(:), allocatable
integer ier O Error code. 0 means success.

150
6.4.62. iric_geo_polygon_close_f

• Closes the geographic data file

[Format]
call iric_geo_polygon_close_f(pid, ier)
[Arguments]
Type Variable name I/O Description
integer pid I Polygon ID
integer ier O Error code. 0 means success.

6.4.63. iric_geo_riversurvey_open_f

• Opens the geographic data file that contains river survey data

[Format]
call iric_geo_riversurvey_open_f(filename, rid, ier)
[Arguments]
Type Variable name I/O Description
character(*) filename I Filename
integer rid O River Survey Data ID
integer ier O Error code. 0 means success.

6.4.64. iric_geo_riversurvey_read_count_f

• Reads the number of the crosssections in river survey data

[Format]
call iric_geo_riversurvey_read_count_f(rid, count, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer count O The number of crosssections
integer ier O Error code. 0 means success.

151
6.4.65. iric_geo_riversurvey_read_position_f

• Reads the coordinates of the crosssection center point

[Format]
call iric_geo_riversurvey_read_position_f(rid, pointid, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
double precision x O X coordinate of the center point
double precision y O Y coordinate of the center point
integer ier O Error code. 0 means success.

6.4.66. iric_geo_riversurvey_read_direction_f

• Reads the direction of the crosssection as normalized vector

[Format]
call iric_geo_riversurvey_read_direction_f(rid, pointid, vx, vy, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
double precision vx O X component of the normalized direction vector
double precision vx O Y component of the normalized direction vector
integer ier O Error code. 0 means success.

152
6.4.67. iric_geo_riversurvey_read_name_f

• Reads the name of the crosssection as string

[Format]
call iric_geo_riversurvey_read_name_f(rid, pointed, name, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
character(*) name O Name of the crosssection
integer ier O Error code. 0 means success.

6.4.68. iric_geo_riversurvey_read_realname_f

• Reads the name of the crosssection as real number

[Format]
call iric_geo_riversurvey_read_realname_f(rid, pointid, realname, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
double precision realname O Name of the crosssection
integer ier O Error code. 0 means success.

6.4.69. iric_geo_riversurvey_read_leftshift_f

• Reads the shift offset value of the crosssection

[Format]
call iric_geo_riversurvey_read_leftshift_f(rid, pointid, shift, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
double precision shift O The amount of left shift
integer ier O Error code. 0 means success.

153
6.4.70. iric_geo_riversurvey_read_altitudecount_f

• Reads the number of altitude data of the crosssection

[Format]
call iric_geo_riversurvey_read_altitudecount_f(rid, pointid, count, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
integer count O The number of altitude data
integer ier O Error code. 0 means success.

6.4.71. iric_geo_riversurvey_read_altitudes_f

• Reads the altitude data of the crosssection

[Format]
call iric_geo_riversurvey_read_altitudes_f(rid, pointid, position, height, active, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
pointid pointid I Crosssection ID
double precision , position O Altitude position (less than 0: left bank side, grater
dimension(:), allocatable than 0: right bank side)
double precision , height O Altitude height (elevation)
dimension(:), allocatable
integer, dimension(:), active O Altitude data active/inactive (1: active, 0: inactive)
allocatable
integer ier O Error code. 0 means success.

154
6.4.72. iric_geo_riversurvey_read_fixedpointl_f

• Reads the data of left bank extension line of the crosssection

[Format]
call iric_geo_riversurvey_read_fixedpointl_f(rid, pointid, set, directionx, directiony, index, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
integer set O If defined, the value is 1
double precision directionx O X component of normalized direction vector
double precision direction O Y component of normalized direction vector
integer O The ID of the altitude data where the left bank
index
extension line starts
integer ier O Error code. 0 means success.

6.4.73. iric_geo_riversurvey_read_fixedpointr_f

• Reads the data of right bank extension line of the crosssection

[Format]
call iric_geo_riversurvey_read_fixedpointr_f(rid, pointid, set, directionx, directiony, index, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
integer set O If defined, the value is 1
double precision directionx O X component of normalized direction vector
double precision direction O Y component of normalized direction vector
integer O The ID of the altitude data where the right bank
index
extension line starts
integer ier O Error code. 0 means success.

155
6.4.74. iric_geo_riversurvey_read_watersurfaceelevation_f

• Reads the water elevation at the crosssection

[Format]
call iric_geo_riversurvey_read_watersurfaceelevation_f(rid, pointid, set, value, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer pointid I Crosssection ID
integer set O If defined the value is 1
double precision value O Water surface elevation
integer ier O Error code. 0 means success.

6.4.75. iric_geo_riversurvey_close_f

• Closes the geographic data file

[Format]
call iric_geo_ riversurvey_close_f(pid, ier)
[Arguments]
Type Variable name I/O Description
integer rid I River Survey Data ID
integer ier O Error code. 0 means success.

6.4.76. cg_iric_writegridcoord1d_f

• Outputs a one-dimensional structured grid.

[Format]
call cg_iric_writegridcoord1d_f (nx, x, ier)
[Arguments]
Type Variable name I/O Description
integer nx I Number of grid nodes in the i direction
double precision, dimension(:), x I x coordinate value of a grid node
allocatable
integer ier O Error code. 0 means success.

156
6.4.77. cg_iric_writegridcoord2d_f

• Outputs a two-dimensional structured grid.

[Format]
call cg_iric_writegridcoord2d_f (nx, ny, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer nx I Number of grid nodes in the i direction
integer ny I Number of grid nodes in the j direction
double precision, dimension(:,:), x I x coordinate value of a grid node
allocatable
double precision, dimension(:,:), y I y coordinate value of a grid node
allocatable
integer ier O Error code. 0 means success.

6.4.78. cg_iric_writegridcoord3d_f

• Outputs a three-dimensional structured grid.

[Format]
call cg_iric_writegridcoord2d_f (nx, ny, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer nx I Number of grid nodes in the i direction
integer ny I Number of grid nodes in the j direction
integer nz I Number of grid nodes in the k direction
double precision, dimension(:), x I x coordinate value of a grid node
allocatable
double precision, dimension(:), y I y coordinate value of a grid node
allocatable
double precision, dimension(:), z I z coordinate value of a grid node
allocatable
integer ier O Error code. 0 means success.

157
6.4.79. cg_iric_write_grid_integer_node_f

• Outputs grid attribute values defined at grid nodes with integer value.

[Format]
call cg_iric_write_grid_integer_node_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), llocatable values O Attribute values
integer ier O Error code. 0 means success.

6.4.80. cg_iric_write_grid_real_node_f

• Outputs grid attribute values defined at grid nodes with real number value.

[Format]
call cg_iric_write_grid_real_node_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
double precision, dimension(:), values O Attribute values
allocatable
integer ier O Error code. 0 means success.

6.4.81. cg_iric_write_grid_integer_cell_f

• Outputs grid attribute values defined at grid cells with integer value.

[Format]
call cg_iric_write_grid_integer_cell_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
integer, dimension(:), allocatable values O Attribute values
integer ier O Error code. 0 means success.

158
6.4.82. cg_iric_write_grid_real_cell_f

• Outputs grid attribute values defined at grid cells with real number value.

[Format]
call cg_iric_read_grid_real_cell_f (label, values, ier)
[Arguments]
Type Variable name I/O Description
character(*) label I Attribute name
double precision, dimension(:), values O Attribute values
allocatable
integer ier O Error code. 0 means success.

6.4.83. cg_iric_write_sol_time_f

• Outputs time.

[Format]
call cg_iric_write_sol_time_f (time, ier)
[Arguments]
Type Variable name I/O Description
double precision time I Time
integer ier O Error code. 0 means success.

6.4.84. cg_iric_write_sol_iteration_f

• Outputs iteration count.

[Format]
call cg_iric_write_sol_iteration_f (iteration, ier)
[Arguments]
Type Variable name I/O Description
integer iteration I Iteration count
integer ier O Error code. 0 means success.

159
6.4.85. cg_iric_write_sol_gridcoord2d_f

• Outputs a two-dimensional structured grid.

[Format]
call cg_iric_write_sol_gridcoord2d_f (x, y, ier)
[Arguments]
Type Variable name I/O Description
double precision, dimension(:), x I x coordinate.
allocatable
double precision, dimension(:), y I y coordinate
allocatable
integer ier O Error code. 0 means success.

6.4.86. cg_iric_write_sol_gridcoord3d_f

• Outputs a three-dimensional structured grid.

[Format]
call cg_iric_write_sol_gridcoord3d_f (x, y, z, ier)
[Arguments]
Type Variable name I/O Description
double precision, dimension(:), x I x coordinate.
allocatable
double precision, dimension(:), y I y coordinate.
allocatable
double precision, dimension(:), z I z coordinate
allocatable
integer ier O Error code. 0 means success.

160
6.4.87. cg_iric_write_sol_baseiterative_integer_f

• Outputs integer-type calculation results.

[Format]
call cg_iric_write_sol_baseiterative_integer_f (label, val, ier)
[Arguments]
Type Variable name I/O Description
character* label I Name of the value to be output
integer val I Value to be output
integer ier O Error code. 0 means success.

6.4.88. cg_iric_write_sol_baseiterative_real_f

• Outputs double-precision real-type calculation results.

[Format]
call cg_iric_write_sol_baseiterative_real_f (label, val, ier)
[Arguments]
Type Variable name I/O Description
character* label I Name of the value to be output
double precision val I Value to be output
integer ier O Error code. 0 means success.

6.4.89. cg_iric_write_sol_integer_f

• Outputs integer-type calculation results, giving a value for each grid node.

[Format]
call cg_iric_write_sol_integer_f (label, val, ier)
[Arguments]
Type Variable name I/O Description
character* label I Name of the value to be output
integer, dimension(:,:), val I Value to be output
allocatable In the case of a 3D grid, the type should be
integer, dimension(:,:,:), allocatable.
integer ier O Error code. 0 means success.

161
6.4.90. cg_iric_write_sol_real_f

• Outputs double-precision real-type calculation results, having a value for each grid node.

[Format]
call cg_iric_write_sol_real_f (label, val, ier)
[Arguments]
Type Variable name I/O Description
character* label I Name of the value to be output.
double precision, dimension(:,:), val I Value to be output
allocatable In the case of a 3D grid, the type should be
double precision, dimension(:,:,:), allocatable.
integer ier O Error code. 0 means success.

6.4.91. cg_iric_write_sol_particle_pos2d_f

• Outputs particle positions (two-dimensions)

[Format]
call cg_iric_write_sol_particle_pos2d_f (count, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer count I The number of particles
double precision, dimension(:), x I x coordinate.
allocatable
double precision, dimension(:), y I y coordinate.
allocatable
integer ier O Error code. 0 means success.

162
6.4.92. cg_iric_write_sol_particle_pos3d_f

• Outputs particle positions (three-dimensions)

[Format]
call cg_iric_write_sol_particle_pos3d_f (count, x, y, z, ier)
[Arguments]
Type Variable name I/O Description
integer count I The number of particles
double precision, dimension(:), x I x coordinate.
allocatable
double precision, dimension(:), y I y coordinate.
allocatable
double precision, dimension(:), z I z coordinate.
allocatable
integer ier O Error code. 0 means success.

6.4.93. cg_iric_read_sol_count_f

• Reads the number of calculation result

[Format]
call cg_iric_read_sol_count_f (count, ier)
[Arguments]
Type Variable name I/O Description
integer count O The number of the calculation result
integer ier O Error code. 0 means success.

6.4.94. cg_iric_read_sol_time_f

• Reads the time value

[Format]
call cg_iric_read_sol_time_f (step, time, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
double precision time O Time
integer ier O Error code. 0 means success.

163
6.4.95. cg_iric_read_sol_iteration_f

• Reads the loop iteration value

[Format]
call cg_iric_read_sol_iteration_f (step, iteration, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
integer iteration O Iteration value
integer ier O Error code. 0 means success.

6.4.96. cg_iric_read_sol_baseiterative_integer_f

• Reads the integer-type calculation result value

[Format]
call cg_iric_read_sol_baseiterative_integer_f (step, label, val, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
character(*) label I Name
integer val O Value
integer ier O Error code. 0 means success.

6.4.97. cg_iric_read_sol_baseiterative_real_f

• Reads the double-precision real-type calculation result value

[Format]
call cg_iric_read_sol_baseiterative_real_f (step, label, val, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
character(*) label I Name
double precision val O Value
integer ier O Error code. 0 means success.

164
6.4.98. cg_iric_read_sol_gridcoord2d_f

• Reads the 2D structured grid (for moving grid calculation)

[Format]
call cg_iric_read_sol_gridcoord2d_f (step, x, y, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
double precision, dimension(:), x O x coordinates
allocatable
double precision, dimension(:), y O y coordinates
allocatable
integer ier O Error code. 0 means success.

6.4.99. cg_iric_read_sol_gridcoord3d_f

• Reads the 3D structured grid (for moving grid calculation)

[Format]
call cg_iric_read_sol_gridcoord3d_f (step, x, y, z, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
double precision, dimension(:), x O Xcoordinates
allocatable
double precision, dimension(:), y O Y coordinates
allocatable
double precision, dimension(:), z O Z coordinates
allocatable
integer ier O Error code. 0 means success.

165
6.4.100. cg_iric_read_sol_integer_f

• Reads the integer-type calculation result, having a value for each grid node

[Format]
call cg_iric_read_sol_integer_f (step, label, val, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
character(*) label I Name
integer, imension(:,:),allocatable val O Value (In case of 3D grid, integer,
dimension(:,:,:), allocatable)
integer ier O Error code. 0 means success.

6.4.101. cg_iric_read_sol_real_f

• Reads the double-precision real-type calculation result, having a value for each grid node

[Format]
call cg_iric_read_sol_real_f (step, label, val, ier)
[Arguments]
Type Variable name I/O Description
integer step I Result Step Number
character(*) label I Name
double precision, dimension(:,:), val O Value (In case of 3D grid, double precision,
allocatable dimension(:,:,:), allocatable)
integer ier O Error code. 0 means success.

6.4.102. cg_iric_write_errorcode_f

• Outputs error code

[Format]
call cg_iric_write_errorcode_f (code, ier)
[Arguments]
Type Variable name I/O Description
integer code I The error code that the grid generating
program returns.
integer ier O Error code. 0 means success.

166
6.4.103. cg_close_f

 Closing the CGNS file

[Format]
call cg_close_f(fid, ier)
[Arguments]
Type Variable name I/O Description
integer fid I File ID
integer ier O Error code. 0 means success.

167
7. Other Informations

7.1. Handling command line arguments in Fortran programs

When iRIC launches solvers (or grid generating programs), the name of calculation data file (or grid
generating data file) is passed as an argument. So, solvers (or grid generating programs) have to process the
file name and opens that file.
In FORTRAN, the functions prepared for handling arguments are different by compilers. In this section,
functions for handling arguments are explained for Intel Fortran Complier and GNU Fortran compiler.

7.1.1. Intel Fortran Compiler

Obtain the number of command line arguments using nargs(), and if the calculation condition filename is
passed obtain the file name using getarg().

icount = nargs() ! The number includes the executable name, so if user passed one argument, 2 is returned.
if ( icount.eq.2 ) then
call getarg(1, condFile, istatus)
else
write(*,*) “Input File not specified.”
stop
Endif

7.1.2. GNU Fortran, G95

Obtain the number of command line arguments using iargc (), and if the calculation condition filename is
passed obtain the file name using getarg().
Note that nargs(), getargs() in GNU Fortran has different specification to those in Intel Fortran Compiler.

icount = iargc() ! The number does not includes the executable name, so if user passed one argument, 1 is returned.
if ( icount.eq.1 ) then
call getarg(0, str1) ! The file name of the executable.
call getarg(1, condfile) ! The first argument
else
write(*,*) “Input File not specified.”
stop
endif

168
7.2. Linking iRIClib, cgnslib using Fortran

When you develop solvers (or grid generating programs), you have to link the program with iRIClib and
cgnslib. You have to use different library files for different compilers like Intel Fortran Compiler and GNU
Fortran. Table 7-1 shows the files prepared for each compiler. For header file, “libcgns_f.h”, “iriclib_f.h” can
be used for all compilers commonly.

Table 7-1 Files prepared fore each compiler

Compiler iRIClib library cgnslib library

Intel Fortran Compiler iriclib.lib cgnslib.lib

GNU Fortran(gfortran) iriclib.a libcgns.a

We will explain the procedure to compile the source code (solver.f). We assume that the settings for compilers
(like path settings) are already finished.

7.2.1. Intel Fortran Compiler (Windows)

Put solver.f, cgnslib.lib, libiric.lib, msvcprt.lib, cgnslib_f.h, iriclib_f.h in a same folder, move to that folder
with command prompt, and run the following command to create an executable file named solver.exe.

ifort solver.f libcgns.lib iriclib.lib /MD

When compiling is done, a file named solver.exe.manifest is also created. When copying the solver to another
machine, make sure to copy this file and to place them together in the same folder.

7.2.2. GNU Fortran

Put solver.f, cgnslib.lib, libiric.lib, cgnslib_f.h, iriclib_f.h in a same folder, move to that folder with command
prompt, and run the following command to create an executable file named solver.exe.

gfortran -c solver.f
g++ -o solver.exe -lgfortran solver.o cgnslib.a libiric.a

169
7.3. Special names for grid attributes and calculation results

In iRIC, some special names for grid attribute and calculation results are defined for certain purposes. Use
those names when the solver uses the grid attributes or calculation results that match the purposes.

7.3.1. Grid attributes

Table 7-3 shows the special names defined for grid attributes.

Table 7-2 Special names for grid attributes

Name Description Example
Elevation Grid attribute that contains elevation of grid nodes (Unit: Table 7-3
meter). Define “Elevation” attribute as an attribute defined
at grid node, with real number type.

When you use “Elevation” for grid attribute, define an Item element as a child of GridRelatedCondition
element, like Table 7-3. You can change caption attribute value to an arbitrary value.

Table 7-3 Example of “Elevation” element definition

<Item name="Elevation" caption="Elevation">
<Definition position="node" valueType="real" default="max" />
</Item>

When you create a grid generating program and want to output elevation value, use name “Elevation”. iRIC
will automatically load “Elevation” value. Table 7-4 shows an example of code written in Fortran.

Table 7-4 Example of source code to output elevation value in grid generating program
cg_iric_write_grid_real_node_f("Elevation", elevation, ier);

170
7.3.2. Calculation results

Table 7-5 shows the special names defined for calculation results. Specify these names as arguments of
subroutines defined in iRIClib. Table 7-6 shows an example of solver source code that outputs all special
calculation result.

Table 7-5 Special names for calculation results

Name Description Required
Elevation Outputs bed elevation (unit: meter). Output the value as real number calculation Yes
result. You can add unit in the tail as the part of the name, like “Elevation(m)”.

WaterSurfaceElevation Outputs water surface elevation (unit: meter). Output the value as real
numvercalculation result. You can add unit in the tail, like
“WaterSurfaceElevation(m)”.

IBC Valid/invalid flag. At invalid region (i. e. dry region), the value is 0, and at valid

region (i. e. wet region), the value is 1.

Table 7-6 Example of source code to output calculation results with the special names
call cg_iric_write_sol_real_f ('Elevation(m)', elevation_values, ier)
call cg_iric_write_sol_real_f ('WaterSurfaceElevation(m) ', surface_values, ier)
call cg_iric_write_sol_integer_f ('IBC', IBC_values, ier)

171
7.4. Information on CGNS file and CGNS library

7.4.1. General concept of CGNS file format

CGNS, which stands for CFG General Notation System, refers to a general-purpose file format for storing
data for use in numeric hydrodynamics. It can be used across various platforms of different OSes and CPUs.
In addition to its standard data format being defined for use in numeric hydrodynamics, it has expandability
that allows the addition of elements specific to each solver.
An input/output library for CGNS, called cgnslib, is provided. It can be used in the following languages.
C, C++
FORTRAN
Python
Originally jointly developed by the Boeing Company and NASA, it is currently undergoing the addition of
new features and maintenance by an open-source community.

7.4.2. How to view a CGNS file

This section describes how to view a CGNS file that has been created by iRIC using ADFviewer. ADFviewer
is a software tool published as freeware by the developer of CGNS.

1) Installing CGNSTools

First, install CGNSTools, including ADFviewer. The installer of CGNStools can be downloaded from
http://sourceforge.net/projects/cgns/

Figure 7-1a CGNSTool web page

From the CGNS homepage, click the "View all files" link as circled in red in the above figure. You will be
taken to a screen that allows you to download various CGNS-related programs. On this screen, click

172
win-install-2-5-2.zip (circled in red) in the figure to download it.
This is the installer of CGNStools. By unzipping it and executing the installer, you can install GNStools.

Figure 7-2 CGNStools web page

2) Viewing a CGNS file using ADFviewer

Start ADFviewer and view a CGNS file.

To do so, first launch ADFviewer from the start menu. Then, from the following menu, select Open CGNS.
File  Open
An example of the ADFviewer screen immediately after a CGNS file has been opened is shown below.

173
 Figure 7-3 Example of ADFviewer screen

In the Node Tree pane on the left side of the screen, the tree structure of the CGNS file contents appears.
Selecting an item you want to view on the Node Tree displays information on the selected item, including its
name, description and data contained.
Note that when you select any item that has a large-sized array (e.g., x coordinate data of a calculation grid),
the data do not appear immediately. In the case of such a large-sized array, clicking the "read" button after
selecting the item reads the data and brings it into view.

Figure 7-4 Displaying the x coordinate data of a calculation grid in ADFviewer

174
7.4.3. Reference URLs

For information on CGNS files and CGNS libraries, refer to the URLs in Table 7-7.

Table 7-7 Reference URLs for CGNS file format CGNS libraries
Item URL
Homepage http://cgns.sourceforge.net/

Function reference http://www.grc.nasa.gov/WWW/cgns/midlevel/index.html

Data structure inside a CGNS file http://www.grc.nasa.gov/WWW/cgns/sids/index.html

Sample program descriptions that http://sourceforge.net/projects/cgns/files/UserGuideCode/Release%2

demonstrate how to use CGNS 03/UserGuideCodeV3.zip/download
libraries

175
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
Developer’s Manual
Directed by River Center of Hokkaido All

Edited by Mizuho Information & Research Institute All

176