DocumentationInterface 11.9 KB
Newer Older
1
initatmgrid(rank_bn,nbcore,polygons_in,centre_in,area_in,contfrac_in,neighbours_in,[nbpt,nbseg])
POLCHER Jan's avatar
POLCHER Jan committed
2 3 4 5 6

Wrapper for ``initatmgrid``.

Parameters
----------
7 8
rank_bn : input int
nbcore : input int
POLCHER Jan's avatar
POLCHER Jan committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
polygons_in : input rank-3 array('f') with bounds (nbpt,2 * nbseg + 1,2)
centre_in : input rank-2 array('f') with bounds (nbpt,2)
area_in : input rank-1 array('f') with bounds (nbpt)
contfrac_in : input rank-1 array('f') with bounds (nbpt)
neighbours_in : input rank-2 array('i') with bounds (nbpt,2 * nbseg)

Other Parameters
----------------
nbpt : input int, optional
    Default: shape(polygons_in,0)
nbseg : input int, optional
    Default: (shape(polygons_in,1)-1)/(2)
====================================================================
nbi,nbj,area_bx,trip_bx,basin_bx,topoind_bx,fac_bx,hierarchy_bx,lon_bx,lat_bx,lshead_bx,nwbas = gethydrogrid(nbxmax_in,sub_pts,sub_index,sub_area,max_basins,min_topoind,lon_rel,lat_rel,trip,basins,topoindex,fac,hierarchy,[nbpt,nbvmax_in])

Wrapper for ``gethydrogrid``.

Parameters
----------
nbxmax_in : input int
sub_pts : input rank-1 array('i') with bounds (nbpt)
sub_index : input rank-3 array('i') with bounds (nbpt,nbvmax_in,2)
sub_area : input rank-2 array('f') with bounds (nbpt,nbvmax_in)
max_basins : in/output rank-0 array(float,'f')
min_topoind : input float
lon_rel : input rank-2 array('f') with bounds (nbpt,nbvmax_in)
lat_rel : input rank-2 array('f') with bounds (nbpt,nbvmax_in)
trip : in/output rank-2 array('f') with bounds (nbpt,nbvmax_in)
basins : in/output rank-2 array('f') with bounds (nbpt,nbvmax_in)
topoindex : in/output rank-2 array('f') with bounds (nbpt,nbvmax_in)
fac : in/output rank-2 array('f') with bounds (nbpt,nbvmax_in)
hierarchy : in/output rank-2 array('f') with bounds (nbpt,nbvmax_in)

Other Parameters
----------------
nbpt : input int, optional
    Default: len(sub_pts)
nbvmax_in : input int, optional
    Default: shape(sub_index,1)

Returns
-------
nbi : rank-1 array('i') with bounds (nbpt)
nbj : rank-1 array('i') with bounds (nbpt)
area_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
trip_bx : rank-3 array('i') with bounds (nbpt,nbxmax_in,nbxmax_in)
basin_bx : rank-3 array('i') with bounds (nbpt,nbxmax_in,nbxmax_in)
topoind_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
fac_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
hierarchy_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lon_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lat_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lshead_bx : rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
nwbas : int
====================================================================
nb_basin,basin_inbxid,basin_outlet,basin_outtp,basin_sz,basin_bxout,basin_bbout,basin_pts,basin_lshead,coast_pts = findbasins(nbvmax_in,nbi,nbj,trip_bx,basin_bx,fac_bx,hierarchy_bx,topoind_bx,lshead_bx,lontmp,lattmp,[nbpt,nbxmax_in])

Wrapper for ``findbasins``.

Parameters
----------
nbvmax_in : input int
nbi : input rank-1 array('i') with bounds (nbpt)
nbj : input rank-1 array('i') with bounds (nbpt)
trip_bx : in/output rank-3 array('i') with bounds (nbpt,nbxmax_in,nbxmax_in)
basin_bx : in/output rank-3 array('i') with bounds (nbpt,nbxmax_in,nbxmax_in)
fac_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
hierarchy_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
topoind_bx : in/output rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lshead_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lontmp : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lattmp : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)

Other Parameters
----------------
nbpt : input int, optional
    Default: len(nbi)
nbxmax_in : input int, optional
    Default: shape(trip_bx,1)

