flopy.modpath.mp7sim 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 Modpath7Sim(model, mpnamefilename=None, listingfilename=None, endpointfilename=None, pathlinefilename=None, timeseriesfilename=None, tracefilename=None, simulationtype='pathline', trackingdirection='forward', weaksinkoption='stop_at', weaksourceoption='stop_at', budgetoutputoption='no', traceparticledata=None, budgetcellnumbers=None, referencetime=None, stoptimeoption='extend', stoptime=None, timepointdata=None, zonedataoption='off', stopzone=None, zones=0, retardationfactoroption='off', retardation=1.0, particlegroups=None, extension='mpsim')

Bases: flopy.pakbase.Package

MODPATH Simulation File Package Class.

model : model object

The model object (of type flopy.modpath.Modpath7) to which this package will be added.

mpnamefilename : str

Filename of the MODPATH 7 name file. If mpnamefilename is not defined it will be generated from the model name (default is None).

listingfilename : str

Filename of the MODPATH 7 listing file. If listingfilename is not defined it will be generated from the model name (default is None).

endpointfilename : str

Filename of the MODPATH 7 endpoint file. If endpointfilename is not defined it will be generated from the model name (default is None).

pathlinefilename : str

Filename of the MODPATH 7 pathline file. If pathlinefilename is not defined it will be generated from the model name (default is None).

timeseriesfilename : str

Filename of the MODPATH 7 timeseries file. If timeseriesfilename is not defined it will be generated from the model name (default is None).

tracefilename : str

Filename of the MODPATH 7 tracefile file. If tracefilename is not defined it will be generated from the model name (default is None).

simulationtype : str

MODPATH 7 simulation type. Valid simulation types are ‘endpoint’, ‘pathline’, ‘timeseries’, or ‘combined’ (default is ‘pathline’).

trackingdirection : str

MODPATH 7 tracking direction. Valid tracking directions are ‘forward’ or ‘backward’ (default os ‘forward’).

weaksinkoption : str

MODPATH 7 weak sink option. Valid weak sink options are ‘pass_through’ or ‘stop_at’ (default value is ‘stop_at’).

weaksourceoption : str

MODPATH 7 weak source option. Valid weak source options are ‘pass_through’ or ‘stop_at’ (default value is ‘stop_at’).

budgetoutputoption : str

MODPATH 7 budget output option. Valid budget output options are ‘no’ - individual cell water balance errors are not computed and budget record headers are not printed, ‘summary’ - a summary of individual cell water balance errors for each time step is printed in the listing file without record headers, or ‘record_summary’ - a summary of individual cell water balance errors for each time step is printed in the listing file with record headers (default is ‘summary’).

traceparticledata : list or tuple

List or tuple with two ints that define the particle group and particle id (zero-based) of the specified particle that is followed in detail. If traceparticledata is None, trace mode is off (default is None).

budgetcellnumbers : int, list of ints, tuple of ints, or np.ndarray

Cell numbers (zero-based) for which detailed water budgets are computed. If budgetcellnumbers is None, detailed water budgets are not calculated (default is None).

referencetime : float, list, or tuple

Specified reference time if a float or a list/tuple with a single float value is provided (reference time option 1). Otherwise a list or tuple with a zero-based stress period (int) and time step (int) and a float defining the relative time position in the time step is provided (reference time option 2). If referencetime is None, reference time is set to 0 (default is None).

stoptimeoption : str

String indicating how a particle tracking simulation is terminated based on time. If stop time option is ‘total’, particles will be stopped at the end of the final time step if ‘forward’ tracking is simulated or at the beginning of the first time step if backward tracking. If stop time option is ‘extend’, initial or final steady-state time steps will be extended and all particles will be tracked until they reach a termination location. If stop time option is ‘specified’, particles will be tracked until they reach a termination location or the specified stop time is reached (default is ‘extend’).

stoptime : float

User-specified value of tracking time at which to stop a particle tracking simulation. Stop time is only used if the stop time option is ‘specified’. If stoptime is None and the stop time option is ‘specified’ particles will be terminated at the end of the last time step if ‘forward’ tracking or the beginning of the first time step if ‘backward’ tracking (default is None).

timepointdata : list or tuple

List or tuple with 2 items that is only used if simulationtype is ‘timeseries’ or ‘combined’. If the second item is a float then the timepoint data corresponds to time point option 1 and the first entry is the number of time points (timepointcount) and the second entry is the time point interval. If the second item is a list, tuple, or np.ndarray then the timepoint data corresponds to time point option 2 and the number of time points entries (timepointcount) in the second item and the second item is an list, tuple, or array of user-defined time points. If Timepointdata is None, time point option 1 is specified and the total simulation time is split into 100 intervals (default is None).

zonedataoption : str

If zonedataoption is ‘off’, zone array data are not read and a zone value of 1 is applied to all cells. If zonedataoption is ‘on’, zone array data are read (default is ‘off’).

stopzone : int

A zero-based specified integer zone value that indicates an automatic stopping location for particles and is only used if zonedataoption is ‘on’. A value of -1 indicates no automatic stop zone is used. Stopzone values less than -1 are not allowed. If stopzone is None, stopzone is set to -1 (default is None).

zones : float or array of floats (nlay, nrow, ncol)

Array of zero-based positive integer zones that are only used if zonedataoption is ‘on’ (default is 0).

retardationfactoroption : str

If retardationfactoroption is ‘off’, retardation array data are not read and a retardation factor of 1 is applied to all cells. If retardationfactoroption is ‘on’, retardation factor array data are read (default is ‘off’).

retardation : float or array of floats (nlay, nrow, ncol)

Array of retardation factors that are only used if retardationfactoroption is ‘on’ (default is 1).

particlegroups : ParticleGroup or list of ParticleGroups

ParticleGroup or list of ParticlesGroups that contain data for individual particle groups. If None is specified, a particle in the center of node 0 will be created (default is None).

extension : string

Filename extension (default is ‘mpsim’)

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow.load('mf2005.nam')
>>> mp = flopy.modpath.Modpath7('mf2005_mp', flowmodel=m)
>>> mpsim = flopy.modpath.Modpath7Sim(mp)

write_file(check=False)

Write the package file

Parameters:check (boolean) – Check package data for common errors. (default False) Returns: Return type:None

class budgetOpt

Bases: enum.Enum

Enumeration of different budget output options

no = 0

record_summary = 2

summary = 1

class onoffOpt

Bases: enum.Enum

Enumeration of on-off options

off = 1

on = 2

class simType

Bases: enum.Enum

Enumeration of different simulation types

combined = 4

endpoint = 1

pathline = 2

timeseries = 3

sim_enum_error(v, s, e)

Standard enumeration error format error :param v: Enumeration value :type v: str :param s: User-defined value :type s: str :param e: Enumeration class :type e: Enum class

class stopOpt

Bases: enum.Enum

Enumeration of different stop time options

extend = 2

specified = 3

total = 1

class trackDir

Bases: enum.Enum

Enumeration of different tracking directions

backward = 2

forward = 1

class weakOpt

Bases: enum.Enum

Enumeration of different weak sink and source options

pass_through = 1

stop_at = 2