From XMS Wiki
Jump to navigationJump to search
Model Info
Model type Particle tracking
Developer Christopher Muffles et al., S.S. Papadopulos & Associates, Inc.
Web site mod-PATH3DU

mod-PATH3DU 1.0.0
mod-PATH3DU 1.1.0

mod-PATH3DU 2.0.0

The mod-PATH3DU model is a particle tracking program similar to MODPATH but designed to work with MODFLOW-USG. GMS includes an interface that makes it easy to create mod-PATH3DU simulations, run them, and view the results.

Much of the mod-PATH3DU interface in GMS is similar to the MODPATH interface, but the mod-PATH3DU interface is not yet as fully developed. For example, mod-PATH3DU works more like other models in GMS in that the simulation must be saved and run and then the results are read and displayed, whereas in MODPATH this typically happens automatically whenever a change is made. In the future, more functionality will be added to the mod-PATH3DU interface in GMS.

Creating a Model

Creating a mod-PATH3DU model is taught in the mod-PATH3DU tutorial.


There are three requirements for creating a mod-PATH3DU model:

  1. The MP3DU component must be enabled.
  2. A MODFLOW-USG model must exist. mod-PATH3DU only works with MODFLOW-USG (in GMS).
  3. The MODFLOW-USG model must use the Save native text copy option.

Importing an Existing Model

GMS can import an existing mod-PATH3DU model. Open (or drag and drop) the *.mpsim file into GMS and the model will be imported. For mod-PATH3DU v2.0, this file is the primary file which may have a *.mpsim, *.p3p, or *.json extension.

Creating a New Model

To create a mod-PATH3DU simulation, right-click on a UGrid containing a MODFLOW-USG model and select the New mod-PATH3DU command. A mod-PATH3DU model icon will appear in the Project Explorer. Multiple mod-PATH3DU simulations can be created, with different starting locations and options.

Setting Options

Right-clicking the mod-PATH3DU model and selecting the Options command opens the mod-PATH3DU Options dialog. This dialog can be used to set various options such as the direction.

mod-PATH3DU Options Dialog

The mod-PATH3DU Options dialog.

There are two items to select from in the mod-PATH3DU Options dialog. When selecting "Options" from the list on the left, the following settings are available:

mod-PATH3DU Options[1]
Variable Options/Values Description
A flag indicating the direction of the particle tracking computation. The default is "Forward".
Auto compute release time False
Whether the release time will be automatically computed or manually specified.
Release time   If Auto compute release time is set to "False", release time of particles relative to mod-PATH3DU tracking time. This value should be greater than "0.0".
Whether to track particles to until termination at a boundary.
SIMULATION_END_TIME   Can be used to override the default end time in the flow model. If it is known a priori that only a portion of the flow solution is going to be processed, SIMULATION_END_TIME can be used to restrict the duration of the particle tracking to prevent unneeded time steps or stress periods from being processed.

When forward tracking, the default end time is the total duration of the flow model simulation. When backward tracking, the default end time is "0.0".

CAPTURE_RADIUS   The radial distance from a pumping well, expressed as a decimal value, within which a particle is considered captured. Because an analytic correction is applied to calculate paths near a well, CAPTURE_RADIUS is used to terminate particles at a well. Default is "10.0".
Turn "On" to invoke dispersion. Default is "Off".
The initial tracking stepsize, expressed as a positive decimal. Default is "0.1".
ADAPTIVE_STEP_ERROR The error criterion used to determine the maximum allowed error in all directions for the adaptive stepsize procedure, step-doubling. Smaller values will impact run time, but will also affect the calculated path. Care should be taken when setting this parameter greater than the default. Default is "1.0e-6".
MAX_DT   Maximum tracking stepsize. Default is "1.0e-6".
THREAD_COUNT   The number of threads to use to calculate particle paths. With more particles, more threads can improve run time. It is recommended to use no more than 4 threads. Default is "1".
REPEAT_DT   Repeat initial particles in time. Particle initial locations are repeated every REPEAT_DT between the release time and the SIMULATION_END_TIME. Default is "1.0e-30".
REPEAT   The number of particles to repeat at each starting location. Default is "1".

When selecting "IFACE" from the list on the left, the following options are available (listed alphabetically). If the desired FTYPE is not listed, click the Add Row button at the bottom of the dialog. FTYPEs can be removed by selecting the desired row and clicking Delete Row.

mod-PATH3DU IFACE Keys[1]
FTYPE Package
CHD Constant head package
CLN Connected-linear network
DRN Drain package
EVT Evapotranspiration package
FHB Flow and head package
GHB General-head package
MNW1 Multi-node well package (v.1)
MNW2 Multi-node well package (v.2)
RCH Recharge package
RIV River package
SFR Stream-flow routing package
STR Stream package
WEL Well package

