Skip to content

Commit

Permalink
docs(prt-oc): add subsection describing tracking events (#1919)
Browse files Browse the repository at this point in the history
Previously the PRT OC section of mf6io did not describe tracking events beyond the enumeration substituted in from DFN files.
  • Loading branch information
wpbonelli authored Jul 2, 2024
1 parent 59773f2 commit 667230b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/mf6io/prt/oc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

For the PRINT and SAVE options, there is no option to specify individual layers. Whenever the budget array is printed or saved, all layers are printed or saved.

\subsection{Tracking Events}

The PRT Model distinguishes a number of tracking events that can trigger writing of particle track information to binary and/or CSV output files. When a particle track record is written to an output file, the record includes an IREASON code that indicates the type of event that triggered the output. IREASON codes and their associated tracking events are enumerated in the Particle Track Output subsection of the PRT Model Input and Output section.

The Output Control package provides keyword options that correspond to the various types of tracking events that can trigger output. The keywords are of the form TRACK\_\textit{event}, where \textit{event} indicates the type of event. If no tracking event keywords are provided, output is triggered by all types of tracking events. If any tracking event keywords are provided, only the selected types of events trigger output. This mechanism can be used to filter out events that are not of interest, thereby limiting the size of output files and reducing the runtime spent on writing output.

For instance, to configure PRT output for an endpoint analysis, provide the TRACK\_RELEASE and TRACK\_TERMINATE keywords. To configure PRT output for a timeseries analysis, provide the TRACK\_USERTIME keyword as well as a tracking time selection via the TRACK\_TIMES or TRACK\_TIMESFILE keyword.

\vspace{5mm}
\subsubsection{Structure of Blocks}
\vspace{5mm}
Expand Down

0 comments on commit 667230b

Please sign in to comment.