Modpath

class hydromodpy.modeling.modpath.Modpath(geographic: object, model_modflow: object, model_folder: str = 'HydroModPy_outputs', model_name: str = 'Default_modpath', bin_path: str = '/home/docs/checkouts/readthedocs.org/user_builds/hydromod/checkouts/dev/docs/readthedocs/source/bin', zone_partic: str = 'domain', track_dir: str = 'forward', bore_depth: list = None, cell_div: int = 1, zloc_div: bool = False, sel_random: int = None, sel_slice: int = None)

Bases: object

Class Modpath.

To build, run particle traccking from modflow simulation.

Initialize method.

Parameters

geographicobject

Geographic object build by HydroModPy.

model_modflowobject

Python object of the MODFLOW model.

model_folderstr, optional

Name of the folder. The default is ‘HydroModPy_outputs’.

model_namestr, optional

Name of the model. The default is ‘Default’.

bin_pathstr, optional

Location folder of the modflow executables. The default is ‘bin’.

zone_particstr, optional

Path of the raster used to inject particles: where value > 0. The default is ‘domain’, so the particles are injected where the model domain area > 0m.

track_dir: str

Choice ‘forward’ or ‘backward’ particle tracking method. The default is ‘forward’.

bore_depth: list

[Not stable, currently in development] If not None, inject a particle in the z direction (vertical), at the center position of each lays.

cell_div: int

Fix the number of particles injected uniformly distributed for each cell. If 3 is set, 9 particles will be inejcted (3x*3y) The dault is 1.

zloc_div: bool

If True, ‘cell_div’ is also applied vetically for the cells. If cell_div is 3 and zloc_div is True, 18 particles will be injected (3x*3y*3z). The default is False.

sel_random: int

Select randomly where inject a total number of particles.

sel_random: int

Select with slicing value where particles.

filt_processing(model_modpath: object, norm_flux: bool = False, filt_time: bool = True, filt_seep: bool = True, filt_inout: bool = True, calc_rtd: bool = True, random_id: int = None)

post_processing(model_modpath: object, starting_point: bool = True, ending_point: bool = True, pathlines_shp: bool = True, particles_shp: bool = True, random_id=None)

Create outputs files.

Parameters

model_modpathobject

MODPATH python object.

ending_pointbool, optional

Write ending point files. The default is True.

starting_pointbool, optional

Write starting point files. The default is True.

pathlines_shpbool, optional

Write pathlines shapefiles. The default is True.

particles_shpbool, optional

Write particles shapefiles. The default is True.

random_idint, optional

Export random pathlines. The default is None.

pre_processing()

Pre-processing to build the partickle tracking.

Returns

None.

processing(write_model: bool = True, run_model: bool = False)

Run the partickle tracking.

Parameters

write_modelbool, optional

Flag to write input files or not. The default is True.

run_modelbool, optional

Flag to run model or not. The default is False.

Returns

success_modelbool

Flag to know if the simulation finished correctly.