mibitrans.visualize API reference
animation
animate_1d(x_axis_parameter, y_axis_parameter, time_parameter, y_names=None, y_colors=None, linestyle=None)
Animate any type and number of input 1D plottables.
Source code in mibitrans/visualize/animation.py
plot_line
Author: Jorrit Bakker.
Module plotting a 3D matrix of contaminant plume concentrations as a line.
allowed_model_types()
breakthrough(model, x_position, y_position=0, relative_concentration=False, legend_names=None, animate=False, **kwargs)
Plot contaminant breakthrough curve at given x and y position in model domain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Model object from mibitrans.transport, or list of model objects. |
required | |
x_position
|
x-position along the plume (longitudinal direction). |
required | |
y_position
|
y-position across the plume (transverse horizontal direction). By default, at the center of the plume (at y=0). |
required | |
relative_concentration (bool, optional)
|
If set to True, will plot concentrations relative to maximum source zone concentrations at t=0. By default, absolute concentrations are shown. |
required | |
legend_names
|
str | list
|
List of legend names as strings, in the same order as given models. By default, no legend is shown. |
None
|
animate
|
bool
|
If True, animation of contaminant plume until given time is shown. If multiple models are given as input, dt should be the same for each one to ensure accurate animation. Default is False. |
False
|
**kwargs
|
Arguments to be passed to plt.plot(). |
required |
Source code in mibitrans/visualize/plot_line.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | |
centerline(model, y_position=0, time=None, relative_concentration=False, legend_names=None, animate=False, **kwargs)
Plot center of contaminant plume of one or multiple models as a line, at a specified time and y position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Model object from mibitrans.transport, or list of model objects. |
required | |
y_position
|
float
|
y-position across the plume (transverse horizontal direction) for the plot. By default, the center of the plume at y=0 is plotted. |
0
|
time
|
float
|
Point of time for the plot. Will show the closest time step to given value. By default, last point in time is plotted. |
None
|
relative_concentration (bool, optional)
|
If set to True, will plot concentrations relative to maximum source zone concentrations at t=0. By default, absolute concentrations are shown. |
required | |
legend_names
|
str | list
|
List of legend names as strings, in the same order as given models. By default, no legend is shown. |
None
|
animate
|
bool
|
If True, animation of contaminant plume until given time is shown. If multiple models are given as input, dt should be the same for each one to ensure accurate animation. Default is False. |
False
|
**kwargs
|
Arguments to be passed to plt.plot(). |
required |
Source code in mibitrans/visualize/plot_line.py
transverse(model, x_position, time=None, relative_concentration=False, legend_names=None, animate=False, **kwargs)
Plot concentration distribution as a line horizontal transverse to the plume extent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Model object from mibitrans.transport, or list of model objects. |
required | |
x_position
|
x-position along the plume (longitudinal direction) for the plot. |
required | |
time
|
float
|
Point of time for the plot. Will show the closest time step to given value. By default, last point in time is plotted. |
None
|
relative_concentration (bool, optional)
|
If set to True, will plot concentrations relative to maximum source zone concentrations at t=0. By default, absolute concentrations are shown. |
required | |
legend_names
|
str | list
|
List of legend names as strings, in the same order as given models. By default, no legend is shown. |
None
|
animate
|
bool
|
If True, animation of contaminant plume until given time is shown. If multiple models are given as input, dt should be the same for each one to ensure accurate animation. Default is False. |
False
|
**kwargs
|
Arguments to be passed to plt.plot(). |
required |
Source code in mibitrans/visualize/plot_line.py
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 142 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 | |
plot_surface
plume_2d(model, time=None, relative_concentration=False, animate=False, **kwargs)
Plot contaminant plume as a 2D colormesh, at a specified time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Model object from mibitrans.transport. |
required | |
time
|
float
|
Point of time for the plot. Will show the closest time step to given value. By default, last point in time is plotted. |
None
|
relative_concentration (bool, optional)
|
If set to True, will plot concentrations relative to maximum source zone concentrations at t=0. By default, absolute concentrations are shown. |
required | |
animate
|
bool
|
If True, animation of contaminant plume until given time is shown. Default is False. |
False
|
**kwargs
|
Arguments to be passed to plt.pcolormesh(). |
required |
Returns a matrix plot of the input plume as object.
Source code in mibitrans/visualize/plot_surface.py
plume_3d(model, time=None, relative_concentration=False, animate=False, **kwargs)
Plot contaminant plume as a 3D surface, at a specified time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model
|
Model object from mibitrans.transport. |
required | |
time
|
float
|
Point of time for the plot. Will show the closest time step to given value. By default, last point in time is plotted. |
None
|
relative_concentration (bool, optional)
|
If set to True, will plot concentrations relative to maximum source zone concentrations at t=0. By default, absolute concentrations are shown. |
required | |
animate
|
bool
|
If True, animation of contaminant plume until given time is shown. Default is False. |
False
|
**kwargs
|
Arguments to be passed to plt.plot_surface(). |
required |
Returns:
| Type | Description |
|---|---|
|
ax (matplotlib.axes._axes.Axes) : Returns matplotlib axes object of plume plot. |
Source code in mibitrans/visualize/plot_surface.py
show_conditions
Author: Jorrit Bakker.
Module including various methods to visualize (input) parameter conditions, intended to only be called internally.
model_grid(model_parameters)
source_zone(source_parameters)
Visualize source zone conditions.