GMS:Mod-PATH3DU: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 25: Line 25:


===Importing an Existing Model===
===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.
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===
===Creating a New Model===
Line 31: Line 31:


===Setting 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 tracking direction.
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.


====Time Concepts====
<!-- ====Time Concepts====
The following figure from the mod-PATH3DU documentation is useful for understanding time concepts in mod-PATH3DU and the time variables in the ''mod-PATH3DU Options'' dialog.
The following figure from the mod-PATH3DU documentation is useful for understanding time concepts in mod-PATH3DU and the time variables in the ''mod-PATH3DU Options'' dialog.


[[Image:mp3duTime.png|frame|none|200|Time concepts in mod-PATH3DU<ref name="users_guide"> Christopher Muffels, Xiaomin Wang, Matthew Tonkin, and Christopher Neville, "User's Guide for mod-PATH3DU, A groundwater path and travel-time simulator", S.S. Papadopulos & Associates, Inc., 2014.</ref>]]
[[Image:mp3duTime.png|frame|none|200|Time concepts in mod-PATH3DU<ref name="users_guide"/>]]
 
-->
====mod-PATH3DU Options Dialog====
====mod-PATH3DU Options Dialog====
[[File:Mod-PATH3DU Options.png|thumb|none|450px|right|The ''Mod-PATH3DU Options'' dialog.]]
[[File:Mod-PATH3DU Options.png|thumb|none|450px|right|The ''mod-PATH3DU Options'' dialog.]]
The variables in the ''mod-PATH3DU Options'' dialog are explained in the following table.
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:
 
