diff --git a/autotest/__snapshots__/.numpy_snapshot_version b/autotest/__snapshots__/.numpy_snapshot_version index 59aa62c1..f225a78a 100644 --- a/autotest/__snapshots__/.numpy_snapshot_version +++ b/autotest/__snapshots__/.numpy_snapshot_version @@ -1 +1 @@ -2.4.5 +2.5.2 diff --git a/autotest/dfns/__snapshots__/.numpy_snapshot_version b/autotest/dfns/__snapshots__/.numpy_snapshot_version index 59aa62c1..f225a78a 100644 --- a/autotest/dfns/__snapshots__/.numpy_snapshot_version +++ b/autotest/dfns/__snapshots__/.numpy_snapshot_version @@ -1 +1 @@ -2.4.5 +2.5.2 diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.json index 54721134..abadf23b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package.", + "tagged": false, + "direction": "in" } } } @@ -81,6 +87,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -104,6 +111,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -123,6 +131,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.toml index 940a38aa..94bfb045 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -70,6 +76,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -93,6 +100,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -105,3 +113,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.yaml index 12bc64b6..4d173be2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-cdb.yaml @@ -56,10 +56,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CDB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CDB package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -82,6 +89,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -112,6 +120,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -126,3 +135,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.json index dff2f0f5..2c540297 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.toml index af849566..146b970a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "constant head boundary name" description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.yaml index a7de74e8..0d35199c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-chd.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.json index 61736d1b..d579e97a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.json @@ -47,10 +47,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.toml index 19244289..71ca8f94 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.yaml index 579859fd..c4dc1c7e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-dfw.yaml @@ -61,10 +61,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.json index 4d31a019..2ef5486b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -189,6 +195,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.toml index f6b9649a..54d67807 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -168,6 +174,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.yaml index 99dda855..cd14bc73 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -179,6 +185,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.json index 9516b94e..b2686702 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.toml index a61ba9ad..3fd735d5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "evaporation name" description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.yaml index 34268020..c86bda7f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-evp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.json index 1a8babf8..bb195c6b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.toml index dce347de..273bd1bb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "inflow name" description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.yaml index e354a181..300e0ff7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-flw.yaml @@ -60,19 +60,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the FLW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the FLW package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -95,6 +109,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.json index f1d44e3b..1551d634 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.toml index 27f73e8f..03373d30 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.yaml index b51f6e6f..e615af5d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.json index bfd54e0a..62b319ab 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.toml index 818844c8..0dba2280 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "precipitation name" description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.yaml index 39a917a7..ca972774 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-pcp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the PCP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the PCP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.json index 93257fc5..2a419cf9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.toml index 18e4eae8..4575e7bb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.toml @@ -24,3 +24,10 @@ valid = [ "steady-state", "transient", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.yaml index 861c8777..64ef944e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-sto.yaml @@ -28,3 +28,13 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.json index f267acc3..a47099ef 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -64,10 +70,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package.", + "tagged": false, + "direction": "in" } } } @@ -93,6 +105,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -130,6 +143,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -149,6 +163,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.toml index 5115c5c7..b62bff3f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.toml @@ -47,20 +47,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -80,6 +92,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -117,6 +130,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -129,3 +143,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.yaml index 0d7ae4fc..0bc52b95 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/chf-zdg.yaml @@ -56,19 +56,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ZDG package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ZDG package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -91,6 +105,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -141,6 +156,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -155,3 +171,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.json index 4a529c8a..42f7cf08 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.toml index a5c677a7..329c5b10 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" [blocks.dimensions.fields.nexg] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.yaml index 059db683..bff3b203 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-chfgwf.yaml @@ -35,10 +35,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the SWF-GWF package. + tagged: false + direction: in dimensions: fields: nexg: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.json index 2f0a001a..94a53663 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.json @@ -85,10 +85,16 @@ "optional": true, "fields": { "mve6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an energy transport mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an energy transport mover file." + }, + "mve6_filename": { + "type": "file", + "longname": "mve6 input filename", + "description": "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords.", + "tagged": false, + "direction": "in" } } }, @@ -97,10 +103,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package.", + "tagged": false, + "direction": "in" } } }, @@ -170,6 +182,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.toml index bf392ab4..5036af62 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.toml @@ -80,20 +80,32 @@ type = "record" optional = true [blocks.options.fields.mve_filerecord.fields.mve6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an energy transport mover file." -mode = "filein" + +[blocks.options.fields.mve_filerecord.fields.mve6_filename] +type = "file" +longname = "mve6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -157,6 +169,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.yaml index 8b35bf9f..488699f1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwegwe.yaml @@ -92,19 +92,32 @@ blocks: optional: true fields: mve6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an energy transport mover file. - mode: filein + mve6_filename: + type: file + longname: mve6 input filename + description: is the file name of the transport mover input file to apply to this exchange. Information + for the transport mover are provided in the file provided with these keywords. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} + lists observation type(s) supported by the GWE-GWE Exchange Package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -177,6 +190,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.json index 91c77610..e13d0fde 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.json @@ -94,10 +94,16 @@ "optional": true, "fields": { "gnc6": { - "type": "file", + "type": "keyword", "longname": "gnc6 keyword", - "description": "keyword to specify that record corresponds to a ghost-node correction file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a ghost-node correction file." + }, + "gnc6_filename": { + "type": "file", + "longname": "gnc6 input filename", + "description": "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2.", + "tagged": false, + "direction": "in" } } }, @@ -106,10 +112,16 @@ "optional": true, "fields": { "mvr6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to a mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a mover file." + }, + "mvr6_filename": { + "type": "file", + "longname": "mvr6 input filename", + "description": "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange.", + "tagged": false, + "direction": "in" } } }, @@ -118,10 +130,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package.", + "tagged": false, + "direction": "in" } } }, @@ -191,6 +209,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.toml index 8573878d..eb138f9b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.toml @@ -87,30 +87,48 @@ type = "record" optional = true [blocks.options.fields.gnc_filerecord.fields.gnc6] -type = "file" +type = "keyword" longname = "gnc6 keyword" description = "keyword to specify that record corresponds to a ghost-node correction file." -mode = "filein" + +[blocks.options.fields.gnc_filerecord.fields.gnc6_filename] +type = "file" +longname = "gnc6 input filename" +description = "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2." +tagged = false +direction = "in" [blocks.options.fields.mvr_filerecord] type = "record" optional = true [blocks.options.fields.mvr_filerecord.fields.mvr6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to a mover file." -mode = "filein" + +[blocks.options.fields.mvr_filerecord.fields.mvr6_filename] +type = "file" +longname = "mvr6 input filename" +description = "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -174,6 +192,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.yaml index a9f0a773..c053f5fb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwfgwf.yaml @@ -111,28 +111,58 @@ blocks: optional: true fields: gnc6: - type: file + type: keyword longname: gnc6 keyword description: keyword to specify that record corresponds to a ghost-node correction file. - mode: filein + gnc6_filename: + type: file + longname: gnc6 input filename + description: is the file name for ghost node correction input file. Information for the ghost + nodes are provided in the file provided with these keywords. The format for specifying + the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes + specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow + the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden + and all of the nodej values are assumed to be located in model 1, and nodem is assumed to + be in model 2. + tagged: false + direction: in mvr_filerecord: type: record optional: true fields: mvr6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to a mover file. - mode: filein + mvr6_filename: + type: file + longname: mvr6 input filename + description: is the file name of the water mover input file to apply to this exchange. Information + for the water mover are provided in the file provided with these keywords. The format for + specifying the water mover information is the same as described for the Water Mover (MVR) + Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model + name must be included as a separate string before each package. Second, the appropriate + model name must be included before package name 1 and package name 2 in the BEGIN PERIOD + block. This allows providers and receivers to be located in both models listed as part + of this exchange. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the GWF-GWF package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -205,6 +235,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.json index 6d892215..e705daa3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.json @@ -85,10 +85,16 @@ "optional": true, "fields": { "mvt6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to a transport mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a transport mover file." + }, + "mvt6_filename": { + "type": "file", + "longname": "mvt6 input filename", + "description": "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords.", + "tagged": false, + "direction": "in" } } }, @@ -97,10 +103,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package.", + "tagged": false, + "direction": "in" } } }, @@ -170,6 +182,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.toml index 897cd7e4..932f4d90 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.toml @@ -80,20 +80,32 @@ type = "record" optional = true [blocks.options.fields.mvt_filerecord.fields.mvt6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to a transport mover file." -mode = "filein" + +[blocks.options.fields.mvt_filerecord.fields.mvt6_filename] +type = "file" +longname = "mvt6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -157,6 +169,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.yaml index c285bb5a..cbe078fd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-gwtgwt.yaml @@ -90,19 +90,32 @@ blocks: optional: true fields: mvt6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to a transport mover file. - mode: filein + mvt6_filename: + type: file + longname: mvt6 input filename + description: is the file name of the transport mover input file to apply to this exchange. Information + for the transport mover are provided in the file provided with these keywords. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} + lists observation type(s) supported by the GWT-GWT package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -175,6 +188,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.json index 78751f15..306cfe95 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.toml index c105d7bd..201303de 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" [blocks.dimensions.fields.nexg] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.yaml index 638d0380..6b1bd5e1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/exg-olfgwf.yaml @@ -35,10 +35,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the SWF-GWF package. + tagged: false + direction: in dimensions: fields: nexg: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.json index c596aa67..f5f9ec47 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "time series keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.toml index f9f80933..376e4337 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "time series keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "constant temperature name" description = "name of the constant temperature cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.yaml index 629a19ad..0d030764 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-ctp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: time series keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CTP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CTP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.json index 99697f85..d4edb349 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.toml index 096944c9..25ef27b3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.yaml index 3a09ae0f..6816bc47 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.json index 31ad9bb2..15c36b4e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -279,6 +285,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.toml index 2086f4b9..71868161 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -254,6 +260,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.yaml index 2dab6b49..bf0975c3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disu.yaml @@ -34,10 +34,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -286,6 +292,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.json index e6782b5b..25ad3bb7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.toml index 23ff5ace..1f497730 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.yaml index 8755b959..108b33aa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.json index 7f2a143f..bbebabf2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.toml index c70461d4..3eae054f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "well name" description = "name of the energy source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.yaml index efdd7294..b5c1adc2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-esl.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ESL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ESL package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -118,6 +133,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -132,3 +148,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.json index f2a0ad45..abcab31c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package.", + "tagged": false, + "direction": "in" } } } @@ -160,6 +190,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -257,6 +288,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.toml index 36620513..76b88f0a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -142,6 +172,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -225,3 +256,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.yaml index ee64c47a..326bebfd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-lke.yaml @@ -76,46 +76,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LKE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LKE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -160,6 +190,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -269,3 +300,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.json index d5df5c35..1c1943da 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +47,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.toml index 01ec1de7..68644362 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.toml @@ -26,17 +26,29 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.yaml index 8dc89b3a..d4c910fb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mve.yaml @@ -30,16 +30,27 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.json index df6c27c9..f5ddc905 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package.", + "tagged": false, + "direction": "in" } } } @@ -160,6 +190,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -239,6 +270,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.toml index 87181179..9f779cbe 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -142,6 +172,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -207,3 +238,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.yaml index 62a98ece..bc268e51 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-mwe.yaml @@ -76,46 +76,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MWE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MWE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -160,6 +190,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -243,3 +274,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.json index 754713fa..a9f4428c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.json @@ -44,10 +44,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -57,10 +63,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +82,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.toml index 114440d4..17a8fdf1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.toml @@ -41,10 +41,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -52,10 +58,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -63,10 +75,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.yaml index 018582f3..c0d4a06f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-nam.yaml @@ -46,30 +46,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.json index 51c88508..089cdaba 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "temperature keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "temperaturefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -193,6 +211,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.toml index fc318e38..673872f5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.temperature_filerecord] type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "temperature keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.temperaturefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.temperatureprintrecord] type = "record" @@ -165,3 +183,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.yaml index e45408ac..c03f2b25 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out temperature_filerecord: type: record optional: true fields: temperature: - type: file + type: keyword longname: temperature keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + temperaturefile: + type: file + longname: file keyword + description: name of the output file to write temperature information. + tagged: false + direction: out temperatureprintrecord: type: record optional: true @@ -158,3 +174,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.json index fd1f7d5e..17a18479 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "temperature keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package.", + "tagged": false, + "direction": "in" } } } @@ -160,6 +190,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -257,6 +288,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.toml index 78de991e..24a26465 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "temperature keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -142,6 +172,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -225,3 +256,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.yaml index 084f0361..a2367b2e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-sfe.yaml @@ -77,46 +77,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: temperature keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -161,6 +191,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -269,3 +300,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.json index 823ff856..9e86b21f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package.", + "tagged": false, + "direction": "in" } } } @@ -148,6 +178,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -233,6 +264,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.toml index 327ab12f..f306757c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -130,6 +160,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -201,3 +232,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.yaml index e2858a7a..3078fa9c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwe-uze.yaml @@ -77,46 +77,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -150,6 +180,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -241,3 +272,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.json index f7f6647a..6bfb40c3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.toml index ea1a5839..64ff44ce 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.yaml index b118bb93..0670ca74 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-api.yaml @@ -40,10 +40,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the api boundary package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the api boundary package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the api boundary Package can be used with diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.json index 2a3d323d..bac0acc0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.json @@ -30,10 +30,16 @@ "optional": true, "fields": { "density": { - "type": "file", + "type": "keyword", "longname": "density keyword", - "description": "keyword to specify that record corresponds to density.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to density." + }, + "densityfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.toml index db3737e4..83f88be0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.toml @@ -25,10 +25,16 @@ type = "record" optional = true [blocks.options.fields.density_filerecord.fields.density] -type = "file" +type = "keyword" longname = "density keyword" description = "keyword to specify that record corresponds to density." -mode = "fileout" + +[blocks.options.fields.density_filerecord.fields.densityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.dev_efh_formulation] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.yaml index c4cba90d..6a4c6ece 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-buy.yaml @@ -28,10 +28,18 @@ blocks: optional: true fields: density: - type: file + type: keyword longname: density keyword description: keyword to specify that record corresponds to density. - mode: fileout + densityfile: + type: file + longname: file keyword + description: name of the binary output file to write density information. The density file + has the same format as the head file. Density values will be written to the density file + whenever heads are written to the binary head file. The settings for controlling head output + are contained in the Output Control option. + tagged: false + direction: out dev_efh_formulation: type: keyword longname: use equivalent freshwater head formulation diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.json index f9efac92..ef3ac69f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } }, @@ -105,6 +117,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -122,6 +135,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -141,6 +155,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.toml index cf2a8c59..4879bf52 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.options.fields.dev_no_newton] type = "keyword" @@ -92,6 +104,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -109,6 +122,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -121,3 +135,10 @@ longname = "constant head boundary name" description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.yaml index 45705b50..71037236 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chd.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dev_no_newton: type: keyword longname: turn off Newton for unconfined cells @@ -101,6 +115,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -122,6 +137,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -136,3 +152,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.json index 2fc2e75c..76aad594 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.json @@ -60,10 +60,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } }, @@ -115,6 +121,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.toml index 9ba5bce1..05dd6112 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.toml @@ -55,10 +55,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -99,3 +105,10 @@ dtype = "double" shape = [ "nodes", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.yaml index 000e1b92..0f5f7961 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-chdg.yaml @@ -66,10 +66,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -114,3 +121,13 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.json index be1a6d22..95644528 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.json @@ -112,10 +112,16 @@ "optional": true, "fields": { "strain_csv_interbed": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify the record that corresponds to final interbed strain output.", - "mode": "fileout" + "description": "keyword to specify the record that corresponds to final interbed strain output." + }, + "interbedstrain_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated-values output file to write final interbed strain information.", + "tagged": false, + "direction": "out" } } }, @@ -124,10 +130,16 @@ "optional": true, "fields": { "strain_csv_coarse": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify the record that corresponds to final coarse-grained material strain output.", - "mode": "fileout" + "description": "keyword to specify the record that corresponds to final coarse-grained material strain output." + }, + "coarsestrain_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated-values output file to write final coarse-grained material strain information.", + "tagged": false, + "direction": "out" } } }, @@ -136,10 +148,16 @@ "optional": true, "fields": { "compaction": { - "type": "file", + "type": "keyword", "longname": "compaction keyword", - "description": "keyword to specify that record corresponds to the compaction.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the compaction." + }, + "compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -148,10 +166,16 @@ "optional": true, "fields": { "compaction_elastic": { - "type": "file", + "type": "keyword", "longname": "elastic interbed compaction keyword", - "description": "keyword to specify that record corresponds to the elastic interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the elastic interbed compaction binary file." + }, + "elastic_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write elastic interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -160,10 +184,16 @@ "optional": true, "fields": { "compaction_inelastic": { - "type": "file", + "type": "keyword", "longname": "inelastic interbed compaction keyword", - "description": "keyword to specify that record corresponds to the inelastic interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the inelastic interbed compaction binary file." + }, + "inelastic_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write inelastic interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -172,10 +202,16 @@ "optional": true, "fields": { "compaction_interbed": { - "type": "file", + "type": "keyword", "longname": "interbed compaction keyword", - "description": "keyword to specify that record corresponds to the interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the interbed compaction binary file." + }, + "interbed_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -184,10 +220,16 @@ "optional": true, "fields": { "compaction_coarse": { - "type": "file", + "type": "keyword", "longname": "coarse compaction keyword", - "description": "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." + }, + "coarse_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write elastic coarse-grained material compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -196,10 +238,16 @@ "optional": true, "fields": { "zdisplacement": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the z-displacement binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the z-displacement binary file." + }, + "zdisplacement_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write z-displacement information.", + "tagged": false, + "direction": "out" } } }, @@ -208,10 +256,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -220,10 +274,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -232,10 +292,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package.", + "tagged": false, + "direction": "in" } } } @@ -323,6 +389,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -409,6 +476,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -427,6 +495,13 @@ "maxsig0" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.toml index fbaff1f0..c5a2acdf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.toml @@ -107,110 +107,176 @@ type = "record" optional = true [blocks.options.fields.strainib_filerecord.fields.strain_csv_interbed] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify the record that corresponds to final interbed strain output." -mode = "fileout" + +[blocks.options.fields.strainib_filerecord.fields.interbedstrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final interbed strain information." +tagged = false +direction = "out" [blocks.options.fields.straincg_filerecord] type = "record" optional = true [blocks.options.fields.straincg_filerecord.fields.strain_csv_coarse] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify the record that corresponds to final coarse-grained material strain output." -mode = "fileout" + +[blocks.options.fields.straincg_filerecord.fields.coarsestrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final coarse-grained material strain information." +tagged = false +direction = "out" [blocks.options.fields.compaction_filerecord] type = "record" optional = true [blocks.options.fields.compaction_filerecord.fields.compaction] -type = "file" +type = "keyword" longname = "compaction keyword" description = "keyword to specify that record corresponds to the compaction." -mode = "fileout" + +[blocks.options.fields.compaction_filerecord.fields.compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_elastic_filerecord] type = "record" optional = true [blocks.options.fields.compaction_elastic_filerecord.fields.compaction_elastic] -type = "file" +type = "keyword" longname = "elastic interbed compaction keyword" description = "keyword to specify that record corresponds to the elastic interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_elastic_filerecord.fields.elastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_inelastic_filerecord] type = "record" optional = true [blocks.options.fields.compaction_inelastic_filerecord.fields.compaction_inelastic] -type = "file" +type = "keyword" longname = "inelastic interbed compaction keyword" description = "keyword to specify that record corresponds to the inelastic interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_inelastic_filerecord.fields.inelastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write inelastic interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_interbed_filerecord] type = "record" optional = true [blocks.options.fields.compaction_interbed_filerecord.fields.compaction_interbed] -type = "file" +type = "keyword" longname = "interbed compaction keyword" description = "keyword to specify that record corresponds to the interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_interbed_filerecord.fields.interbed_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_coarse_filerecord] type = "record" optional = true [blocks.options.fields.compaction_coarse_filerecord.fields.compaction_coarse] -type = "file" +type = "keyword" longname = "coarse compaction keyword" description = "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_coarse_filerecord.fields.coarse_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic coarse-grained material compaction information." +tagged = false +direction = "out" [blocks.options.fields.zdisplacement_filerecord] type = "record" optional = true [blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the z-displacement binary file." -mode = "fileout" + +[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write z-displacement information." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package." +tagged = false +direction = "in" [blocks.dimensions.fields.ninterbeds] type = "integer" @@ -288,6 +354,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -368,6 +435,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -379,3 +447,10 @@ longname = "well stress offset" description = "is the stress offset for the cell. SIG0 is added to the calculated geostatic stress for the cell. SIG0 is specified only if MAXSIG0 is specified to be greater than 0 in the DIMENSIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.yaml index 57644f2c..b6514e8e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-csub.yaml @@ -131,108 +131,170 @@ blocks: optional: true fields: strain_csv_interbed: - type: file + type: keyword longname: budget keyword description: keyword to specify the record that corresponds to final interbed strain output. - mode: fileout + interbedstrain_filename: + type: file + longname: file keyword + description: name of the comma-separated-values output file to write final interbed strain + information. + tagged: false + direction: out straincg_filerecord: type: record optional: true fields: strain_csv_coarse: - type: file + type: keyword longname: budget keyword description: keyword to specify the record that corresponds to final coarse-grained material strain output. - mode: fileout + coarsestrain_filename: + type: file + longname: file keyword + description: name of the comma-separated-values output file to write final coarse-grained + material strain information. + tagged: false + direction: out compaction_filerecord: type: record optional: true fields: compaction: - type: file + type: keyword longname: compaction keyword description: keyword to specify that record corresponds to the compaction. - mode: fileout + compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write compaction information. + tagged: false + direction: out compaction_elastic_filerecord: type: record optional: true fields: compaction_elastic: - type: file + type: keyword longname: elastic interbed compaction keyword description: keyword to specify that record corresponds to the elastic interbed compaction binary file. - mode: fileout + elastic_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write elastic interbed compaction information. + tagged: false + direction: out compaction_inelastic_filerecord: type: record optional: true fields: compaction_inelastic: - type: file + type: keyword longname: inelastic interbed compaction keyword description: keyword to specify that record corresponds to the inelastic interbed compaction binary file. - mode: fileout + inelastic_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write inelastic interbed compaction information. + tagged: false + direction: out compaction_interbed_filerecord: type: record optional: true fields: compaction_interbed: - type: file + type: keyword longname: interbed compaction keyword description: keyword to specify that record corresponds to the interbed compaction binary file. - mode: fileout + interbed_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write interbed compaction information. + tagged: false + direction: out compaction_coarse_filerecord: type: record optional: true fields: compaction_coarse: - type: file + type: keyword longname: coarse compaction keyword description: keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file. - mode: fileout + coarse_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write elastic coarse-grained material compaction + information. + tagged: false + direction: out zdisplacement_filerecord: type: record optional: true fields: zdisplacement: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the z-displacement binary file. - mode: fileout + zdisplacement_filename: + type: file + longname: file keyword + description: name of the binary output file to write z-displacement information. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CSUB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CSUB package. + tagged: false + direction: in dimensions: fields: ninterbeds: @@ -315,6 +377,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -413,6 +476,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -428,3 +492,13 @@ blocks: time_series: true shape: - maxsig0 + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.json index 04118db6..6aa43b77 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.toml index 71557552..33440798 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.yaml index b391ec07..b71b2771 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.json index f904ddac..bca862ed 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -281,6 +287,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.toml index 921ed7c3..f96c687f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -256,6 +262,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.yaml index 8591a1bf..f6d5d665 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disu.yaml @@ -34,10 +34,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -288,6 +294,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.json index 3c4b1783..56be2810 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.toml index fb4c9c02..fd97b218 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.yaml index 3189e7a7..692eebfa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.json index 55d752af..15355eda 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.json @@ -64,10 +64,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -76,10 +82,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package.", + "tagged": false, + "direction": "in" } } }, @@ -116,6 +128,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -140,6 +153,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -159,6 +173,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.toml index 9d5d3741..c7e351e1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.toml @@ -59,20 +59,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -103,6 +115,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -127,6 +140,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -139,3 +153,10 @@ longname = "drain name" description = "name of the drain cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.yaml index f21fec21..02a84ebf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drn.yaml @@ -73,19 +73,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DRN package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DRN package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Drain Package can be used with the @@ -119,6 +133,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -149,6 +164,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -163,3 +179,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.json index 746db0e1..88c77eb3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package.", + "tagged": false, + "direction": "in" } } }, @@ -137,6 +143,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.toml index 56c67346..c007b7c7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.toml @@ -61,10 +61,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -121,3 +127,10 @@ dtype = "double" shape = [ "nodes", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.yaml index 67ecb202..9bc845a7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-drng.yaml @@ -79,10 +79,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DRN package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DRN package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Drain Package can be used with the @@ -142,3 +149,13 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.json index d8183d52..cc2e68c2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.json @@ -68,10 +68,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -80,10 +86,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package.", + "tagged": false, + "direction": "in" } } }, @@ -120,6 +132,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -151,6 +164,7 @@ "longname": "proportion of ET extinction depth", "description": "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -162,6 +176,7 @@ "longname": "proportion of maximum ET rate", "description": "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -181,6 +196,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -200,6 +216,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.toml index 31d51748..353d518d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.toml @@ -63,20 +63,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" [blocks.options.fields.surf_rate_specified] type = "keyword" @@ -107,6 +119,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -138,6 +151,7 @@ type = "array" longname = "proportion of ET extinction depth" description = "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -149,6 +163,7 @@ type = "array" longname = "proportion of maximum ET rate" description = "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -168,6 +183,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -180,3 +196,10 @@ longname = "evapotranspiration name" description = "name of the evapotranspiration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.yaml index 5c972bb5..7eeab466 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evt.yaml @@ -70,19 +70,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVT package. + tagged: false + direction: in surf_rate_specified: type: keyword longname: specify proportion of evapotranspiration rate at ET surface @@ -119,6 +133,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -155,6 +170,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -167,6 +183,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -192,6 +209,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -206,3 +224,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.json index 617fd69b..3e5ee5bf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } }, @@ -73,10 +79,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package.", + "tagged": false, + "direction": "in" } } }, @@ -146,6 +158,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.toml index 81f1a198..f324d12d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.toml @@ -56,20 +56,32 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -132,3 +144,10 @@ time_series = true shape = [ "ncpl", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.yaml index 96795e2f..64d68f19 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-evta.yaml @@ -68,19 +68,33 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the Time-Variable Input section for instructions on using + the time-array series capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVT package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -144,3 +158,13 @@ blocks: time_series: true shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.json index b95cf582..eba39feb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package.", + "tagged": false, + "direction": "in" } } }, @@ -104,6 +116,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -128,6 +141,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -147,6 +161,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.toml index 3be6e800..cae155cd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -91,6 +103,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -115,6 +128,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -127,3 +141,10 @@ longname = "general-head boundary name" description = "name of the general-head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.yaml index 3fd0ba57..829566fb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghb.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the GHB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the GHB package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the General-Head Boundary Package can be @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -132,6 +147,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -146,3 +162,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.json index 6764b34d..d93c33b5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.json @@ -60,10 +60,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package.", + "tagged": false, + "direction": "in" } } }, @@ -125,6 +131,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.toml index bf0ba4b4..e44eb688 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.toml @@ -55,10 +55,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -109,3 +115,10 @@ dtype = "double" shape = [ "nodes", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.yaml index 650ed9a6..4dd890b4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-ghbg.yaml @@ -67,10 +67,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the GHB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the GHB package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the General-Head Boundary Package can be @@ -125,3 +132,13 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.json index 79bf74b7..746b5c68 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.json @@ -73,6 +73,7 @@ "type": "array", "longname": "GNC contributing cells", "description": "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "numalphaj" @@ -82,6 +83,7 @@ "type": "array", "longname": "GNC contributing factors", "description": "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n.", + "tagged": false, "dtype": "double", "shape": [ "numalphaj" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.toml index de0ec43f..e8542cd3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.toml @@ -64,6 +64,7 @@ tagged = false type = "array" longname = "GNC contributing cells" description = "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "numalphaj", @@ -73,6 +74,7 @@ shape = [ type = "array" longname = "GNC contributing factors" description = "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n." +tagged = false dtype = "double" shape = [ "numalphaj", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.yaml index 40a06376..93a0de08 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-gnc.yaml @@ -84,6 +84,7 @@ blocks: a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell. + tagged: false dtype: integer shape: - numalphaj @@ -96,6 +97,7 @@ blocks: sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n. + tagged: false dtype: double shape: - numalphaj diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.json index 19411c94..2aa46a37 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.json @@ -40,6 +40,7 @@ "type": "array", "longname": "first cell adjacent to barrier", "description": "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node numbers for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -49,6 +50,7 @@ "type": "array", "longname": "second cell adjacent to barrier", "description": "identifier for the second cell. See CELLID1 for description of how to specify.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -66,6 +68,13 @@ "maxhfb" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.toml index b49cb2dd..42dfbc05 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.toml @@ -31,6 +31,7 @@ type = "record" type = "array" longname = "first cell adjacent to barrier" description = "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node numbers for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -40,6 +41,7 @@ shape = [ type = "array" longname = "second cell adjacent to barrier" description = "identifier for the second cell. See CELLID1 for description of how to specify." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -50,3 +52,10 @@ type = "double" longname = "barrier hydraulic characteristic" description = "is the hydraulic characteristic of the hydraulic-flow barrier. The hydraulic characteristic is the barrier hydraulic conductivity divided by the width of the hydraulic-flow barrier. If the hydraulic characteristic is negative, then the absolute value of HYDCHR acts as a multiplier to the conductance between the two model cells specified as containing the barrier. For example, if the value for HYDCHR was specified as -1.5, the conductance calculated for the two cells would be multiplied by 1.5." tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.yaml index dea9c9a4..9c8e4bda 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-hfb.yaml @@ -41,6 +41,7 @@ blocks: and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent. + tagged: false dtype: integer shape: - ncelldim @@ -48,6 +49,7 @@ blocks: type: array longname: second cell adjacent to barrier description: identifier for the second cell. See CELLID1 for description of how to specify. + tagged: false dtype: integer shape: - ncelldim @@ -63,3 +65,13 @@ blocks: tagged: false shape: - maxhfb + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.json index da3658eb..598ed9a9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.json @@ -70,10 +70,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -82,10 +88,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -94,10 +106,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -106,10 +124,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -118,10 +142,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -130,10 +160,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package.", + "tagged": false, + "direction": "in" } } }, @@ -224,6 +260,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -269,6 +306,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -686,6 +724,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.toml index 11b48ac0..59b8029d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.toml @@ -65,60 +65,96 @@ type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -203,6 +239,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -242,6 +279,7 @@ tagged = false type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -606,3 +644,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.yaml index 1f68f7bf..982a1a40 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-lak.yaml @@ -72,56 +72,91 @@ blocks: optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the binary output file to write stage information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LAK package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LAK package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the LAK Package can be used with the Water @@ -226,6 +261,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -272,6 +308,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -752,3 +789,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.json index 4eebacec..62d77758 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "head": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to head.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to head." + }, + "headfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write head information.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -82,10 +94,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -124,10 +142,16 @@ "optional": true, "fields": { "maw_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." + }, + "mfrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -136,10 +160,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -148,10 +178,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package.", + "tagged": false, + "direction": "in" } } }, @@ -220,6 +256,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -265,6 +302,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -436,6 +474,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.toml index cb556e46..26dbb4ba 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.toml @@ -53,30 +53,48 @@ type = "record" optional = true [blocks.options.fields.head_filerecord.fields.head] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to head." -mode = "fileout" + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write head information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.no_well_storage] type = "keyword" @@ -113,30 +131,48 @@ type = "record" optional = true [blocks.options.fields.mfrcsv_filerecord.fields.maw_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.mfrcsv_filerecord.fields.mfrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -199,6 +235,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -235,6 +272,7 @@ tagged = false type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -386,3 +424,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.yaml index 678bc1f1..13c8c61c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-maw.yaml @@ -64,28 +64,44 @@ blocks: optional: true fields: head: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to head. - mode: fileout + headfile: + type: file + longname: file keyword + description: name of the binary output file to write head information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out no_well_storage: type: keyword longname: deactivate well storage @@ -135,30 +151,51 @@ blocks: optional: true fields: maw_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program. - mode: fileout + mfrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + multi-aquifer well extraction or injection rates that have been reduced by the program. + Entries are only written if the extraction or injection rates are reduced. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MAW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MAW package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the MAW Package can be used with the Water @@ -250,6 +287,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -300,6 +338,7 @@ blocks: CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID. + tagged: false dtype: integer shape: - ncelldim @@ -513,3 +552,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.json index 3638cac9..4ce936fa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.json @@ -39,10 +39,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -51,10 +57,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } @@ -161,6 +173,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.toml index 34ac4f48..6b38a185 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.toml @@ -34,20 +34,32 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.dimensions.fields.maxmvr] type = "integer" @@ -135,3 +147,10 @@ type = "double" longname = "mover value" description = "is the value to be used in the equation for calculating the amount of water to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$." tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.yaml index e788fb6c..75ab9312 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-mvr.yaml @@ -38,19 +38,30 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out dimensions: fields: maxmvr: @@ -155,3 +166,13 @@ blocks: to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$. tagged: false + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.json index 7e11797a..d43090e1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.json @@ -57,10 +57,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -83,10 +95,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.toml index 95036e0a..6dc08f63 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.toml @@ -52,10 +52,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -63,10 +69,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -74,10 +86,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.yaml index bfc062fd..8d78a83e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-nam.yaml @@ -60,30 +60,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.json index f4c835e4..8cf24005 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.json @@ -140,10 +140,16 @@ "optional": true, "fields": { "tvk6": { - "type": "file", + "type": "keyword", "longname": "tvk keyword", - "description": "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." + }, + "tvk6_filename": { + "type": "file", + "longname": "file name of TVK information", + "description": "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.toml index 9a52ac15..0ee8fe37 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.toml @@ -131,10 +131,16 @@ type = "record" optional = true [blocks.options.fields.tvk_filerecord.fields.tvk6] -type = "file" +type = "keyword" longname = "tvk keyword" description = "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.tvk_filerecord.fields.tvk6_filename] +type = "file" +longname = "file name of TVK information" +description = "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.yaml index 451514f3..7084999d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-npf.yaml @@ -177,11 +177,18 @@ blocks: optional: true fields: tvk6: - type: file + type: keyword longname: tvk keyword description: keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately. - mode: filein + tvk6_filename: + type: file + longname: file name of TVK information + description: defines a time-varying hydraulic conductivity (TVK) input file. Records in the + TVK file can be used to change hydraulic conductivity properties at specified times or stress + periods. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.json index 8632a74d..12ff22f0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "head": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to head.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to head." + }, + "headfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write head information.", + "tagged": false, + "direction": "out" } } }, @@ -193,6 +211,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.toml index 66e109f5..40422bfd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.head_filerecord] type = "record" optional = true [blocks.options.fields.head_filerecord.fields.head] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to head." -mode = "fileout" + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write head information." +tagged = false +direction = "out" [blocks.options.fields.headprintrecord] type = "record" @@ -165,3 +183,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.yaml index 96242c05..1d3cc8a1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out head_filerecord: type: record optional: true fields: head: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to head. - mode: fileout + headfile: + type: file + longname: file keyword + description: name of the output file to write head information. + tagged: false + direction: out headprintrecord: type: record optional: true @@ -158,3 +174,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.json index 4a43b9ef..58ca47b1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.json @@ -64,10 +64,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -76,10 +82,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package.", + "tagged": false, + "direction": "in" } } } @@ -105,6 +117,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -122,6 +135,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -141,6 +155,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.toml index 5ca3188a..9fcfff36 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.toml @@ -59,20 +59,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -92,6 +104,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -109,6 +122,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -121,3 +135,10 @@ longname = "recharge name" description = "name of the recharge cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.yaml index 0b8ba98e..6718b029 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rch.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RCH package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RCH package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,3 +155,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.json index 9c9b6231..64bb4898 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } }, @@ -73,10 +79,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package.", + "tagged": false, + "direction": "in" } } }, @@ -125,6 +137,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.toml index 1179e0ac..ec311806 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.toml @@ -56,20 +56,32 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -111,3 +123,10 @@ time_series = true shape = [ "ncpl", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.yaml index 6ada521a..af3be5ea 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rcha.yaml @@ -68,19 +68,33 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the 'Time-Variable Input' section for instructions on + using the time-array series capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RCH package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RCH package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -129,3 +143,13 @@ blocks: time_series: true shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.json index 15dd5874..ca7604d6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package.", + "tagged": false, + "direction": "in" } } }, @@ -104,6 +116,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -135,6 +148,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -154,6 +168,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.toml index a15248b5..20a1fa8d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -91,6 +103,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -122,6 +135,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -134,3 +148,10 @@ longname = "drain name" description = "name of the river cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.yaml index aa5835a1..d0c8a0be 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-riv.yaml @@ -60,19 +60,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RIV package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RIV package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the River Package can be used with the @@ -101,6 +115,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -138,6 +153,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -152,3 +168,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.json index d3b3ddaa..70311fc5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.json @@ -60,10 +60,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package.", + "tagged": false, + "direction": "in" } } }, @@ -136,6 +142,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.toml index b67510a1..55231875 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.toml @@ -55,10 +55,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -120,3 +126,10 @@ dtype = "double" shape = [ "nodes", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.yaml index 2b884f5b..dfee2e1d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-rivg.yaml @@ -66,10 +66,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RIV package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RIV package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the River Package can be used with the @@ -133,3 +140,13 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.json index 13e400f5..db7943c2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.json @@ -64,10 +64,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -76,10 +82,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -88,10 +100,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -100,10 +118,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -112,10 +136,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -124,10 +154,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package.", + "tagged": false, + "direction": "in" } } }, @@ -207,6 +243,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -280,6 +317,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -356,6 +394,7 @@ "longname": "connected reach numbers", "description": "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise.", "optional": true, + "tagged": false, "dtype": "integer", "shape": [ "packagedata.ncon(ifno)" @@ -525,16 +564,21 @@ "type": "record", "fields": { "cross_section": { - "type": "file", + "type": "keyword", "longname": "cross_section keyword", - "description": "keyword to specify that record corresponds to a reach cross-section.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a reach cross-section." }, "tab6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a cross-section table file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a cross-section table file." + }, + "tab6_filename": { + "type": "file", + "longname": "table file name", + "description": "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section.", + "tagged": false, + "direction": "in" } } }, @@ -564,6 +608,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.toml index 86f6ecbb..f09b9d22 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.toml @@ -59,60 +59,96 @@ type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -186,6 +222,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -259,6 +296,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -320,6 +358,7 @@ type = "array" longname = "connected reach numbers" description = "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise." optional = true +tagged = false dtype = "integer" shape = [ "packagedata.ncon(ifno)", @@ -469,16 +508,21 @@ description = "real value that defines the fraction of upstream flow (USTRF) fro type = "record" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.cross_section] -type = "file" +type = "keyword" longname = "cross_section keyword" description = "keyword to specify that record corresponds to a reach cross-section." -mode = "filein" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a cross-section table file." -mode = "filein" + +[blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6_filename] +type = "file" +longname = "table file name" +description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." +tagged = false +direction = "in" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.auxiliaryrecord] type = "record" @@ -498,3 +542,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.yaml index e5c81476..2fad499d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sfr.yaml @@ -70,56 +70,91 @@ blocks: optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the binary output file to write stage information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFR package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFR package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the SFR Package can be used with the Water @@ -221,6 +256,7 @@ blocks: The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error. + tagged: false dtype: integer shape: - ncelldim @@ -304,6 +340,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -380,6 +417,7 @@ blocks: or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise. optional: true + tagged: false dtype: integer shape: - packagedata.ncon(ifno) @@ -600,16 +638,24 @@ blocks: type: record fields: cross_section: - type: file + type: keyword longname: cross_section keyword description: keyword to specify that record corresponds to a reach cross-section. - mode: filein tab6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a cross-section table file. - mode: filein + tab6_filename: + type: file + longname: table file name + description: character string that defines the path and filename for the file containing + cross-section table data for the reach. The TAB6_FILENAME file includes the number + of entries in the file and the station elevation data in terms of the fractional + width and the reach depth. Instructions for creating the TAB6_FILENAME input file + are provided in SFR Reach Cross-Section Table Input File section. + tagged: false + direction: in auxiliaryrecord: type: record fields: @@ -631,3 +677,13 @@ blocks: from a time series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.json index 78accf61..3fab9a7c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "tvs6": { - "type": "file", + "type": "keyword", "longname": "tvs keyword", - "description": "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." + }, + "tvs6_filename": { + "type": "file", + "longname": "file name of TVS information", + "description": "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods.", + "tagged": false, + "direction": "in" } } }, @@ -111,6 +117,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.toml index b7e12a03..c42b0c85 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.toml @@ -26,10 +26,16 @@ type = "record" optional = true [blocks.options.fields.tvs_filerecord.fields.tvs6] -type = "file" +type = "keyword" longname = "tvs keyword" description = "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.tvs_filerecord.fields.tvs6_filename] +type = "file" +longname = "file name of TVS information" +description = "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" @@ -97,3 +103,10 @@ valid = [ "steady-state", "transient", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.yaml index 9334a2ea..d45cc089 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-sto.yaml @@ -31,11 +31,18 @@ blocks: optional: true fields: tvs6: - type: file + type: keyword longname: tvs keyword description: keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately. - mode: filein + tvs6_filename: + type: file + longname: file name of TVS information + description: defines a time-varying storage (TVS) input file. Records in the TVS file can + be used to change specific storage and specific yield properties at specified times or stress + periods. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. @@ -107,3 +114,13 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.json index 39558254..d2091901 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "water_content": { - "type": "file", + "type": "keyword", "longname": "water_content keyword", - "description": "keyword to specify that record corresponds to unsaturated zone water contents.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to unsaturated zone water contents." + }, + "wcfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write water content information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -126,10 +156,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package.", + "tagged": false, + "direction": "in" } } }, @@ -214,6 +250,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -350,6 +387,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -359,6 +397,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.toml index 572aa481..b10fa293 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.toml @@ -61,60 +61,96 @@ type = "record" optional = true [blocks.options.fields.wc_filerecord.fields.water_content] -type = "file" +type = "keyword" longname = "water_content keyword" description = "keyword to specify that record corresponds to unsaturated zone water contents." -mode = "fileout" + +[blocks.options.fields.wc_filerecord.fields.wcfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write water content information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -193,6 +229,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -320,8 +357,16 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ "auxiliary", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.yaml index 59663eff..28ae16b5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-uzf.yaml @@ -67,56 +67,91 @@ blocks: optional: true fields: water_content: - type: file + type: keyword longname: water_content keyword description: keyword to specify that record corresponds to unsaturated zone water contents. - mode: fileout + wcfile: + type: file + longname: file keyword + description: name of the binary output file to write water content information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZF package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZF package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the UZF Package can be used with the Water @@ -213,6 +248,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -384,7 +420,18 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: - auxiliary + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.json index 747d9ac7..03d5a3e6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "viscosity": { - "type": "file", + "type": "keyword", "longname": "viscosity keyword", - "description": "keyword to specify that record corresponds to viscosity.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to viscosity." + }, + "viscosityfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.toml index 21b4a6a6..b6e07adf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.toml @@ -56,10 +56,16 @@ type = "record" optional = true [blocks.options.fields.viscosity_filerecord.fields.viscosity] -type = "file" +type = "keyword" longname = "viscosity keyword" description = "keyword to specify that record corresponds to viscosity." -mode = "fileout" + +[blocks.options.fields.viscosity_filerecord.fields.viscosityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" [blocks.dimensions.fields.nviscspecies] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.yaml index ea531ac8..10bc101e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-vsc.yaml @@ -61,10 +61,18 @@ blocks: optional: true fields: viscosity: - type: file + type: keyword longname: viscosity keyword description: keyword to specify that record corresponds to viscosity. - mode: fileout + viscosityfile: + type: file + longname: file keyword + description: name of the binary output file to write viscosity information. The viscosity + file has the same format as the head file. Viscosity values will be written to the viscosity + file whenever heads are written to the binary head file. The settings for controlling head + output are contained in the Output Control option. + tagged: false + direction: out dimensions: fields: nviscspecies: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.json index e787d0fb..686a91db 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.json @@ -64,10 +64,16 @@ "optional": true, "fields": { "auto_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + }, + "afrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -82,10 +88,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -94,10 +106,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package.", + "tagged": false, + "direction": "in" } } }, @@ -128,6 +146,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -145,6 +164,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -164,6 +184,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.toml index 648d29b5..9b2eb6b2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.toml @@ -59,10 +59,16 @@ type = "record" optional = true [blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.flow_reduction_length] type = "keyword" @@ -75,20 +81,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -113,6 +131,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -130,6 +149,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -142,3 +162,10 @@ longname = "well name" description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.yaml index f1e37caa..edc6a31a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-wel.yaml @@ -73,12 +73,19 @@ blocks: optional: true fields: auto_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program. - mode: fileout + afrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + well extraction rates that have been reduced by the program. Entries are only written if + the extraction rates are reduced. + tagged: false + direction: out flow_reduction_length: type: keyword longname: flow reduction length keyword @@ -93,19 +100,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the WEL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the WEL package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Well Package can be used with the Water @@ -134,6 +155,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -156,6 +178,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -170,3 +193,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.json index 9390ff0c..2c35edd6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "auto_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + }, + "afrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -84,10 +90,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package.", + "tagged": false, + "direction": "in" } } }, @@ -138,6 +150,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.toml index 0a293967..c3f9f55d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.toml @@ -61,10 +61,16 @@ type = "record" optional = true [blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.flow_reduction_length] type = "keyword" @@ -77,10 +83,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -120,3 +132,10 @@ dtype = "double" shape = [ "nodes", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.yaml index 27d2f75c..e3f0aa4d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwf-welg.yaml @@ -79,12 +79,19 @@ blocks: optional: true fields: auto_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program. - mode: fileout + afrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + well extraction rates that have been reduced by the program. Entries are only written if + the extraction rates are reduced. + tagged: false + direction: out flow_reduction_length: type: keyword longname: flow reduction length keyword @@ -99,10 +106,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the WEL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the WEL package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Well Package can be used with the Water @@ -149,3 +163,13 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.json index 5495391e..1e75a616 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.toml index d2b81725..5ad0a5d2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.yaml index ac9ee102..2275440c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-api.yaml @@ -40,10 +40,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the api boundary package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the api boundary package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the api boundary Package can be used with diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.json index eaa53f98..ea3e24cd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "time series keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.toml index a4a562ce..76ea5a33 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "time series keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "constant concentration name" description = "name of the constant concentration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.yaml index 6f9164c6..17587823 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-cnc.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: time series keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CNC package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CNC package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.json index 2700d587..bc9ff203 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.toml index b163a3c6..eadc9395 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.yaml index b0b21eb5..338f9bc2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.json index e58e31ef..2dc372b9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -281,6 +287,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.toml index 210c68ed..9ab8922a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -256,6 +262,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.yaml index 2d3bcf97..f44d7ba1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disu.yaml @@ -34,10 +34,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -288,6 +294,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.json index 0744ab02..991b447d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.toml index 04351cf6..cc675f07 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.yaml index 620c57f7..a5eaa749 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.json index 2d35bb55..6178ba81 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.json @@ -18,10 +18,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -30,10 +36,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -65,10 +77,16 @@ "optional": true, "fields": { "cim": { - "type": "file", + "type": "keyword", "longname": "cim keyword", - "description": "keyword to specify that record corresponds to immobile concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to immobile concentration." + }, + "cimfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file.", + "tagged": false, + "direction": "out" } } }, @@ -119,10 +137,16 @@ "optional": true, "fields": { "sorbate": { - "type": "file", + "type": "keyword", "longname": "sorbate keyword", - "description": "keyword to specify that record corresponds to immobile sorbate concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to immobile sorbate concentration." + }, + "sorbatefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.toml index dc5e810c..412c95ee 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.toml @@ -15,20 +15,32 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.sorption] type = "string" @@ -58,10 +70,16 @@ type = "record" optional = true [blocks.options.fields.cim_filerecord.fields.cim] -type = "file" +type = "keyword" longname = "cim keyword" description = "keyword to specify that record corresponds to immobile concentration." -mode = "fileout" + +[blocks.options.fields.cim_filerecord.fields.cimfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file." +tagged = false +direction = "out" [blocks.options.fields.cimprintrecord] type = "record" @@ -106,10 +124,16 @@ type = "record" optional = true [blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "file" +type = "keyword" longname = "sorbate keyword" description = "keyword to specify that record corresponds to immobile sorbate concentration." -mode = "fileout" + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.yaml index 5082fc41..0354cf1b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-ist.yaml @@ -17,19 +17,30 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out sorption: type: string longname: activate sorption @@ -60,10 +71,19 @@ blocks: optional: true fields: cim: - type: file + type: keyword longname: cim keyword description: keyword to specify that record corresponds to immobile concentration. - mode: fileout + cimfile: + type: file + longname: file keyword + description: name of the output file to write immobile concentrations. This file is a binary + file that has the same format and structure as a binary head and concentration file. The + value for the text variable written to the file is CIM. Immobile domain concentrations + will be written to this file at the same interval as mobile domain concentrations are saved, + as specified in the GWT Model Output Control file. + tagged: false + direction: out cimprintrecord: type: record optional: true @@ -101,10 +121,17 @@ blocks: optional: true fields: sorbate: - type: file + type: keyword longname: sorbate keyword description: keyword to specify that record corresponds to immobile sorbate concentration. - mode: fileout + sorbatefile: + type: file + longname: file keyword + description: name of the output file to write immobile sorbate concentration information. Immobile + sorbate concentrations will be written whenever aqueous immobile concentrations are saved, + as determined by settings in the Output Control option. + tagged: false + direction: out export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.json index 0c34e722..76bb9f3f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package.", + "tagged": false, + "direction": "in" } } } @@ -148,6 +178,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -245,6 +276,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.toml index e57f8a37..49dd61c4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -130,6 +160,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -213,3 +244,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.yaml index 961b1b15..4a4f3743 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-lkt.yaml @@ -76,46 +76,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LKT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LKT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -148,6 +178,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -258,3 +289,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.json index e11388b0..38c74532 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.json @@ -40,10 +40,16 @@ "optional": true, "fields": { "sorbate": { - "type": "file", + "type": "keyword", "longname": "sorbate keyword", - "description": "keyword to specify that record corresponds to sorbate concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to sorbate concentration." + }, + "sorbatefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.toml index 356f07e8..161dcc0e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.toml @@ -37,10 +37,16 @@ type = "record" optional = true [blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "file" +type = "keyword" longname = "sorbate keyword" description = "keyword to specify that record corresponds to sorbate concentration." -mode = "fileout" + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.yaml index abc2aa4c..2b0f8e8b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mst.yaml @@ -40,10 +40,17 @@ blocks: optional: true fields: sorbate: - type: file + type: keyword longname: sorbate keyword description: keyword to specify that record corresponds to sorbate concentration. - mode: fileout + sorbatefile: + type: file + longname: file keyword + description: name of the output file to write sorbate concentration information. Sorbate + concentrations will be written whenever aqueous concentrations are saved, as determined + by settings in the Output Control option. + tagged: false + direction: out export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.json index 595b8aab..7a3af779 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +47,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.toml index a243423e..989d4821 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.toml @@ -26,17 +26,29 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.yaml index 9075d7bd..e77482dc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mvt.yaml @@ -30,16 +30,27 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.json index 0577d849..50ca0508 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package.", + "tagged": false, + "direction": "in" } } } @@ -148,6 +178,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -227,6 +258,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.toml index 7c8c41da..d4d4106a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -130,6 +160,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -195,3 +226,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.yaml index d85c87e1..7fcff2e8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-mwt.yaml @@ -76,46 +76,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MWT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MWT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -148,6 +178,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -231,3 +262,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.json index 3848d286..d8dd9077 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.json @@ -44,10 +44,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -57,10 +63,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +82,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.toml index 5786731f..edcab7de 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.toml @@ -41,10 +41,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -52,10 +58,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -63,10 +75,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.yaml index f3321007..05e31708 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-nam.yaml @@ -46,30 +46,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.json index a98a0174..9759163a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "concentration keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concentrationfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -193,6 +211,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.toml index d82bd001..ce81cee0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.concentration_filerecord] type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "concentration keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concentrationfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.concentrationprintrecord] type = "record" @@ -165,3 +183,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.yaml index 683047a2..1cbfa031 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out concentration_filerecord: type: record optional: true fields: concentration: - type: file + type: keyword longname: concentration keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concentrationfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out concentrationprintrecord: type: record optional: true @@ -158,3 +174,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.json index 5c3094dc..ecc1199f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "concentration keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package.", + "tagged": false, + "direction": "in" } } } @@ -148,6 +178,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -245,6 +276,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.toml index 134ed107..7373da20 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "concentration keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -130,6 +160,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -213,3 +244,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.yaml index e3835701..1005becc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-sft.yaml @@ -76,46 +76,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: concentration keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -148,6 +178,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -256,3 +287,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.json index b455adb2..9ca6dff9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package.", + "tagged": false, + "direction": "in" } } }, @@ -105,6 +117,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -122,6 +135,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -141,6 +155,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.toml index e40f19b9..f669d60e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package." +tagged = false +direction = "in" [blocks.options.fields.highest_saturated] type = "keyword" @@ -92,6 +104,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -109,6 +122,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -121,3 +135,10 @@ longname = "well name" description = "name of the mass source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.yaml index 7fab4fbe..08d05b6b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-src.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SRC package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SRC package. + tagged: false + direction: in highest_saturated: type: keyword longname: apply source to highest saturated cell @@ -111,6 +125,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -133,6 +148,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -147,3 +163,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.json index 1d68db9e..a76449d1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package.", + "tagged": false, + "direction": "in" } } } @@ -148,6 +178,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -233,6 +264,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.toml index a35b3646..34d74c51 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.toml @@ -61,50 +61,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -130,6 +160,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -201,3 +232,10 @@ longname = "auxiliary variable value" description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." tagged = false time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.yaml index fd73e8dc..522a18b1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/gwt-uzt.yaml @@ -77,46 +77,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -150,6 +180,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -242,3 +273,13 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.json index eb887384..f98432e6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package.", + "tagged": false, + "direction": "in" } } } @@ -81,6 +87,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -104,6 +111,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -123,6 +131,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.toml index 05ca7e75..6e0a6740 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -70,6 +76,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -93,6 +100,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -105,3 +113,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.yaml index 695376a9..246c7056 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-cdb.yaml @@ -56,10 +56,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CDB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CDB package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -82,6 +89,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -112,6 +120,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -126,3 +135,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.json index afbeb51a..4d19d621 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.toml index 237cec3a..285169d4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "constant head boundary name" description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.yaml index ffb74b3c..2bfd2d62 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-chd.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.json index b4188c67..d6f14dc9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.json @@ -47,10 +47,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.toml index cf27345e..1c614e45 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.yaml index c28c3727..49aba973 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dfw.yaml @@ -61,10 +61,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.json index 4941dd81..1626fc8b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.toml index 47b43282..612775a1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.yaml index 70841516..4faff874 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-dis2d.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.json index c83b2a30..b4340505 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -198,6 +204,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.toml index 90d1d6b2..c9db8ca2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -177,6 +183,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.yaml index 755962e9..be77e4a3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -186,6 +192,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.json index eec6e7f1..b98b8540 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -185,6 +191,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.toml index c7658c18..1b9714c7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -164,6 +170,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.yaml index 4840d153..4530b260 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-disv2d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -172,6 +178,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.json index afc15fed..23264393 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.toml index 8d7f7fca..a08d8e23 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "evaporation name" description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.yaml index af1d489c..843e8b53 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-evp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.json index 096f9ad4..302b68ab 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.toml index e4b2f254..cfcc9ef9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "inflow name" description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.yaml index 6aca9374..dec9471b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-flw.yaml @@ -60,19 +60,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the FLW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the FLW package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -95,6 +109,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.json index 7fade3d7..46f7ca9b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.toml index 22b60ad6..1c41a1cc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.yaml index 844d8aef..0482420c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.json index a4043f2d..fd9c3ee7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.toml index 2c93a478..de4ddecf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "precipitation name" description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.yaml index 3b52aaaa..495e9712 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-pcp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the PCP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the PCP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.json index 100e39b0..f991ec03 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.toml index 0dff0281..c4587ac5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.toml @@ -24,3 +24,10 @@ valid = [ "steady-state", "transient", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.yaml index 0322e7c8..470d4e39 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-sto.yaml @@ -28,3 +28,13 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.json index 4c8f8a39..a7ba2e0e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -64,10 +70,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package.", + "tagged": false, + "direction": "in" } } } @@ -93,6 +105,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -130,6 +143,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -149,6 +163,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.toml index 87123734..2e3ddb03 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.toml @@ -47,20 +47,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -80,6 +92,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -117,6 +130,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -129,3 +143,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.yaml index db88283a..e7a1aeae 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/olf-zdg.yaml @@ -56,19 +56,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ZDG package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ZDG package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -91,6 +105,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -141,6 +156,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -155,3 +171,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.json index e214080d..161c0ab6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.toml index d3e33f91..63555b3b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.yaml index ea37cf65..6c64b911 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.json index ddf9515e..b4e97da2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -227,6 +239,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.toml index c91e6423..517359a0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -204,6 +216,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.yaml index d958b368..02263fda 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-disv.yaml @@ -37,10 +37,15 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +100,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -210,6 +220,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.json index a7348ad3..1f6a551c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.json @@ -20,19 +20,19 @@ "type": "file", "longname": "gwf head file", "optional": true, - "mode": "filein" + "direction": "in" }, "gwfbudget": { "type": "file", "longname": "gwf budget file", "optional": true, - "mode": "filein" + "direction": "in" }, "gwfgrid": { "type": "file", "longname": "gwf grid file", "optional": true, - "mode": "filein" + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.toml index 1d4095e9..a87b239a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.toml @@ -13,16 +13,16 @@ optional = true type = "file" longname = "gwf head file" optional = true -mode = "filein" +direction = "in" [blocks.packagedata.fields.gwfbudget] type = "file" longname = "gwf budget file" optional = true -mode = "filein" +direction = "in" [blocks.packagedata.fields.gwfgrid] type = "file" longname = "gwf grid file" optional = true -mode = "filein" +direction = "in" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.yaml index b6678b9e..8988e119 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-fmi.yaml @@ -17,14 +17,14 @@ blocks: type: file longname: gwf head file optional: true - mode: filein + direction: in gwfbudget: type: file longname: gwf budget file optional: true - mode: filein + direction: in gwfgrid: type: file longname: gwf grid file optional: true - mode: filein + direction: in diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.json index 2bf0487b..7c2d7af2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.json @@ -17,10 +17,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -29,10 +35,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +53,16 @@ "optional": true, "fields": { "track": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." + }, + "trackfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -53,10 +71,16 @@ "optional": true, "fields": { "trackcsv": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." + }, + "trackcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -120,6 +144,7 @@ "type": "array", "longname": "tracking times", "description": "times to track, relative to the beginning of the simulation.", + "tagged": false, "dtype": "double" } } @@ -286,6 +311,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.toml index cf270a77..158e662f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.toml @@ -12,40 +12,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.track_filerecord] type = "record" optional = true [blocks.options.fields.track_filerecord.fields.track] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." -mode = "fileout" + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.trackcsv_filerecord] type = "record" optional = true [blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." -mode = "fileout" + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.track_release] type = "keyword" @@ -107,6 +131,7 @@ description = "keyword indicating tracking times will follow" type = "array" longname = "tracking times" description = "times to track, relative to the beginning of the simulation." +tagged = false dtype = "double" [blocks.options.fields.track_timesfilerecord] @@ -244,3 +269,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.yaml index 485603e8..fbb8999b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-oc.yaml @@ -14,39 +14,60 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out track_filerecord: type: record optional: true fields: track: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file. - mode: fileout + trackfile: + type: file + longname: file keyword + description: name of the binary output file to write tracking information. + tagged: false + direction: out trackcsv_filerecord: type: record optional: true fields: trackcsv: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file. - mode: fileout + trackcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) file to write tracking information. + tagged: false + direction: out track_release: type: keyword longname: track release @@ -108,6 +129,7 @@ blocks: type: array longname: tracking times description: times to track, relative to the beginning of the simulation. + tagged: false dtype: double track_timesfilerecord: type: record @@ -242,3 +264,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.json index f9bd5585..356e332e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.json @@ -59,10 +59,16 @@ "optional": true, "fields": { "track": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." + }, + "trackfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -71,10 +77,16 @@ "optional": true, "fields": { "trackcsv": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." + }, + "trackcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -120,6 +132,7 @@ "type": "array", "longname": "release times", "description": "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive.", + "tagged": false, "dtype": "double" } } @@ -220,6 +233,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -318,6 +332,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.toml index c5fe2cd6..d88cc33d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.toml @@ -54,20 +54,32 @@ type = "record" optional = true [blocks.options.fields.track_filerecord.fields.track] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." -mode = "fileout" + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.trackcsv_filerecord] type = "record" optional = true [blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." -mode = "fileout" + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.stoptime] type = "double" @@ -111,6 +123,7 @@ description = "keyword indicating release times will follow" type = "array" longname = "release times" description = "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +tagged = false dtype = "double" [blocks.options.fields.release_timesfilerecord] @@ -203,6 +216,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -282,3 +296,10 @@ type = "array" description = "release particles after the specified fraction of the time step has elapsed. If FRACTION is not set, particles are released at the start of the specified time step(s). FRACTION must be a single value when used with ALL, FIRST, or FREQUENCY. When used with STEPS, FRACTION may be a single value or an array of the same length as STEPS. If a single FRACTION value is provided with STEPS, the fraction applies to all steps. NOTE: The FRACTION option has been removed. For fine control over release timing, specify times explicitly using the RELEASETIMES block." optional = true dtype = "double" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.yaml index c17a0cbf..b98578ea 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/prt-prp.yaml @@ -62,21 +62,31 @@ blocks: optional: true fields: track: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file. - mode: fileout + trackfile: + type: file + longname: file keyword + description: name of the binary output file to write tracking information. + tagged: false + direction: out trackcsv_filerecord: type: record optional: true fields: trackcsv: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file. - mode: fileout + trackcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) file to write tracking information. + tagged: false + direction: out stoptime: type: double longname: stop time @@ -138,6 +148,7 @@ blocks: longname: release times description: times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive. + tagged: false dtype: double release_timesfilerecord: type: record @@ -242,6 +253,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -340,3 +352,13 @@ blocks: using the RELEASETIMES block.' optional: true dtype: double + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the stress period number for which the data specified in the + PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than + zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned + for the previous PERIOD block. The information specified in the PERIOD block applies only to that + stress period. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.json index 8c62b403..45348c93 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.json @@ -47,10 +47,16 @@ "optional": true, "fields": { "hpc6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a hpc file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a hpc file." + }, + "hpc6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files.", + "tagged": false, + "direction": "in" } } } @@ -177,11 +183,18 @@ "type": "array", "longname": "array of model names in this solution", "description": "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line.", + "tagged": false, "dtype": "string" } } } } + }, + "header": { + "name": "group_num", + "type": "integer", + "description": "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.toml index 84c41cbb..fefdb06c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.toml @@ -44,10 +44,16 @@ description = "hpc record" optional = true [blocks.options.fields.hpc_filerecord.fields.hpc6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a hpc file." -mode = "filein" + +[blocks.options.fields.hpc_filerecord.fields.hpc6_filename] +type = "file" +longname = "file name of time series information" +description = "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files." +tagged = false +direction = "in" [blocks.timing.fields.tdis6] type = "string" @@ -153,4 +159,11 @@ case_sensitive = true type = "array" longname = "array of model names in this solution" description = "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line." +tagged = false dtype = "string" + +[blocks.solutiongroup.header] +name = "group_num" +type = "integer" +description = "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.yaml index 572b60fc..a7a02493 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-nam.yaml @@ -51,10 +51,16 @@ blocks: optional: true fields: hpc6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a hpc file. - mode: filein + hpc6_filename: + type: file + longname: file name of time series information + description: name of input file to define HPC file settings for the HPC package. See the 'HPC + File' section for instructions for preparing HPC input files. + tagged: false + direction: in timing: fields: tdis6: @@ -157,4 +163,11 @@ blocks: longname: array of model names in this solution description: is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line. + tagged: false dtype: string + header: + name: group_num + type: integer + description: is the group number of the solution group. Solution groups must be numbered sequentially, + starting with group number one. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.json index def67c62..4015c481 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "ats6": { - "type": "file", + "type": "keyword", "longname": "ats keyword", - "description": "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." + }, + "ats6_filename": { + "type": "file", + "longname": "file name of adaptive time series information", + "description": "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.toml index 43c9b62b..e35aa6ef 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.toml @@ -24,10 +24,16 @@ type = "record" optional = true [blocks.options.fields.ats_filerecord.fields.ats6] -type = "file" +type = "keyword" longname = "ats keyword" description = "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.ats_filerecord.fields.ats6_filename] +type = "file" +longname = "file name of adaptive time series information" +description = "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods." +tagged = false +direction = "in" [blocks.dimensions.fields.nper] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.yaml index cf1ce6d7..39f5995c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sim-tdis.yaml @@ -28,11 +28,17 @@ blocks: optional: true fields: ats6: - type: file + type: keyword longname: ats keyword description: keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately. - mode: filein + ats6_filename: + type: file + longname: file name of adaptive time series information + description: defines an adaptive time step (ATS) input file defining ATS controls. Records + in the ATS file can be used to override the time step behavior for selected stress periods. + tagged: false + direction: in dimensions: fields: nper: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.json index 8b14c99f..9fe00501 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "csv_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." + }, + "csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, @@ -36,10 +42,16 @@ "optional": true, "fields": { "csv_outer_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." + }, + "outer_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step.", + "tagged": false, + "direction": "out" } } }, @@ -48,10 +60,16 @@ "optional": true, "fields": { "csv_inner_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output." + }, + "inner_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.toml index 20d729bf..b813451b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.toml @@ -21,30 +21,48 @@ type = "record" optional = true [blocks.options.fields.csv_output_filerecord.fields.csv_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." -mode = "fileout" + +[blocks.options.fields.csv_output_filerecord.fields.csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.csv_outer_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." -mode = "fileout" + +[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." +tagged = false +direction = "out" [blocks.options.fields.csv_inner_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." -mode = "fileout" + +[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.no_ptcrecord] type = "record" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.yaml index a6ca0ca2..9e3875a2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-ims.yaml @@ -39,33 +39,59 @@ blocks: optional: true fields: csv_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option. - mode: fileout + csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes + maximum head change convergence information at the end of each outer iteration for each + time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change + and maximum residual convergence information for the solution and each model (if the solution + includes more than one model) and linear acceleration information for each inner iteration. + tagged: false + direction: out csv_outer_output_filerecord: type: record optional: true fields: csv_outer_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values outer iteration convergence output. - mode: fileout + outer_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write maximum dependent-variable + (for example, head) change convergence information at the end of each outer iteration for + each time step. + tagged: false + direction: out csv_inner_output_filerecord: type: record optional: true fields: csv_inner_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. - mode: fileout + inner_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. Comma separated values output includes maximum dependent-variable (for example, + head) change and maximum residual convergence information for the solution and each model + (if the solution includes more than one model) and linear acceleration information for each + inner iteration. + tagged: false + direction: out no_ptcrecord: type: record longname: no_ptc record diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.json index 0597b71c..460b5a6e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "csv_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." + }, + "csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, @@ -36,10 +42,16 @@ "optional": true, "fields": { "csv_outer_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." + }, + "outer_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step.", + "tagged": false, + "direction": "out" } } }, @@ -48,10 +60,16 @@ "optional": true, "fields": { "csv_inner_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output." + }, + "inner_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.toml index 5705d72b..36c1fea3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.toml @@ -21,30 +21,48 @@ type = "record" optional = true [blocks.options.fields.csv_output_filerecord.fields.csv_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." -mode = "fileout" + +[blocks.options.fields.csv_output_filerecord.fields.csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.csv_outer_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." -mode = "fileout" + +[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." +tagged = false +direction = "out" [blocks.options.fields.csv_inner_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." -mode = "fileout" + +[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.no_ptcrecord] type = "record" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.yaml index 8ca1f600..188c7ddd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/sln-pts.yaml @@ -39,33 +39,59 @@ blocks: optional: true fields: csv_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option. - mode: fileout + csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes + maximum head change convergence information at the end of each outer iteration for each + time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change + and maximum residual convergence information for the solution and each model (if the solution + includes more than one model) and linear acceleration information for each inner iteration. + tagged: false + direction: out csv_outer_output_filerecord: type: record optional: true fields: csv_outer_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values outer iteration convergence output. - mode: fileout + outer_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write maximum dependent-variable + (for example, head) change convergence information at the end of each outer iteration for + each time step. + tagged: false + direction: out csv_inner_output_filerecord: type: record optional: true fields: csv_inner_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. - mode: fileout + inner_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. Comma separated values output includes maximum dependent-variable (for example, + head) change and maximum residual convergence information for the solution and each model + (if the solution includes more than one model) and linear acceleration information for each + inner iteration. + tagged: false + direction: out no_ptcrecord: type: record longname: no_ptc record diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.json index 2b539974..defe76d9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package.", + "tagged": false, + "direction": "in" } } } @@ -81,6 +87,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -104,6 +111,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -123,6 +131,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.toml index 87c1440a..c615681c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -70,6 +76,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -93,6 +100,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -105,3 +113,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.yaml index c5d5c879..97ca1c8e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-cdb.yaml @@ -56,10 +56,18 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Zero-Depth-Gradient Boundary + package. See the 'Observation utility' section for instructions for preparing observation + input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary + package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -82,6 +90,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -112,6 +121,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -126,3 +136,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.json index 076f6318..24b18995 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the constant-head package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the constant-head package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.toml index 67d84f1a..bcebfef2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the constant-head package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the constant-head package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "constant head boundary name" description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.yaml index 9bf9c801..352136a0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-chd.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the constant-head package. See + the 'Observation utility' section for instructions for preparing observation input files. + Table {#2} lists observation type(s) supported by the constant-head package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.json index 0b31fb58..941546dd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.json @@ -47,10 +47,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.toml index 6c54d70a..835d7858 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.yaml index 8892f114..7dfa8a2d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dfw.yaml @@ -61,10 +61,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.json index 7578dca3..20f3d80e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.toml index afd3439b..618cefd7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.yaml index 4c6d2b68..bd12e585 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-dis2d.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.json index a6e73418..63265483 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -189,6 +195,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.toml index ee2fee85..06f11f4f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -168,6 +174,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.yaml index a22cbfd4..2a8b9d5d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -179,6 +185,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.json index 410f7a0f..7adf38f3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -185,6 +191,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.toml index 1fb7ff52..0e9cd323 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -164,6 +170,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.yaml index 5139217f..bbd16948 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-disv2d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -172,6 +178,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.json index 2617183f..dc89e000 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Evaporation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Evaporation package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.toml index 877b0eb3..0c048ae0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Evaporation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Evaporation package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "evaporation name" description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.yaml index c9842258..235e9b37 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-evp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Evaporation package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the Evaporation package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.json index e24a8f52..0f704808 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the inflow package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the inflow package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.toml index d58281dc..aae7e0d7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the inflow package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the inflow package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "inflow name" description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.yaml index f5843e9c..1fe776e9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-flw.yaml @@ -60,19 +60,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the inflow package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the inflow package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -95,6 +109,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -117,6 +132,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -131,3 +147,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.json index 9a3e5412..156cd2e5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.toml index 6fa432bb..c7f5b810 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.yaml index 91ce65fa..ff05a2e5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.json index 2bb6a4a3..9df9ad2a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Precipitation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Precipitation package.", + "tagged": false, + "direction": "in" } } } @@ -99,6 +111,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -116,6 +129,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -135,6 +149,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.toml index 4d832e63..4859e065 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.toml @@ -53,20 +53,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Precipitation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Precipitation package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -86,6 +98,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -103,6 +116,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,3 +129,10 @@ longname = "precipitation name" description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.yaml index 148d2236..6d3abcf5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-pcp.yaml @@ -61,19 +61,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Precipitation package. See + the 'Observation utility' section for instructions for preparing observation input files. + Table {#2} lists observation type(s) supported by the Precipitation package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -96,6 +110,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -119,6 +134,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -133,3 +149,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.json index 5eca0972..bb2bc26f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.toml index 0454b06b..85a299e4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.toml @@ -24,3 +24,10 @@ valid = [ "steady-state", "transient", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.yaml index 14762f13..8ef02fb7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-sto.yaml @@ -28,3 +28,13 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.json index 553f9b70..68bb1847 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -64,10 +70,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package.", + "tagged": false, + "direction": "in" } } } @@ -93,6 +105,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -130,6 +143,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -149,6 +163,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.toml index 1a09fddd..6f1ff3a5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.toml @@ -47,20 +47,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -80,6 +92,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -117,6 +130,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -129,3 +143,10 @@ longname = "zero-depth-gradient boundary name" description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." optional = true tagged = false + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.yaml index 679f700a..c20c90f9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/swf-zdg.yaml @@ -56,19 +56,34 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Zero-Depth-Gradient Boundary + package. See the 'Observation utility' section for instructions for preparing observation + input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary + package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -91,6 +106,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -141,6 +157,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -155,3 +172,13 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.json index 6a1ed9d4..c0cce862 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.json @@ -56,6 +56,23 @@ } } } + }, + "header": { + "name": "output", + "type": "record", + "fields": { + "obs_output_file_name": { + "type": "file", + "description": "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values').", + "tagged": false, + "direction": "out" + }, + "binary": { + "type": "keyword", + "description": "an optional keyword used to indicate that the output file should be written in binary (unformatted) form.", + "optional": true + } + } } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.toml index ce0781df..6f32e6b7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.toml @@ -46,3 +46,18 @@ longname = "time" description = "Text identifying cell adjacent to cell identified by ID. The form of ID2 is as described for ID. ID2 is used for intercell-flow observations of a GWF model, for three observation types of the LAK Package, for two observation types of the MAW Package, and one observation type of the UZF Package." optional = true tagged = false + +[blocks.continuous.header] +name = "output" +type = "record" + +[blocks.continuous.header.fields.obs_output_file_name] +type = "file" +description = "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values')." +tagged = false +direction = "out" + +[blocks.continuous.header.fields.binary] +type = "keyword" +description = "an optional keyword used to indicate that the output file should be written in binary (unformatted) form." +optional = true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.yaml index 49ffb580..b5ae61a1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-obs.yaml @@ -61,3 +61,21 @@ blocks: one observation type of the UZF Package. optional: true tagged: false + header: + name: output + type: record + fields: + obs_output_file_name: + type: file + description: Name of a file to which simulated values corresponding to observations in the block + are to be written. The file name can be an absolute or relative path name. A unique output + file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is + written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated + Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values'). + tagged: false + direction: out + binary: + type: keyword + description: an optional keyword used to indicate that the output file should be written in + binary (unformatted) form. + optional: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.json index fb6aceae..9762bffe 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.json @@ -25,10 +25,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -80,6 +86,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.toml index b952f724..5605d3e2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.toml @@ -20,10 +20,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -60,3 +66,10 @@ type = "double" longname = "boundary temperature" description = "is the user-supplied boundary temperature. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the TEMPERATURE for each boundary feature is zero." time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.yaml index f2017f15..ce53abf0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spc.yaml @@ -22,10 +22,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in dimensions: fields: maxbound: @@ -70,3 +77,13 @@ blocks: time_series: true shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.json index 08df9a0d..4d34e3a7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.json @@ -25,10 +25,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } } @@ -56,6 +62,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.toml index a0435d96..73007d53 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.toml @@ -22,10 +22,16 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.period.fields.concentration] type = "array" @@ -46,3 +52,10 @@ dtype = "double" shape = [ "ncpl", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.yaml index b93714aa..c97780ac 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-spca.yaml @@ -27,10 +27,17 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the Time-Variable Input section for instructions on using + the time-array series capability. + tagged: false + direction: in period: fields: concentration: @@ -53,3 +60,13 @@ blocks: dtype: double shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.json index 3316b7b5..e0cd2f00 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.json @@ -24,6 +24,7 @@ "time_series_name": { "type": "array", "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.", + "tagged": false, "dtype": "string" } } @@ -61,6 +62,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double", "shape": [ "time_series_name" @@ -75,8 +77,15 @@ "tas_array": { "type": "array", "description": "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.", + "tagged": false, "dtype": "double" } + }, + "header": { + "name": "time_from_model_start", + "type": "double", + "description": "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.toml index acbecfad..aceefb7b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.toml @@ -19,6 +19,7 @@ description = "xxx" [blocks.attributes.fields.time_series_namerecord.fields.time_series_name] type = "array" 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." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord] @@ -52,6 +53,7 @@ description = " xxx" [blocks.attributes.fields.sfacrecord.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" shape = [ "time_series_name", @@ -60,4 +62,11 @@ shape = [ [blocks.time.fields.tas_array] type = "array" description = "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false dtype = "double" + +[blocks.time.header] +name = "time_from_model_start" +type = "double" +description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.yaml index 1d7caad6..85496450 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tas.yaml @@ -21,6 +21,7 @@ blocks: type: array 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. + tagged: false dtype: string interpolation_methodrecord: type: record @@ -50,6 +51,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double shape: - time_series_name @@ -59,4 +61,11 @@ blocks: type: array description: An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility. + tagged: false dtype: double + header: + name: time_from_model_start + type: double + description: A numeric time relative to the start of the simulation, in the time unit used in the + simulation. Times must be strictly increasing. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.json index 4ffc7a1a..08706934 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.json @@ -24,6 +24,7 @@ "time_series_names": { "type": "array", "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.", + "tagged": false, "dtype": "string" } } @@ -40,6 +41,7 @@ "interpolation_method": { "type": "array", "description": "Interpolation method, which is either STEPWISE or LINEAR.", + "tagged": false, "dtype": "string" } } @@ -75,6 +77,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double" } } @@ -87,6 +90,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double" } } @@ -114,6 +118,7 @@ "ts_array": { "type": "array", "description": "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.", + "tagged": false, "dtype": "double", "shape": [ "interpolation_method" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.toml index 3275c189..956367eb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.toml @@ -19,6 +19,7 @@ description = "xxx" [blocks.attributes.fields.time_series_namerecord.fields.time_series_names] type = "array" 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." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord] @@ -33,6 +34,7 @@ description = " xxx" [blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] type = "array" description = "Interpolation method, which is either STEPWISE or LINEAR." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord_single] @@ -66,6 +68,7 @@ description = " xxx" [blocks.attributes.fields.sfacrecord.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" [blocks.attributes.fields.sfacrecord_single] @@ -76,6 +79,7 @@ optional = true [blocks.attributes.fields.sfacrecord_single.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" [blocks.attributes.fields.sfac] @@ -98,6 +102,7 @@ tagged = false [blocks.timeseries.fields.timeseries.item.fields.ts_array] type = "array" description = "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false dtype = "double" shape = [ "interpolation_method", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.yaml index 82a2adf6..5be55ae2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-ts.yaml @@ -21,6 +21,7 @@ blocks: type: array 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. + tagged: false dtype: string interpolation_methodrecord: type: record @@ -33,6 +34,7 @@ blocks: interpolation_method: type: array description: Interpolation method, which is either STEPWISE or LINEAR. + tagged: false dtype: string interpolation_methodrecord_single: type: record @@ -61,6 +63,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double sfacrecord_single: type: record @@ -71,6 +74,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double sfac: type: keyword @@ -93,6 +97,7 @@ blocks: type: array description: A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility. + tagged: false dtype: double shape: - interpolation_method diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.json index 07414182..786e76fd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.json @@ -18,10 +18,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -38,6 +44,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -70,6 +77,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.toml index af95d9af..1de70447 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.toml @@ -15,10 +15,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.period.fields.perioddata] type = "list" @@ -30,6 +36,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -56,3 +63,10 @@ type = "double" longname = "hydraulic conductivity of third ellipsoid axis (L/T)" description = "is the new value to be assigned as the cell's hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK NPF package option is specified) from the start of the specified stress period, as per K33 in the NPF package. For an unrotated case, this is the vertical hydraulic conductivity. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.yaml index c75eb23f..57688c62 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvk.yaml @@ -17,10 +17,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in period: fields: perioddata: @@ -36,6 +43,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -75,3 +83,13 @@ blocks: can be obtained from a time series by entering the time-series name in place of a numeric value. time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.json b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.json index dfbd32de..52999487 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -44,6 +50,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -70,6 +77,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.toml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.toml index f943cd9f..f8ce31f9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.toml @@ -21,10 +21,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.period.fields.perioddata] type = "list" @@ -36,6 +42,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -56,3 +63,10 @@ type = "double" longname = "specific yield" description = "is the new value to be assigned as the cell's specific yield from the start of the specified stress period, as per SY in the STO package. Specific yield values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.yaml index 952bcd17..ae293c56 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev2/utl-tvs.yaml @@ -25,10 +25,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in period: fields: perioddata: @@ -44,6 +51,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -71,3 +79,13 @@ blocks: the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.json index bb891378..e6969f31 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package.", + "tagged": false, + "direction": "in" } } } @@ -90,6 +96,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -113,6 +120,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -132,6 +140,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.toml index 6853c8d6..0b5390cb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.toml @@ -56,10 +56,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -79,6 +85,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -102,6 +109,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,6 +123,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.yaml index bbffa1ea..3cbcf911 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-cdb.yaml @@ -62,10 +62,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CDB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CDB package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -88,6 +95,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -118,6 +126,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -132,6 +141,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.json index 9537e3f2..727336d6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.toml index 5c2d0113..43ec27b5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the constant head boundary cell. BOUNDNAME is an ASCII c optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.yaml index 963fcc62..0e52a2a8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-chd.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.json index 551ae7d8..98be405b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.toml index 81128eab..0eaf5960 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.yaml index 66b89744..4f863b5d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-dfw.yaml @@ -64,10 +64,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.json index 01279d69..f9fbc782 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -189,6 +195,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.toml index 878262f2..c9a5c2b2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -168,6 +174,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.yaml index 2ff1faea..e7db1da9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -179,6 +185,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.json index f489074b..d39e786d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.toml index 9eaca43c..e06c06f9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the evaporation cell. BOUNDNAME is an ASCII character va optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.yaml index 5f6cd2b9..1ee299c3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-evp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.json index 492aab35..3fe7fdfa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.toml index 65697818..2073e980 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the inflow cell. BOUNDNAME is an ASCII character variabl optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.yaml index 8697c035..170167a6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-flw.yaml @@ -66,19 +66,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the FLW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the FLW package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -101,6 +115,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.json index ce596aba..1cb60622 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.toml index a6b079d2..dac07aa4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.yaml index 285bbcd4..7d282e77 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.json index 65da489d..c52dd855 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.toml index f958525d..755cb5f5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the precipitation cell. BOUNDNAME is an ASCII character optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.yaml index cd3f2a87..d8a75e1d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-pcp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the PCP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the PCP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.json index 65820fe3..48578c24 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.toml index 70c6746b..8bcba60a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.toml @@ -25,6 +25,13 @@ valid = [ "transient", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ipakcb] set_in = "ar" source = "save_flows" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.yaml index c68e2364..eb4b6cb1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-sto.yaml @@ -28,6 +28,16 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ipakcb: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.json index a429a0b0..3bb79933 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -73,10 +79,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package.", + "tagged": false, + "direction": "in" } } } @@ -102,6 +114,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -139,6 +152,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -158,6 +172,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.toml index 9b016efd..25524317 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.toml @@ -56,20 +56,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -89,6 +101,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -126,6 +139,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -139,6 +153,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.yaml index 2a8b65ab..bb89214c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/chf-zdg.yaml @@ -62,19 +62,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ZDG package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ZDG package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -97,6 +111,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -147,6 +162,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -161,6 +177,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.json index 6e0b751f..0c9bb637 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.toml index c572d543..a8bbc890 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" [blocks.dimensions.fields.nexg] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.yaml index 1841e50f..71bbd298 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-chfgwf.yaml @@ -35,10 +35,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the SWF-GWF package. + tagged: false + direction: in dimensions: fields: nexg: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.json index 41f23731..7e35127b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.json @@ -88,10 +88,16 @@ "optional": true, "fields": { "mve6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an energy transport mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an energy transport mover file." + }, + "mve6_filename": { + "type": "file", + "longname": "mve6 input filename", + "description": "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords.", + "tagged": false, + "direction": "in" } } }, @@ -100,10 +106,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package.", + "tagged": false, + "direction": "in" } } }, @@ -173,6 +185,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.toml index 7fcc36fb..68002198 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.toml @@ -83,20 +83,32 @@ type = "record" optional = true [blocks.options.fields.mve_filerecord.fields.mve6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an energy transport mover file." -mode = "filein" + +[blocks.options.fields.mve_filerecord.fields.mve6_filename] +type = "file" +longname = "mve6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -160,6 +172,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.yaml index 8e23d62c..56e006d5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwegwe.yaml @@ -94,19 +94,32 @@ blocks: optional: true fields: mve6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an energy transport mover file. - mode: filein + mve6_filename: + type: file + longname: mve6 input filename + description: is the file name of the transport mover input file to apply to this exchange. Information + for the transport mover are provided in the file provided with these keywords. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} + lists observation type(s) supported by the GWE-GWE Exchange Package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -179,6 +192,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.json index 963937fc..fa2f1dc1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.json @@ -97,10 +97,16 @@ "optional": true, "fields": { "gnc6": { - "type": "file", + "type": "keyword", "longname": "gnc6 keyword", - "description": "keyword to specify that record corresponds to a ghost-node correction file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a ghost-node correction file." + }, + "gnc6_filename": { + "type": "file", + "longname": "gnc6 input filename", + "description": "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2.", + "tagged": false, + "direction": "in" } } }, @@ -109,10 +115,16 @@ "optional": true, "fields": { "mvr6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to a mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a mover file." + }, + "mvr6_filename": { + "type": "file", + "longname": "mvr6 input filename", + "description": "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange.", + "tagged": false, + "direction": "in" } } }, @@ -121,10 +133,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package.", + "tagged": false, + "direction": "in" } } }, @@ -194,6 +212,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.toml index 27abe2d3..efdc7273 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.toml @@ -90,30 +90,48 @@ type = "record" optional = true [blocks.options.fields.gnc_filerecord.fields.gnc6] -type = "file" +type = "keyword" longname = "gnc6 keyword" description = "keyword to specify that record corresponds to a ghost-node correction file." -mode = "filein" + +[blocks.options.fields.gnc_filerecord.fields.gnc6_filename] +type = "file" +longname = "gnc6 input filename" +description = "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2." +tagged = false +direction = "in" [blocks.options.fields.mvr_filerecord] type = "record" optional = true [blocks.options.fields.mvr_filerecord.fields.mvr6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to a mover file." -mode = "filein" + +[blocks.options.fields.mvr_filerecord.fields.mvr6_filename] +type = "file" +longname = "mvr6 input filename" +description = "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -177,6 +195,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.yaml index 4e6da572..a6007d32 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwfgwf.yaml @@ -113,28 +113,58 @@ blocks: optional: true fields: gnc6: - type: file + type: keyword longname: gnc6 keyword description: keyword to specify that record corresponds to a ghost-node correction file. - mode: filein + gnc6_filename: + type: file + longname: gnc6 input filename + description: is the file name for ghost node correction input file. Information for the ghost + nodes are provided in the file provided with these keywords. The format for specifying + the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes + specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow + the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden + and all of the nodej values are assumed to be located in model 1, and nodem is assumed to + be in model 2. + tagged: false + direction: in mvr_filerecord: type: record optional: true fields: mvr6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to a mover file. - mode: filein + mvr6_filename: + type: file + longname: mvr6 input filename + description: is the file name of the water mover input file to apply to this exchange. Information + for the water mover are provided in the file provided with these keywords. The format for + specifying the water mover information is the same as described for the Water Mover (MVR) + Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model + name must be included as a separate string before each package. Second, the appropriate + model name must be included before package name 1 and package name 2 in the BEGIN PERIOD + block. This allows providers and receivers to be located in both models listed as part + of this exchange. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the GWF-GWF package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -207,6 +237,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.json index a42c2eb1..f5e0c612 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.json @@ -88,10 +88,16 @@ "optional": true, "fields": { "mvt6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to a transport mover file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a transport mover file." + }, + "mvt6_filename": { + "type": "file", + "longname": "mvt6 input filename", + "description": "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords.", + "tagged": false, + "direction": "in" } } }, @@ -100,10 +106,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package.", + "tagged": false, + "direction": "in" } } }, @@ -173,6 +185,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block.", "optional": true, + "tagged": false, "dtype": "double", "shape": [ "auxiliary" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.toml index 92025458..2d1757a4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.toml @@ -83,20 +83,32 @@ type = "record" optional = true [blocks.options.fields.mvt_filerecord.fields.mvt6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to a transport mover file." -mode = "filein" + +[blocks.options.fields.mvt_filerecord.fields.mvt6_filename] +type = "file" +longname = "mvt6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package." +tagged = false +direction = "in" [blocks.options.fields.dev_interfacemodel_on] type = "keyword" @@ -160,6 +172,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." optional = true +tagged = false dtype = "double" shape = [ "auxiliary", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.yaml index 2897a101..b0a5aa53 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-gwtgwt.yaml @@ -92,19 +92,32 @@ blocks: optional: true fields: mvt6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to a transport mover file. - mode: filein + mvt6_filename: + type: file + longname: mvt6 input filename + description: is the file name of the transport mover input file to apply to this exchange. Information + for the transport mover are provided in the file provided with these keywords. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} + lists observation type(s) supported by the GWT-GWT package. + tagged: false + direction: in dev_interfacemodel_on: type: keyword longname: activate interface model on exchange @@ -177,6 +190,7 @@ blocks: The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. optional: true + tagged: false dtype: double shape: - auxiliary diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.json index 7ab3d3ac..91d78e4c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.toml index 42933aaa..4d25d015 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" [blocks.dimensions.fields.nexg] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.yaml index 5b008d71..dd14a5ed 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/exg-olfgwf.yaml @@ -35,10 +35,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: is the file name of the observations input file for this exchange. See the 'Observation + utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} + lists observation type(s) supported by the SWF-GWF package. + tagged: false + direction: in dimensions: fields: nexg: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.json index a4d3099c..03077909 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "time series keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.toml index 1959d987..5b66230e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "time series keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the constant temperature cell. BOUNDNAME is an ASCII cha optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprflow] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.yaml index 0d41cf1f..23ca3d77 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-ctp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: time series keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CTP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CTP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprflow: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.json index 9cbbddb8..caab0b44 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.toml index d2ab4567..e3e8ba91 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.yaml index 0d77a1e0..c65ff7ad 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.json index bc6c7fc0..b257dd7b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.json @@ -44,10 +44,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -282,6 +288,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.toml index 7266bb41..8589b45d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.toml @@ -39,10 +39,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -257,6 +263,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.yaml index 5397f1d2..f1e0b01d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disu.yaml @@ -36,10 +36,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -288,6 +294,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.json index ffffb876..51f84b32 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.toml index 70e9b6ef..6cfc383a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.yaml index b958c51f..b85eb894 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.json index 8b5436a3..b7454aa2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.toml index f46f6c7b..0d15adeb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the energy source cell. BOUNDNAME is an ASCII character optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.yaml index fdadad0e..09f64fec 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-esl.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ESL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ESL package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -124,6 +139,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -138,6 +154,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.json index 2e9af6e5..388e3be7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package.", + "tagged": false, + "direction": "in" } } } @@ -163,6 +193,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -260,6 +291,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.toml index 12b65cf1..0d331bf9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -145,6 +175,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -229,6 +260,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.yaml index 932ce4d0..23bcba9e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-lke.yaml @@ -78,46 +78,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LKE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LKE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -162,6 +192,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -271,6 +302,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.json index 21e02e16..5a5a10f1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +47,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.toml index c49bfa5a..ca776a0b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.toml @@ -26,17 +26,29 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.yaml index 8a4a879e..1883f9bc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mve.yaml @@ -30,16 +30,27 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.json index 00e1e6d3..b203f5f1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package.", + "tagged": false, + "direction": "in" } } } @@ -163,6 +193,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -242,6 +273,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.toml index c9edb04b..4a83b912 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -145,6 +175,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -211,6 +242,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.yaml index 16aae518..809bcf9a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-mwe.yaml @@ -78,46 +78,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MWE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MWE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -162,6 +192,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -245,6 +276,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.json index 6f4bbbc8..2ebfe483 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -65,10 +71,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +90,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } @@ -134,6 +152,7 @@ }, "netcdf_fname": { "set_in": "ar", + "source": "netcdf_filename", "type": "string" }, "x": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.toml index 7b86fe77..152d8d09 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.toml @@ -47,10 +47,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -58,10 +64,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -69,10 +81,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" @@ -113,6 +131,7 @@ type = "logical" [memory.netcdf_fname] set_in = "ar" +source = "netcdf_filename" type = "string" [memory.x] diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.yaml index aba0a5ce..e9182288 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-nam.yaml @@ -51,30 +51,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: @@ -120,6 +135,7 @@ memory: type: logical netcdf_fname: set_in: ar + source: netcdf_filename type: string x: type: array diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.json index 97027392..1fdd7e50 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "temperature keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "temperaturefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -193,12 +211,20 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, "memory": { "tempfile": { "set_in": "ar", + "source": "temperaturefile", "type": "string" } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.toml index 2b2aa43b..c43d7b12 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.temperature_filerecord] type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "temperature keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.temperaturefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.temperatureprintrecord] type = "record" @@ -166,6 +184,14 @@ type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.tempfile] set_in = "ar" +source = "temperaturefile" type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.yaml index 72213415..fd31cdf5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out temperature_filerecord: type: record optional: true fields: temperature: - type: file + type: keyword longname: temperature keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + temperaturefile: + type: file + longname: file keyword + description: name of the output file to write temperature information. + tagged: false + direction: out temperatureprintrecord: type: record optional: true @@ -158,7 +174,18 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: tempfile: set_in: ar + source: temperaturefile type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.json index 5538ff27..1e31246a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "temperature keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package.", + "tagged": false, + "direction": "in" } } } @@ -163,6 +193,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -260,6 +291,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.toml index b3f0601f..c457c05e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "temperature keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -145,6 +175,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -229,6 +260,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.yaml index 6dc6213a..8a6a26be 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-sfe.yaml @@ -79,46 +79,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: temperature keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -163,6 +193,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -271,6 +302,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.json index 8df26eba..cabd0daf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "temperature": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to temperature.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to temperature." + }, + "tempfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write temperature information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package.", + "tagged": false, + "direction": "in" } } } @@ -151,6 +181,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -236,6 +267,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.toml index 7aca25a7..0ea59483 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.temperature_filerecord.fields.temperature] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to temperature." -mode = "fileout" + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -133,6 +163,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -205,6 +236,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.yaml index 62f27299..9a35ce61 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwe-uze.yaml @@ -79,46 +79,76 @@ blocks: optional: true fields: temperature: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to temperature. - mode: fileout + tempfile: + type: file + longname: file keyword + description: name of the binary output file to write temperature information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZE package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZE package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -152,6 +182,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -243,6 +274,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.json index 30078f44..ec9733bc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.toml index f1824eaa..1ed1d9b8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.yaml index 4db34e80..82a2333f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-api.yaml @@ -40,10 +40,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the api boundary package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the api boundary package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the api boundary Package can be used with diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.json index 59544d26..e45866c2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.json @@ -30,10 +30,16 @@ "optional": true, "fields": { "density": { - "type": "file", + "type": "keyword", "longname": "density keyword", - "description": "keyword to specify that record corresponds to density.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to density." + }, + "densityfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.toml index d5c25aec..fc20ba0a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.toml @@ -25,10 +25,16 @@ type = "record" optional = true [blocks.options.fields.density_filerecord.fields.density] -type = "file" +type = "keyword" longname = "density keyword" description = "keyword to specify that record corresponds to density." -mode = "fileout" + +[blocks.options.fields.density_filerecord.fields.densityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.dev_efh_formulation] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.yaml index 2df2b461..4900c104 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-buy.yaml @@ -28,10 +28,18 @@ blocks: optional: true fields: density: - type: file + type: keyword longname: density keyword description: keyword to specify that record corresponds to density. - mode: fileout + densityfile: + type: file + longname: file keyword + description: name of the binary output file to write density information. The density file + has the same format as the head file. Density values will be written to the density file + whenever heads are written to the binary head file. The settings for controlling head output + are contained in the Output Control option. + tagged: false + direction: out dev_efh_formulation: type: keyword longname: use equivalent freshwater head formulation diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.json index bfff7130..fe6a329d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } }, @@ -114,6 +126,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -131,6 +144,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -150,6 +164,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.toml index fc4ae0d6..d5a3445d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.options.fields.dev_no_newton] type = "keyword" @@ -101,6 +113,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -118,6 +131,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -131,6 +145,13 @@ description = "name of the constant head boundary cell. BOUNDNAME is an ASCII c optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.yaml index 76ca542a..4eb6d438 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chd.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dev_no_newton: type: keyword longname: turn off Newton for unconfined cells @@ -107,6 +121,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -128,6 +143,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -142,6 +158,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.json index d4a5f233..f8438e61 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } }, @@ -124,6 +130,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.toml index 5d6faef3..a041cf5b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.toml @@ -64,10 +64,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -109,6 +115,13 @@ shape = [ "nodes", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.yaml index da91d47d..6bf5e593 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-chdg.yaml @@ -72,10 +72,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -120,6 +127,16 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.json index 98057e31..6ee89647 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.json @@ -118,10 +118,16 @@ "optional": true, "fields": { "strain_csv_interbed": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify the record that corresponds to final interbed strain output.", - "mode": "fileout" + "description": "keyword to specify the record that corresponds to final interbed strain output." + }, + "interbedstrain_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated-values output file to write final interbed strain information.", + "tagged": false, + "direction": "out" } } }, @@ -130,10 +136,16 @@ "optional": true, "fields": { "strain_csv_coarse": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify the record that corresponds to final coarse-grained material strain output.", - "mode": "fileout" + "description": "keyword to specify the record that corresponds to final coarse-grained material strain output." + }, + "coarsestrain_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated-values output file to write final coarse-grained material strain information.", + "tagged": false, + "direction": "out" } } }, @@ -142,10 +154,16 @@ "optional": true, "fields": { "compaction": { - "type": "file", + "type": "keyword", "longname": "compaction keyword", - "description": "keyword to specify that record corresponds to the compaction.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the compaction." + }, + "compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -154,10 +172,16 @@ "optional": true, "fields": { "compaction_elastic": { - "type": "file", + "type": "keyword", "longname": "elastic interbed compaction keyword", - "description": "keyword to specify that record corresponds to the elastic interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the elastic interbed compaction binary file." + }, + "elastic_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write elastic interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -166,10 +190,16 @@ "optional": true, "fields": { "compaction_inelastic": { - "type": "file", + "type": "keyword", "longname": "inelastic interbed compaction keyword", - "description": "keyword to specify that record corresponds to the inelastic interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the inelastic interbed compaction binary file." + }, + "inelastic_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write inelastic interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -178,10 +208,16 @@ "optional": true, "fields": { "compaction_interbed": { - "type": "file", + "type": "keyword", "longname": "interbed compaction keyword", - "description": "keyword to specify that record corresponds to the interbed compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the interbed compaction binary file." + }, + "interbed_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write interbed compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -190,10 +226,16 @@ "optional": true, "fields": { "compaction_coarse": { - "type": "file", + "type": "keyword", "longname": "coarse compaction keyword", - "description": "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." + }, + "coarse_compaction_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write elastic coarse-grained material compaction information.", + "tagged": false, + "direction": "out" } } }, @@ -202,10 +244,16 @@ "optional": true, "fields": { "zdisplacement": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the z-displacement binary file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the z-displacement binary file." + }, + "zdisplacement_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write z-displacement information.", + "tagged": false, + "direction": "out" } } }, @@ -214,10 +262,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -226,10 +280,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -238,10 +298,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package.", + "tagged": false, + "direction": "in" } } } @@ -329,6 +395,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -415,6 +482,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -433,6 +501,13 @@ "maxsig0" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, @@ -479,6 +554,7 @@ }, "interbedstrainfn": { "set_in": "ar", + "source": "interbedstrain_filename", "type": "string" }, "csvcoarse": { @@ -488,10 +564,12 @@ }, "coarsestrainfn": { "set_in": "ar", + "source": "coarsestrain_filename", "type": "string" }, "cmpfn": { "set_in": "ar", + "source": "compaction_filename", "type": "string" }, "cmpelastic": { @@ -501,6 +579,7 @@ }, "elasticcmpfn": { "set_in": "ar", + "source": "elastic_compaction_filename", "type": "string" }, "cmpinelastic": { @@ -510,6 +589,7 @@ }, "inelasticcmpfn": { "set_in": "ar", + "source": "inelastic_compaction_filename", "type": "string" }, "cmpinterbed": { @@ -519,6 +599,7 @@ }, "interbedcmpfn": { "set_in": "ar", + "source": "interbed_compaction_filename", "type": "string" }, "cmpcoarse": { @@ -528,10 +609,12 @@ }, "cmpcoarsefn": { "set_in": "ar", + "source": "coarse_compaction_filename", "type": "string" }, "zdispfn": { "set_in": "ar", + "source": "zdisplacement_filename", "type": "string" }, "pkgconverge": { @@ -541,6 +624,7 @@ }, "pkgconvergefn": { "set_in": "ar", + "source": "package_convergence_filename", "type": "string" }, "maxbound": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.toml index 517b15a2..1a2cafa1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.toml @@ -113,110 +113,176 @@ type = "record" optional = true [blocks.options.fields.strainib_filerecord.fields.strain_csv_interbed] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify the record that corresponds to final interbed strain output." -mode = "fileout" + +[blocks.options.fields.strainib_filerecord.fields.interbedstrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final interbed strain information." +tagged = false +direction = "out" [blocks.options.fields.straincg_filerecord] type = "record" optional = true [blocks.options.fields.straincg_filerecord.fields.strain_csv_coarse] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify the record that corresponds to final coarse-grained material strain output." -mode = "fileout" + +[blocks.options.fields.straincg_filerecord.fields.coarsestrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final coarse-grained material strain information." +tagged = false +direction = "out" [blocks.options.fields.compaction_filerecord] type = "record" optional = true [blocks.options.fields.compaction_filerecord.fields.compaction] -type = "file" +type = "keyword" longname = "compaction keyword" description = "keyword to specify that record corresponds to the compaction." -mode = "fileout" + +[blocks.options.fields.compaction_filerecord.fields.compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_elastic_filerecord] type = "record" optional = true [blocks.options.fields.compaction_elastic_filerecord.fields.compaction_elastic] -type = "file" +type = "keyword" longname = "elastic interbed compaction keyword" description = "keyword to specify that record corresponds to the elastic interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_elastic_filerecord.fields.elastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_inelastic_filerecord] type = "record" optional = true [blocks.options.fields.compaction_inelastic_filerecord.fields.compaction_inelastic] -type = "file" +type = "keyword" longname = "inelastic interbed compaction keyword" description = "keyword to specify that record corresponds to the inelastic interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_inelastic_filerecord.fields.inelastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write inelastic interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_interbed_filerecord] type = "record" optional = true [blocks.options.fields.compaction_interbed_filerecord.fields.compaction_interbed] -type = "file" +type = "keyword" longname = "interbed compaction keyword" description = "keyword to specify that record corresponds to the interbed compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_interbed_filerecord.fields.interbed_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write interbed compaction information." +tagged = false +direction = "out" [blocks.options.fields.compaction_coarse_filerecord] type = "record" optional = true [blocks.options.fields.compaction_coarse_filerecord.fields.compaction_coarse] -type = "file" +type = "keyword" longname = "coarse compaction keyword" description = "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." -mode = "fileout" + +[blocks.options.fields.compaction_coarse_filerecord.fields.coarse_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic coarse-grained material compaction information." +tagged = false +direction = "out" [blocks.options.fields.zdisplacement_filerecord] type = "record" optional = true [blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the z-displacement binary file." -mode = "fileout" + +[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write z-displacement information." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package." +tagged = false +direction = "in" [blocks.dimensions.fields.ninterbeds] type = "integer" @@ -294,6 +360,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -374,6 +441,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -386,6 +454,13 @@ description = "is the stress offset for the cell. SIG0 is added to the calculate tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.precon_head] set_in = "ar" source = "initial_preconsolidation_head" @@ -428,6 +503,7 @@ type = "logical" [memory.interbedstrainfn] set_in = "ar" +source = "interbedstrain_filename" type = "string" [memory.csvcoarse] @@ -437,10 +513,12 @@ type = "logical" [memory.coarsestrainfn] set_in = "ar" +source = "coarsestrain_filename" type = "string" [memory.cmpfn] set_in = "ar" +source = "compaction_filename" type = "string" [memory.cmpelastic] @@ -450,6 +528,7 @@ type = "logical" [memory.elasticcmpfn] set_in = "ar" +source = "elastic_compaction_filename" type = "string" [memory.cmpinelastic] @@ -459,6 +538,7 @@ type = "logical" [memory.inelasticcmpfn] set_in = "ar" +source = "inelastic_compaction_filename" type = "string" [memory.cmpinterbed] @@ -468,6 +548,7 @@ type = "logical" [memory.interbedcmpfn] set_in = "ar" +source = "interbed_compaction_filename" type = "string" [memory.cmpcoarse] @@ -477,10 +558,12 @@ type = "logical" [memory.cmpcoarsefn] set_in = "ar" +source = "coarse_compaction_filename" type = "string" [memory.zdispfn] set_in = "ar" +source = "zdisplacement_filename" type = "string" [memory.pkgconverge] @@ -490,6 +573,7 @@ type = "logical" [memory.pkgconvergefn] set_in = "ar" +source = "package_convergence_filename" type = "string" [memory.maxbound] diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.yaml index 0a2fa99b..7f904525 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-csub.yaml @@ -135,108 +135,170 @@ blocks: optional: true fields: strain_csv_interbed: - type: file + type: keyword longname: budget keyword description: keyword to specify the record that corresponds to final interbed strain output. - mode: fileout + interbedstrain_filename: + type: file + longname: file keyword + description: name of the comma-separated-values output file to write final interbed strain + information. + tagged: false + direction: out straincg_filerecord: type: record optional: true fields: strain_csv_coarse: - type: file + type: keyword longname: budget keyword description: keyword to specify the record that corresponds to final coarse-grained material strain output. - mode: fileout + coarsestrain_filename: + type: file + longname: file keyword + description: name of the comma-separated-values output file to write final coarse-grained + material strain information. + tagged: false + direction: out compaction_filerecord: type: record optional: true fields: compaction: - type: file + type: keyword longname: compaction keyword description: keyword to specify that record corresponds to the compaction. - mode: fileout + compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write compaction information. + tagged: false + direction: out compaction_elastic_filerecord: type: record optional: true fields: compaction_elastic: - type: file + type: keyword longname: elastic interbed compaction keyword description: keyword to specify that record corresponds to the elastic interbed compaction binary file. - mode: fileout + elastic_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write elastic interbed compaction information. + tagged: false + direction: out compaction_inelastic_filerecord: type: record optional: true fields: compaction_inelastic: - type: file + type: keyword longname: inelastic interbed compaction keyword description: keyword to specify that record corresponds to the inelastic interbed compaction binary file. - mode: fileout + inelastic_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write inelastic interbed compaction information. + tagged: false + direction: out compaction_interbed_filerecord: type: record optional: true fields: compaction_interbed: - type: file + type: keyword longname: interbed compaction keyword description: keyword to specify that record corresponds to the interbed compaction binary file. - mode: fileout + interbed_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write interbed compaction information. + tagged: false + direction: out compaction_coarse_filerecord: type: record optional: true fields: compaction_coarse: - type: file + type: keyword longname: coarse compaction keyword description: keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file. - mode: fileout + coarse_compaction_filename: + type: file + longname: file keyword + description: name of the binary output file to write elastic coarse-grained material compaction + information. + tagged: false + direction: out zdisplacement_filerecord: type: record optional: true fields: zdisplacement: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the z-displacement binary file. - mode: fileout + zdisplacement_filename: + type: file + longname: file keyword + description: name of the binary output file to write z-displacement information. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CSUB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CSUB package. + tagged: false + direction: in dimensions: fields: ninterbeds: @@ -319,6 +381,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -417,6 +480,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -432,6 +496,16 @@ blocks: time_series: true shape: - maxsig0 + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: precon_head: set_in: ar @@ -467,6 +541,7 @@ memory: type: logical interbedstrainfn: set_in: ar + source: interbedstrain_filename type: string csvcoarse: set_in: ar @@ -474,9 +549,11 @@ memory: type: logical coarsestrainfn: set_in: ar + source: coarsestrain_filename type: string cmpfn: set_in: ar + source: compaction_filename type: string cmpelastic: set_in: ar @@ -484,6 +561,7 @@ memory: type: logical elasticcmpfn: set_in: ar + source: elastic_compaction_filename type: string cmpinelastic: set_in: ar @@ -491,6 +569,7 @@ memory: type: logical inelasticcmpfn: set_in: ar + source: inelastic_compaction_filename type: string cmpinterbed: set_in: ar @@ -498,6 +577,7 @@ memory: type: logical interbedcmpfn: set_in: ar + source: interbed_compaction_filename type: string cmpcoarse: set_in: ar @@ -505,9 +585,11 @@ memory: type: logical cmpcoarsefn: set_in: ar + source: coarse_compaction_filename type: string zdispfn: set_in: ar + source: zdisplacement_filename type: string pkgconverge: set_in: ar @@ -515,6 +597,7 @@ memory: type: logical pkgconvergefn: set_in: ar + source: package_convergence_filename type: string maxbound: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.json index 4274988e..a2634ce3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.toml index fcfbd7e3..6040e82b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.yaml index 61caa366..86607b90 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.json index da504d87..31a12a20 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.json @@ -44,10 +44,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -284,6 +290,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.toml index 25665573..d8e98ec0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.toml @@ -39,10 +39,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -259,6 +265,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.yaml index 8ddcb02b..6db044e7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disu.yaml @@ -36,10 +36,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -290,6 +296,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.json index f4369991..06f40f1e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.toml index 9160c06f..f1dd5dc6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.yaml index 8825d1a7..3305427a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.json index 8466d012..603784f6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.json @@ -73,10 +73,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -85,10 +91,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package.", + "tagged": false, + "direction": "in" } } }, @@ -125,6 +137,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -149,6 +162,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -168,6 +182,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.toml index 0a7dbc33..f9c0c846 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.toml @@ -68,20 +68,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -112,6 +124,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -136,6 +149,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -149,6 +163,13 @@ description = "name of the drain cell. BOUNDNAME is an ASCII character variable optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.yaml index fae5c709..bfd4004e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drn.yaml @@ -79,19 +79,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DRN package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DRN package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Drain Package can be used with the @@ -125,6 +139,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -155,6 +170,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -169,6 +185,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.json index f5b736da..6d0abe18 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.json @@ -75,10 +75,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package.", + "tagged": false, + "direction": "in" } } }, @@ -146,6 +152,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.toml index 2287018e..248435fe 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.toml @@ -70,10 +70,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -131,6 +137,13 @@ shape = [ "nodes", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.yaml index 7afe566d..836270c8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-drng.yaml @@ -85,10 +85,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DRN package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DRN package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Drain Package can be used with the @@ -148,6 +155,16 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.json index 33c391af..97fbecb2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.json @@ -77,10 +77,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -89,10 +95,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package.", + "tagged": false, + "direction": "in" } } }, @@ -129,6 +141,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -160,6 +173,7 @@ "longname": "proportion of ET extinction depth", "description": "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -171,6 +185,7 @@ "longname": "proportion of maximum ET rate", "description": "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -190,6 +205,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -209,6 +225,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.toml index 63ac2099..84396d85 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.toml @@ -72,20 +72,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" [blocks.options.fields.surf_rate_specified] type = "keyword" @@ -116,6 +128,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -147,6 +160,7 @@ type = "array" longname = "proportion of ET extinction depth" description = "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -158,6 +172,7 @@ type = "array" longname = "proportion of maximum ET rate" description = "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -177,6 +192,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -190,6 +206,13 @@ description = "name of the evapotranspiration cell. BOUNDNAME is an ASCII chara optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.yaml index d3e7397f..b0422293 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evt.yaml @@ -76,19 +76,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVT package. + tagged: false + direction: in surf_rate_specified: type: keyword longname: specify proportion of evapotranspiration rate at ET surface @@ -125,6 +139,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -161,6 +176,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -173,6 +189,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -198,6 +215,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -212,6 +230,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.json index 3420a479..0959a1da 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.json @@ -70,10 +70,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } }, @@ -82,10 +88,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package.", + "tagged": false, + "direction": "in" } } }, @@ -155,6 +167,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.toml index a6357d12..2f0e12d9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.toml @@ -65,20 +65,32 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -142,6 +154,13 @@ shape = [ "ncpl", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.yaml index 1ac24f9b..4fdfb886 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-evta.yaml @@ -74,19 +74,33 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the Time-Variable Input section for instructions on using + the time-array series capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVT package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -150,6 +164,16 @@ blocks: time_series: true shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.json index 2945e789..ba57ed3b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package.", + "tagged": false, + "direction": "in" } } }, @@ -113,6 +125,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -137,6 +150,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -156,6 +170,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.toml index 431a4f1e..2c3ee506 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -100,6 +112,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -124,6 +137,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -137,6 +151,13 @@ description = "name of the general-head boundary cell. BOUNDNAME is an ASCII ch optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.yaml index 052ec420..f99ee1af 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghb.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the GHB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the GHB package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the General-Head Boundary Package can be @@ -108,6 +122,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -138,6 +153,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -152,6 +168,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.json index feaad038..47d66c71 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package.", + "tagged": false, + "direction": "in" } } }, @@ -134,6 +140,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.toml index 0db58672..a11ebe82 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.toml @@ -64,10 +64,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -119,6 +125,13 @@ shape = [ "nodes", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.yaml index d8e50c8d..78e23ca3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-ghbg.yaml @@ -73,10 +73,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the GHB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the GHB package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the General-Head Boundary Package can be @@ -131,6 +138,16 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.json index 0be4b014..12df9976 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.json @@ -73,6 +73,7 @@ "type": "array", "longname": "GNC contributing cells", "description": "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "numalphaj" @@ -82,6 +83,7 @@ "type": "array", "longname": "GNC contributing factors", "description": "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n.", + "tagged": false, "dtype": "double", "shape": [ "numalphaj" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.toml index a9ae4ebd..74d3443d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.toml @@ -64,6 +64,7 @@ tagged = false type = "array" longname = "GNC contributing cells" description = "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "numalphaj", @@ -73,6 +74,7 @@ shape = [ type = "array" longname = "GNC contributing factors" description = "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n." +tagged = false dtype = "double" shape = [ "numalphaj", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.yaml index b1fa7128..c6adedf0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-gnc.yaml @@ -84,6 +84,7 @@ blocks: a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell. + tagged: false dtype: integer shape: - numalphaj @@ -96,6 +97,7 @@ blocks: sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n. + tagged: false dtype: double shape: - numalphaj diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.json index af2608f0..64de58d5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.json @@ -40,6 +40,7 @@ "type": "array", "longname": "first cell adjacent to barrier", "description": "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node numbers for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -49,6 +50,7 @@ "type": "array", "longname": "second cell adjacent to barrier", "description": "identifier for the second cell. See CELLID1 for description of how to specify.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -66,6 +68,13 @@ "maxhfb" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.toml index 3fe7851a..d91d1063 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.toml @@ -31,6 +31,7 @@ type = "record" type = "array" longname = "first cell adjacent to barrier" description = "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node numbers for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -40,6 +41,7 @@ shape = [ type = "array" longname = "second cell adjacent to barrier" description = "identifier for the second cell. See CELLID1 for description of how to specify." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -51,6 +53,13 @@ longname = "barrier hydraulic characteristic" description = "is the hydraulic characteristic of the hydraulic-flow barrier. The hydraulic characteristic is the barrier hydraulic conductivity divided by the width of the hydraulic-flow barrier. If the hydraulic characteristic is negative, then the absolute value of HYDCHR acts as a multiplier to the conductance between the two model cells specified as containing the barrier. For example, if the value for HYDCHR was specified as -1.5, the conductance calculated for the two cells would be multiplied by 1.5." tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] set_in = "ar" source = "maxhfb" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.yaml index 02ed4369..b12fe6f4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-hfb.yaml @@ -41,6 +41,7 @@ blocks: and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally or vertically adjacent. + tagged: false dtype: integer shape: - ncelldim @@ -48,6 +49,7 @@ blocks: type: array longname: second cell adjacent to barrier description: identifier for the second cell. See CELLID1 for description of how to specify. + tagged: false dtype: integer shape: - ncelldim @@ -63,6 +65,16 @@ blocks: tagged: false shape: - maxhfb + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.json index d509cc77..c772b8f3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.json @@ -70,10 +70,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -82,10 +88,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -94,10 +106,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -106,10 +124,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -118,10 +142,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -130,10 +160,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package.", + "tagged": false, + "direction": "in" } } }, @@ -224,6 +260,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -269,6 +306,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -686,6 +724,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.toml index ed233b9c..cf7c321b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.toml @@ -65,60 +65,96 @@ type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -203,6 +239,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -242,6 +279,7 @@ tagged = false type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -607,6 +645,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.nlakes] set_in = "ar" source = "nlakes" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.yaml index 10040ef8..7a7a768f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-lak.yaml @@ -72,56 +72,91 @@ blocks: optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the binary output file to write stage information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LAK package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LAK package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the LAK Package can be used with the Water @@ -226,6 +261,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -272,6 +308,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -752,6 +789,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: nlakes: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.json index 7466185a..50979bba 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.json @@ -58,10 +58,16 @@ "optional": true, "fields": { "head": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to head.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to head." + }, + "headfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write head information.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +76,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -82,10 +94,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -124,10 +142,16 @@ "optional": true, "fields": { "maw_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." + }, + "mfrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -136,10 +160,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -148,10 +178,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package.", + "tagged": false, + "direction": "in" } } }, @@ -220,6 +256,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -265,6 +302,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -436,6 +474,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.toml index 1695a858..ad23b399 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.toml @@ -53,30 +53,48 @@ type = "record" optional = true [blocks.options.fields.head_filerecord.fields.head] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to head." -mode = "fileout" + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write head information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.no_well_storage] type = "keyword" @@ -113,30 +131,48 @@ type = "record" optional = true [blocks.options.fields.mfrcsv_filerecord.fields.maw_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.mfrcsv_filerecord.fields.mfrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -199,6 +235,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -235,6 +272,7 @@ tagged = false type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -387,6 +425,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.nmawwells] set_in = "ar" source = "nmawwells" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.yaml index 11f64aab..8a15b4c8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-maw.yaml @@ -64,28 +64,44 @@ blocks: optional: true fields: head: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to head. - mode: fileout + headfile: + type: file + longname: file keyword + description: name of the binary output file to write head information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out no_well_storage: type: keyword longname: deactivate well storage @@ -135,30 +151,51 @@ blocks: optional: true fields: maw_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program. - mode: fileout + mfrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + multi-aquifer well extraction or injection rates that have been reduced by the program. + Entries are only written if the extraction or injection rates are reduced. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MAW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MAW package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the MAW Package can be used with the Water @@ -250,6 +287,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -300,6 +338,7 @@ blocks: CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID. + tagged: false dtype: integer shape: - ncelldim @@ -513,6 +552,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: nmawwells: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.json index ed49ddeb..67e89dd1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.json @@ -39,10 +39,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -51,10 +57,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } @@ -161,6 +173,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.toml index 9051d825..fcc6cd19 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.toml @@ -34,20 +34,32 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.dimensions.fields.maxmvr] type = "integer" @@ -136,6 +148,13 @@ longname = "mover value" description = "is the value to be used in the equation for calculating the amount of water to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$." tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxmvr] set_in = "ar" source = "maxmvr" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.yaml index 8197cdbe..2c134db8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-mvr.yaml @@ -38,19 +38,30 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out dimensions: fields: maxmvr: @@ -155,6 +166,16 @@ blocks: to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$. tagged: false + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxmvr: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.json index 10dbc53d..b31ece72 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.json @@ -65,10 +65,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -91,10 +103,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } @@ -142,6 +160,7 @@ }, "netcdf_fname": { "set_in": "ar", + "source": "netcdf_filename", "type": "string" }, "x": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.toml index 48937051..3b4f8501 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.toml @@ -58,10 +58,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -69,10 +75,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -80,10 +92,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" @@ -119,6 +137,7 @@ type = "logical" [memory.netcdf_fname] set_in = "ar" +source = "netcdf_filename" type = "string" [memory.x] diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.yaml index 69e434f8..b32c9f15 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-nam.yaml @@ -65,30 +65,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: @@ -130,6 +145,7 @@ memory: type: logical netcdf_fname: set_in: ar + source: netcdf_filename type: string x: type: array diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.json index eb9b9b71..9ad1b430 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.json @@ -148,10 +148,16 @@ "optional": true, "fields": { "tvk6": { - "type": "file", + "type": "keyword", "longname": "tvk keyword", - "description": "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." + }, + "tvk6_filename": { + "type": "file", + "longname": "file name of TVK information", + "description": "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.toml index b1c03340..033e6898 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.toml @@ -137,10 +137,16 @@ type = "record" optional = true [blocks.options.fields.tvk_filerecord.fields.tvk6] -type = "file" +type = "keyword" longname = "tvk keyword" description = "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.tvk_filerecord.fields.tvk6_filename] +type = "file" +longname = "file name of TVK information" +description = "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.yaml index 293371a3..91df546d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-npf.yaml @@ -182,11 +182,18 @@ blocks: optional: true fields: tvk6: - type: file + type: keyword longname: tvk keyword description: keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately. - mode: filein + tvk6_filename: + type: file + longname: file name of TVK information + description: defines a time-varying hydraulic conductivity (TVK) input file. Records in the + TVK file can be used to change hydraulic conductivity properties at specified times or stress + periods. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.json index 2904876f..92f02313 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "head": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to head.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to head." + }, + "headfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write head information.", + "tagged": false, + "direction": "out" } } }, @@ -193,6 +211,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.toml index b1a79274..0e2732bd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.head_filerecord] type = "record" optional = true [blocks.options.fields.head_filerecord.fields.head] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to head." -mode = "fileout" + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write head information." +tagged = false +direction = "out" [blocks.options.fields.headprintrecord] type = "record" @@ -165,3 +183,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.yaml index c1ae0090..52eec131 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out head_filerecord: type: record optional: true fields: head: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to head. - mode: fileout + headfile: + type: file + longname: file keyword + description: name of the output file to write head information. + tagged: false + direction: out headprintrecord: type: record optional: true @@ -158,3 +174,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.json index c329736f..ae88b7a5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.json @@ -73,10 +73,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -85,10 +91,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package.", + "tagged": false, + "direction": "in" } } } @@ -114,6 +126,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -131,6 +144,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -150,6 +164,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.toml index b7ce1e98..b6151c13 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.toml @@ -68,20 +68,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -101,6 +113,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -118,6 +131,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -131,6 +145,13 @@ description = "name of the recharge cell. BOUNDNAME is an ASCII character varia optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.yaml index c20f1e04..742bbdeb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rch.yaml @@ -73,19 +73,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RCH package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RCH package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -108,6 +122,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -131,6 +146,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -145,6 +161,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.json index f30d6430..a66eed59 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.json @@ -70,10 +70,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } }, @@ -82,10 +88,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package.", + "tagged": false, + "direction": "in" } } }, @@ -134,6 +146,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.toml index 8db3e12a..30feb88d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.toml @@ -65,20 +65,32 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" [blocks.options.fields.export_array_netcdf] type = "keyword" @@ -121,6 +133,13 @@ shape = [ "ncpl", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.yaml index fca36ad9..0a19346e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rcha.yaml @@ -74,19 +74,33 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the 'Time-Variable Input' section for instructions on + using the time-array series capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RCH package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RCH package. + tagged: false + direction: in export_array_netcdf: type: keyword longname: export array variables to netcdf output files. @@ -135,6 +149,16 @@ blocks: time_series: true shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.json index 75c259da..f88f8097 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package.", + "tagged": false, + "direction": "in" } } }, @@ -113,6 +125,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -144,6 +157,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -163,6 +177,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.toml index d6ec79b5..97493d95 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -100,6 +112,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -131,6 +144,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -144,6 +158,13 @@ description = "name of the river cell. BOUNDNAME is an ASCII character variable optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.yaml index 7c820b0f..f3638cef 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-riv.yaml @@ -66,19 +66,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RIV package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RIV package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the River Package can be used with the @@ -107,6 +121,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -144,6 +159,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -158,6 +174,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.json index 98e3bc65..c09a6ebf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package.", + "tagged": false, + "direction": "in" } } }, @@ -145,6 +151,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.toml index 83fca2e9..eed5fe83 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.toml @@ -64,10 +64,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -130,6 +136,13 @@ shape = [ "nodes", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.yaml index 19506cf7..2f7bbef3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-rivg.yaml @@ -72,10 +72,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the RIV package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the RIV package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the River Package can be used with the @@ -139,6 +146,16 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.json index 280a1e48..b1a66530 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -91,10 +103,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -103,10 +121,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -115,10 +139,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -127,10 +157,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package.", + "tagged": false, + "direction": "in" } } }, @@ -210,6 +246,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -283,6 +320,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -359,6 +397,7 @@ "longname": "connected reach numbers", "description": "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise.", "optional": true, + "tagged": false, "dtype": "integer", "shape": [ "packagedata.ncon(ifno)" @@ -528,16 +567,21 @@ "type": "record", "fields": { "cross_section": { - "type": "file", + "type": "keyword", "longname": "cross_section keyword", - "description": "keyword to specify that record corresponds to a reach cross-section.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a reach cross-section." }, "tab6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a cross-section table file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a cross-section table file." + }, + "tab6_filename": { + "type": "file", + "longname": "table file name", + "description": "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section.", + "tagged": false, + "direction": "in" } } }, @@ -567,6 +611,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.toml index e717f74a..0c459715 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.toml @@ -62,60 +62,96 @@ type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -189,6 +225,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -262,6 +299,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -323,6 +361,7 @@ type = "array" longname = "connected reach numbers" description = "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise." optional = true +tagged = false dtype = "integer" shape = [ "packagedata.ncon(ifno)", @@ -472,16 +511,21 @@ description = "real value that defines the fraction of upstream flow (USTRF) fro type = "record" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.cross_section] -type = "file" +type = "keyword" longname = "cross_section keyword" description = "keyword to specify that record corresponds to a reach cross-section." -mode = "filein" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a cross-section table file." -mode = "filein" + +[blocks.period.fields.perioddata.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6_filename] +type = "file" +longname = "table file name" +description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." +tagged = false +direction = "in" [blocks.period.fields.perioddata.item.fields.sfrsetting.arms.auxiliaryrecord] type = "record" @@ -502,6 +546,13 @@ description = "value for the auxiliary variable. If the Options block includes tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.nreaches] set_in = "ar" source = "nreaches" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.yaml index 84cd4b16..e29bfd48 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sfr.yaml @@ -72,56 +72,91 @@ blocks: optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the binary output file to write stage information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFR package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFR package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the SFR Package can be used with the Water @@ -223,6 +258,7 @@ blocks: The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error. + tagged: false dtype: integer shape: - ncelldim @@ -306,6 +342,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -382,6 +419,7 @@ blocks: or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise. optional: true + tagged: false dtype: integer shape: - packagedata.ncon(ifno) @@ -602,16 +640,24 @@ blocks: type: record fields: cross_section: - type: file + type: keyword longname: cross_section keyword description: keyword to specify that record corresponds to a reach cross-section. - mode: filein tab6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a cross-section table file. - mode: filein + tab6_filename: + type: file + longname: table file name + description: character string that defines the path and filename for the file containing + cross-section table data for the reach. The TAB6_FILENAME file includes the number + of entries in the file and the station elevation data in terms of the fractional + width and the reach depth. Instructions for creating the TAB6_FILENAME input file + are provided in SFR Reach Cross-Section Table Input File section. + tagged: false + direction: in auxiliaryrecord: type: record fields: @@ -633,6 +679,16 @@ blocks: from a time series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: nreaches: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.json index 79d0418e..822ece1e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.json @@ -34,10 +34,16 @@ "optional": true, "fields": { "tvs6": { - "type": "file", + "type": "keyword", "longname": "tvs keyword", - "description": "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." + }, + "tvs6_filename": { + "type": "file", + "longname": "file name of TVS information", + "description": "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods.", + "tagged": false, + "direction": "in" } } }, @@ -116,6 +122,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.toml index c8609a25..d347b14e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.toml @@ -29,10 +29,16 @@ type = "record" optional = true [blocks.options.fields.tvs_filerecord.fields.tvs6] -type = "file" +type = "keyword" longname = "tvs keyword" description = "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.tvs_filerecord.fields.tvs6_filename] +type = "file" +longname = "file name of TVS information" +description = "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" @@ -101,6 +107,13 @@ valid = [ "transient", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ipakcb] set_in = "ar" source = "save_flows" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.yaml index fba4e1ce..6dc29f2e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-sto.yaml @@ -34,11 +34,18 @@ blocks: optional: true fields: tvs6: - type: file + type: keyword longname: tvs keyword description: keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately. - mode: filein + tvs6_filename: + type: file + longname: file name of TVS information + description: defines a time-varying storage (TVS) input file. Records in the TVS file can + be used to change specific storage and specific yield properties at specified times or stress + periods. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. @@ -110,6 +117,16 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ipakcb: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.json index a4e1a9dc..f5bf2dc6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.json @@ -66,10 +66,16 @@ "optional": true, "fields": { "water_content": { - "type": "file", + "type": "keyword", "longname": "water_content keyword", - "description": "keyword to specify that record corresponds to unsaturated zone water contents.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to unsaturated zone water contents." + }, + "wcfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write water content information.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +84,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -90,10 +102,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -102,10 +120,16 @@ "optional": true, "fields": { "package_convergence": { - "type": "file", + "type": "keyword", "longname": "package_convergence keyword", - "description": "keyword to specify that record corresponds to the package convergence comma spaced values file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the package convergence comma spaced values file." + }, + "package_convergence_filename": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma spaced values output file to write package convergence information.", + "tagged": false, + "direction": "out" } } }, @@ -114,10 +138,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -126,10 +156,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package.", + "tagged": false, + "direction": "in" } } }, @@ -214,6 +250,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -350,6 +387,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -359,6 +397,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.toml index 4cd3955a..d030da7e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.toml @@ -61,60 +61,96 @@ type = "record" optional = true [blocks.options.fields.wc_filerecord.fields.water_content] -type = "file" +type = "keyword" longname = "water_content keyword" description = "keyword to specify that record corresponds to unsaturated zone water contents." -mode = "fileout" + +[blocks.options.fields.wc_filerecord.fields.wcfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write water content information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.package_convergence_filerecord] type = "record" optional = true [blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "file" +type = "keyword" longname = "package_convergence keyword" description = "keyword to specify that record corresponds to the package convergence comma spaced values file." -mode = "fileout" + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -193,6 +229,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -320,12 +357,20 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ "auxiliary", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.nuzfcells] set_in = "ar" source = "nuzfcells" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.yaml index 47987a04..cd341d9f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-uzf.yaml @@ -67,56 +67,91 @@ blocks: optional: true fields: water_content: - type: file + type: keyword longname: water_content keyword description: keyword to specify that record corresponds to unsaturated zone water contents. - mode: fileout + wcfile: + type: file + longname: file keyword + description: name of the binary output file to write water content information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out package_convergence_filerecord: type: record optional: true fields: package_convergence: - type: file + type: keyword longname: package_convergence keyword description: keyword to specify that record corresponds to the package convergence comma spaced values file. - mode: fileout + package_convergence_filename: + type: file + longname: file keyword + description: name of the comma spaced values output file to write package convergence information. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZF package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZF package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the UZF Package can be used with the Water @@ -213,6 +248,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -384,10 +420,21 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: - auxiliary + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: nuzfcells: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.json index 21aad50e..c4b80c52 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "viscosity": { - "type": "file", + "type": "keyword", "longname": "viscosity keyword", - "description": "keyword to specify that record corresponds to viscosity.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to viscosity." + }, + "viscosityfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.toml index bc2a813d..f22ed59d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.toml @@ -56,10 +56,16 @@ type = "record" optional = true [blocks.options.fields.viscosity_filerecord.fields.viscosity] -type = "file" +type = "keyword" longname = "viscosity keyword" description = "keyword to specify that record corresponds to viscosity." -mode = "fileout" + +[blocks.options.fields.viscosity_filerecord.fields.viscosityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" [blocks.dimensions.fields.nviscspecies] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.yaml index 79eefb81..162aaf61 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-vsc.yaml @@ -61,10 +61,18 @@ blocks: optional: true fields: viscosity: - type: file + type: keyword longname: viscosity keyword description: keyword to specify that record corresponds to viscosity. - mode: fileout + viscosityfile: + type: file + longname: file keyword + description: name of the binary output file to write viscosity information. The viscosity + file has the same format as the head file. Viscosity values will be written to the viscosity + file whenever heads are written to the binary head file. The settings for controlling head + output are contained in the Output Control option. + tagged: false + direction: out dimensions: fields: nviscspecies: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.json index b493b277..2ed60538 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.json @@ -73,10 +73,16 @@ "optional": true, "fields": { "auto_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + }, + "afrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -91,10 +97,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -103,10 +115,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package.", + "tagged": false, + "direction": "in" } } }, @@ -137,6 +155,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -154,6 +173,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -173,6 +193,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.toml index 00a234b2..0187a24e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.toml @@ -68,10 +68,16 @@ type = "record" optional = true [blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.flow_reduction_length] type = "keyword" @@ -84,20 +90,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -122,6 +140,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -139,6 +158,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -152,6 +172,13 @@ description = "name of the well cell. BOUNDNAME is an ASCII character variable optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.yaml index 117e7b1e..96442f03 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-wel.yaml @@ -79,12 +79,19 @@ blocks: optional: true fields: auto_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program. - mode: fileout + afrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + well extraction rates that have been reduced by the program. Entries are only written if + the extraction rates are reduced. + tagged: false + direction: out flow_reduction_length: type: keyword longname: flow reduction length keyword @@ -99,19 +106,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the WEL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the WEL package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Well Package can be used with the Water @@ -140,6 +161,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -162,6 +184,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -176,6 +199,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.json index 6a6560cd..bfb7f34b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.json @@ -75,10 +75,16 @@ "optional": true, "fields": { "auto_flow_reduce_csv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + }, + "afrcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +99,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package.", + "tagged": false, + "direction": "in" } } }, @@ -147,6 +159,13 @@ "nodes" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.toml index be3d9a2f..e15610cf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.toml @@ -70,10 +70,16 @@ type = "record" optional = true [blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." -mode = "fileout" + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" [blocks.options.fields.flow_reduction_length] type = "keyword" @@ -86,10 +92,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" @@ -130,6 +142,13 @@ shape = [ "nodes", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.yaml index 4f14ba1e..c67e3af6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwf-welg.yaml @@ -85,12 +85,19 @@ blocks: optional: true fields: auto_flow_reduce_csv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program. - mode: fileout + afrcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write information about + well extraction rates that have been reduced by the program. Entries are only written if + the extraction rates are reduced. + tagged: false + direction: out flow_reduction_length: type: keyword longname: flow reduction length keyword @@ -105,10 +112,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the WEL package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the WEL package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the Well Package can be used with the Water @@ -155,6 +169,16 @@ blocks: dtype: double shape: - nodes + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.json index 434e5661..183bf497 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.json @@ -41,10 +41,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.toml index 05e0b370..9f50eeaf 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.toml @@ -36,10 +36,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" [blocks.options.fields.mover] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.yaml index aa6c43d5..67810a8c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-api.yaml @@ -40,10 +40,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the api boundary package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the api boundary package. + tagged: false + direction: in mover: type: keyword description: keyword to indicate that this instance of the api boundary Package can be used with diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.json index c7ac82f2..cf4e6475 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "time series keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.toml index 38f1b784..4367ccaa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "time series keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the constant concentration cell. BOUNDNAME is an ASCII c optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprflow] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.yaml index 51f18f95..30e2d585 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-cnc.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: time series keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CNC package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CNC package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprflow: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.json index 87f10ad4..f372cda5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.toml index 69fc4a67..259fbbc6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.yaml index f337e4d0..6182bf09 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.json index ff70a725..112ca6b8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.json @@ -44,10 +44,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -284,6 +290,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.toml index acc60e7b..707b0326 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.toml @@ -39,10 +39,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -259,6 +265,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.yaml index 3afbd387..c31e2772 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disu.yaml @@ -36,10 +36,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -290,6 +296,7 @@ blocks: longname: array of vertex numbers description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.json index e86d0d6f..52b03d9d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -230,6 +242,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.toml index 93936265..c61b2be7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -207,6 +219,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.yaml index b5236ea9..20a8662d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-disv.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +101,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -213,6 +224,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.json index 5df33062..d30419ea 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.json @@ -23,10 +23,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +41,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -70,10 +82,16 @@ "optional": true, "fields": { "cim": { - "type": "file", + "type": "keyword", "longname": "cim keyword", - "description": "keyword to specify that record corresponds to immobile concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to immobile concentration." + }, + "cimfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file.", + "tagged": false, + "direction": "out" } } }, @@ -124,10 +142,16 @@ "optional": true, "fields": { "sorbate": { - "type": "file", + "type": "keyword", "longname": "sorbate keyword", - "description": "keyword to specify that record corresponds to immobile sorbate concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to immobile sorbate concentration." + }, + "sorbatefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.toml index 6e45e0e1..75deb4d7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.toml @@ -18,20 +18,32 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.sorption] type = "string" @@ -61,10 +73,16 @@ type = "record" optional = true [blocks.options.fields.cim_filerecord.fields.cim] -type = "file" +type = "keyword" longname = "cim keyword" description = "keyword to specify that record corresponds to immobile concentration." -mode = "fileout" + +[blocks.options.fields.cim_filerecord.fields.cimfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file." +tagged = false +direction = "out" [blocks.options.fields.cimprintrecord] type = "record" @@ -109,10 +127,16 @@ type = "record" optional = true [blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "file" +type = "keyword" longname = "sorbate keyword" description = "keyword to specify that record corresponds to immobile sorbate concentration." -mode = "fileout" + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.yaml index 73e92db5..cd25dad9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-ist.yaml @@ -20,19 +20,30 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out sorption: type: string longname: activate sorption @@ -63,10 +74,19 @@ blocks: optional: true fields: cim: - type: file + type: keyword longname: cim keyword description: keyword to specify that record corresponds to immobile concentration. - mode: fileout + cimfile: + type: file + longname: file keyword + description: name of the output file to write immobile concentrations. This file is a binary + file that has the same format and structure as a binary head and concentration file. The + value for the text variable written to the file is CIM. Immobile domain concentrations + will be written to this file at the same interval as mobile domain concentrations are saved, + as specified in the GWT Model Output Control file. + tagged: false + direction: out cimprintrecord: type: record optional: true @@ -104,10 +124,17 @@ blocks: optional: true fields: sorbate: - type: file + type: keyword longname: sorbate keyword description: keyword to specify that record corresponds to immobile sorbate concentration. - mode: fileout + sorbatefile: + type: file + longname: file keyword + description: name of the output file to write immobile sorbate concentration information. Immobile + sorbate concentrations will be written whenever aqueous immobile concentrations are saved, + as determined by settings in the Output Control option. + tagged: false + direction: out export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.json index 636b513e..28b89648 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package.", + "tagged": false, + "direction": "in" } } } @@ -151,6 +181,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -248,6 +279,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.toml index aa59befe..76d56a5f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -133,6 +163,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -217,6 +248,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.yaml index b058aba0..5799bedc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-lkt.yaml @@ -78,46 +78,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the LKT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the LKT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -150,6 +180,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -260,6 +291,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.json index 4c8d6d17..f6a6ca60 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "sorbate": { - "type": "file", + "type": "keyword", "longname": "sorbate keyword", - "description": "keyword to specify that record corresponds to sorbate concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to sorbate concentration." + }, + "sorbatefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.toml index a8e3e484..366147e3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "file" +type = "keyword" longname = "sorbate keyword" description = "keyword to specify that record corresponds to sorbate concentration." -mode = "fileout" + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.yaml index 37979d71..c13809ab 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mst.yaml @@ -43,10 +43,17 @@ blocks: optional: true fields: sorbate: - type: file + type: keyword longname: sorbate keyword description: keyword to specify that record corresponds to sorbate concentration. - mode: fileout + sorbatefile: + type: file + longname: file keyword + description: name of the output file to write sorbate concentration information. Sorbate + concentrations will be written whenever aqueous concentrations are saved, as determined + by settings in the Output Control option. + tagged: false + direction: out export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.json index ddd04d14..aa1b9126 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +47,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.toml index 05519a04..84520e03 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.toml @@ -26,17 +26,29 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.yaml index caf48fb1..619825f4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mvt.yaml @@ -30,16 +30,27 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.json index 91b63cca..cdaad4f0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package.", + "tagged": false, + "direction": "in" } } } @@ -151,6 +181,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -230,6 +261,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.toml index 7aa41081..941e0a21 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -133,6 +163,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -199,6 +230,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.yaml index fd967f9e..c323ab91 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-mwt.yaml @@ -78,46 +78,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the MWT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the MWT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -150,6 +180,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -233,6 +264,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.json index efd81e5e..96c06d3a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "netcdf_mesh2d": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a layered mesh NetCDF file." + }, + "ncmesh2dfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF ugrid layered mesh output file.", + "tagged": false, + "direction": "out" } } }, @@ -65,10 +71,16 @@ "optional": true, "fields": { "netcdf_structured": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a structured NetCDF file." + }, + "ncstructfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the NetCDF structured output file.", + "tagged": false, + "direction": "out" } } }, @@ -78,10 +90,16 @@ "optional": true, "fields": { "netcdf": { - "type": "file", + "type": "keyword", "longname": "netcdf keyword", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF input file." + }, + "netcdf_filename": { + "type": "file", + "longname": "netcdf input filename", + "description": "defines a NetCDF input file.", + "tagged": false, + "direction": "in" } } } @@ -134,6 +152,7 @@ }, "netcdf_fname": { "set_in": "ar", + "source": "netcdf_filename", "type": "string" }, "x": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.toml index 884a7ba1..259043c7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.toml @@ -47,10 +47,16 @@ description = "NetCDF layered mesh fileout record." optional = true [blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" [blocks.options.fields.nc_structured_filerecord] type = "record" @@ -58,10 +64,16 @@ description = "NetCDF structured fileout record." optional = true [blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to a structured NetCDF file." -mode = "fileout" + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" [blocks.options.fields.nc_filerecord] type = "record" @@ -69,10 +81,16 @@ description = "NetCDF filerecord" optional = true [blocks.options.fields.nc_filerecord.fields.netcdf] -type = "file" +type = "keyword" longname = "netcdf keyword" description = "keyword to specify that record corresponds to a NetCDF input file." -mode = "filein" + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" [blocks.packages.fields.packages] type = "list" @@ -113,6 +131,7 @@ type = "logical" [memory.netcdf_fname] set_in = "ar" +source = "netcdf_filename" type = "string" [memory.x] diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.yaml index 0ca07226..2065af53 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-nam.yaml @@ -51,30 +51,45 @@ blocks: optional: true fields: netcdf_mesh2d: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a layered mesh NetCDF file. - mode: fileout + ncmesh2dfile: + type: file + longname: file keyword + description: name of the NetCDF ugrid layered mesh output file. + tagged: false + direction: out nc_structured_filerecord: type: record description: NetCDF structured fileout record. optional: true fields: netcdf_structured: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to a structured NetCDF file. - mode: fileout + ncstructfile: + type: file + longname: file keyword + description: name of the NetCDF structured output file. + tagged: false + direction: out nc_filerecord: type: record description: NetCDF filerecord optional: true fields: netcdf: - type: file + type: keyword longname: netcdf keyword description: keyword to specify that record corresponds to a NetCDF input file. - mode: filein + netcdf_filename: + type: file + longname: netcdf input filename + description: defines a NetCDF input file. + tagged: false + direction: in packages: fields: packages: @@ -120,6 +135,7 @@ memory: type: logical netcdf_fname: set_in: ar + source: netcdf_filename type: string x: type: array diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.json index cc216b28..dd4133bc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "concentration keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concentrationfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -193,12 +211,20 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, "memory": { "concfile": { "set_in": "ar", + "source": "concentrationfile", "type": "string" } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.toml index d5db1a90..cccfd4df 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.toml @@ -8,30 +8,48 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.concentration_filerecord] type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "concentration keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concentrationfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.concentrationprintrecord] type = "record" @@ -166,6 +184,14 @@ type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.concfile] set_in = "ar" +source = "concentrationfile" type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.yaml index ba42eb3e..12f7b2f1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-oc.yaml @@ -10,28 +10,44 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out concentration_filerecord: type: record optional: true fields: concentration: - type: file + type: keyword longname: concentration keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concentrationfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out concentrationprintrecord: type: record optional: true @@ -158,7 +174,18 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: concfile: set_in: ar + source: concentrationfile type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.json index 6cdf70a3..de13534b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "concentration keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package.", + "tagged": false, + "direction": "in" } } } @@ -151,6 +181,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -248,6 +279,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.toml index dfa8e9e8..9e255183 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "concentration keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -133,6 +163,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -217,6 +248,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.yaml index 476d2809..9326f14f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-sft.yaml @@ -78,46 +78,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: concentration keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SFT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SFT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -150,6 +180,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -258,6 +289,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.json index 5dce7ebd..83fc2671 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package.", + "tagged": false, + "direction": "in" } } }, @@ -114,6 +126,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -131,6 +144,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -150,6 +164,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.toml index c1198097..d8884f57 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package." +tagged = false +direction = "in" [blocks.options.fields.highest_saturated] type = "keyword" @@ -101,6 +113,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -118,6 +131,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -131,6 +145,13 @@ description = "name of the mass source cell. BOUNDNAME is an ASCII character va optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.yaml index 2ecae661..29f13f41 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-src.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the SRC package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the SRC package. + tagged: false + direction: in highest_saturated: type: keyword longname: apply source to highest saturated cell @@ -117,6 +131,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -139,6 +154,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -153,6 +169,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.json index ce98b63b..a2ac828b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.json @@ -69,10 +69,16 @@ "optional": true, "fields": { "concentration": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to concentration.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to concentration." + }, + "concfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write concentration information.", + "tagged": false, + "direction": "out" } } }, @@ -81,10 +87,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -93,10 +105,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -105,10 +123,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -117,10 +141,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package.", + "tagged": false, + "direction": "in" } } } @@ -151,6 +181,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -236,6 +267,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.toml index 93af630f..fd9918f0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.toml @@ -64,50 +64,80 @@ type = "record" optional = true [blocks.options.fields.concentration_filerecord.fields.concentration] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to concentration." -mode = "fileout" + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" [blocks.options.fields.budget_filerecord] type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.ts_filerecord] type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package." +tagged = false +direction = "in" [blocks.packagedata.fields.packagedata] type = "list" @@ -133,6 +163,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -205,6 +236,13 @@ description = "value for the auxiliary variable. If the Options block includes a tagged = false time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ncv] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.yaml index 9388eec0..64d763fb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/gwt-uzt.yaml @@ -79,46 +79,76 @@ blocks: optional: true fields: concentration: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to concentration. - mode: fileout + concfile: + type: file + longname: file keyword + description: name of the binary output file to write concentration information. + tagged: false + direction: out budget_filerecord: type: record optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the binary output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out ts_filerecord: type: record optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the UZT package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the UZT package. + tagged: false + direction: in packagedata: fields: packagedata: @@ -152,6 +182,7 @@ blocks: entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -244,6 +275,16 @@ blocks: series by entering the time-series name in place of a numeric value. tagged: false time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ncv: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.json index a70e5616..ccb8ff95 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package.", + "tagged": false, + "direction": "in" } } } @@ -90,6 +96,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -113,6 +120,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -132,6 +140,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.toml index eff411ea..f1f0d0d2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.toml @@ -56,10 +56,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -79,6 +85,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -102,6 +109,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,6 +123,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.yaml index 2ef06fdd..a4e533f2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-cdb.yaml @@ -62,10 +62,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CDB package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CDB package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -88,6 +95,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -118,6 +126,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -132,6 +141,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.json index fe36a6ab..bbfb7fc0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.toml index 9f9d85a7..90664df3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the constant head boundary cell. BOUNDNAME is an ASCII c optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.yaml index ac29560a..fe57b3e7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-chd.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the CHD package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the CHD package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.json index 3adecc8f..58a3f2a8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.toml index 7fdd3d50..98c74ae9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.yaml index cd9d3f77..ec1403f5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dfw.yaml @@ -64,10 +64,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.json index 9df75637..b65ded74 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.toml index 1b32d563..149fd23b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.yaml index 1099dd73..326d4782 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-dis2d.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.json index c2e876dd..864a5948 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -198,6 +204,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.toml index 491b0922..45007456 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -177,6 +183,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.yaml index 592fe3f7..29a595b4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -186,6 +192,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.json index bd8ccf49..70fe9821 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -185,6 +191,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.toml index bab72b55..f1e5c89f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -164,6 +170,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.yaml index bd72ee44..dc0ddbd9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-disv2d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -172,6 +178,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.json index 255fe2c2..3bbb9208 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.toml index 109f73a9..f5c7515e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the evaporation cell. BOUNDNAME is an ASCII character va optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.yaml index 4ea6664f..3c4e4c9b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-evp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the EVP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the EVP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.json index d5c96b55..0f251d1b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.toml index d32fffcb..5231e0c5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the inflow cell. BOUNDNAME is an ASCII character variabl optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.yaml index 9bd4b412..ba2aacbd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-flw.yaml @@ -66,19 +66,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the FLW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the FLW package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -101,6 +115,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.json index c8f89260..b089e94b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.toml index c7fce291..ab008992 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.yaml index 01e5cbff..de8858a6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.json index 0202a000..e59e41cc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.toml index 520bfb4c..42ca292a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the precipitation cell. BOUNDNAME is an ASCII character optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.yaml index 370e58a6..c4ad8cf0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-pcp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the PCP package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the PCP package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.json index 9642ae05..67aab182 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.toml index 37beb26c..977c2809 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.toml @@ -25,6 +25,13 @@ valid = [ "transient", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ipakcb] set_in = "ar" source = "save_flows" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.yaml index dbe9dc28..992bd500 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-sto.yaml @@ -28,6 +28,16 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ipakcb: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.json index f4059904..b7985d1b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -73,10 +79,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package.", + "tagged": false, + "direction": "in" } } } @@ -102,6 +114,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -139,6 +152,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -158,6 +172,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.toml index f8559803..99e2913e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.toml @@ -56,20 +56,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -89,6 +101,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -126,6 +139,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -139,6 +153,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.yaml index 31ef79a9..7d65a70e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/olf-zdg.yaml @@ -62,19 +62,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the ZDG package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the ZDG package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -97,6 +111,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -147,6 +162,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -161,6 +177,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.json index ca991b43..dcc519fa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.json @@ -49,10 +49,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -99,10 +105,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.toml index f00ed2ca..3a5a690a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.toml @@ -44,10 +44,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -92,10 +98,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.yaml index 4749dfbf..98e572be 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-dis.yaml @@ -40,10 +40,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -96,10 +102,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.json index 8c82276a..4dc612ef 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file.", + "tagged": false, + "direction": "out" } } }, @@ -95,10 +101,16 @@ "optional": true, "fields": { "ncf6": { - "type": "file", + "type": "keyword", "longname": "ncf keyword", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + }, + "ncf6_filename": { + "type": "file", + "longname": "file name of NCF information", + "description": "defines a NetCDF configuration (NCF) input file.", + "tagged": false, + "direction": "in" } } } @@ -227,6 +239,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.toml index 741ccde2..f927e6b9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -88,10 +94,16 @@ type = "record" optional = true [blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "file" +type = "keyword" longname = "ncf keyword" description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -mode = "filein" + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" [blocks.dimensions.fields.nlay] type = "integer" @@ -204,6 +216,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.yaml index d58447d4..2d3b1df8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-disv.yaml @@ -37,10 +37,15 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -95,10 +100,15 @@ blocks: optional: true fields: ncf6: - type: file + type: keyword longname: ncf keyword description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - mode: filein + ncf6_filename: + type: file + longname: file name of NCF information + description: defines a NetCDF configuration (NCF) input file. + tagged: false + direction: in dimensions: fields: nlay: @@ -210,6 +220,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.json index 7485e70c..d20293fb 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.json @@ -20,19 +20,19 @@ "type": "file", "longname": "gwf head file", "optional": true, - "mode": "filein" + "direction": "in" }, "gwfbudget": { "type": "file", "longname": "gwf budget file", "optional": true, - "mode": "filein" + "direction": "in" }, "gwfgrid": { "type": "file", "longname": "gwf grid file", "optional": true, - "mode": "filein" + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.toml index aa216db7..0795531e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.toml @@ -13,16 +13,16 @@ optional = true type = "file" longname = "gwf head file" optional = true -mode = "filein" +direction = "in" [blocks.packagedata.fields.gwfbudget] type = "file" longname = "gwf budget file" optional = true -mode = "filein" +direction = "in" [blocks.packagedata.fields.gwfgrid] type = "file" longname = "gwf grid file" optional = true -mode = "filein" +direction = "in" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.yaml index ce3c44fa..633c5362 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-fmi.yaml @@ -17,14 +17,14 @@ blocks: type: file longname: gwf head file optional: true - mode: filein + direction: in gwfbudget: type: file longname: gwf budget file optional: true - mode: filein + direction: in gwfgrid: type: file longname: gwf grid file optional: true - mode: filein + direction: in diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.json index dd56a26c..6a93777a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.json @@ -17,10 +17,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -29,10 +35,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -41,10 +53,16 @@ "optional": true, "fields": { "track": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." + }, + "trackfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -53,10 +71,16 @@ "optional": true, "fields": { "trackcsv": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." + }, + "trackcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -120,6 +144,7 @@ "type": "array", "longname": "tracking times", "description": "times to track, relative to the beginning of the simulation.", + "tagged": false, "dtype": "double" } } @@ -286,6 +311,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.toml index 586b7649..6c1e16b7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.toml @@ -12,40 +12,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.track_filerecord] type = "record" optional = true [blocks.options.fields.track_filerecord.fields.track] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." -mode = "fileout" + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.trackcsv_filerecord] type = "record" optional = true [blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." -mode = "fileout" + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.track_release] type = "keyword" @@ -107,6 +131,7 @@ description = "keyword indicating tracking times will follow" type = "array" longname = "tracking times" description = "times to track, relative to the beginning of the simulation." +tagged = false dtype = "double" [blocks.options.fields.track_timesfilerecord] @@ -245,6 +270,13 @@ type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.track_subf_exit] set_in = "ar" source = "track_subfeature_exit" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.yaml index a7c9c495..a3bc243d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-oc.yaml @@ -14,39 +14,60 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out track_filerecord: type: record optional: true fields: track: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file. - mode: fileout + trackfile: + type: file + longname: file keyword + description: name of the binary output file to write tracking information. + tagged: false + direction: out trackcsv_filerecord: type: record optional: true fields: trackcsv: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file. - mode: fileout + trackcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) file to write tracking information. + tagged: false + direction: out track_release: type: keyword longname: track release @@ -108,6 +129,7 @@ blocks: type: array longname: tracking times description: times to track, relative to the beginning of the simulation. + tagged: false dtype: double track_timesfilerecord: type: record @@ -242,6 +264,16 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: track_subf_exit: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.json index 13e657c0..c86ed446 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.json @@ -68,10 +68,16 @@ "optional": true, "fields": { "track": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." + }, + "trackfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the binary output file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -80,10 +86,16 @@ "optional": true, "fields": { "trackcsv": { - "type": "file", + "type": "keyword", "longname": "track keyword", - "description": "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." + }, + "trackcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) file to write tracking information.", + "tagged": false, + "direction": "out" } } }, @@ -129,6 +141,7 @@ "type": "array", "longname": "release times", "description": "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive.", + "tagged": false, "dtype": "double" } } @@ -229,6 +242,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -327,6 +341,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.toml index cb44be2e..8f93a98e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.toml @@ -63,20 +63,32 @@ type = "record" optional = true [blocks.options.fields.track_filerecord.fields.track] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." -mode = "fileout" + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.trackcsv_filerecord] type = "record" optional = true [blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "file" +type = "keyword" longname = "track keyword" description = "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." -mode = "fileout" + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" [blocks.options.fields.stoptime] type = "double" @@ -120,6 +132,7 @@ description = "keyword indicating release times will follow" type = "array" longname = "release times" description = "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +tagged = false dtype = "double" [blocks.options.fields.release_timesfilerecord] @@ -212,6 +225,7 @@ pk = true type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -292,6 +306,13 @@ description = "release particles after the specified fraction of the time step h optional = true dtype = "double" +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.yaml index 57ae49c7..ce084a87 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/prt-prp.yaml @@ -68,21 +68,31 @@ blocks: optional: true fields: track: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file. - mode: fileout + trackfile: + type: file + longname: file keyword + description: name of the binary output file to write tracking information. + tagged: false + direction: out trackcsv_filerecord: type: record optional: true fields: trackcsv: - type: file + type: keyword longname: track keyword description: keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file. - mode: fileout + trackcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) file to write tracking information. + tagged: false + direction: out stoptime: type: double longname: stop time @@ -144,6 +154,7 @@ blocks: longname: release times description: times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive. + tagged: false dtype: double release_timesfilerecord: type: record @@ -248,6 +259,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -346,6 +358,16 @@ blocks: using the RELEASETIMES block.' optional: true dtype: double + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the stress period number for which the data specified in the + PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than + zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned + for the previous PERIOD block. The information specified in the PERIOD block applies only to that + stress period. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.json index 21c50201..c3026c37 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.json @@ -47,10 +47,16 @@ "optional": true, "fields": { "hpc6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a hpc file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a hpc file." + }, + "hpc6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files.", + "tagged": false, + "direction": "in" } } } @@ -177,11 +183,18 @@ "type": "array", "longname": "array of model names in this solution", "description": "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line.", + "tagged": false, "dtype": "string" } } } } + }, + "header": { + "name": "group_num", + "type": "integer", + "description": "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.toml index 1cddc452..94a98d8c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.toml @@ -44,10 +44,16 @@ description = "hpc record" optional = true [blocks.options.fields.hpc_filerecord.fields.hpc6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a hpc file." -mode = "filein" + +[blocks.options.fields.hpc_filerecord.fields.hpc6_filename] +type = "file" +longname = "file name of time series information" +description = "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files." +tagged = false +direction = "in" [blocks.timing.fields.tdis6] type = "string" @@ -153,8 +159,15 @@ case_sensitive = true type = "array" longname = "array of model names in this solution" description = "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line." +tagged = false dtype = "string" +[blocks.solutiongroup.header] +name = "group_num" +type = "integer" +description = "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one." +tagged = false + [memory.prmem] set_in = "ar" source = "memory_print_option" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.yaml index 7e44c6a6..922aa4c2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-nam.yaml @@ -51,10 +51,16 @@ blocks: optional: true fields: hpc6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a hpc file. - mode: filein + hpc6_filename: + type: file + longname: file name of time series information + description: name of input file to define HPC file settings for the HPC package. See the 'HPC + File' section for instructions for preparing HPC input files. + tagged: false + direction: in timing: fields: tdis6: @@ -157,7 +163,14 @@ blocks: longname: array of model names in this solution description: is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line. + tagged: false dtype: string + header: + name: group_num + type: integer + description: is the group number of the solution group. Solution groups must be numbered sequentially, + starting with group number one. + tagged: false memory: prmem: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.json index 5b6b8923..dc3426a0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.json @@ -29,10 +29,16 @@ "optional": true, "fields": { "ats6": { - "type": "file", + "type": "keyword", "longname": "ats keyword", - "description": "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." + }, + "ats6_filename": { + "type": "file", + "longname": "file name of adaptive time series information", + "description": "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods.", + "tagged": false, + "direction": "in" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.toml index b39119c1..985e0652 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.toml @@ -24,10 +24,16 @@ type = "record" optional = true [blocks.options.fields.ats_filerecord.fields.ats6] -type = "file" +type = "keyword" longname = "ats keyword" description = "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." -mode = "filein" + +[blocks.options.fields.ats_filerecord.fields.ats6_filename] +type = "file" +longname = "file name of adaptive time series information" +description = "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods." +tagged = false +direction = "in" [blocks.dimensions.fields.nper] type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.yaml index 6dfe3436..7816a3ac 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sim-tdis.yaml @@ -28,11 +28,17 @@ blocks: optional: true fields: ats6: - type: file + type: keyword longname: ats keyword description: keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately. - mode: filein + ats6_filename: + type: file + longname: file name of adaptive time series information + description: defines an adaptive time step (ATS) input file defining ATS controls. Records + in the ATS file can be used to override the time step behavior for selected stress periods. + tagged: false + direction: in dimensions: fields: nper: diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.json index 66acdb74..21e21db9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "csv_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." + }, + "csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, @@ -36,10 +42,16 @@ "optional": true, "fields": { "csv_outer_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." + }, + "outer_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step.", + "tagged": false, + "direction": "out" } } }, @@ -48,10 +60,16 @@ "optional": true, "fields": { "csv_inner_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output." + }, + "inner_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.toml index 66944b87..bc0b3ebc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.toml @@ -21,30 +21,48 @@ type = "record" optional = true [blocks.options.fields.csv_output_filerecord.fields.csv_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." -mode = "fileout" + +[blocks.options.fields.csv_output_filerecord.fields.csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.csv_outer_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." -mode = "fileout" + +[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." +tagged = false +direction = "out" [blocks.options.fields.csv_inner_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." -mode = "fileout" + +[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.no_ptcrecord] type = "record" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.yaml index e766f1ad..89a63d63 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-ims.yaml @@ -39,33 +39,59 @@ blocks: optional: true fields: csv_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option. - mode: fileout + csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes + maximum head change convergence information at the end of each outer iteration for each + time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change + and maximum residual convergence information for the solution and each model (if the solution + includes more than one model) and linear acceleration information for each inner iteration. + tagged: false + direction: out csv_outer_output_filerecord: type: record optional: true fields: csv_outer_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values outer iteration convergence output. - mode: fileout + outer_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write maximum dependent-variable + (for example, head) change convergence information at the end of each outer iteration for + each time step. + tagged: false + direction: out csv_inner_output_filerecord: type: record optional: true fields: csv_inner_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. - mode: fileout + inner_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. Comma separated values output includes maximum dependent-variable (for example, + head) change and maximum residual convergence information for the solution and each model + (if the solution includes more than one model) and linear acceleration information for each + inner iteration. + tagged: false + direction: out no_ptcrecord: type: record longname: no_ptc record diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.json index 6298bd79..ea50dd99 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "csv_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." + }, + "csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, @@ -36,10 +42,16 @@ "optional": true, "fields": { "csv_outer_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." + }, + "outer_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step.", + "tagged": false, + "direction": "out" } } }, @@ -48,10 +60,16 @@ "optional": true, "fields": { "csv_inner_output": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output.", - "mode": "fileout" + "description": "keyword to specify that the record corresponds to the comma separated values solver convergence output." + }, + "inner_csvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.toml index b13cc41e..8b4cfa7c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.toml @@ -21,30 +21,48 @@ type = "record" optional = true [blocks.options.fields.csv_output_filerecord.fields.csv_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." -mode = "fileout" + +[blocks.options.fields.csv_output_filerecord.fields.csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.csv_outer_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." -mode = "fileout" + +[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." +tagged = false +direction = "out" [blocks.options.fields.csv_inner_output_filerecord] type = "record" optional = true [blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." -mode = "fileout" + +[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" [blocks.options.fields.no_ptcrecord] type = "record" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.yaml index 6d887eb7..3e491ff0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/sln-pts.yaml @@ -39,33 +39,59 @@ blocks: optional: true fields: csv_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option. - mode: fileout + csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes + maximum head change convergence information at the end of each outer iteration for each + time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change + and maximum residual convergence information for the solution and each model (if the solution + includes more than one model) and linear acceleration information for each inner iteration. + tagged: false + direction: out csv_outer_output_filerecord: type: record optional: true fields: csv_outer_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values outer iteration convergence output. - mode: fileout + outer_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write maximum dependent-variable + (for example, head) change convergence information at the end of each outer iteration for + each time step. + tagged: false + direction: out csv_inner_output_filerecord: type: record optional: true fields: csv_inner_output: - type: file + type: keyword longname: budget keyword description: keyword to specify that the record corresponds to the comma separated values solver convergence output. - mode: fileout + inner_csvfile: + type: file + longname: file keyword + description: name of the ascii comma separated values output file to write solver convergence + information. Comma separated values output includes maximum dependent-variable (for example, + head) change and maximum residual convergence information for the solution and each model + (if the solution includes more than one model) and linear acceleration information for each + inner iteration. + tagged: false + direction: out no_ptcrecord: type: record longname: no_ptc record diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.json index 1bffcc34..eb1c3ed1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package.", + "tagged": false, + "direction": "in" } } } @@ -90,6 +96,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -113,6 +120,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -132,6 +140,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.toml index b9182868..06187e1f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.toml @@ -56,10 +56,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -79,6 +85,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -102,6 +109,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -115,6 +123,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.yaml index 21865127..a7d18d41 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-cdb.yaml @@ -62,10 +62,18 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Zero-Depth-Gradient Boundary + package. See the 'Observation utility' section for instructions for preparing observation + input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary + package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -88,6 +96,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -118,6 +127,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -132,6 +142,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.json index 087379df..770f93ab 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the constant-head package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the constant-head package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.toml index da57b337..b1f66e52 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the constant-head package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the constant-head package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the constant head boundary cell. BOUNDNAME is an ASCII c optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.yaml index ef778892..737e6abe 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-chd.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the constant-head package. See + the 'Observation utility' section for instructions for preparing observation input files. + Table {#2} lists observation type(s) supported by the constant-head package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.json index 963ae0f9..656cd003 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.json @@ -52,10 +52,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package.", + "tagged": false, + "direction": "in" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.toml index 6df890c9..1fad6969 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.toml @@ -47,10 +47,16 @@ type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" [blocks.options.fields.export_array_ascii] type = "keyword" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.yaml index f78499f1..42f02820 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dfw.yaml @@ -64,10 +64,17 @@ blocks: optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the DFW package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the DFW package. + tagged: false + direction: in export_array_ascii: type: keyword longname: export array variables to layered ascii files. diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.json index b4357bf7..43a862f6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.json @@ -45,10 +45,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.toml index ff104039..b10e784e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.toml @@ -40,10 +40,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.yaml index a8639987..18770e53 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-dis2d.yaml @@ -37,10 +37,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.json index e110d347..557b5877 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -189,6 +195,7 @@ "type": "array", "longname": "number of cell vertices", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.toml index 2ba16fb1..c6e36d78 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -168,6 +174,7 @@ tagged = false type = "array" longname = "number of cell vertices" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.yaml index 3b880a09..f35eaf46 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv1d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position origin of the model grid coordinate system @@ -179,6 +185,7 @@ blocks: used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.json index f9c8e55b..6ff9f72e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.json @@ -37,10 +37,16 @@ "optional": true, "fields": { "grb6": { - "type": "file", + "type": "keyword", "longname": "grb keyword", - "description": "keyword to specify that record corresponds to a binary grid file.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to a binary grid file." + }, + "grb6_filename": { + "type": "file", + "longname": "file name of GRB information", + "description": "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'.", + "tagged": false, + "direction": "out" } } }, @@ -185,6 +191,7 @@ "type": "array", "longname": "array of vertex numbers", "description": "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices.", + "tagged": false, "dtype": "integer", "shape": [ "ncvert" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.toml index d1674c9c..2bbfecfa 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.toml @@ -32,10 +32,16 @@ type = "record" optional = true [blocks.options.fields.grb_filerecord.fields.grb6] -type = "file" +type = "keyword" longname = "grb keyword" description = "keyword to specify that record corresponds to a binary grid file." -mode = "fileout" + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" [blocks.options.fields.xorigin] type = "double" @@ -164,6 +170,7 @@ tagged = false type = "array" longname = "array of vertex numbers" description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false dtype = "integer" shape = [ "ncvert", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.yaml index a73cdac4..8703d348 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-disv2d.yaml @@ -31,10 +31,16 @@ blocks: optional: true fields: grb6: - type: file + type: keyword longname: grb keyword description: keyword to specify that record corresponds to a binary grid file. - mode: fileout + grb6_filename: + type: file + longname: file name of GRB information + description: defines a binary grid output file. If this option is not provided, the output + file will have the same name as the discretization input file, plus extension '.grb'. + tagged: false + direction: out xorigin: type: double longname: x-position of the model grid origin @@ -172,6 +178,7 @@ blocks: description: is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices. + tagged: false dtype: integer shape: - ncvert diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.json index f38af6bf..c3e8707b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Evaporation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Evaporation package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.toml index 0dfd4942..960ad8d8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Evaporation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Evaporation package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the evaporation cell. BOUNDNAME is an ASCII character va optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.yaml index f8b143b7..a4e96f7b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-evp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Evaporation package. See the + 'Observation utility' section for instructions for preparing observation input files. Table + {#2} lists observation type(s) supported by the Evaporation package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.json index 589d2138..9c02c554 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the inflow package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the inflow package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.toml index 34a0135f..634fc8a1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the inflow package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the inflow package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the inflow cell. BOUNDNAME is an ASCII character variabl optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] readonly = true set_in = "ar" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.yaml index 047dfed7..8f4fb1a9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-flw.yaml @@ -66,19 +66,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the inflow package. See the 'Observation + utility' section for instructions for preparing observation input files. Table {#2} lists + observation type(s) supported by the inflow package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -101,6 +115,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -123,6 +138,7 @@ blocks: Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -137,6 +153,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: readonly: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.json index 8271978e..299be678 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.json @@ -11,10 +11,16 @@ "optional": true, "fields": { "budget": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget." + }, + "budgetfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "tagged": false, + "direction": "out" } } }, @@ -23,10 +29,16 @@ "optional": true, "fields": { "budgetcsv": { - "type": "file", + "type": "keyword", "longname": "budget keyword", - "description": "keyword to specify that record corresponds to the budget CSV.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to the budget CSV." + }, + "budgetcsvfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.", + "tagged": false, + "direction": "out" } } }, @@ -35,10 +47,16 @@ "optional": true, "fields": { "qoutflow": { - "type": "file", + "type": "keyword", "longname": "qoutflow keyword", - "description": "keyword to specify that record corresponds to qoutflow.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to qoutflow." + }, + "qoutflowfile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "tagged": false, + "direction": "out" } } }, @@ -47,10 +65,16 @@ "optional": true, "fields": { "stage": { - "type": "file", + "type": "keyword", "longname": "stage keyword", - "description": "keyword to specify that record corresponds to stage.", - "mode": "fileout" + "description": "keyword to specify that record corresponds to stage." + }, + "stagefile": { + "type": "file", + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "tagged": false, + "direction": "out" } } }, @@ -205,6 +229,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.toml index 31a33ee2..199d9655 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.toml @@ -8,40 +8,64 @@ type = "record" optional = true [blocks.options.fields.budget_filerecord.fields.budget] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget." -mode = "fileout" + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" [blocks.options.fields.budgetcsv_filerecord] type = "record" optional = true [blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "file" +type = "keyword" longname = "budget keyword" description = "keyword to specify that record corresponds to the budget CSV." -mode = "fileout" + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" [blocks.options.fields.qoutflow_filerecord] type = "record" optional = true [blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "file" +type = "keyword" longname = "qoutflow keyword" description = "keyword to specify that record corresponds to qoutflow." -mode = "fileout" + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" [blocks.options.fields.stage_filerecord] type = "record" optional = true [blocks.options.fields.stage_filerecord.fields.stage] -type = "file" +type = "keyword" longname = "stage keyword" description = "keyword to specify that record corresponds to stage." -mode = "fileout" + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" [blocks.options.fields.qoutflowprintrecord] type = "record" @@ -175,3 +199,10 @@ description = "save at the specified time step frequency. This keyword may be us type = "array" description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." dtype = "integer" + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.yaml index ca09766d..27321978 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-oc.yaml @@ -10,37 +10,58 @@ blocks: optional: true fields: budget: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget. - mode: fileout + budgetfile: + type: file + longname: file keyword + description: name of the output file to write budget information. + tagged: false + direction: out budgetcsv_filerecord: type: record optional: true fields: budgetcsv: - type: file + type: keyword longname: budget keyword description: keyword to specify that record corresponds to the budget CSV. - mode: fileout + budgetcsvfile: + type: file + longname: file keyword + description: name of the comma-separated value (CSV) output file to write budget summary information. A + budget summary record will be written to this file for each time step of the simulation. + tagged: false + direction: out qoutflow_filerecord: type: record optional: true fields: qoutflow: - type: file + type: keyword longname: qoutflow keyword description: keyword to specify that record corresponds to qoutflow. - mode: fileout + qoutflowfile: + type: file + longname: file keyword + description: name of the output file to write conc information. + tagged: false + direction: out stage_filerecord: type: record optional: true fields: stage: - type: file + type: keyword longname: stage keyword description: keyword to specify that record corresponds to stage. - mode: fileout + stagefile: + type: file + longname: file keyword + description: name of the output file to write stage information. + tagged: false + direction: out qoutflowprintrecord: type: record optional: true @@ -167,3 +188,13 @@ blocks: description: save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps. dtype: integer + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.json index fe96df03..4431571e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.json @@ -67,10 +67,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -79,10 +85,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Precipitation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Precipitation package.", + "tagged": false, + "direction": "in" } } } @@ -108,6 +120,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -125,6 +138,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -144,6 +158,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.toml index f0977187..e9c9473f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.toml @@ -62,20 +62,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Precipitation package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Precipitation package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -95,6 +107,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -112,6 +125,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -125,6 +139,13 @@ description = "name of the precipitation cell. BOUNDNAME is an ASCII character optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.yaml index ec3e6b0e..c4618aa7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-pcp.yaml @@ -67,19 +67,33 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Precipitation package. See + the 'Observation utility' section for instructions for preparing observation input files. + Table {#2} lists observation type(s) supported by the Precipitation package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -102,6 +116,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -125,6 +140,7 @@ blocks: (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -139,6 +155,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.json index 957977c5..de12cd39 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.json @@ -32,6 +32,13 @@ "transient" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.toml index ef1dba1e..f2db9f2b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.toml @@ -25,6 +25,13 @@ valid = [ "transient", ] +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.ipakcb] set_in = "ar" source = "save_flows" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.yaml index 5d9ef6b8..b7a57ed1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-sto.yaml @@ -28,6 +28,16 @@ blocks: valid: - steady-state - transient + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: ipakcb: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.json index 236d50dd..7ce43a7e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.json @@ -61,10 +61,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } }, @@ -73,10 +79,16 @@ "optional": true, "fields": { "obs6": { - "type": "file", + "type": "keyword", "longname": "obs keyword", - "description": "keyword to specify that record corresponds to an observations file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to an observations file." + }, + "obs6_filename": { + "type": "file", + "longname": "obs6 input filename", + "description": "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package.", + "tagged": false, + "direction": "in" } } } @@ -102,6 +114,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -139,6 +152,7 @@ "longname": "auxiliary variables", "description": "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value.", "optional": true, + "tagged": false, "dtype": "double", "time_series": true, "shape": [ @@ -158,6 +172,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.toml index f1fe4bd1..10bc67a4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.toml @@ -56,20 +56,32 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.options.fields.obs_filerecord] type = "record" optional = true [blocks.options.fields.obs_filerecord.fields.obs6] -type = "file" +type = "keyword" longname = "obs keyword" description = "keyword to specify that record corresponds to an observations file." -mode = "filein" + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the Zero-Depth-Gradient Boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary package." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -89,6 +101,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -126,6 +139,7 @@ type = "array" longname = "auxiliary variables" description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." optional = true +tagged = false dtype = "double" time_series = true shape = [ @@ -139,6 +153,13 @@ description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an A optional = true tagged = false +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.iprpak] set_in = "ar" source = "print_input" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.yaml index af49a6a9..5f00a49b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/swf-zdg.yaml @@ -62,19 +62,34 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in obs_filerecord: type: record optional: true fields: obs6: - type: file + type: keyword longname: obs keyword description: keyword to specify that record corresponds to an observations file. - mode: filein + obs6_filename: + type: file + longname: obs6 input filename + description: name of input file to define observations for the Zero-Depth-Gradient Boundary + package. See the 'Observation utility' section for instructions for preparing observation + input files. Table {#2} lists observation type(s) supported by the Zero-Depth-Gradient Boundary + package. + tagged: false + direction: in dimensions: fields: maxbound: @@ -97,6 +112,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -147,6 +163,7 @@ blocks: a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. optional: true + tagged: false dtype: double time_series: true shape: @@ -161,6 +178,16 @@ blocks: tagged: false shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: iprpak: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.json index da25e3be..68a6f052 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.json @@ -56,6 +56,23 @@ } } } + }, + "header": { + "name": "output", + "type": "record", + "fields": { + "obs_output_file_name": { + "type": "file", + "description": "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values').", + "tagged": false, + "direction": "out" + }, + "binary": { + "type": "keyword", + "description": "an optional keyword used to indicate that the output file should be written in binary (unformatted) form.", + "optional": true + } + } } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.toml index cf2e3cb2..dbb6dbf8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.toml @@ -46,3 +46,18 @@ longname = "time" description = "Text identifying cell adjacent to cell identified by ID. The form of ID2 is as described for ID. ID2 is used for intercell-flow observations of a GWF model, for three observation types of the LAK Package, for two observation types of the MAW Package, and one observation type of the UZF Package." optional = true tagged = false + +[blocks.continuous.header] +name = "output" +type = "record" + +[blocks.continuous.header.fields.obs_output_file_name] +type = "file" +description = "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values')." +tagged = false +direction = "out" + +[blocks.continuous.header.fields.binary] +type = "keyword" +description = "an optional keyword used to indicate that the output file should be written in binary (unformatted) form." +optional = true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.yaml index 86732207..6bc91716 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-obs.yaml @@ -61,3 +61,21 @@ blocks: one observation type of the UZF Package. optional: true tagged: false + header: + name: output + type: record + fields: + obs_output_file_name: + type: file + description: Name of a file to which simulated values corresponding to observations in the block + are to be written. The file name can be an absolute or relative path name. A unique output + file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is + written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated + Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values'). + tagged: false + direction: out + binary: + type: keyword + description: an optional keyword used to indicate that the output file should be written in + binary (unformatted) form. + optional: true diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.json index ae4de176..d3c21980 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.json @@ -25,10 +25,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -80,6 +86,13 @@ "maxbound" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } }, diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.toml index 692cea15..d4f4d852 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.toml @@ -20,10 +20,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.dimensions.fields.maxbound] type = "integer" @@ -61,6 +67,13 @@ longname = "boundary temperature" description = "is the user-supplied boundary temperature. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the TEMPERATURE for each boundary feature is zero." time_series = true +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false + [memory.maxbound] set_in = "ar" source = "maxbound" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.yaml index 970c37ee..3f0816ff 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spc.yaml @@ -22,10 +22,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in dimensions: fields: maxbound: @@ -70,6 +77,16 @@ blocks: time_series: true shape: - maxbound + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false memory: maxbound: set_in: ar diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.json index f2bf1b0b..820acc9c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.json @@ -25,10 +25,16 @@ "optional": true, "fields": { "tas6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-array-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-array-series file." + }, + "tas6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability.", + "tagged": false, + "direction": "in" } } } @@ -56,6 +62,13 @@ "ncpl" ] } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.toml index 1e17366d..8ab7b11a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.toml @@ -22,10 +22,16 @@ type = "record" optional = true [blocks.options.fields.tas_filerecord.fields.tas6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-array-series file." -mode = "filein" + +[blocks.options.fields.tas_filerecord.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" [blocks.period.fields.concentration] type = "array" @@ -46,3 +52,10 @@ dtype = "double" shape = [ "ncpl", ] + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.yaml index a33d1d7d..bab78592 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-spca.yaml @@ -27,10 +27,17 @@ blocks: optional: true fields: tas6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-array-series file. - mode: filein + tas6_filename: + type: file + longname: file name of time series information + description: defines a time-array-series file defining a time-array series that can be used + to assign time-varying values. See the Time-Variable Input section for instructions on using + the time-array series capability. + tagged: false + direction: in period: fields: concentration: @@ -53,3 +60,13 @@ blocks: dtype: double shape: - ncpl + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.json index 3d7a99ab..ba390db5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.json @@ -24,6 +24,7 @@ "time_series_name": { "type": "array", "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.", + "tagged": false, "dtype": "string" } } @@ -61,6 +62,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double", "shape": [ "time_series_name" @@ -75,8 +77,15 @@ "tas_array": { "type": "array", "description": "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.", + "tagged": false, "dtype": "double" } + }, + "header": { + "name": "time_from_model_start", + "type": "double", + "description": "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.toml index 93f39fcf..a57bbdd6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.toml @@ -19,6 +19,7 @@ description = "xxx" [blocks.attributes.fields.time_series_namerecord.fields.time_series_name] type = "array" 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." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord] @@ -52,6 +53,7 @@ description = " xxx" [blocks.attributes.fields.sfacrecord.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" shape = [ "time_series_name", @@ -60,4 +62,11 @@ shape = [ [blocks.time.fields.tas_array] type = "array" description = "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false dtype = "double" + +[blocks.time.header] +name = "time_from_model_start" +type = "double" +description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.yaml index 9ec4b0d7..49e69fc2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tas.yaml @@ -21,6 +21,7 @@ blocks: type: array 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. + tagged: false dtype: string interpolation_methodrecord: type: record @@ -50,6 +51,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double shape: - time_series_name @@ -59,4 +61,11 @@ blocks: type: array description: An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility. + tagged: false dtype: double + header: + name: time_from_model_start + type: double + description: A numeric time relative to the start of the simulation, in the time unit used in the + simulation. Times must be strictly increasing. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.json index 31a2c136..13617494 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.json @@ -24,6 +24,7 @@ "time_series_names": { "type": "array", "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.", + "tagged": false, "dtype": "string" } } @@ -40,6 +41,7 @@ "interpolation_method": { "type": "array", "description": "Interpolation method, which is either STEPWISE or LINEAR.", + "tagged": false, "dtype": "string" } } @@ -75,6 +77,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double" } } @@ -87,6 +90,7 @@ "sfacval": { "type": "array", "description": "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.", + "tagged": false, "dtype": "double" } } @@ -114,6 +118,7 @@ "ts_array": { "type": "array", "description": "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.", + "tagged": false, "dtype": "double", "shape": [ "interpolation_method" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.toml index 3b5ac685..65d0e22c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.toml @@ -19,6 +19,7 @@ description = "xxx" [blocks.attributes.fields.time_series_namerecord.fields.time_series_names] type = "array" 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." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord] @@ -33,6 +34,7 @@ description = " xxx" [blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] type = "array" description = "Interpolation method, which is either STEPWISE or LINEAR." +tagged = false dtype = "string" [blocks.attributes.fields.interpolation_methodrecord_single] @@ -66,6 +68,7 @@ description = " xxx" [blocks.attributes.fields.sfacrecord.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" [blocks.attributes.fields.sfacrecord_single] @@ -76,6 +79,7 @@ optional = true [blocks.attributes.fields.sfacrecord_single.fields.sfacval] type = "array" description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false dtype = "double" [blocks.attributes.fields.sfac] @@ -98,6 +102,7 @@ tagged = false [blocks.timeseries.fields.timeseries.item.fields.ts_array] type = "array" description = "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false dtype = "double" shape = [ "interpolation_method", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.yaml index a0f1cbd5..490fdd04 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-ts.yaml @@ -21,6 +21,7 @@ blocks: type: array 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. + tagged: false dtype: string interpolation_methodrecord: type: record @@ -33,6 +34,7 @@ blocks: interpolation_method: type: array description: Interpolation method, which is either STEPWISE or LINEAR. + tagged: false dtype: string interpolation_methodrecord_single: type: record @@ -61,6 +63,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double sfacrecord_single: type: record @@ -71,6 +74,7 @@ blocks: type: array description: Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0. + tagged: false dtype: double sfac: type: keyword @@ -93,6 +97,7 @@ blocks: type: array description: A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility. + tagged: false dtype: double shape: - interpolation_method diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.json index 796b6eb1..77cc08ea 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.json @@ -18,10 +18,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -38,6 +44,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -70,6 +77,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.toml index 19564ca6..2dfa441e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.toml @@ -15,10 +15,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.period.fields.perioddata] type = "list" @@ -30,6 +36,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -56,3 +63,10 @@ type = "double" longname = "hydraulic conductivity of third ellipsoid axis (L/T)" description = "is the new value to be assigned as the cell's hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK NPF package option is specified) from the start of the specified stress period, as per K33 in the NPF package. For an unrotated case, this is the vertical hydraulic conductivity. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.yaml index e584aee2..005ad321 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvk.yaml @@ -17,10 +17,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in period: fields: perioddata: @@ -36,6 +43,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -75,3 +83,13 @@ blocks: can be obtained from a time series by entering the time-series name in place of a numeric value. time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.json b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.json index eb6926a2..b731f4ae 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.json @@ -24,10 +24,16 @@ "optional": true, "fields": { "ts6": { - "type": "file", + "type": "keyword", "longname": "head keyword", - "description": "keyword to specify that record corresponds to a time-series file.", - "mode": "filein" + "description": "keyword to specify that record corresponds to a time-series file." + }, + "ts6_filename": { + "type": "file", + "longname": "file name of time series information", + "description": "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability.", + "tagged": false, + "direction": "in" } } } @@ -44,6 +50,7 @@ "type": "array", "longname": "cell identifier", "description": "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell.", + "tagged": false, "dtype": "integer", "shape": [ "ncelldim" @@ -70,6 +77,13 @@ } } } + }, + "header": { + "name": "iper", + "type": "integer", + "longname": "stress period number", + "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", + "tagged": false } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.toml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.toml index fb9d7021..9e6723d7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.toml @@ -21,10 +21,16 @@ type = "record" optional = true [blocks.options.fields.ts_filerecord.fields.ts6] -type = "file" +type = "keyword" longname = "head keyword" description = "keyword to specify that record corresponds to a time-series file." -mode = "filein" + +[blocks.options.fields.ts_filerecord.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" [blocks.period.fields.perioddata] type = "list" @@ -36,6 +42,7 @@ type = "record" type = "array" longname = "cell identifier" description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false dtype = "integer" shape = [ "ncelldim", @@ -56,3 +63,10 @@ type = "double" longname = "specific yield" description = "is the new value to be assigned as the cell's specific yield from the start of the specified stress period, as per SY in the STO package. Specific yield values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." time_series = true + +[blocks.period.header] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.yaml index 4659f728..d5184fd5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev3/utl-tvs.yaml @@ -25,10 +25,17 @@ blocks: optional: true fields: ts6: - type: file + type: keyword longname: head keyword description: keyword to specify that record corresponds to a time-series file. - mode: filein + ts6_filename: + type: file + longname: file name of time series information + description: defines a time-series file defining time series that can be used to assign time-varying + values. See the 'Time-Variable Input' section for instructions on using the time-series + capability. + tagged: false + direction: in period: fields: perioddata: @@ -44,6 +51,7 @@ blocks: row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. + tagged: false dtype: integer shape: - ncelldim @@ -71,3 +79,13 @@ blocks: the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. time_series: true + header: + name: iper + type: integer + longname: stress period number + description: integer value specifying the starting stress period number for which the data specified + in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater + than zero. The IPER value assigned to a stress period block must be greater than the IPER value + assigned for the previous PERIOD block. The information specified in the PERIOD block will continue + to apply for all subsequent stress periods, unless the program encounters another PERIOD block. + tagged: false diff --git a/autotest/dfns/test_schema.py b/autotest/dfns/test_schema.py index 0d1b9c16..4e997ca7 100644 --- a/autotest/dfns/test_schema.py +++ b/autotest/dfns/test_schema.py @@ -11,6 +11,7 @@ MemoryScalar, Model, Package, + Record, Simulation, ) @@ -334,6 +335,95 @@ def test_memory_output_attributes_rcha(dev3_spec): assert simvals.output is True +def test_render_respects_tagged_scalars_in_record(dev3_spec): + """Tagged Integer/String subfields of a Record must keep their keyword on render().""" + render = dev3_spec.components["gwf-oc"].blocks["options"].render() + assert "HEAD PRINT_FORMAT COLUMNS WIDTH DIGITS " in render + + +def test_render_respects_untagged_arrays_in_record(dev3_spec): + """Untagged Array subfields of a Record (e.g. cellid) must render without a keyword.""" + render = dev3_spec.components["gwf-chd"].blocks["period"].render() + assert " " in render + assert "CELLID" not in render + + +def test_block_header_scalar(dev3_spec): + """A block_variable scalar (e.g. iper) attaches to the block as `header`, not a body field.""" + period = dev3_spec.components["gwf-wel"].blocks["period"] + assert "iper" not in period.fields + assert isinstance(period.header, Integer) + assert period.header.name == "iper" + assert period.header.tagged is False + + +def test_block_header_record(dev3_spec): + """A block_variable record (e.g. utl-obs's `output`) attaches to the block as `header`.""" + continuous = dev3_spec.components["utl-obs"].blocks["continuous"] + assert "output" not in continuous.fields + assert isinstance(continuous.header, Record) + assert continuous.header.name == "output" + + +def test_get_fields_and_get_block_include_header(dev3_spec): + """get_fields()/get_block() must see block.header, not just block.fields.""" + wel = dev3_spec.components["gwf-wel"] + fields = wel.get_fields(recurse=True) + assert "iper" in fields + assert fields["iper"].tagged is False + assert wel.get_block("iper") is wel.blocks["period"] + + +def test_render_block_header_scalar(dev3_spec): + """render() attaches a scalar header to the BEGIN line, matching mf6io.pdf.""" + render = dev3_spec.components["gwf-wel"].blocks["period"].render() + assert render.startswith("BEGIN PERIOD \n") + + +def test_render_block_header_record(dev3_spec): + """render() attaches a record header to the BEGIN line, matching mf6io.pdf.""" + render = dev3_spec.components["utl-obs"].blocks["continuous"].render() + assert render.startswith("BEGIN CONTINUOUS FILEOUT [BINARY]\n") + + +def test_render_file_field_named_after_path_not_tag(dev3_spec): + """The File placeholder is named after the v1 path subfield, matching mf6io.pdf + (e.g. ), not the tag keyword (e.g. ).""" + render = dev3_spec.components["gwf-wel"].blocks["options"].render() + assert "AUTO_FLOW_REDUCE_CSV FILEOUT " in render + + +def test_file_filerecord_not_collapsed(dev3_spec): + """A v1 filerecord stays a Record of {tag Keyword(s), path File}; the tag + keyword isn't folded into the File field itself (no File.tag).""" + afrcsv = dev3_spec.components["gwf-wel"].blocks["options"].fields["afrcsv_filerecord"] + assert isinstance(afrcsv, Record) + assert list(afrcsv.fields.keys()) == ["auto_flow_reduce_csv", "afrcsvfile"] + + tag_field = afrcsv.fields["auto_flow_reduce_csv"] + assert tag_field.type == "keyword" + + file_field = afrcsv.fields["afrcsvfile"] + assert file_field.type == "file" + assert file_field.tagged is False + assert file_field.direction == "out" + assert not hasattr(file_field, "tag") + + +def test_file_filerecord_multiword_tag_not_collapsed(dev3_spec): + """A multi-word v1 tag (e.g. `CROSS_SECTION TAB6`) becomes two sibling + Keyword fields, not a single synthetic File.tag string.""" + period = dev3_spec.components["gwf-sfr"].blocks["period"] + item = period.fields["perioddata"].item + union = item.children["sfrsetting"] + xsrecord = union.arms["cross_sectionrecord"] + assert isinstance(xsrecord, Record) + assert list(xsrecord.fields.keys()) == ["cross_section", "tab6", "tab6_filename"] + assert xsrecord.fields["cross_section"].type == "keyword" + assert xsrecord.fields["tab6"].type == "keyword" + assert xsrecord.fields["tab6_filename"].direction == "in" + + def test_memory_output_attributes_chd_no_to_mvr(dev3_spec): """CHD does not support the Water Mover provider role; simtomvr has no budget.""" chd = dev3_spec.components["gwf-chd"] diff --git a/docs/md/dfns.md b/docs/md/dfns.md index c9958807..c3b92114 100644 --- a/docs/md/dfns.md +++ b/docs/md/dfns.md @@ -174,6 +174,7 @@ from modflow_devtools.dfns import Block, Keyword, Double, List, Record period = gwf_chd.blocks["period"] assert period.repeats is True +assert period.header.name == "iper" spd = period.fields["stress_period_data"] assert isinstance(spd, List) @@ -216,13 +217,15 @@ print(wel.blocks["options"].render()) # END OPTIONS print(wel.blocks["period"].render()) -# BEGIN PERIOD +# BEGIN PERIOD # [] [] # [] [] # ... # END PERIOD ``` +A block whose `header` is set (see [`header`](dfnspec.md#header)) has that field's token attached to the `BEGIN` line rather than rendered as a body row — `` above comes from `wel.blocks["period"].header`, not `.fields`. + `ComponentBase.render()` renders all blocks joined by blank lines: ```python @@ -235,7 +238,7 @@ print(wel.render()) # ... # END DIMENSIONS # -# BEGIN PERIOD +# BEGIN PERIOD # ... # END PERIOD ``` @@ -247,7 +250,8 @@ Rendering rules by field type: | `Keyword` | `KEYWORD` | `KEYWORD` | | `String` / `Integer` / `Double` (tagged) | `NAME ` | `` | | `String` / `Integer` / `Double` (untagged) | `` | `` | -| `File` | `NAME FILEIN\|FILEOUT ` | `NAME FILEIN\|FILEOUT ` | +| `File` (tagged) | `NAME FILEIN\|FILEOUT ` | `NAME FILEIN\|FILEOUT ` | +| `File` (untagged) | `FILEIN\|FILEOUT ` | `FILEIN\|FILEOUT ` | | `Array` with shape (READARRAY) | `NAME\n -- READARRAY` | `` | | `Array` without shape (inline) | `NAME ` | `` | | `Record` | children expanded inline | children expanded inline | @@ -256,6 +260,7 @@ Rendering rules by field type: | `List` (single row type) | row repeated twice + `...` | — | | `List` with `Record`-arm `Union` | one row per arm, no `...` | — | | `List` with scalar-arm `Union` | `` twice + `...` | — | +| `Block.header` (any field type) | attached to `BEGIN ` line, inline form | — | Optional fields are wrapped in `[...]`. Array shapes use the abstract dimension names from the specification (e.g. `ncelldim`, `naux`) rather than resolved grid-specific values. diff --git a/docs/md/dfnspec.md b/docs/md/dfnspec.md index a2863050..9146a805 100644 --- a/docs/md/dfnspec.md +++ b/docs/md/dfnspec.md @@ -26,7 +26,7 @@ This document describes the MODFLOW 6 component definition (DFN) system. This sy - [Attributes](#attributes) - [`name`](#name-1) - [`fields`](#fields) - - [`repeats`](#repeats) + - [`header`](#header) - [Field ordering](#field-ordering) - [Fields](#fields-1) - [Shared attributes](#shared-attributes-1) @@ -61,7 +61,7 @@ This document describes the MODFLOW 6 component definition (DFN) system. This sy - [`time_series`](#time_series-2) - [File](#file) - [Type-specific attributes](#type-specific-attributes-5) - - [`mode`](#mode) + - [`direction`](#direction) - [Composites](#composites) - [Array](#array) - [Type-specific attributes](#type-specific-attributes-6) @@ -236,18 +236,13 @@ Blocks are treated differently depending on the structural composition of their `{string: Field} (default: {})`. The block's fields, in definition order. -#### `repeats` +#### `header` -`boolean (default: false)`. Whether the block may appear multiple times in an input file. When true, each occurrence is read independently and associated with a unique label. The canonical repeating block is the period block, whose label is the stress period number. +`Field | null (default: null)`. A field whose token attaches directly to the block's `begin ` line instead of appearing as a body row, e.g. `BEGIN PERIOD `. Its presence means the block may appear multiple times, each occurrence labeled by the header field's value. The canonical repeating block is the period block, whose header is the stress period number `iper`. -A block has no explicit `optional` attribute. Its optionality is derived from its fields: a block is optional if and only if all of its fields are optional (vacuously true for an empty block). This combines with `repeats` to give four configurations: +Unlike `fields`, which is a `{string: Field}` mapping keyed by field name, `header` holds a single `Field` directly since there is at most one per block. -| `repeats` | derived optional | Meaning | -|---|---|---| -| `false` | `false` | must appear exactly once | -| `false` | `true` | may appear at most once | -| `true` | `false` | must appear at least once | -| `true` | `true` | may appear zero or more times | +A block has no explicit `optional` attribute. Its optionality is derived from its fields: a block is optional if and only if all of its fields are optional (vacuously true for an empty block). ### Field ordering @@ -404,13 +399,15 @@ Type `double`. #### File -Type `file`. +Type `file`. A path to another file. + +If a file option is introduced by one or more leading keywords (e.g. `CROSS_SECTION TAB6` before `FILEIN `), those keywords are ordinary `Keyword` fields alongside the `File` field in the enclosing `Record`, in declaration order -- `File` carries no keyword/tag data of its own. An exception: `prt-fmi`'s `GWFHEAD`/`GWFBUDGET`/`GWFGRID` fields have no enclosing record, so they're directly `tagged: true`, using their own `name` as the tag like any other tagged scalar field. ##### Type-specific attributes -###### `mode` +###### `direction` -`"filein" | "fileout"`. Whether the path is to an input or output file. Required. +`"in" | "out"`. Whether the program reads or writes the file. Required. ### Composites diff --git a/modflow_devtools/dfns/migrate_to_v2_0_0_dev2.py b/modflow_devtools/dfns/migrate_to_v2_0_0_dev2.py index 270f2ea0..dc822087 100644 --- a/modflow_devtools/dfns/migrate_to_v2_0_0_dev2.py +++ b/modflow_devtools/dfns/migrate_to_v2_0_0_dev2.py @@ -963,7 +963,7 @@ def _fix_prt_fmi(component: v2.Component) -> v2.Component: if block is None: return component new_fields = { - name: v2.File(name=name, longname=longname, optional=True, tagged=True, mode="filein") + name: v2.File(name=name, longname=longname, optional=True, tagged=True, direction="in") for name, longname in ( ("gwfhead", "gwf head file"), ("gwfbudget", "gwf budget file"), @@ -1060,7 +1060,7 @@ def _parse_shape(s: str) -> list[str]: for fi in fields.values(multi=True) if fi["name"] == col_name and fi["type"] == "integer" - and fi.get("in_record", False) + and try_parse_bool(fi.get("in_record", False)) ), None, ) @@ -1141,7 +1141,7 @@ def _row_field() -> v2.Record | v2.Union: fi["type"] for fi in fields.values(multi=True) if fi["name"] in item_names - and fi.get("in_record", False) + and try_parse_bool(fi.get("in_record", False)) and fi.get("block") == f.get("block") ] @@ -1174,7 +1174,7 @@ def _row_field() -> v2.Record | v2.Union: fi["name"]: _map_field(fi) for fi in fields.values(multi=True) if fi["name"] in item_names - and fi.get("in_record", False) + and try_parse_bool(fi.get("in_record", False)) and fi.get("block") == f.get("block") } first = next(iter(children.values())) @@ -1194,7 +1194,7 @@ def _subfield_map() -> dict: for fi in fields.values(multi=True): if ( fi["name"] == rname - and fi.get("in_record", False) + and try_parse_bool(fi.get("in_record", False)) and fi.get("block") == f.get("block") ): result[rname] = _map_field(fi) @@ -1251,9 +1251,15 @@ def _subfield_map() -> dict: break if file_mode: - # Filerecord pattern: - # In v2: drop the mode keyword and the untagged path string; promote - # the tag keyword to a File field (tagged=True, name=tag keyword name). + # Filerecord pattern: [...]. + # The mode keyword and path string together denote one File value; + # tag keyword(s) before it and flag keyword(s) after it are ordinary + # sibling fields, mapped like any other tagged Record subfield -- no + # special-casing needed for render() to reconstruct the v1 text + # exactly (e.g. utl-obs's untagged `output` record already worked + # this way: `FILEOUT [BINARY]`). + mode_idx = subnames.index(file_mode) + path_field_name: str | None = None for sname in subnames: if sname == file_mode: @@ -1274,11 +1280,8 @@ def _subfield_map() -> dict: path_field_name = sname break - rec_fields: dict[str, v2.Field] = {} - for rname in subnames: - if rname in (file_mode, path_field_name): - continue # drop mode keyword and path string - m = next( + def _lookup(rname: str) -> dict | None: + return next( ( fi for fi in fields.values(multi=True) @@ -1288,22 +1291,30 @@ def _subfield_map() -> dict: ), None, ) - if m is None: - continue - ftype = (m.get("type") or "").strip() - if ftype == "keyword": - rec_fields[rname] = v2.File( - name=rname, + + rec_fields: dict[str, v2.Field] = {} + for i, sname in enumerate(subnames): + if i == mode_idx: + continue # folded into the File field at the path's position + if sname == path_field_name: + m = _lookup(sname) + if m is None: + continue + rec_fields[sname] = v2.File( + name=sname, longname=m.get("longname") or None, description=m.get("description") or None, optional=try_parse_bool(m.get("optional"), False), developmode=try_parse_bool(m.get("developmode"), False), netcdf=try_parse_bool(m.get("netcdf"), False), - tagged=True, - mode=file_mode, # type: ignore[arg-type] + tagged=False, + direction="in" if file_mode == "filein" else "out", ) - else: - rec_fields[rname] = _map_field(m) # type: ignore + continue + m = _lookup(sname) + if m is None: + continue + rec_fields[sname] = _map_field(m) # type: ignore else: rec_fields = _subfield_map() @@ -1337,6 +1348,7 @@ def _subfield_map() -> dict: default=default, developmode=developmode, netcdf=netcdf, + tagged=tagged, time_series=time_series, dtype="string", shape=[], @@ -1353,6 +1365,7 @@ def _subfield_map() -> dict: default=default, developmode=developmode, netcdf=netcdf, + tagged=tagged, time_series=time_series, dtype=dtype, shape=parsed_shape, @@ -1363,13 +1376,17 @@ def _subfield_map() -> dict: blocks: dict[str, v2.Block] = {} for field in fields.values(multi=True): - if field.get("in_record", False): + block = blocks.setdefault(field["block"], v2.Block(name=field["block"], fields={})) + if try_parse_bool(field.get("block_variable", False)): + # Field's token(s) attach to the BEGIN line itself (e.g. `BEGIN + # PERIOD `) rather than appearing as a body row. Must be checked + # before the in_record skip below: block-attached scalars are marked + # in_record=true in v1 even though they aren't a record subfield. + block.header = _map_field(field) + continue + if try_parse_bool(field.get("in_record", False)): continue # record subfields are handled recursively - v2_field = _map_field(field) - blocks.setdefault(field["block"], v2.Block(name=field["block"], fields={})).fields[ - field["name"] - ] = v2_field - blocks[field["block"]].repeats = try_parse_bool(field.get("block_variable"), False) + block.fields[field["name"]] = _map_field(field) blocks, array_dims = _resolve_dimensions(blocks) blocks = _resolve_relations(blocks) diff --git a/modflow_devtools/dfns/schema.json b/modflow_devtools/dfns/schema.json index 4a275ede..60237a85 100644 --- a/modflow_devtools/dfns/schema.json +++ b/modflow_devtools/dfns/schema.json @@ -168,10 +168,59 @@ "title": "Fields", "type": "object" }, - "repeats": { - "default": false, - "title": "Repeats", - "type": "boolean" + "header": { + "anyOf": [ + { + "discriminator": { + "mapping": { + "array": "#/$defs/Array", + "double": "#/$defs/Double", + "file": "#/$defs/File", + "integer": "#/$defs/Integer", + "keyword": "#/$defs/Keyword", + "list": "#/$defs/List", + "record": "#/$defs/Record", + "string": "#/$defs/String", + "union": "#/$defs/Union" + }, + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/$defs/Keyword" + }, + { + "$ref": "#/$defs/String" + }, + { + "$ref": "#/$defs/Integer" + }, + { + "$ref": "#/$defs/Double" + }, + { + "$ref": "#/$defs/File" + }, + { + "$ref": "#/$defs/Array" + }, + { + "$ref": "#/$defs/Record" + }, + { + "$ref": "#/$defs/Union" + }, + { + "$ref": "#/$defs/List" + } + ] + }, + { + "type": "null" + } + ], + "default": null, + "title": "Header" } }, "required": [ @@ -182,7 +231,7 @@ "type": "object" }, "Dim": { - "description": "A named dimension backed by a field reference or derived from an expression.\n\n``value`` is a Python expression string:\n - bare identifier ``nlay`` \u2192 integer field reference\n - ``len(auxiliary)`` \u2192 self-sizing array field reference\n - anything else, e.g. ``nlay * ncol`` \u2192 derived arithmetic expression\n\nIf ``value`` is None, the dimension is runtime-only: its value cannot be\nderived from DFN input fields. ``set_in`` then indicates the simulation phase\nin which the value is first established by MODFLOW (e.g. ``\"ar\"`` for dims\nset during grid allocation, ``\"rp\"`` for dims reset each stress period).\n\nRuntime dims are valid in memory variable shapes but not in input field shapes,\nsince a sequential parser must know an array's size before reading it.", + "description": "A named dimension backed by a field reference or derived from an expression.\n\n``value`` is a Python expression string:\n - bare identifier ``nlay`` \u2192 integer field reference\n - ``len(auxiliary)`` \u2192 self-sizing array field reference\n - anything else, e.g. ``nlay * ncol`` \u2192 derived arithmetic expression\n\nIf ``value`` is None, the dimension is runtime-only: its value cannot be\nderived from DFN input fields. ``set_in`` then indicates the simulation hook\nin which the value is first established by MODFLOW (e.g. ``\"ar\"`` for dims\nset during grid allocation, ``\"rp\"`` for dims reset each stress period).\n\nRuntime dims are valid in memory variable shapes but not in input field shapes,\nsince a sequential parser must know an array's size before reading it.", "properties": { "value": { "anyOf": [ @@ -375,18 +424,18 @@ "title": "Type", "type": "string" }, - "mode": { + "direction": { "enum": [ - "filein", - "fileout" + "in", + "out" ], - "title": "Mode", + "title": "Direction", "type": "string" } }, "required": [ "name", - "mode" + "direction" ], "title": "File", "type": "object" @@ -771,9 +820,6 @@ { "type": "boolean" }, - { - "type": "string" - }, { "type": "null" } @@ -915,9 +961,6 @@ { "type": "boolean" }, - { - "type": "string" - }, { "type": "null" } diff --git a/modflow_devtools/dfns/schema.py b/modflow_devtools/dfns/schema.py index a72d975b..f6798aaf 100644 --- a/modflow_devtools/dfns/schema.py +++ b/modflow_devtools/dfns/schema.py @@ -81,7 +81,9 @@ class Double(FieldBase): class File(FieldBase): type: Literal["file"] = PydanticField(default="file", frozen=True) - mode: Literal["filein", "fileout"] + # Whether MF6 reads ("in") or writes ("out") the file. Independent of any + # particular serialization's keyword vocabulary (v1 text uses FILEIN/FILEOUT). + direction: Literal["in", "out"] Scalar = Annotated[ @@ -160,18 +162,29 @@ def _render_shape(field: "Array") -> str: return f"({', '.join(field.shape)})" if field.shape else "" +def _render_file(field: "File") -> str: + keyword = "FILEIN" if field.direction == "in" else "FILEOUT" + if not field.tagged: + return f"{keyword} <{field.name}>" + return f"{field.name.upper()} {keyword} <{field.name}>" + + +def _tag(field: "Field", inner: str) -> str: + """Prefix `inner` with the field's uppercased name if it's tagged.""" + return f"{field.name.upper()} {inner}" if field.tagged else inner + + def _render_inline(field: "Field") -> str: """Render a field as a token within a record row.""" match field: case Keyword(): token = field.name.upper() case Array(): - token = f"<{field.name}{_render_shape(field)}>" + token = _tag(field, f"<{field.name}{_render_shape(field)}>") case String() | Integer() | Double(): - token = f"<{field.name}>" + token = _tag(field, f"<{field.name}>") case File(): - # file name (uppercased) acts as the keyword in the record row - token = f"{field.name.upper()} {field.mode.upper()} <{field.name}>" + token = _render_file(field) case Record(): token = " ".join(_render_inline(f) for f in field.fields.values()) case Union(): @@ -211,16 +224,14 @@ def _wrap(token: str) -> str: case Keyword(): return f"{indent}{_wrap(field.name.upper())}" case String() | Integer() | Double(): - inner = f"{field.name.upper()} <{field.name}>" if field.tagged else f"<{field.name}>" - return f"{indent}{_wrap(inner)}" + return f"{indent}{_wrap(_tag(field, f'<{field.name}>'))}" case File(): - return f"{indent}{_wrap(f'{field.mode.upper()} <{field.name}>')}" + return f"{indent}{_wrap(_render_file(field))}" case Array(): if field.shape: body = f"{field.name.upper()}\n{indent} <{field.name}{_render_shape(field)}> -- READARRAY" # noqa: E501 return f"{indent}{_wrap(body)}" - inner = f"{field.name.upper()} <{field.name}>" if field.tagged else f"<{field.name}>" - return f"{indent}{_wrap(inner)}" + return f"{indent}{_wrap(_tag(field, f'<{field.name}>'))}" case Record(): return f"{indent}{_wrap(' '.join(_render_inline(f) for f in field.fields.values()))}" case Union(): @@ -242,7 +253,10 @@ def _wrap(token: str) -> str: def _render_block(block: "Block") -> str: """Render a Block as a BEGIN/END template string.""" - lines = [f"BEGIN {block.name.upper()}"] + begin = f"BEGIN {block.name.upper()}" + if block.header is not None: + begin = f"{begin} {_render_inline(block.header)}" + lines = [begin] for field in block.fields.values(): lines.append(_render_field(field)) lines.append(f"END {block.name.upper()}") @@ -473,7 +487,7 @@ def _resolve_derived_dims(component: "ComponentBase", known_dims: set[str]) -> l class Block(BaseModel): name: str fields: dict[str, Field] - repeats: bool = False + header: "Field | None" = None @model_validator(mode="after") def _check_field_order(self) -> "Block": @@ -496,6 +510,11 @@ def _check_field_order(self) -> "Block": def _serialize(self, handler: Any) -> dict[str, Any]: data = handler(self) data.pop("name", None) # name is the dict key in ComponentBase.blocks + # Unlike `fields`, `header` isn't stored in a name-keyed dict, so its + # `name` (stripped by FieldBase._serialize under strip_names) must be + # restored here or it can't be recovered on load. + if self.header is not None and isinstance(data.get("header"), dict): + data["header"] = {"name": self.header.name, **data["header"]} return data def dump(self, *, strip_names: bool = True, **kwargs) -> dict[str, Any]: @@ -512,6 +531,11 @@ def dump_json(self, *, strip_names: bool = True, **kwargs) -> str: def optional(self) -> bool: return all(f.optional for f in self.fields.values()) + @property + def repeats(self) -> bool: + """Whether the block may appear multiple times, each labeled by `header`.""" + return self.header is not None + def render(self) -> str: return _render_block(self) @@ -592,11 +616,15 @@ def _collect(fields: dict) -> None: for block in (self.blocks or {}).values(): _collect(block.fields) + if block.header is not None: + _collect({block.header.name: block.header}) return OMD(items) def get_block(self, field_name: str) -> Block | None: for block in (self.blocks or {}).values(): - if block.fields.get(field_name, None): + if block.fields.get(field_name, None) or ( + block.header is not None and block.header.name == field_name + ): return block return None @@ -1077,6 +1105,13 @@ def _inject_names(comp_data: dict) -> None: for block_name, block in (comp_data.get("blocks") or {}).items(): block.setdefault("name", block_name) _inject_field_names(block.get("fields") or {}) + header = block.get("header") + if isinstance(header, dict): + # header's own name is preserved verbatim by Block._serialize (it + # isn't stored in a name-keyed dict like `fields`); only its nested + # children need names injected from their dict keys. + _inject_field_names(header.get("fields") or {}) + _inject_field_names(header.get("arms") or {}) class Dfns(BaseModel):