Returns
-------
nb_basin : rank-1 array('i') with bounds (nbpt)
basin_inbxid : rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_outlet : rank-3 array('f') with bounds (nbpt,nbvmax_in,2)
basin_outtp : rank-2 array('f') with bounds (nbpt,nbvmax_in)
basin_sz : rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_bxout : rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_bbout : rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_pts : rank-4 array('i') with bounds (nbpt,nbvmax_in,nbvmax_in,2)
basin_lshead : rank-2 array('f') with bounds (nbpt,nbvmax_in)
coast_pts : rank-2 array('i') with bounds (nbpt,nbvmax_in)
====================================================================
102
basin_count,basin_notrun,basin_area,basin_cg,basin_hierarchy,basin_fac,basin_topoind,basin_id,basin_coor,basin_type,basin_flowdir,basin_lshead,outflow_grid,outflow_basin,nbcoastal,coastal_basin = globalize(area_bx,lon_bx,lat_bx,trip_bx,hierarchy_bx,fac_bx,topoind_bx,min_topoind,nb_basin,basin_inbxid,basin_outlet,basin_outtp,basin_sz,basin_pts,basin_bxout,basin_bbout,lshead,coast_pts,nwbas,[nbpt,nbvmax_in,nbxmax_in])
POLCHER Jan's avatar
POLCHER Jan committed
103 104 105 106 107 108

Wrapper for ``globalize``.

Parameters
----------
area_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
109 110
lon_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
lat_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
POLCHER Jan's avatar
POLCHER Jan committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
trip_bx : input rank-3 array('i') with bounds (nbpt,nbxmax_in,nbxmax_in)
hierarchy_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
fac_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
topoind_bx : input rank-3 array('f') with bounds (nbpt,nbxmax_in,nbxmax_in)
min_topoind : input float
nb_basin : input rank-1 array('i') with bounds (nbpt)
basin_inbxid : input rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_outlet : input rank-3 array('f') with bounds (nbpt,nbvmax_in,2)
basin_outtp : input rank-2 array('f') with bounds (nbpt,nbvmax_in)
basin_sz : input rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_pts : input rank-4 array('i') with bounds (nbpt,nbvmax_in,nbvmax_in,2)
basin_bxout : input rank-2 array('i') with bounds (nbpt,nbvmax_in)
basin_bbout : input rank-2 array('i') with bounds (nbpt,nbvmax_in)
lshead : input rank-2 array('f') with bounds (nbpt,nbvmax_in)
coast_pts : input rank-2 array('i') with bounds (nbpt,nbvmax_in)
nwbas : input int

Other Parameters
----------------
nbpt : input int, optional
    Default: shape(area_bx,0)
nbvmax_in : input int, optional
    Default: shape(basin_inbxid,1)
nbxmax_in : input int, optional
    Default: shape(area_bx,1)

Returns
-------
basin_count : rank-1 array('i') with bounds (nbpt)
basin_notrun : rank-1 array('i') with bounds (nbpt)
basin_area : rank-2 array('f') with bounds (nbpt,nwbas)
142
basin_cg : rank-3 array('f') with bounds (nbpt,nwbas,2)
POLCHER Jan's avatar
POLCHER Jan committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
basin_hierarchy : rank-2 array('f') with bounds (nbpt,nwbas)
basin_fac : rank-2 array('f') with bounds (nbpt,nwbas)
basin_topoind : rank-2 array('f') with bounds (nbpt,nwbas)
basin_id : rank-2 array('i') with bounds (nbpt,nwbas)
basin_coor : rank-3 array('f') with bounds (nbpt,nwbas,2)
basin_type : rank-2 array('f') with bounds (nbpt,nwbas)
basin_flowdir : rank-2 array('i') with bounds (nbpt,nwbas)
basin_lshead : rank-2 array('f') with bounds (nbpt,nwbas)
outflow_grid : rank-2 array('i') with bounds (nbpt,nwbas)
outflow_basin : rank-2 array('i') with bounds (nbpt,nwbas)
nbcoastal : rank-1 array('i') with bounds (nbpt)
coastal_basin : rank-2 array('i') with bounds (nbpt,nwbas)
====================================================================
inflow_number,inflow_grid,inflow_basin = linkup(nbxmax_in,basin_count,basin_area,basin_id,basin_flowdir,basin_lshead,basin_hierarchy,basin_fac,outflow_grid,outflow_basin,nbcoastal,coastal_basin,invented_basins,[nbpt,nwbas])

Wrapper for ``linkup``.

Parameters
----------
nbxmax_in : input int
basin_count : input rank-1 array('i') with bounds (nbpt)
basin_area : input rank-2 array('f') with bounds (nbpt,nwbas)
basin_id : input rank-2 array('i') with bounds (nbpt,nwbas)
basin_flowdir : input rank-2 array('i') with bounds (nbpt,nwbas)
basin_lshead : input rank-2 array('f') with bounds (nbpt,nwbas)
basin_hierarchy : in/output rank-2 array('f') with bounds (nbpt,nwbas)
basin_fac : input rank-2 array('f') with bounds (nbpt,nwbas)
outflow_grid : in/output rank-2 array('i') with bounds (nbpt,nwbas)
outflow_basin : in/output rank-2 array('i') with bounds (nbpt,nwbas)
nbcoastal : in/output rank-1 array('i') with bounds (nbpt)
coastal_basin : in/output rank-2 array('i') with bounds (nbpt,nwbas)
invented_basins : input float

