flopy.modpath.mp6sim module

mpsim module. Contains the ModpathSim class. Note that the user can access the ModpathSim class as flopy.modpath.ModpathSim.

Additional information for this MODFLOW/MODPATH package can be found at the Online MODFLOW Guide.

class Modpath6Sim(model, mp_name_file='mp.nam', mp_list_file='mp.list', option_flags=[1, 2, 1, 1, 1, 2, 2, 1, 2, 1, 1, 1], ref_time=0, ref_time_per_stp=[0, 0, 1.0], stop_time=None, group_name=['group_1'], group_placement=[[1, 1, 1, 0, 1, 1]], release_times=[[1, 1]], group_region=[[1, 1, 1, 1, 1, 1]], mask_nlay=[1], mask_layer=[1], mask_1lay=[1], face_ct=[1], ifaces=[[6, 1, 1]], part_ct=[[1, 1, 1]], time_ct=1, release_time_incr=1, time_pts=[1], particle_cell_cnt=[[2, 2, 2]], cell_bd_ct=1, bud_loc=[[1, 1, 1, 1]], trace_id=1, stop_zone=1, zone=1, retard_fac=1.0, retard_fcCB=1.0, strt_file=None, extension='mpsim')[source]

Bases: Package

MODPATH Simulation File Package Class.

Parameters:

  • model (model object) – The model object (of type flopy.modpath.mp.Modpath) to which this package will be added.

  • extension (string) – Filename extension (default is ‘mpsim’)

heading

Text string written to top of package input file.

Type:

str

Notes

Examples

>>> import flopy
>>> m = flopy.modpath.Modpath6()
>>> dis = flopy.modpath.Modpath6Sim(m)
check(f=None, verbose=True, level=1, checktype=None)[source]

Check package data for common errors.

Parameters:

  • f (str or file handle) – String defining file name or file handle for summary file of check method output. If a sting is passed a file handle is created. If f is None, check method does not write results to a summary file. (default is None)

  • verbose (bool) – Boolean flag used to determine if check method results are written to the screen

  • level (int) – Check method analysis level. If level=0, summary checks are performed. If level=1, full checks are performed.

Return type:

None

Examples

write_file()[source]

Write the package file

Return type:

None

class StartingLocationsFile(model, inputstyle=1, extension='loc', verbose=False, use_pandas=True)[source]

Bases: Package

Class for working with MODPATH Starting Locations file for particles.

Parameters:

  • model (Modpath object) – The model object (of type flopy.modpath.mp.Modpath) to which this package will be added.

  • inputstyle (1) – Input style described in MODPATH6 manual (currently only input style 1 is supported)

  • extension (string) – Filename extension (default is ‘loc’)

  • use_pandas (bool, if True and pandas is available use pandas to write the particle locations >2x speed) –

static get_dtypes()[source]

Build numpy dtype for the MODPATH 6 starting locations file.

static get_empty_starting_locations_data(npt=0, default_xloc0=0.5, default_yloc0=0.5, default_zloc0=0.0)[source]

get an empty recarray for particle starting location info.

Parameters:

npt (int) – Number of particles. Particles in array will be numbered consecutively from 1 to npt.

write_file(data=None, float_format='{:.8f}')[source]

Every Package needs its own write_file function