List of subroutines¶
The table below shows a list of subroutines and their classifications.
Classification |
Name |
Description |
|---|---|---|
Opening a CGNS file |
cg_iric_open |
Opens a CGNS file |
Setting up options |
iric_initoption |
Set up solver option |
Reading the calculation conditions |
cg_iric_read_integer |
Gets the value of an integer variable |
Reading the calculation conditions |
cg_iric_read_real |
Gets the value of a real (double-precision) variable |
Reading the calculation conditions |
cg_iric_read_realsingle |
Gets the value of a real (single-precision) variable |
Reading the calculation conditions |
cg_iric_read_string |
Gets the value of a string-type variable |
Reading the calculation conditions |
cg_iric_read_functionalsize |
Gets the size of a f_functional-type variable |
Reading the calculation conditions |
cg_iric_read_functional |
Gets the value of a f_functional-type double-precision variable |
Reading the calculation conditions |
cg_iric_read_functional_realsingle |
Gets the value of a f_functional-type single-precision variable |
Reading the calculation conditions |
cg_iric_read_functionalwithname |
Gets the value of a f_functional-type variable (with multiple values) |
Reading a calculation grid |
cg_iric_read_grid2d_str_size |
Makes preparations for reading a grid |
Reading a calculation grid |
cg_iric_read_grid2d_coords |
Reads the x and y coordinates of a grid |
Reading a calculation grid |
cg_iric_read_grid_nodecount |
Reads node count of a grid |
Reading a calculation grid |
cg_iric_read_grid_cellcount |
Reads cell count of a grid |
Reading a calculation grid |
cg_iric_read_grid_triangleelements |
Reads the list of ids of triangles for unstructured grid |
Reading a calculation grid |
cg_iric_read_grid_integer_node |
Reads the integer attribute values defined for grid nodes |
Reading a calculation grid |
cg_iric_read_grid_real_node |
Reads double-precision attribute values defined for grid nodes |
Reading a calculation grid |
cg_iric_read_grid_integer_cell |
Reads the integer attribute values defined for cells |
Reading a calculation grid |
cg_iric_read_grid_real_cell |
Reads the double-precision attribute values defined for cells |
Reading a calculation grid |
cg_iric_read_complex_count |
Reads the number of groups of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_integer |
Reads the integer attribute values of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_real |
Reads the double precision attribute values of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_realsingle |
Reads the single precision attribute values of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_string |
Reads the string attribute values of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_functionalsize |
Checks the size of a f_functional-type attribute of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_functional |
Reads f_functional attribute data of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_complex_functionalwithname |
Reads f_functional attribute of complex type grid attribute (with multiple values) |
Reading a calculation grid |
cg_iric_read_complex_functional_realsingle |
Reads f_functional attribute data of complex type grid attribute |
Reading a calculation grid |
cg_iric_read_grid_complex_node |
Reads the complex attribute values defined for grid nodes |
Reading a calculation grid |
cg_iric_read_grid_complex_cell |
Reads the complex attribute values defined for grid cells |
Reading a calculation grid |
cg_iric_read_grid_functionaltimesize |
Reads the number of values of dimension \”Time\” for f_functional grid attribute |
Reading a calculation grid |
cg_iric_read_grid_functionaltime |
Reads the values of dimension \”Time\” for f_functional grid attribute |
Reading a calculation grid |
cg_iric_read_grid_functionaldimensionsize |
Reads the number of values of dimension for f_functional grid attribute |
Reading a calculation grid |
cg_iric_read_grid_functionaldimension_integer |
Reads the values of integer dimension for f_functional grid attribute |
Reading a calculation grid |
cg_iric_read_grid_functionaldimension_real |
Reads the values of double-precision dimension for f_functional grid attribute |
Reading a calculation grid |
cg_iric_read_grid_functional_integer_node |
Reads the values of f_functional integer grid attribute with dimension \”Time\” definied at grid nodes. |
Reading a calculation grid |
cg_iric_read_grid_functional_real_node |
Reads the values of f_functional double-precision grid attribute with dimension \”Time\” definied at grid nodes. |
Reading a calculation grid |
cg_iric_read_grid_functional_integer_cell |
Reads the values of f_functional integer grid attribute with dimension \”Time\” definied at grid cells. |
Reading a calculation grid |
cg_iric_read_grid_functional_real_cell |
Reads the values of f_functional double-precision grid attribute with dimension \”Time\” definied at grid cells. |
Reading boundary conditions |
cg_iric_read_bc_count |
Reads the number of boundary conditions |
Reading boundary conditions |
cg_iric_read_bc_indicessize |
Reads the number of elements (nodes or cells) where boundary conditions are assigned. |
Reading boundary conditions |
cg_iric_read_bc_indices |
Reads the list of indices of elements (nodes or cells) where boundary conditions are assigned. |
Reading boundary conditions |
cg_iric_read_bc_integer |
Gets the value of an integer boundary condition |
Reading boundary conditions |
cg_iric_read_bc_real |
Gets the value of an real (double-precision) boundary condition |
Reading boundary conditions |
cg_iric_read_bc_realsingle |
Gets the value of an real (single-precision) boundary condition |
Reading boundary conditions |
cg_iric_read_bc_string |
Gets the value of an string-type boundary condition |
Reading boundary conditions |
cg_iric_read_bc_functionalsize |
Gets the size of an f_functional-type boundary condition |
Reading boundary conditions |
cg_iric_read_bc_functional |
Gets the value of an f_functional-type double-precision boundary condition |
Reading boundary conditions |
cg_iric_read_bc_functional_realsingle |
Gets the value of an f_functional-type single-precision boundary condition |
Reading boundary conditions |
cg_iric_read_bc_functionalwithname |
Gets the value of a f_functional-type boundary condition (with multiple values) |
Reading geographic data |
cg_iric_read_geo_count |
Reads the number of geographic data |
Reading geographic data |
cg_iric_read_geo_filename |
Reads the file name and data type of geographic data |
Reading geographic data |
iric_geo_polygon_open |
Opens the geographic data file that contains polygon data |
Reading geographic data |
iric_geo_polygon_read_integervalue |
Reads the value of polygon data as integer |
Reading geographic data |
iric_geo_polygon_read_realvalue |
Reads the value of polygon datas double precision real |
Reading geographic data |
iric_geo_polygon_read_pointcount |
Reads the number of polygon vertices |
Reading geographic data |
iric_geo_polygon_read_points |
Reads the coorinates of polygon vertices |
Reading geographic data |
iric_geo_polygon_read_holecount |
Reads the number of holes in the polygon |
Reading geographic data |
iric_geo_polygon_read_holepointcount |
Reads the number of vertices of hole polygon |
Reading geographic data |
iric_geo_polygon_read_holepoints |
Reads the coordinates of hole polygon vertices |
Reading geographic data |
iric_geo_polygon_close |
Closes the geographic data file |
Reading geographic data |
iric_geo_riversurvey_open |
Opens the geographic data file that contains river survey data |
Reading geographic data |
iric_geo_riversurvey_read_count |
Reads the number of the crosssections in river survey data |
Reading geographic data |
iric_geo_riversurvey_read_position |
Reads the coordinates of the crosssection center point |
Reading geographic data |
iric_geo_riversurvey_read_direction |
Reads the direction of the crosssection as normalized vector |
Reading geographic data |
iric_geo_riversurvey_read_name |
Reads the name of the crosssection as string |
Reading geographic data |
iric_geo_riversurvey_read_realname |
Reads the name of the crosssection as real number |
Reading geographic data |
iric_geo_riversurvey_read_leftshift |
Reads the shift offset value of the crosssection |
Reading geographic data |
iric_geo_riversurvey_read_altitudecount |
Reads the number of altitude data of the crosssection |
Reading geographic data |
iric_geo_riversurvey_read_altitudes |
Reads the altitude data of the crosssection |
Reading geographic data |
iric_geo_riversurvey_read_fixedpointl |
Reads the data of left bank extension line of the crosssection |
Reading geographic data |
iric_geo_riversurvey_read_fixedpointr |
Reads the data of right bank extension line of the crosssection |
Reading geographic data |
iric_geo_riversurvey_read_watersurfaceelevation |
Reads the water elevation at the crosssection |
Reading geographic data |
iric_geo_riversurvey_close |
Closes the geographic data file |
Outputting a calculation grid |
cg_iric_write_grid1d_coords |
Outputs a one-dimensional structured grid |
Outputting a calculation grid |
cg_iric_write_grid2d_coords |
Outputs a two-dimensional structured grid |
Outputting a calculation grid |
cg_iric_write_grid3d_coords |
Outputs a three-dimensional structured grid |
Outputting a calculation grid |
cg_iric_write_grid_integer_node |
Outputs a grid attributed defined at grid nodes with integer values. |
Outputting a calculation grid |
cg_iric_write_grid_real_node |
Outputs a grid attributed defined at grid nodes with real number (double-precision) values. |
Outputting a calculation grid |
cg_iric_write_grid_integer_cell |
Outputs a grid attributed defined at grid cells with integer values. |
Outputting a calculation grid |
cg_iric_write_grid_real_cell |
Outputs a grid attributed defined at grid cells with real number (double-precision) values. |
Outputting time (or iteration count) information |
cg_iric_write_sol_time |
Outputs time |
Outputting time (or iteration count) information |
cg_iric_write_sol_iteration |
Outputs the iteration count |
Outputting calculation results |
cg_iric_write_sol_grid2d_coords |
Outputs a two-dimensional structured grid |
Outputting calculation results |
cg_iric_write_sol_grid3d_coords |
Outputs a three-dimensional structured grid |
Outputting calculation results |
cg_iric_write_sol_baseiterative_integer |
Outputs integer-type calculation results |
Outputting calculation results |
cg_iric_write_sol_baseiterative_real |
Outputs double-precision real-type calculation results |
Outputting calculation results |
cg_iric_write_sol_baseiterative_string |
Outputs string-type calculation results |
Outputting calculation results |
cg_iric_write_sol_node_integer |
Outputs integer-type calculation results, having a value for each grid node |
Outputting calculation results |
cg_iric_write_sol_node_real |
Outputs double-precision real-type calculation results, having a value for each grid node |
Outputting calculation results |
cg_iric_write_sol_cell_integer |
Outputs integer-type calculation results, having a value for each grid cell |
Outputting calculation results |
cg_iric_write_sol_cell_real |
Outputs double-precision real-type calculation results, having a value for each grid cell |
Outputting calculation results |
cg_iric_write_sol_iface_integer |
Outputs integer-type calculation results, having a value for each grid edge at i-direction |
Outputting calculation results |
cg_iric_write_sol_iface_real |
Outputs double-precision real-type calculation results, having a value for each grid edge at i-direction |
Outputting calculation results |
cg_iric_write_sol_jface_integer |
Outputs integer-type calculation results, having a value for each grid edge at j-direction |
Outputting calculation results |
cg_iric_write_sol_jface_real |
Outputs double-precision real-type calculation results, having a value for each grid edge at j-direction |
Outputting calculation results (particles) |
cg_iric_write_sol_particle_pos2d |
Outputs particle positions (two-dimensions) |
Outputting calculation results (particles) |
cg_iric_write_sol_particle_pos3d |
Outputs particle positions (three-dimensions) |
Outputting calculation results (particles) |
cg_iric_write_sol_particle_integer |
Outputs integer-type calculation results, having a value for each particle |
Outputting calculation results (particles) |
cg_iric_write_sol_particle_real |
Outputs double-precision real-type calculation results, having a value for each particle |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_groupbegin |
Start outputting calculation result defined as particles |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_groupend |
Finish outputting calculation result defined as particles |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_pos2d |
Outputs particle positions (two-dimensions) |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_pos3d |
Outputs particle positions (three-dimensions) |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_integer |
Outputs integer-type calculation results, having a value for each particle |
Outputting calculation results (particles) |
cg_iric_write_sol_particlegroup_real |
Outputs double-precision real-type calculation results, having a value for each particle |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_groupbegin |
Start outputting calculation result defined as polygons or polylines |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_groupend |
Finish outputting calculation result defined as polygons or polylines |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_polygon |
Output calculation result defined as polygon |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_polyline |
Output calculation result defined as polyline |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_integer |
Outputs integer-type calculation results, having a value for a polygon or polyline |
Outputting calculation results (polygons, polylines) |
cg_iric_write_sol_polydata_real |
Outputs double-precision real-type calculation results, having a value for a polygon or polyline |
Functions to call before and after outputting calculation results |
iric_check_cancel |
Checks whether user canceled solver execution |
Functions to call before and after outputting calculation results |
cg_iric_check_update |
Checks whether user requested reloading calculation result |
Functions to call before and after outputting calculation results |
cg_iric_write_sol_start |
Inform the GUI that the solver started outputting result |
Functions to call before and after outputting calculation results |
cg_iric_write_sol_end |
Inform the GUI that the solver finished outputting result |
Reading calculation results |
cg_iric_read_sol_count |
Reads the number of calculation results |
Reading calculation results |
cg_iric_read_sol_time |
Reads the time value |
Reading calculation results |
cg_iric_read_sol_iteration |
Reads the loop iteration value |
Reading calculation results |
cg_iric_read_sol_baseiterative_integer |
Reads the integer-type calculation result value |
Reading calculation results |
cg_iric_read_sol_baseiterative_real |
Reads the double-precision real-type calculation result value |
Reading calculation results |
cg_iric_read_sol_baseiterative_string |
Reads the string-type calculation result value |
Reading calculation results |
cg_iric_read_sol_grid2d_coords |
Reads the 2D structured grid (for moving grid calculation) |
Reading calculation results |
cg_iric_read_sol_grid3d_coords |
Reads the 3D structured grid (for moving grid calculation) |
Reading calculation results |
cg_iric_read_sol_node_integer |
Reads the integer-type calculation result, having a value for each grid node |
Reading calculation results |
cg_iric_read_sol_node_real |
Reads the double-precision real-type calculation result, having a value for each grid node |
Reading calculation results |
cg_iric_read_sol_cell_integer |
Reads the integer-type calculation result, having a value for each grid cell |
Reading calculation results |
cg_iric_read_sol_cell_real |
Reads the double-precision real-type calculation result, having a value for each grid cell |
Reading calculation results |
cg_iric_read_sol_iface_integer |
Reads the integer-type calculation result, having a value for each grid edge at i-direction |
Reading calculation results |
cg_iric_read_sol_iface_real |
Reads the double-precision real-type calculation result, having a value for each grid edge at i-direction |
Reading calculation results |
cg_iric_read_sol_jface_integer |
Reads the integer-type calculation result, having a value for each grid edge at j-direction |
Reading calculation results |
cg_iric_read_sol_jface_real |
Reads the double-precision real-type calculation result, having a value for each grid edge at j-direction |
Outputting error codes |
cg_iric_write_errorcode |
Outputs error code |
Closing the CGNS file |
cg_iric_close |
Closes a CGNS file |