Skip to content

Commit

Permalink
refactor(dfns): add in_record attr to utl-ts and utl-tas vars (MODFLO…
Browse files Browse the repository at this point in the history
…W-USGS#2031)

Add 'in_record true' to several record fields in utl-ts.dfn and utl-tas.dfn. Motivated by modflowpy/flopy#2317. FloPy can infer this, evidently, but a less clever (and ideally much simpler) implementation may require them explicitly. IMO it makes sense to do this anyway for consistency's sake, at least while the DFN specification is flat and record membership cannot be inferred directly from the spec's structure.

This is not necessarily comprehensive, further work may reveal the same (or similar) updates are needed elsewhere.
  • Loading branch information
wpbonelli authored Oct 8, 2024
1 parent de9b543 commit 0c46781
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/mf6io/mf6ivar/dfn/utl-tas.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -29,6 +30,7 @@ shape any1d
tagged false
reader urword
optional false
in_record true
longname
description Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package.

Expand All @@ -48,6 +50,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -59,6 +62,7 @@ shape
tagged false
reader urword
optional false
in_record true
longname
description Interpolation method, which is either STEPWISE or LINEAR.

Expand All @@ -78,6 +82,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -88,6 +93,7 @@ shape time_series_name
tagged false
reader urword
optional false
in_record true
longname
description Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.

Expand Down
8 changes: 8 additions & 0 deletions doc/mf6io/mf6ivar/dfn/utl-ts.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -30,6 +31,7 @@ shape any1d
tagged false
reader urword
optional false
in_record true
longname
description Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package.

Expand All @@ -49,6 +51,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -60,6 +63,7 @@ shape time_series_names
tagged false
reader urword
optional false
in_record true
longname
description Interpolation method, which is either STEPWISE or LINEAR.

Expand Down Expand Up @@ -109,6 +113,7 @@ type keyword
shape
reader urword
optional false
in_record true
longname
description xxx

Expand All @@ -119,6 +124,7 @@ shape <time_series_name
tagged false
reader urword
optional false
in_record true
longname
description Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.

Expand Down Expand Up @@ -162,6 +168,7 @@ tagged false
reader urword
optional false
repeating false
in_record true
longname
description A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing.

Expand All @@ -172,5 +179,6 @@ shape time_series_names
tagged false
reader urword
optional false
in_record true
longname
description A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.

0 comments on commit 0c46781

Please sign in to comment.