mod-PATH3DU supports a limited set of IFACE values. The following table lists the supported values:

mod-PATH3DU IFACE Values[1]
IFACE Value Description
0 Internal sink/source. Flow is included in the Qw term in Equation 35.
2 Implicit side-face. Flow is not explicitly assigned to a cell face. Instead, mod-PATH3DU distributes the flow to any side faces with zero flow for inclusion in the first term on the RHS of Equation 35.
5 Same as MODPATH. Flow through the bottom face of a cell, which is included in the qv term in Equation 35 and in the calculation of velocity in the z-direction.
6 Same as MODPATH. Flow through the top face of a cell, which is included in the qv term in Equation 35 and in the calculation of velocity in the z-direction.
7 Internal sink/source. Flow is assigned to the top face (i.e. included in the qv term in Equation 35), but a particle is terminated as soon as it enters the cell.

Adding Starting Locations

To add starting locations to the simulation, there are three methods:

  1. Select cells and use the Create mod-PATH3DU Particles command from the right-click menu.
  2. Right-click the mod-PATH3DU UGrid Veronoi Icon.svg simulation and select the Create Particles at Wells command.
  3. Creating starting locations from another UGrid's points or cells (starting at GMS 10.3).

See MODPATH Particle Tracking, Generating Particles for more information on these commands.

Model Checker

Prior to running mod-PATH3DU, it is a good idea to run the Model Checker by right-clicking the mod-PATH3DU simulation and selecting the Check Simulation command. The Model Checker looks for obvious problems in model setup and reports them as warnings or errors.

Saving and Running the Model

Unlike MODPATH, mod-PATH3DU does not have an option to run automatically in GMS when changes are made to the model. The user must save and run the model manually.

mod-PATH3DU cannot read the MODFLOW-USG files that use the GMS modified input format. The user must use the Save native text copy option for MODFLOW-USG, and a solution must be generated for the native text copy of the MODFLOW-USG model. This can be done by using the MODFLOW | Advanced | Run MODFLOW Dialog command. Running MODFLOW-USG normally will not generate a solution for the native text copy.

When the project is saved, the mod-PATH3DU input files are saved with the MODFLOW-USG native text input files.

To run mod-PATH3DU, right-click the mod-PATH3DU model icon in the Project Explorer and select the Run mod-PATH3DU command. In GMS 10.2, the Run Model dialog appears and let's the user choose the mod-PATH3DU model executable to run and the *.mpsim file to pass to it. mod-PATH3DU runs in a console window—there is no model wrapper dialog for mod-PATH3DU like with other models. Starting at GMS 10.3, a model wrapper dialog is used to display the model progress and when the model finishes, the solution will be read automatically if the "Read solution on exit" option is checked.

mod-PATH3DU version 1.1.0 and 2.0 uses a modified grid specification file (GSF). A utility called writep3dgsf.exe creates the modified *GSF given the standard GSF and is included with mod-PATH3DU version 1.1.0 and 2.0. GMS runs this utility automatically just before mod-PATH3DU is run from GMS and the new file is given a .gsf2 extension.

Reading the Solution

After running mod-PATH3DU, a solution is generated consisting of a pathline (*.ptl) file and a listing file (*.mplist). Starting at GMS 10.3, the model wrapper will import the solution automatically. In GMS 10.2, import the solution by right-clicking the mod-PATH3DU model in the Project Explorer and selecting the Read Solution command. The user is prompted to open a *.ptl file. Upon doing so, the solution is displayed in the Project Explorer and the pathlines are drawn on the UGrid.

Display Options

The display options for mod-PATH3DU are identical to those for MODPATH. See MODPATH Display Options. Capture zones and zone codes also work identically for mod-PATH3DU.

Exporting Data

The mod-PATH3DU model data can be exported in a few different ways for processing in other programs if desired. The Export command can be used to export a shapefile of the pathline solution. Three different types of shapefiles can be exported: a point shapefile containing pathline points, a line shapefile containing the pathlines, and a polygon shapefile containing capture zone polygons. A tab delimited file containing the pathline points can also be exported.


  1. ^ a b c Muffels, Christopher; Scantlebury, Leland; Wang, Xiaomin; Tonkin, Matthew; Neville, Christopher; Ramadhan, Muhammad; Craig, James R. (November 2018). "User's Guide for mod-PATH3DU". Bethesda, Maryland: S.S. Papadopulos & Associates.