flopy.mf6.modflow.mfprtprp module

class ModflowPrtprp(model, loading_package=False, boundnames=None, print_input=None, dev_exit_solve_method=None, exit_solve_tolerance=None, local_z=None, track_filerecord=None, trackcsv_filerecord=None, stoptime=None, stoptraveltime=None, stop_at_weak_sink=None, istopzone=None, drape=None, release_timesrecord=None, release_timesfilerecord=None, dev_forceternary=None, nreleasepts=None, packagedata=None, perioddata=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowPrtprp defines a prp package within a prt6 model.

Parameters:

  • model (MFModel) – Model that this package is a part of. Package is automatically added to model when it is initialized.

  • loading_package (bool) – Do not set this parameter. It is intended for debugging and internal processing purposes only.

  • boundnames (boolean) –

    • boundnames (boolean) keyword to indicate that boundary names may be provided with the list of particle release points.

  • print_input (boolean) –

    • print_input (boolean) keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read.

  • dev_exit_solve_method (integer) –

    • dev_exit_solve_method (integer) the method for iterative solution of particle exit location and time in the generalized Pollock’s method. 1 Brent, 2 Chandrupatla. The default is Brent.

  • exit_solve_tolerance (double) –

    • exit_solve_tolerance (double) the convergence tolerance for iterative solution of particle exit location and time in the generalized Pollock’s method. A value of 0.00001 works well for many problems, but the value that strikes the best balance between accuracy and runtime is problem-dependent.

  • local_z (boolean) –

    • local_z (boolean) indicates that “zrpt” defines the local z coordinate of the release point within the cell, with value of 0 at the bottom and 1 at the top of the cell. If the cell is partially saturated at release time, the top of the cell is considered to be the water table elevation (the head in the cell) rather than the top defined by the user.

  • track_filerecord ([trackfile]) –

    • trackfile (string) name of the binary output file to write tracking information.

  • trackcsv_filerecord ([trackcsvfile]) –

    • trackcsvfile (string) name of the comma-separated value (CSV) file to write tracking information.

  • stoptime (double) –

    • stoptime (double) real value defining the maximum simulation time to which particles in the package can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when simulation time STOPTIME is reached. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTIME. If the last stress period in the simulation consists of a single time step, it is assumed to be a steady-state stress period, and its ending time will not limit the simulation time to which particles can be tracked. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached.

  • stoptraveltime (double) –

    • stoptraveltime (double) real value defining the maximum travel time over which particles in the model can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when their travel time reaches STOPTRAVELTIME. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTRAVELTIME. If the last stress period in the simulation consists of a single time step, it is assumed to be a steady-state stress period, and its ending time will not limit the travel time over which particles can be tracked. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached.

  • stop_at_weak_sink (boolean) –

    • stop_at_weak_sink (boolean) is a text keyword to indicate that a particle is to terminate when it enters a cell that is a weak sink. By default, particles are allowed to pass though cells that are weak sinks.

  • istopzone (integer) –

    • istopzone (integer) integer value defining the stop zone number. If cells have been assigned IZONE values in the GRIDDATA block, a particle terminates if it enters a cell whose IZONE value matches ISTOPZONE. An ISTOPZONE value of zero indicates that there is no stop zone. The default value is zero.

  • drape (boolean) –

    • drape (boolean) is a text keyword to indicate that if a particle’s release point is in a cell that happens to be inactive at release time, the particle is to be moved to the topmost active cell below it, if any. By default, a particle is not released into the simulation if its release point’s cell is inactive at release time.

  • release_timesrecord ([times]) –

    • times (double) times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive.

  • release_timesfilerecord ([timesfile]) –

    • timesfile (string) name of the release times file. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive.

  • dev_forceternary (boolean) –

    • dev_forceternary (boolean) force use of the ternary tracking method regardless of cell type in DISV grids.

  • nreleasepts (integer) –

    • nreleasepts (integer) is the number of particle release points.

  • packagedata ([irptno, cellid, xrpt, yrpt, zrpt, boundname]) –

    • irptno (integer) integer value that defines the PRP release point number associated with the specified PACKAGEDATA data on the line. IRPTNO must be greater than zero and less than or equal to NRELEASEPTS. The program will terminate with an error if information for a PRP release point number is specified more than once. This argument is an index variable, which means that it should be treated as zero-based when working with FloPy and Python. Flopy will automatically subtract one when loading index variables and add one when writing index variables.

    • cellid ((integer, …)) is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. This argument is an index variable, which means that it should be treated as zero-based when working with FloPy and Python. Flopy will automatically subtract one when loading index variables and add one when writing index variables.

    • xrpt (double) real value that defines the x coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid.

    • yrpt (double) real value that defines the y coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid.

    • zrpt (double) real value that defines the z coordinate of the release point in model coordinates or, if the LOCAL_Z option is active, in local cell coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid.

    • boundname (string) name of the particle release point. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes.

  • perioddata (releasesetting) –

    • releasesetting (keystring) specifies when to release particles within the stress period. Overrides package-level RELEASETIME option, which applies to all stress periods. By default, RELEASESETTING configures particles for release at the beginning of the specified time steps. For time-offset releases, provide a FRACTION value.

      all[keyword]

      • all (keyword) keyword to indicate release of particles at the start of all time steps in the period.

      first[keyword]

      • first (keyword) keyword to indicate release of particles at the start of the first time step in the period. This keyword may be used in conjunction with other keywords to release particles at the start of multiple time steps.

      frequency[integer]

      • frequency (integer) release particles at the specified time step frequency. This keyword may be used in conjunction with other keywords to release particles at the start of multiple time steps.

      steps[integer]

      • steps (integer) release particles at the start of each step specified in STEPS. This keyword may be used in conjunction with other keywords to release particles at the start of multiple time steps.

      fraction[double]

      • fraction (double) release particles after the specified fraction of the time step has elapsed. If FRACTION is not set, particles are released at the start of the specified time step(s). FRACTION must be a single value when used with ALL, FIRST, or FREQUENCY. When used with STEPS, FRACTION may be a single value or an array of the same length as STEPS. If a single FRACTION value is provided with STEPS, the fraction applies to all steps.

  • filename (String) – File name for this package.

  • pname (String) – Package name for this package.

  • parent_file (MFPackage) – Parent package file that references this package. Only needed for utility packages (mfutl*). For example, mfutllaktab package must have a mfgwflak package parent_file.

dfn = [['header', 'multi-package'], ['block options', 'name boundnames', 'type keyword', 'shape', 'reader urword', 'optional true'], ['block options', 'name print_input', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name dev_exit_solve_method', 'type integer', 'reader urword', 'optional true'], ['block options', 'name exit_solve_tolerance', 'type double precision', 'reader urword', 'optional false'], ['block options', 'name local_z', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name track_filerecord', 'type record track fileout trackfile', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name track', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name fileout', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name trackfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name trackcsv_filerecord', 'type record trackcsv fileout trackcsvfile', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name trackcsv', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name trackcsvfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name stoptime', 'type double precision', 'reader urword', 'optional true'], ['block options', 'name stoptraveltime', 'type double precision', 'reader urword', 'optional true'], ['block options', 'name stop_at_weak_sink', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name istopzone', 'type integer', 'reader urword', 'optional true'], ['block options', 'name drape', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name release_timesrecord', 'type record release_times times', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name release_times', 'type keyword', 'reader urword', 'in_record true', 'tagged true', 'shape'], ['block options', 'name times', 'type double precision', 'shape (unknown)', 'reader urword', 'in_record true', 'tagged false', 'repeating true'], ['block options', 'name release_timesfilerecord', 'type record release_timesfile timesfile', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name release_timesfile', 'type keyword', 'reader urword', 'in_record true', 'tagged true', 'shape'], ['block options', 'name timesfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name dev_forceternary', 'type keyword', 'reader urword', 'optional false', 'mf6internal ifrctrn'], ['block dimensions', 'name nreleasepts', 'type integer', 'reader urword', 'optional false'], ['block packagedata', 'name packagedata', 'type recarray irptno cellid xrpt yrpt zrpt boundname', 'shape (nreleasepts)', 'reader urword'], ['block packagedata', 'name irptno', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block packagedata', 'name cellid', 'type integer', 'shape (ncelldim)', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name xrpt', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name yrpt', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name zrpt', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name boundname', 'type string', 'shape', 'tagged false', 'in_record true', 'reader urword', 'optional true'], ['block period', 'name iper', 'type integer', 'block_variable True', 'in_record true', 'tagged false', 'shape', 'valid', 'reader urword', 'optional false'], ['block period', 'name perioddata', 'type recarray releasesetting', 'shape', 'reader urword'], ['block period', 'name releasesetting', 'type keystring all first frequency steps fraction', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block period', 'name all', 'type keyword', 'shape', 'in_record true', 'reader urword'], ['block period', 'name first', 'type keyword', 'shape', 'in_record true', 'reader urword'], ['block period', 'name frequency', 'type integer', 'shape', 'tagged true', 'in_record true', 'reader urword'], ['block period', 'name steps', 'type integer', 'shape (<nstp)', 'tagged true', 'in_record true', 'reader urword'], ['block period', 'name fraction', 'type double precision', 'shape (<nstp)', 'tagged true', 'in_record true', 'reader urword', 'optional true']]
dfn_file_name = 'prt-prp.dfn'
package_abbr = 'prtprp'
packagedata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
perioddata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
release_timesfilerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
release_timesrecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
track_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
trackcsv_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>