flopy.modpath.mp6 module

class Modpath6(modelname='modpathtest', simfile_ext='mpsim', namefile_ext='mpnam', version='modpath', exe_name='mp6.exe', modflowmodel=None, dis_file=None, dis_unit=87, head_file=None, budget_file=None, model_ws=None, external_path=None, verbose=False, load=True, listunit=7)[source]

Bases: flopy.mbase.BaseModel

Modpath base class

create_mpsim(simtype='pathline', trackdir='forward', packages='WEL', start_time=0, default_ifaces=None, ParticleColumnCount=4, ParticleRowCount=4, MinRow=0, MinColumn=0, MaxRow=None, MaxColumn=None)[source]

Create a MODPATH simulation file using available MODFLOW boundary package data.

Parameters:
  • simtype (str) –
    Keyword defining the MODPATH simulation type. Available simtype’s
    are ‘endpoint’, ‘pathline’, and ‘timeseries’. (default is ‘PATHLINE’)
  • trackdir (str) – Keyword that defines the MODPATH particle tracking direction. Available trackdir’s are ‘backward’ and ‘forward’. (default is ‘forward’)
  • packages (str or list of strings) – Keyword defining the modflow packages used to create initial particle locations. Supported packages are ‘WEL’, ‘MNW2’ and ‘RCH’. (default is ‘WEL’).
  • start_time (float or tuple) –

    Sets the value of MODPATH reference time relative to MODFLOW time. float : value of MODFLOW simulation time at which to start the particle tracking simulation.

    Sets the value of MODPATH ReferenceTimeOption to 1.
    tuple : (period, step, time fraction) MODFLOW stress period, time step and fraction
    between 0 and 1 at which to start the particle tracking simulation. Sets the value of MODPATH ReferenceTimeOption to 2.
  • default_ifaces (list) – List of cell faces (1-6; see MODPATH6 manual, fig. 7) on which to start particles. (default is None, meaning ifaces will vary depending on packages argument above)
  • ParticleRowCount (int) – Rows of particles to start on each cell index face (iface).
  • ParticleColumnCount (int) – Columns of particles to start on each cell index face (iface).
Returns:

mpsim

Return type:

ModpathSim object

getmf()[source]
getsim()[source]
mf
next_ext_unit()[source]

Function to encapsulate next_ext_unit attribute

sim
write_name_file()[source]

Write the name file

Returns:
Return type:None
class Modpath6List(model, extension='list', listunit=7)[source]

Bases: flopy.pakbase.Package

List package class

write_file()[source]

Every Package needs its own write_file function