{{clear}}
{{clear}}
{| class="wikitable"
{| class="wikitable"
|+ mod-PATH3DU Options<ref name="users_guide" />
|+ mod-PATH3DU Options<ref name="users_guide">{{cite web|url=http://mp3du.sspa.com/man/ |title=User's Guide for mod-PATH3DU |date=November 2018 |first1=Christopher  |last1=Muffels |first2=Leland  |last2=Scantlebury |first3=Xiaomin  |last3=Wang |first4=Matthew  |last4=Tonkin |first5=Christopher  |last5=Neville |first6=Muhammad  |last6=Ramadhan |first7=James R. |last7=Craig |publisher= S.S. Papadopulos & Associates |location = Bethesda, Maryland|archivedate=November 15, 2018|archiveurl=http://www.webcitation.org/73xD7c2sz|dead-url=no}}</ref>
|-
|-
!Variable
!Variable
! style="width:350px;" | Options/Values
!Options/Values
!Description
!Description
|-
|-
|TrackingDirection||1 - Forward tracking,<br> 2 - Backward tracking||A flag indicating the direction of the particle tracking computation.
|DIRECTION||Forward<br>Backward||A flag indicating the direction of the particle tracking computation. The default is "Forward".
|-
|Auto compute release time|| False<br>True||Whether the release time will be automatically computed or manually specified.
|-
|Release time|| &nbsp; ||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".
|-
|TRACK_TO_TERMINATION|| Off<br>On ||Whether to track particles to until termination at a boundary.
|-
|SIMULATION_END_TIME|| &nbsp; ||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, use a start time of "0" and have an end time with a negative number.
|-
|CAPTURE_RADIUS|| &nbsp; ||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".
|-
|DISPERSION|| Off<br>On ||Turn "On" to invoke dispersion. Default is "Off".
|-
|INITIAL_STEPSIZE|| Off<br>On ||The initial tracking stepsize, expressed as a positive decimal. Default is "0.1".
|-
|STAGNATION_DT ||  || The tracking size below which a particle is considered stagnated.
|-
|EULER_DT ||  || The step size below which the Euler method is used instead of the Runge-Kutta method.
|-
|-
|AutoComputeReferenceTime|| False<br>True||Option to let GMS pick the reference time based on the TrackingDirection. If true, ReferenceTimeOption is set to 1 and, for forward tracking, the reference time will be 0.0. For backward tracking, the reference time will be the end time of the model.
|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".
|-
|-
|ReferenceTimeOption||1 - Specify a value for reference time<br>2 - Specify stress period, time step and relative time position within the time step to use to compute the reference time||A flag indicating how reference time will be specified. Reference time is the starting time for the particle-tracking with respect to the start of the MODFLOW-USG simulation.
|MAX_DT|| &nbsp; ||Maximum tracking stepsize. Default is "1.0e-6".
|-
|-
|StressPeriod|| Stress period || If ReferenceTimeOption = 2
|THREAD_COUNT|| &nbsp; ||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".
|-
|-
|TimeStep|| Time step || If ReferenceTimeOption = 2
|REPEAT_DT|| &nbsp; ||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".
|-
|-
|RelativeTime|| Relative time (between 0 and 1) || If ReferenceTimeOption = 2
|REPEAT|| &nbsp; ||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'''.
{{clear}}
{| class="wikitable"
|+ mod-PATH3DU IFACE Keys<ref name="users_guide" />
|-
|-
|StopOption||1 - Stop at the end (forward tracking) or beginning (backward tracking) of the MODFLOW-USG simulation<br>2 - Track until all particles reach their termination points<br>3 - Specify a value of tracking time at which to stop|| A flag indicating how the particle tracking simulation should be terminated.
!FTYPE
!Package
|-
|-
|StopTime|| Stop time || If StopOption = 3
|CHD
|Constant head package
|-
|-
|TRACK_TYPE||"RK4" (Default)<br>"EULER"||Tracking method. Default is "RK4"
|CLN
|Connected-linear network
|-
|-
|UseStepError|| || STEP_ERROR is set to 1e6 if not being used.
|DRN
|Drain package
|-
|-
|STEP_ERROR|| ||Adaptive stepsize error term, ɛ, in equation 2-17. Default is 1.00E-06. Larger values will result in a faster runtime with, potentially, less accurate paths. To turn-off the adaptive step size option make STEPERROR large (1.00E+06).
|EVT
|Evapotranspiration package
|-
|-
|DT_INIT|| || Initial step size. Default is 10.
|FHB
|Flow and head package
|-
|-
|DT_MAX|| ||Maximum step size. Default is 1.00E+06
|GHB
|General-head package
|-
|-
|WELL_CAPTURE_RADIUS|| ||When FORWARD tracking using the adaptive time step option (STEP_ERROR < 1), WELL_CAPTURE_RADIUS is the radial distance from the well, within which, a particle is considered captured.
|MNW1
|Multi-node well package (v.1)
|-
|-
|TemporalOption||1 - A single ReleaseTime will be used for all particles<br>2 - Particles will be released ReleaseEventCount times every ReleasePeriodLength<br>3 - Particles will be released ReleaseEventCount times at the specified ReleaseTimes||A flag indicating whether a single or multiple release events will be used for particles.
|MNW2
|Multi-node well package (v.2)
|-
|-
|ReleaseTime||Greater than 0.0||Release time of particles relative to mod-PATH3DU tracking time.
|RCH
|Recharge package
|-
|-
|ReleaseEventCount||Greater than 0|| If TemporalOption = 2 or 3. The number of release events.
|RIV
|River package
|-
|-
|ReleasePeriodLength||Greater than 0.0||If TemporalOption = 2. The time interval between particle release events.
|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:
{{clear}}
{| class="wikitable"
|+ mod-PATH3DU IFACE Values<ref name="users_guide" />
|-
!IFACE Value
!Description
|-
|0
|Internal sink/source. Flow is included in the <i>Q<sub>w</sub></i> 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 <i>q<sub>v</sub></i> 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 <i>q<sub>v</sub></i> 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 <i>q<sub>v</sub></i> term in Equation 35), but a particle is terminated as soon as it enters the cell.
|}
|}


Line 94: Line 161:


See [[GMS:MODPATH_Particle_Tracking#Generating_Particles|MODPATH Particle Tracking, Generating Particles]] for more information on these commands.
See [[GMS:MODPATH_Particle_Tracking#Generating_Particles|MODPATH Particle Tracking, Generating Particles]] for more information on these commands.
 
<!--The GRID2D and WELL2D options are not yet supported for defining starting locations.-->
The GRID2D and WELL2D options are not yet supported for defining starting locations.


===Model Checker===
===Model Checker===
Line 109: Line 175:
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&mdash;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.
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&mdash;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 uses a modified [[GMS:GSF_File_Format|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. GMS runs this utility automatically just before mod-PATH3DU is run from GMS and the new file is given a .gsf2 extension.
mod-PATH3DU version 1.1.0 and 2.0 uses a modified [[GMS:GSF_File_Format|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==
==Reading the Solution==
Line 116: Line 182:
==Display Options==
==Display Options==
The display options for mod-PATH3DU are identical to those for MODPATH. See [[GMS:MODPATH_Display_Options|MODPATH Display Options]]. Capture zones and [[GMS:MODPATH_Zone_Codes|zone codes]] also work identically for mod-PATH3DU.
The display options for mod-PATH3DU are identical to those for MODPATH. See [[GMS:MODPATH_Display_Options|MODPATH Display Options]]. Capture zones and [[GMS:MODPATH_Zone_Codes|zone codes]] also work identically for mod-PATH3DU.
==mod-PATH3DU Properties==
In the Project Explorer, right-clicking on the mod-PATH3DU simulation and selecting '''Properties''' will being up a dialog with details about the simulation.


==Exporting Data==
==Exporting Data==
Line 123: Line 192:
* [[GMS:mod-PATH3DU Commands|mod-PATH3DU Commands]]
* [[GMS:mod-PATH3DU Commands|mod-PATH3DU Commands]]


==References==
<!--==References==
{{reflist}}
{{reflist}}-->




Latest revision as of 19:31, 8 April 2024

mod-PATH3DU
Model Info
Model type Particle tracking
Developer Christopher Muffles et al., S.S. Papadopulos & Associates, Inc.
Web site mod-PATH3DU
Documentation

mod-PATH3DU 1.0.0
mod-PATH3DU 1.1.0

mod-PATH3DU 2.0.0
v • e

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.

Requirements

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
DIRECTION Forward
Backward		 A flag indicating the direction of the particle tracking computation. The default is "Forward".
Auto compute release time False
True		 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".
TRACK_TO_TERMINATION Off
On		 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, use a start time of "0" and have an end time with a negative number.

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".
DISPERSION Off
On		 Turn "On" to invoke dispersion. Default is "Off".
INITIAL_STEPSIZE Off
On		 The initial tracking stepsize, expressed as a positive decimal. Default is "0.1".
STAGNATION_DT The tracking size below which a particle is considered stagnated.
EULER_DT The step size below which the Euler method is used instead of the Runge-Kutta method.
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.

mod-PATH3DU Properties

In the Project Explorer, right-clicking on the mod-PATH3DU simulation and selecting Properties will being up a dialog with details about the simulation.

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.

Links


v • e
GMS – Groundwater Modeling System
Modules:2D Grid  •  2D Mesh  •  2D Scatter Point  •  3D Grid  •  3D Mesh  •  3D Scatter Point  •  Boreholes  •  GIS  •  Map  •  Solid  •  TINs  •  UGridsGMS Logo2.png
Models:FEFLOW  •  FEMWATER  •  HydroGeoSphere  •   MODAEM  •  MODFLOW  •  MODPATH  •  mod-PATH3DU  •  MT3DMS  •  MT3D-USGS  •  PEST  •  PHT3D  •  RT3D  •  SEAM3D  •  SEAWAT  •  SEEP2D  •  T-PROGS  •  ZONEBUDGET
Aquaveo
  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. http://mp3du.sspa.com/man/. 
Retrieved from "https://www.xmswiki.com/index.php?title=GMS:Mod-PATH3DU&oldid=162029"