Other Parameters
----------------
nbpt : input int, optional
    Default: len(basin_count)
nwbas : input int, optional
    Default: shape(basin_area,1)

Returns
-------
inflow_number : rank-2 array('i') with bounds (nbpt,8 * nbxmax_in)
inflow_grid : rank-3 array('i') with bounds (nbpt,8 * nbxmax_in,8 * nbxmax_in)
inflow_basin : rank-3 array('i') with bounds (nbpt,8 * nbxmax_in,8 * nbxmax_in)
====================================================================
fetch_basin = fetch(basin_count,basin_area,basin_id,basin_hierarchy,basin_fac,outflow_grid,outflow_basin,[nbpt,nwbas])

Wrapper for ``fetch``.

Parameters
----------
basin_count : input rank-1 array('i') with bounds (nbpt)
basin_area : in/output rank-2 array('f') with bounds (nbpt,nwbas)
basin_id : input rank-2 array('i') with bounds (nbpt,nwbas)
basin_hierarchy : input rank-2 array('f') with bounds (nbpt,nwbas)
basin_fac : input rank-2 array('f') with bounds (nbpt,nwbas)
outflow_grid : in/output rank-2 array('i') with bounds (nbpt,nwbas)
outflow_basin : input rank-2 array('i') with bounds (nbpt,nwbas)

Other Parameters
----------------
nbpt : input int, optional
    Default: len(basin_count)
nwbas : input int, optional
    Default: shape(basin_area,1)

Returns
-------
fetch_basin : rank-2 array('f') with bounds (nbpt,nwbas)
====================================================================
214
routing_area,routing_cg,topo_resid,route_togrid,route_tobasin,route_nbintobas,global_basinid,route_outlet,route_type,origin_nbintobas = truncate(nbasmax,basin_count,basin_notrun,basin_area,basin_cg,basin_topoind,fetch_basin,basin_id,basin_coor,basin_type,basin_flowdir,outflow_grid,outflow_basin,inflow_number,inflow_grid,inflow_basin,[nbpt,nbxmax_in,nwbas])
POLCHER Jan's avatar
POLCHER Jan committed
215 216 217 218 219 220 221 222 223

Wrapper for ``truncate``.

Parameters
----------
nbasmax : input int
basin_count : in/output rank-1 array('i') with bounds (nbpt)
basin_notrun : in/output rank-1 array('i') with bounds (nbpt)
basin_area : in/output rank-2 array('f') with bounds (nbpt,nwbas)
224
basin_cg : in/output rank-3 array('f') with bounds (nbpt,nwbas,2)
POLCHER Jan's avatar
POLCHER Jan committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
basin_topoind : in/output rank-2 array('f') with bounds (nbpt,nwbas)
fetch_basin : in/output rank-2 array('f') with bounds (nbpt,nwbas)
basin_id : in/output rank-2 array('i') with bounds (nbpt,nwbas)
basin_coor : in/output rank-3 array('f') with bounds (nbpt,nwbas,2)
basin_type : in/output rank-2 array('f') with bounds (nbpt,nwbas)
basin_flowdir : in/output rank-2 array('i') with bounds (nbpt,nwbas)
outflow_grid : in/output rank-2 array('i') with bounds (nbpt,nwbas)
outflow_basin : in/output rank-2 array('i') with bounds (nbpt,nwbas)
inflow_number : in/output rank-2 array('i') with bounds (nbpt,8 * nbxmax_in)
inflow_grid : in/output rank-3 array('i') with bounds (nbpt,8 * nbxmax_in,8 * nbxmax_in)
inflow_basin : in/output rank-3 array('i') with bounds (nbpt,8 * nbxmax_in,8 * nbxmax_in)

Other Parameters
----------------
nbpt : input int, optional
    Default: len(basin_count)
nbxmax_in : input int, optional
    Default: (shape(inflow_number,1))/(8)
nwbas : input int, optional
    Default: shape(basin_area,1)

Returns
-------
routing_area : rank-2 array('f') with bounds (nbpt,nbasmax)
249
routing_cg : rank-3 array('f') with bounds (nbpt,nbasmax,2)
POLCHER Jan's avatar
POLCHER Jan committed
250 251 252 253 254 255 256 257
topo_resid : rank-2 array('f') with bounds (nbpt,nbasmax)
route_togrid : rank-2 array('i') with bounds (nbpt,nbasmax)
route_tobasin : rank-2 array('i') with bounds (nbpt,nbasmax)
route_nbintobas : rank-1 array('i') with bounds (nbpt)
global_basinid : rank-2 array('i') with bounds (nbpt,nbasmax)
route_outlet : rank-3 array('f') with bounds (nbpt,nbasmax,2)
route_type : rank-2 array('f') with bounds (nbpt,nbasmax)
origin_nbintobas : rank-1 array('i') with bounds (nbpt)