Skip to content

Commit d79607a

Browse files
authored
docs(prt): fix ref to removed option, restore dfns (#2309)
We had a lingering reference to TRACK_TIMES and TRACK_TIMESFILE, fix it. And also, I'm not sure why I removed the options from the DFNs in bf47ec6, for deprecations/removals we conventionally leave the options in the DFN and just mark them as such. The automation will then put them in the deprecation section in the release notes. Also fix the automation options that are removed without a deprecation period show the same version number for both deprecated and removed columns.
1 parent 930849f commit d79607a

File tree

4 files changed

+140
-2
lines changed

4 files changed

+140
-2
lines changed

doc/mf6io/mf6ivar/deprecations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def create_deprecations_file(dfndir, mddir, verbose):
4949
s += "|:--------------|:-------|:-----------|:--------|\n"
5050
for file, option, deprecated, removed in deprecations:
5151
s += (
52-
f"| {file.stem} | {option} | {deprecated} "
52+
f"| {file.stem} | {option} | {deprecated if deprecated else removed if removed else ''} "
5353
f"| {removed if removed else ''} |\n"
5454
)
5555
if len(s) > 0:

doc/mf6io/mf6ivar/dfn/prt-oc.dfn

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,75 @@ optional true
191191
longname track usertime
192192
description keyword to indicate that particle tracking output is to be written at user-specified times, provided as double precision values in the TRACKTIMES block.
193193

194+
block options
195+
name track_timesrecord
196+
type record track_times times
197+
shape
198+
reader urword
199+
tagged true
200+
optional true
201+
longname
202+
description
203+
removed 6.6.1
204+
205+
block options
206+
name track_times
207+
type keyword
208+
reader urword
209+
in_record true
210+
tagged true
211+
shape
212+
longname
213+
description keyword indicating tracking times will follow
214+
removed 6.6.1
215+
216+
block options
217+
name times
218+
type double precision
219+
shape (unknown)
220+
reader urword
221+
in_record true
222+
tagged false
223+
repeating true
224+
longname tracking times
225+
description times to track, relative to the beginning of the simulation.
226+
removed 6.6.1
227+
228+
block options
229+
name track_timesfilerecord
230+
type record track_timesfile timesfile
231+
shape
232+
reader urword
233+
tagged true
234+
optional true
235+
longname
236+
description
237+
removed 6.6.1
238+
239+
block options
240+
name track_timesfile
241+
type keyword
242+
reader urword
243+
in_record true
244+
tagged true
245+
shape
246+
longname
247+
description keyword indicating tracking times file name will follow
248+
removed 6.6.1
249+
250+
block options
251+
name timesfile
252+
type string
253+
preserve_case true
254+
shape
255+
in_record true
256+
reader urword
257+
tagged false
258+
optional false
259+
longname file keyword
260+
description name of the tracking times file
261+
removed 6.6.1
262+
194263
# --------------------- prt oc dimensions ------------------
195264

196265
block dimensions

doc/mf6io/mf6ivar/dfn/prt-prp.dfn

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,75 @@ optional true
168168
longname drape
169169
description 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.
170170

171+
block options
172+
name release_timesrecord
173+
type record release_times times
174+
shape
175+
reader urword
176+
tagged true
177+
optional true
178+
longname
179+
description
180+
removed 6.6.1
181+
182+
block options
183+
name release_times
184+
type keyword
185+
reader urword
186+
in_record true
187+
tagged true
188+
shape
189+
longname
190+
description keyword indicating release times will follow
191+
removed 6.6.1
192+
193+
block options
194+
name times
195+
type double precision
196+
shape (unknown)
197+
reader urword
198+
in_record true
199+
tagged false
200+
repeating true
201+
longname release times
202+
description times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive.
203+
removed 6.6.1
204+
205+
block options
206+
name release_timesfilerecord
207+
type record release_timesfile timesfile
208+
shape
209+
reader urword
210+
tagged true
211+
optional true
212+
longname
213+
description
214+
removed 6.6.1
215+
216+
block options
217+
name release_timesfile
218+
type keyword
219+
reader urword
220+
in_record true
221+
tagged true
222+
shape
223+
longname
224+
description keyword indicating release times file name will follow
225+
removed 6.6.1
226+
227+
block options
228+
name timesfile
229+
type string
230+
preserve_case true
231+
shape
232+
in_record true
233+
reader urword
234+
tagged false
235+
optional false
236+
longname file keyword
237+
description name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive.
238+
removed 6.6.1
239+
171240
block options
172241
name dry_tracking_method
173242
type string

doc/mf6io/prt/oc.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ \subsubsection{Tracking Events}
1111

1212
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.
1313

14-
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.
14+
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 TRACKTIMES block.
1515

1616
\vspace{5mm}
1717
\subsubsection{Structure of Blocks}

0 commit comments

Comments
 (0)