diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.json b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.json index 5768182c..34ffd4bc 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.json @@ -22,10 +22,43 @@ }, "grb_filerecord": { "block": "options", - "type": "record grb6 fileout grb6_filename", + "type": "record", "reader": "urword", "optional": true, - "tagged": true + "tagged": true, + "fields": { + "grb6": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "grb keyword", + "description": "keyword to specify that record corresponds to a binary grid file.", + "in_record": true, + "tagged": true + }, + "fileout": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "keyword to specify that an output filename is expected next.", + "in_record": true, + "tagged": true + }, + "grb6_filename": { + "block": "options", + "type": "string", + "reader": "urword", + "optional": false, + "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'.", + "preserve_case": true, + "in_record": true, + "tagged": false + } + } }, "xorigin": { "block": "options", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.toml b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.toml index f78e024f..bea613fd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.toml @@ -21,11 +21,42 @@ description = "keyword to deactivate writing of the binary grid file." [options.grb_filerecord] block = "options" -type = "record grb6 fileout grb6_filename" +type = "record" reader = "urword" optional = true tagged = true +[options.grb_filerecord.fields.grb6] +block = "options" +type = "keyword" +reader = "urword" +optional = false +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +in_record = true +tagged = true + +[options.grb_filerecord.fields.fileout] +block = "options" +type = "keyword" +reader = "urword" +optional = false +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." +in_record = true +tagged = true + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +type = "string" +reader = "urword" +optional = false +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'." +preserve_case = true +in_record = true +tagged = false + [options.xorigin] block = "options" type = "double precision" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.yaml index 6732b55e..14f3b753 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-disv1d.yaml @@ -20,10 +20,40 @@ options: description: keyword to deactivate writing of the binary grid file. grb_filerecord: block: options - type: record grb6 fileout grb6_filename + type: record reader: urword optional: true tagged: true + fields: + grb6: + block: options + type: keyword + reader: urword + optional: false + longname: grb keyword + description: keyword to specify that record corresponds to a binary grid file. + in_record: true + tagged: true + fileout: + block: options + type: keyword + reader: urword + optional: false + longname: file keyword + description: keyword to specify that an output filename is expected next. + in_record: true + tagged: true + grb6_filename: + block: options + type: string + reader: urword + optional: false + 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'. + preserve_case: true + in_record: true + tagged: false xorigin: block: options type: double precision diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.json index 62032f93..412d744c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.json @@ -39,11 +39,30 @@ }, "newtonoptions": { "block": "options", - "type": "record newton under_relaxation", + "type": "record", "reader": "urword", "optional": true, "longname": "newton keyword and options", - "description": "none" + "description": "none", + "fields": { + "newton": { + "block": "options", + "type": "keyword", + "reader": "urword", + "longname": "keyword to activate Newton-Raphson formulation", + "description": "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms.", + "in_record": true + }, + "under_relaxation": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": true, + "longname": "keyword to activate Newton-Raphson UNDER_RELAXATION option", + "description": "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied.", + "in_record": true + } + } } }, "packages": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.toml index 9063659e..d38bee4a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.toml @@ -38,12 +38,29 @@ description = "keyword to indicate that all model package flow terms will be wri [options.newtonoptions] block = "options" -type = "record newton under_relaxation" +type = "record" reader = "urword" optional = true longname = "newton keyword and options" description = "none" +[options.newtonoptions.fields.newton] +block = "options" +type = "keyword" +reader = "urword" +longname = "keyword to activate Newton-Raphson formulation" +description = "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms." +in_record = true + +[options.newtonoptions.fields.under_relaxation] +block = "options" +type = "keyword" +reader = "urword" +optional = true +longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" +description = "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." +in_record = true + [packages.packages] block = "packages" type = "recarray" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.yaml index 5d625fe4..db4b8708 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-nam.yaml @@ -41,11 +41,30 @@ options: with 'BUDGET FILEOUT' in Output Control. newtonoptions: block: options - type: record newton under_relaxation + type: record reader: urword optional: true longname: newton keyword and options description: none + fields: + newton: + block: options + type: keyword + reader: urword + longname: keyword to activate Newton-Raphson formulation + description: keyword that activates the Newton-Raphson formulation for surface water flow between + connected reaches and stress packages that support calculation of Newton-Raphson terms. + in_record: true + under_relaxation: + block: options + type: keyword + reader: urword + optional: true + longname: keyword to activate Newton-Raphson UNDER_RELAXATION option + description: keyword that indicates whether the surface water stage in a reach will be under-relaxed + when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson + UNDER_RELAXATION is not applied. + in_record: true packages: packages: block: packages diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-oc.json index 225f6501..0434475a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev0/chf-oc.json @@ -6,59 +6,353 @@ "options": { "budget_filerecord": { "block": "options", - "type": "record budget fileout budgetfile", + "type": "record", "reader": "urword", "optional": true, "tagged": true, - "mf6internal": "budfilerec" + "mf6internal": "budfilerec", + "fields": { + "budget": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "budget keyword", + "description": "keyword to specify that record corresponds to the budget.", + "in_record": true, + "tagged": true + }, + "fileout": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "keyword to specify that an output filename is expected next.", + "in_record": true, + "tagged": true + }, + "budgetfile": { + "block": "options", + "type": "string", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "name of the output file to write budget information.", + "preserve_case": true, + "in_record": true, + "tagged": false + } + } }, "budgetcsv_filerecord": { "block": "options", - "type": "record budgetcsv fileout budgetcsvfile", + "type": "record", "reader": "urword", "optional": true, "tagged": true, - "mf6internal": "budcsvfilerec" + "mf6internal": "budcsvfilerec", + "fields": { + "fileout": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "keyword to specify that an output filename is expected next.", + "in_record": true, + "tagged": true + }, + "budgetcsv": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "budget keyword", + "description": "keyword to specify that record corresponds to the budget CSV.", + "in_record": true, + "tagged": true + }, + "budgetcsvfile": { + "block": "options", + "type": "string", + "reader": "urword", + "optional": false, + "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.", + "preserve_case": true, + "in_record": true, + "tagged": false + } + } }, "qoutflow_filerecord": { "block": "options", - "type": "record qoutflow fileout qoutflowfile", + "type": "record", "reader": "urword", "optional": true, "tagged": true, - "mf6internal": "qoutfilerec" + "mf6internal": "qoutfilerec", + "fields": { + "fileout": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "keyword to specify that an output filename is expected next.", + "in_record": true, + "tagged": true + }, + "qoutflow": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "qoutflow keyword", + "description": "keyword to specify that record corresponds to qoutflow.", + "in_record": true, + "tagged": true + }, + "qoutflowfile": { + "block": "options", + "type": "string", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "name of the output file to write conc information.", + "preserve_case": true, + "in_record": true, + "tagged": false + } + } }, "stage_filerecord": { "block": "options", - "type": "record stage fileout stagefile", + "type": "record", "reader": "urword", "optional": true, "tagged": true, - "mf6internal": "stagefilerec" + "mf6internal": "stagefilerec", + "fields": { + "fileout": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "keyword to specify that an output filename is expected next.", + "in_record": true, + "tagged": true + }, + "stage": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "stage keyword", + "description": "keyword to specify that record corresponds to stage.", + "in_record": true, + "tagged": true + }, + "stagefile": { + "block": "options", + "type": "string", + "reader": "urword", + "optional": false, + "longname": "file keyword", + "description": "name of the output file to write stage information.", + "preserve_case": true, + "in_record": true, + "tagged": false + } + } }, "qoutflowprintrecord": { "block": "options", - "type": "record qoutflow print_format formatrecord", + "type": "record", "reader": "urword", "optional": true, - "mf6internal": "qoutprintrec" + "mf6internal": "qoutprintrec", + "fields": { + "qoutflow": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "qoutflow keyword", + "description": "keyword to specify that record corresponds to qoutflow.", + "in_record": true, + "tagged": true + }, + "print_format": { + "block": "options", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "keyword to indicate that a print format follows", + "description": "keyword to specify format for printing to the listing file.", + "in_record": true, + "tagged": true + } + } } }, "period": { "transient_block": true, "saverecord": { "block": "period", - "type": "record save rtype ocsetting", + "type": "record", "reader": "urword", "optional": true, - "tagged": false + "tagged": false, + "fields": { + "save": { + "block": "period", + "type": "keyword", + "reader": "urword", + "optional": false, + "longname": "keyword to save", + "description": "keyword to indicate that information will be saved this stress period.", + "in_record": true, + "tagged": true + }, + "rtype": { + "block": "period", + "type": "string", + "reader": "urword", + "optional": false, + "longname": "record type", + "description": "type of information to save or print. Can be BUDGET.", + "in_record": true, + "tagged": false + }, + "ocsetting": { + "block": "period", + "type": "keystring", + "reader": "urword", + "description": "specifies the steps for which the data will be saved.", + "tagged": false, + "in_record": true, + "choices": { + "all": { + "block": "period", + "type": "keyword", + "reader": "urword", + "description": "keyword to indicate save for all time steps in period.", + "in_record": true + }, + "first": { + "block": "period", + "type": "keyword", + "reader": "urword", + "description": "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", + "in_record": true + }, + "last": { + "block": "period", + "type": "keyword", + "reader": "urword", + "description": "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", + "in_record": true + }, + "frequency": { + "block": "period", + "type": "integer", + "reader": "urword", + "description": "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", + "tagged": true, + "in_record": true + }, + "steps": { + "block": "period", + "type": "integer", + "shape": "($ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0.", - "reader": "urword", - "optional": false, - "longname": "horizontal cell width or area for vertical flow", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "exchangedata", - "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.", - "reader": "urword", - "optional": true, - "longname": "auxiliary variables", - "mf6internal": "auxvar", - "type": "double" - }, - "boundname": { - "block": "exchangedata", - "description": "name of the GWE Exchange 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.", - "reader": "urword", - "optional": true, - "longname": "exchange boundname", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.toml index 37e81c5f..e484a899 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.toml @@ -88,14 +88,6 @@ optional = true longname = "xt3d on right-hand side" type = "keyword" -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - [blocks.options.mve_filerecord] block = "options" reader = "urword" @@ -126,22 +118,6 @@ optional = false longname = "mve6 input filename" type = "string" -[blocks.options.mve6] -block = "options" -description = "keyword to specify that record corresponds to an energy transport mover file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.mve6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "mve6 input filename" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -172,22 +148,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.options.dev_interfacemodel_on] block = "options" description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." @@ -288,71 +248,3 @@ reader = "urword" optional = true longname = "exchange boundname" type = "string" - -[blocks.exchangedata.cellidm1] -block = "exchangedata" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of first cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.cellidm2] -block = "exchangedata" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of second cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.ihc] -block = "exchangedata" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -reader = "urword" -optional = false -longname = "integer flag for connection type" -type = "integer" - -[blocks.exchangedata.cl1] -block = "exchangedata" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.cl2] -block = "exchangedata" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.hwva] -block = "exchangedata" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -reader = "urword" -optional = false -longname = "horizontal cell width or area for vertical flow" -type = "double" - -[blocks.exchangedata.aux] -shape = "(naux)" -block = "exchangedata" -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." -reader = "urword" -optional = true -longname = "auxiliary variables" -mf6internal = "auxvar" -type = "double" - -[blocks.exchangedata.boundname] -block = "exchangedata" -description = "name of the GWE Exchange 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." -reader = "urword" -optional = true -longname = "exchange boundname" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.yaml index 8238c9ed..3ac47198 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwegwe.yaml @@ -101,13 +101,6 @@ blocks: optional: true longname: xt3d on right-hand side type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword mve_filerecord: block: options reader: urword @@ -136,21 +129,6 @@ blocks: optional: false longname: mve6 input filename type: string - mve6: - block: options - description: keyword to specify that record corresponds to an energy transport mover file. - reader: urword - optional: false - longname: obs keyword - type: keyword - mve6_filename: - block: options - 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. - reader: urword - optional: false - longname: mve6 input filename - type: string obs_filerecord: block: options reader: urword @@ -180,22 +158,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dev_interfacemodel_on: block: options description: activates the interface model mechanism for calculating the coefficients at (and possibly @@ -309,79 +271,3 @@ blocks: optional: true longname: exchange boundname type: string - cellidm1: - block: exchangedata - description: is the cellid of the cell in model 1 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM1 is the node number for the cell. - reader: urword - optional: false - longname: cellid of first cell - numeric_index: true - type: integer - cellidm2: - block: exchangedata - description: is the cellid of the cell in model 2 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM2 is the node number for the cell. - reader: urword - optional: false - longname: cellid of second cell - numeric_index: true - type: integer - ihc: - block: exchangedata - description: is an integer flag indicating the direction between node n and all of its m connections. - If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If - IHC = 2 then the connection is horizontal for a vertically staggered grid. - reader: urword - optional: false - longname: integer flag for connection type - type: integer - cl1: - block: exchangedata - description: is the distance between the center of cell 1 and the its shared face with cell 2. - reader: urword - optional: false - longname: connection distance - type: double - cl2: - block: exchangedata - description: is the distance between the center of cell 2 and the its shared face with cell 1. - reader: urword - optional: false - longname: connection distance - type: double - hwva: - block: exchangedata - description: is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ - 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell - 2 if IHC = 0. - reader: urword - optional: false - longname: horizontal cell width or area for vertical flow - type: double - aux: - shape: (naux) - block: exchangedata - 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. - reader: urword - optional: true - longname: auxiliary variables - mf6internal: auxvar - type: double - boundname: - block: exchangedata - description: name of the GWE Exchange 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. - reader: urword - optional: true - longname: exchange boundname - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.json index 55230a76..6ef21415 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.json @@ -83,21 +83,6 @@ } } }, - "variablecv": { - "block": "options", - "description": "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation.", - "reader": "urword", - "longname": "keyword to activate VARIABLECV option", - "type": "keyword" - }, - "dewatered": { - "block": "options", - "description": "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top.", - "reader": "urword", - "optional": true, - "longname": "keyword to activate DEWATERED option", - "type": "keyword" - }, "newton": { "block": "options", "description": "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells. Cells will not dry when this option is used.", @@ -146,30 +131,6 @@ } } }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "gnc6": { - "block": "options", - "description": "keyword to specify that record corresponds to a ghost-node correction file.", - "reader": "urword", - "optional": false, - "longname": "gnc6 keyword", - "type": "keyword" - }, - "gnc6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "gnc6 input filename", - "type": "string" - }, "mvr_filerecord": { "block": "options", "reader": "urword", @@ -202,22 +163,6 @@ } } }, - "mvr6": { - "block": "options", - "description": "keyword to specify that record corresponds to a mover file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "mvr6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "mvr6 input filename", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -250,22 +195,6 @@ } } }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" - }, "dev_interfacemodel_on": { "block": "options", "description": "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes.", @@ -374,74 +303,6 @@ } } } - }, - "cellidm1": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of first cell", - "numeric_index": true, - "type": "integer" - }, - "cellidm2": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of second cell", - "numeric_index": true, - "type": "integer" - }, - "ihc": { - "block": "exchangedata", - "description": "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid.", - "reader": "urword", - "optional": false, - "longname": "integer flag for connection type", - "type": "integer" - }, - "cl1": { - "block": "exchangedata", - "description": "is the distance between the center of cell 1 and the its shared face with cell 2.", - "reader": "urword", - "optional": false, - "longname": "connection distance", - "type": "double" - }, - "cl2": { - "block": "exchangedata", - "description": "is the distance between the center of cell 2 and the its shared face with cell 1.", - "reader": "urword", - "optional": false, - "longname": "connection distance", - "type": "double" - }, - "hwva": { - "block": "exchangedata", - "description": "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0.", - "reader": "urword", - "optional": false, - "longname": "horizontal cell width or area for vertical flow", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "exchangedata", - "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.", - "reader": "urword", - "optional": true, - "longname": "auxiliary variables", - "mf6internal": "auxvar", - "type": "double" - }, - "boundname": { - "block": "exchangedata", - "description": "name of the GWF Exchange 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.", - "reader": "urword", - "optional": true, - "longname": "exchange boundname", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.toml index efc9390d..9ddd9484 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.toml @@ -79,21 +79,6 @@ optional = true longname = "keyword to activate DEWATERED option" type = "keyword" -[blocks.options.variablecv] -block = "options" -description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." -reader = "urword" -longname = "keyword to activate VARIABLECV option" -type = "keyword" - -[blocks.options.dewatered] -block = "options" -description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." -reader = "urword" -optional = true -longname = "keyword to activate DEWATERED option" -type = "keyword" - [blocks.options.newton] block = "options" description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells. Cells will not dry when this option is used." @@ -140,30 +125,6 @@ optional = false longname = "gnc6 input filename" type = "string" -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.gnc6] -block = "options" -description = "keyword to specify that record corresponds to a ghost-node correction file." -reader = "urword" -optional = false -longname = "gnc6 keyword" -type = "keyword" - -[blocks.options.gnc6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "gnc6 input filename" -type = "string" - [blocks.options.mvr_filerecord] block = "options" reader = "urword" @@ -194,22 +155,6 @@ optional = false longname = "mvr6 input filename" type = "string" -[blocks.options.mvr6] -block = "options" -description = "keyword to specify that record corresponds to a mover file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.mvr6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "mvr6 input filename" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -240,22 +185,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.options.dev_interfacemodel_on] block = "options" description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." @@ -356,71 +285,3 @@ reader = "urword" optional = true longname = "exchange boundname" type = "string" - -[blocks.exchangedata.cellidm1] -block = "exchangedata" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of first cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.cellidm2] -block = "exchangedata" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of second cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.ihc] -block = "exchangedata" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -reader = "urword" -optional = false -longname = "integer flag for connection type" -type = "integer" - -[blocks.exchangedata.cl1] -block = "exchangedata" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.cl2] -block = "exchangedata" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.hwva] -block = "exchangedata" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -reader = "urword" -optional = false -longname = "horizontal cell width or area for vertical flow" -type = "double" - -[blocks.exchangedata.aux] -shape = "(naux)" -block = "exchangedata" -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." -reader = "urword" -optional = true -longname = "auxiliary variables" -mf6internal = "auxvar" -type = "double" - -[blocks.exchangedata.boundname] -block = "exchangedata" -description = "name of the GWF Exchange 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." -reader = "urword" -optional = true -longname = "exchange boundname" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.yaml index 33af12f2..43103688 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwfgwf.yaml @@ -104,27 +104,6 @@ blocks: optional: true longname: keyword to activate DEWATERED option type: keyword - variablecv: - block: options - description: keyword to indicate that the vertical conductance will be calculated using the saturated - thickness and properties of the overlying cell and the thickness and properties of the underlying - cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated - using only the saturated thickness and properties of the overlying cell if the head in the underlying - cell is below its top. If these keywords are not specified, then the default condition is to - calculate the vertical conductance at the start of the simulation using the initial head and the - cell properties. The vertical conductance remains constant for the entire simulation. - reader: urword - longname: keyword to activate VARIABLECV option - type: keyword - dewatered: - block: options - description: If the DEWATERED keyword is specified, then the vertical conductance is calculated - using only the saturated thickness and properties of the overlying cell if the head in the underlying - cell is below its top. - reader: urword - optional: true - longname: keyword to activate DEWATERED option - type: keyword newton: block: options description: keyword that activates the Newton-Raphson formulation for groundwater flow between @@ -174,32 +153,6 @@ blocks: optional: false longname: gnc6 input filename type: string - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - gnc6: - block: options - description: keyword to specify that record corresponds to a ghost-node correction file. - reader: urword - optional: false - longname: gnc6 keyword - type: keyword - gnc6_filename: - block: options - 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. - reader: urword - optional: false - longname: gnc6 input filename - type: string mvr_filerecord: block: options reader: urword @@ -233,26 +186,6 @@ blocks: optional: false longname: mvr6 input filename type: string - mvr6: - block: options - description: keyword to specify that record corresponds to a mover file. - reader: urword - optional: false - longname: obs keyword - type: keyword - mvr6_filename: - block: options - 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. - reader: urword - optional: false - longname: mvr6 input filename - type: string obs_filerecord: block: options reader: urword @@ -282,22 +215,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dev_interfacemodel_on: block: options description: activates the interface model mechanism for calculating the coefficients at (and possibly @@ -411,79 +328,3 @@ blocks: optional: true longname: exchange boundname type: string - cellidm1: - block: exchangedata - description: is the cellid of the cell in model 1 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM1 is the node number for the cell. - reader: urword - optional: false - longname: cellid of first cell - numeric_index: true - type: integer - cellidm2: - block: exchangedata - description: is the cellid of the cell in model 2 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM2 is the node number for the cell. - reader: urword - optional: false - longname: cellid of second cell - numeric_index: true - type: integer - ihc: - block: exchangedata - description: is an integer flag indicating the direction between node n and all of its m connections. - If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If - IHC = 2 then the connection is horizontal for a vertically staggered grid. - reader: urword - optional: false - longname: integer flag for connection type - type: integer - cl1: - block: exchangedata - description: is the distance between the center of cell 1 and the its shared face with cell 2. - reader: urword - optional: false - longname: connection distance - type: double - cl2: - block: exchangedata - description: is the distance between the center of cell 2 and the its shared face with cell 1. - reader: urword - optional: false - longname: connection distance - type: double - hwva: - block: exchangedata - description: is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ - 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell - 2 if IHC = 0. - reader: urword - optional: false - longname: horizontal cell width or area for vertical flow - type: double - aux: - shape: (naux) - block: exchangedata - 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. - reader: urword - optional: true - longname: auxiliary variables - mf6internal: auxvar - type: double - boundname: - block: exchangedata - description: name of the GWF Exchange 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. - reader: urword - optional: true - longname: exchange boundname - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.json index 5a9c4343..daeeb64b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.json @@ -90,14 +90,6 @@ "longname": "xt3d on right-hand side", "type": "keyword" }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, "mvt_filerecord": { "block": "options", "reader": "urword", @@ -130,22 +122,6 @@ } } }, - "mvt6": { - "block": "options", - "description": "keyword to specify that record corresponds to a transport mover file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "mvt6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "mvt6 input filename", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -178,22 +154,6 @@ } } }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" - }, "dev_interfacemodel_on": { "block": "options", "description": "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes.", @@ -302,74 +262,6 @@ } } } - }, - "cellidm1": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of first cell", - "numeric_index": true, - "type": "integer" - }, - "cellidm2": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of second cell", - "numeric_index": true, - "type": "integer" - }, - "ihc": { - "block": "exchangedata", - "description": "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid.", - "reader": "urword", - "optional": false, - "longname": "integer flag for connection type", - "type": "integer" - }, - "cl1": { - "block": "exchangedata", - "description": "is the distance between the center of cell 1 and the its shared face with cell 2.", - "reader": "urword", - "optional": false, - "longname": "connection distance", - "type": "double" - }, - "cl2": { - "block": "exchangedata", - "description": "is the distance between the center of cell 2 and the its shared face with cell 1.", - "reader": "urword", - "optional": false, - "longname": "connection distance", - "type": "double" - }, - "hwva": { - "block": "exchangedata", - "description": "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0.", - "reader": "urword", - "optional": false, - "longname": "horizontal cell width or area for vertical flow", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "exchangedata", - "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.", - "reader": "urword", - "optional": true, - "longname": "auxiliary variables", - "mf6internal": "auxvar", - "type": "double" - }, - "boundname": { - "block": "exchangedata", - "description": "name of the GWT Exchange 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.", - "reader": "urword", - "optional": true, - "longname": "exchange boundname", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.toml index cc7b6551..0fb70d5f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.toml @@ -88,14 +88,6 @@ optional = true longname = "xt3d on right-hand side" type = "keyword" -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - [blocks.options.mvt_filerecord] block = "options" reader = "urword" @@ -126,22 +118,6 @@ optional = false longname = "mvt6 input filename" type = "string" -[blocks.options.mvt6] -block = "options" -description = "keyword to specify that record corresponds to a transport mover file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.mvt6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "mvt6 input filename" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -172,22 +148,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.options.dev_interfacemodel_on] block = "options" description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." @@ -288,71 +248,3 @@ reader = "urword" optional = true longname = "exchange boundname" type = "string" - -[blocks.exchangedata.cellidm1] -block = "exchangedata" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of first cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.cellidm2] -block = "exchangedata" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of second cell" -numeric_index = true -type = "integer" - -[blocks.exchangedata.ihc] -block = "exchangedata" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -reader = "urword" -optional = false -longname = "integer flag for connection type" -type = "integer" - -[blocks.exchangedata.cl1] -block = "exchangedata" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.cl2] -block = "exchangedata" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -reader = "urword" -optional = false -longname = "connection distance" -type = "double" - -[blocks.exchangedata.hwva] -block = "exchangedata" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -reader = "urword" -optional = false -longname = "horizontal cell width or area for vertical flow" -type = "double" - -[blocks.exchangedata.aux] -shape = "(naux)" -block = "exchangedata" -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." -reader = "urword" -optional = true -longname = "auxiliary variables" -mf6internal = "auxvar" -type = "double" - -[blocks.exchangedata.boundname] -block = "exchangedata" -description = "name of the GWT Exchange 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." -reader = "urword" -optional = true -longname = "exchange boundname" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.yaml index 7274b241..d02e3869 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-gwtgwt.yaml @@ -98,13 +98,6 @@ blocks: optional: true longname: xt3d on right-hand side type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword mvt_filerecord: block: options reader: urword @@ -133,21 +126,6 @@ blocks: optional: false longname: mvt6 input filename type: string - mvt6: - block: options - description: keyword to specify that record corresponds to a transport mover file. - reader: urword - optional: false - longname: obs keyword - type: keyword - mvt6_filename: - block: options - 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. - reader: urword - optional: false - longname: mvt6 input filename - type: string obs_filerecord: block: options reader: urword @@ -177,22 +155,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dev_interfacemodel_on: block: options description: activates the interface model mechanism for calculating the coefficients at (and possibly @@ -306,79 +268,3 @@ blocks: optional: true longname: exchange boundname type: string - cellidm1: - block: exchangedata - description: is the cellid of the cell in model 1 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM1 is the node number for the cell. - reader: urword - optional: false - longname: cellid of first cell - numeric_index: true - type: integer - cellidm2: - block: exchangedata - description: is the cellid of the cell in model 2 as specified in the simulation name file. For - a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers - of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM2 is the node number for the cell. - reader: urword - optional: false - longname: cellid of second cell - numeric_index: true - type: integer - ihc: - block: exchangedata - description: is an integer flag indicating the direction between node n and all of its m connections. - If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If - IHC = 2 then the connection is horizontal for a vertically staggered grid. - reader: urword - optional: false - longname: integer flag for connection type - type: integer - cl1: - block: exchangedata - description: is the distance between the center of cell 1 and the its shared face with cell 2. - reader: urword - optional: false - longname: connection distance - type: double - cl2: - block: exchangedata - description: is the distance between the center of cell 2 and the its shared face with cell 1. - reader: urword - optional: false - longname: connection distance - type: double - hwva: - block: exchangedata - description: is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ - 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell - 2 if IHC = 0. - reader: urword - optional: false - longname: horizontal cell width or area for vertical flow - type: double - aux: - shape: (naux) - block: exchangedata - 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. - reader: urword - optional: true - longname: auxiliary variables - mf6internal: auxvar - type: double - boundname: - block: exchangedata - description: name of the GWT Exchange 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. - reader: urword - optional: true - longname: exchange boundname - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.json index 93c6cdc5..65f048c9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.json @@ -64,30 +64,6 @@ "type": "string" } } - }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" } }, "dimensions": { @@ -154,40 +130,6 @@ } } } - }, - "cellidm1": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of cell in surface water model", - "numeric_index": true, - "type": "integer" - }, - "cellidm2": { - "block": "exchangedata", - "description": "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell.", - "reader": "urword", - "optional": false, - "longname": "cellid of cell in groundwater model", - "numeric_index": true, - "type": "integer" - }, - "bedleak": { - "block": "exchangedata", - "description": "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments.", - "reader": "urword", - "optional": false, - "longname": "bed leakance", - "type": "double" - }, - "cfact": { - "block": "exchangedata", - "description": "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell.", - "reader": "urword", - "optional": false, - "longname": "factor used for conductance calculation", - "type": "double" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.toml index 38255dba..1e594dd7 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.toml @@ -61,30 +61,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.dimensions.nexg] block = "dimensions" description = "keyword and integer value specifying the number of SWF-GWF exchanges." @@ -142,37 +118,3 @@ reader = "urword" optional = false longname = "factor used for conductance calculation" type = "double" - -[blocks.exchangedata.cellidm1] -block = "exchangedata" -description = "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of cell in surface water model" -numeric_index = true -type = "integer" - -[blocks.exchangedata.cellidm2] -block = "exchangedata" -description = "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -reader = "urword" -optional = false -longname = "cellid of cell in groundwater model" -numeric_index = true -type = "integer" - -[blocks.exchangedata.bedleak] -block = "exchangedata" -description = "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments." -reader = "urword" -optional = false -longname = "bed leakance" -type = "double" - -[blocks.exchangedata.cfact] -block = "exchangedata" -description = "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell." -reader = "urword" -optional = false -longname = "factor used for conductance calculation" -type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.yaml index 8b2b0eed..42419f6d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/exg-olfgwf.yaml @@ -62,29 +62,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dimensions: nexg: block: dimensions @@ -160,52 +137,3 @@ blocks: optional: false longname: factor used for conductance calculation type: double - cellidm1: - block: exchangedata - description: is the cellid of the cell in model 1, which must be the surface water model. For a - structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of - the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D - number for the two cells. If the model uses the unstructured discretization (DISU) input file, - then CELLIDM1 is the node number for the cell. - reader: urword - optional: false - longname: cellid of cell in surface water model - numeric_index: true - type: integer - cellidm2: - block: exchangedata - description: is the cellid of the cell in model 2, which must be the groundwater model. For a structured - grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For - a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two - cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is - the node number for the cell. - reader: urword - optional: false - longname: cellid of cell in groundwater model - numeric_index: true - type: integer - bedleak: - block: exchangedata - description: is the leakance between the surface water and groundwater. bedleak has dimensions - of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness - of the bed sediments. - reader: urword - optional: false - longname: bed leakance - type: double - cfact: - block: exchangedata - description: is the factor used for the conductance calculation. The definition for this parameter - depends the type of surface water model and whether or not the fixed_conductance option is specified. If - the fixed_conductance option is specified, then the hydraulic conductance is calculated as the - product of bedleak and cfact. In this case, the conductance is fixed and does not change as a - function of the calculated surface water and groundwater head. If the fixed_conductance option - is not specified, then the definition of cfact depends on whether the surface water model represents - one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents - one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater - model cell. If the surface water model represents two-dimensional overland flow, then cfact is - the intersection area of the overland flow cell and the underlying groundwater model cell. - reader: urword - optional: false - longname: factor used for conductance calculation - type: double diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.json index 6e395d8e..6821e5d1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.json @@ -89,30 +89,6 @@ } } }, - "ts6": { - "block": "options", - "description": "keyword to specify that record corresponds to a time-series file.", - "reader": "urword", - "optional": false, - "longname": "time series keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ts6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file name of time series information", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -144,22 +120,6 @@ "type": "string" } } - }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" } }, "dimensions": { @@ -173,70 +133,6 @@ } }, "period": { - "iper": { - "shape": "(nper, nnodes)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, - "stress_period_data": { - "shape": "(nper, nnodes)", - "block": "period", - "reader": "urword", - "mf6internal": "spd", - "type": "list", - "children": { - "stress_period_data": { - "shape": "(maxbound)", - "block": "period", - "reader": "urword", - "mf6internal": "spd", - "type": "record", - "children": { - "cellid": { - "shape": "(ncelldim)", - "block": "period", - "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.", - "reader": "urword", - "longname": "cell identifier", - "type": "integer" - }, - "temp": { - "block": "period", - "description": "is the constant temperature value. 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.", - "reader": "urword", - "time_series": true, - "longname": "constant temperature value", - "mf6internal": "tspvar", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "period", - "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.", - "reader": "urword", - "optional": true, - "time_series": true, - "longname": "auxiliary variables", - "mf6internal": "auxvar", - "type": "double" - }, - "boundname": { - "block": "period", - "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.", - "reader": "urword", - "optional": true, - "longname": "constant temperature name", - "type": "string" - } - } - } - } - }, "temp": { "shape": "(nper, nnodes)", "block": "period", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.toml index 4928529f..3b2dcf24 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.toml @@ -85,30 +85,6 @@ optional = false longname = "file name of time series information" type = "string" -[blocks.options.ts6] -block = "options" -description = "keyword to specify that record corresponds to a time-series file." -reader = "urword" -optional = false -longname = "time series keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ts6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of time series information" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -139,22 +115,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.dimensions.maxbound] block = "dimensions" description = "integer value specifying the maximum number of constant temperature cells that will be specified for use during any stress period." @@ -163,66 +123,6 @@ optional = false longname = "maximum number of constant temperatures" type = "integer" -[blocks.period.iper] -shape = "(nper, nnodes)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.stress_period_data] -shape = "(nper, nnodes)" -block = "period" -reader = "urword" -mf6internal = "spd" -type = "list" - -[blocks.period.stress_period_data.children.stress_period_data] -shape = "(maxbound)" -block = "period" -reader = "urword" -mf6internal = "spd" -type = "record" - -[blocks.period.stress_period_data.children.stress_period_data.children.cellid] -shape = "(ncelldim)" -block = "period" -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." -reader = "urword" -longname = "cell identifier" -type = "integer" - -[blocks.period.stress_period_data.children.stress_period_data.children.temp] -block = "period" -description = "is the constant temperature value. 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." -reader = "urword" -time_series = true -longname = "constant temperature value" -mf6internal = "tspvar" -type = "double" - -[blocks.period.stress_period_data.children.stress_period_data.children.aux] -shape = "(naux)" -block = "period" -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." -reader = "urword" -optional = true -time_series = true -longname = "auxiliary variables" -mf6internal = "auxvar" -type = "double" - -[blocks.period.stress_period_data.children.stress_period_data.children.boundname] -block = "period" -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." -reader = "urword" -optional = true -longname = "constant temperature name" -type = "string" - [blocks.period.temp] shape = "(nper, nnodes)" block = "period" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.yaml index 94e32403..ce20336d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-ctp.yaml @@ -91,28 +91,6 @@ blocks: optional: false longname: file name of time series information type: string - ts6: - block: options - description: keyword to specify that record corresponds to a time-series file. - reader: urword - optional: false - longname: time series keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ts6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of time series information - type: string obs_filerecord: block: options reader: urword @@ -142,22 +120,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dimensions: maxbound: block: dimensions @@ -168,78 +130,6 @@ blocks: longname: maximum number of constant temperatures type: integer period: - iper: - shape: (nper, nnodes) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - stress_period_data: - shape: (nper, nnodes) - block: period - reader: urword - mf6internal: spd - type: list - children: - stress_period_data: - shape: (maxbound) - block: period - reader: urword - mf6internal: spd - type: record - children: - cellid: - shape: (ncelldim) - block: period - 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. - reader: urword - longname: cell identifier - type: integer - temp: - block: period - description: is the constant temperature value. 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. - reader: urword - time_series: true - longname: constant temperature value - mf6internal: tspvar - type: double - aux: - shape: (naux) - block: period - 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. - reader: urword - optional: true - time_series: true - longname: auxiliary variables - mf6internal: auxvar - type: double - boundname: - block: period - 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. - reader: urword - optional: true - longname: constant temperature name - type: string temp: shape: (nper, nnodes) block: period diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.json index 1e88cbf7..99a147d8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.json @@ -57,30 +57,6 @@ } } }, - "grb6": { - "block": "options", - "description": "keyword to specify that record corresponds to a binary grid file.", - "reader": "urword", - "optional": false, - "longname": "grb keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "grb6_filename": { - "block": "options", - "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'.", - "reader": "urword", - "optional": false, - "longname": "file name of GRB information", - "type": "string" - }, "xorigin": { "block": "options", "description": "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space.", @@ -167,32 +143,6 @@ "type": "string" } } - }, - "ncf6": { - "block": "options", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "reader": "urword", - "optional": false, - "longname": "ncf keyword", - "extended": true, - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ncf6_filename": { - "block": "options", - "description": "defines a NetCDF configuration (NCF) input file.", - "reader": "urword", - "optional": false, - "longname": "file name of NCF information", - "extended": true, - "type": "string" } }, "dimensions": { diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.toml index 0340a45f..b9d6ec10 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.toml @@ -53,30 +53,6 @@ optional = false longname = "file name of GRB information" type = "string" -[blocks.options.grb6] -block = "options" -description = "keyword to specify that record corresponds to a binary grid file." -reader = "urword" -optional = false -longname = "grb keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.grb6_filename] -block = "options" -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'." -reader = "urword" -optional = false -longname = "file name of GRB information" -type = "string" - [blocks.options.xorigin] block = "options" description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." @@ -162,32 +138,6 @@ longname = "file name of NCF information" extended = true type = "string" -[blocks.options.ncf6] -block = "options" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -reader = "urword" -optional = false -longname = "ncf keyword" -extended = true -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ncf6_filename] -block = "options" -description = "defines a NetCDF configuration (NCF) input file." -reader = "urword" -optional = false -longname = "file name of NCF information" -extended = true -type = "string" - [blocks.dimensions.nlay] block = "dimensions" description = "is the number of layers in the model grid." diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.yaml index 33742b3d..88881615 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-dis.yaml @@ -50,28 +50,6 @@ blocks: optional: false longname: file name of GRB information type: string - grb6: - block: options - description: keyword to specify that record corresponds to a binary grid file. - reader: urword - optional: false - longname: grb keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - grb6_filename: - block: options - 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'. - reader: urword - optional: false - longname: file name of GRB information - type: string xorigin: block: options description: x-position of the lower-left corner of the model grid. A default value of zero is @@ -163,29 +141,6 @@ blocks: longname: file name of NCF information extended: true type: string - ncf6: - block: options - description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - reader: urword - optional: false - longname: ncf keyword - extended: true - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ncf6_filename: - block: options - description: defines a NetCDF configuration (NCF) input file. - reader: urword - optional: false - longname: file name of NCF information - extended: true - type: string dimensions: nlay: block: dimensions diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.json index 2eb8d05d..87c419c9 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.json @@ -54,30 +54,6 @@ } } }, - "grb6": { - "block": "options", - "description": "keyword to specify that record corresponds to a binary grid file.", - "reader": "urword", - "optional": false, - "longname": "grb keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "grb6_filename": { - "block": "options", - "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'.", - "reader": "urword", - "optional": false, - "longname": "file name of GRB information", - "type": "string" - }, "xorigin": { "block": "options", "description": "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space.", @@ -296,31 +272,6 @@ } } } - }, - "iv": { - "block": "vertices", - "description": "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT.", - "reader": "urword", - "optional": false, - "longname": "vertex number", - "numeric_index": true, - "type": "integer" - }, - "xv": { - "block": "vertices", - "description": "is the x-coordinate for the vertex.", - "reader": "urword", - "optional": false, - "longname": "x-coordinate for vertex", - "type": "double" - }, - "yv": { - "block": "vertices", - "description": "is the y-coordinate for the vertex.", - "reader": "urword", - "optional": false, - "longname": "y-coordinate for vertex", - "type": "double" } }, "cell2d": { @@ -386,49 +337,6 @@ } } } - }, - "icell2d": { - "block": "cell2d", - "description": "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES.", - "reader": "urword", - "optional": false, - "longname": "cell2d number", - "numeric_index": true, - "type": "integer" - }, - "xc": { - "block": "cell2d", - "description": "is the x-coordinate for the cell center.", - "reader": "urword", - "optional": false, - "longname": "x-coordinate for cell center", - "type": "double" - }, - "yc": { - "block": "cell2d", - "description": "is the y-coordinate for the cell center.", - "reader": "urword", - "optional": false, - "longname": "y-coordinate for cell center", - "type": "double" - }, - "ncvert": { - "block": "cell2d", - "description": "is the number of vertices required to define the cell. There may be a different number of vertices for each cell.", - "reader": "urword", - "optional": false, - "longname": "number of cell vertices", - "type": "integer" - }, - "icvert": { - "shape": "(ncvert)", - "block": "cell2d", - "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.", - "reader": "urword", - "optional": false, - "longname": "array of vertex numbers", - "numeric_index": true, - "type": "integer" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.toml index 1398b4c4..cc2c1cf4 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.toml @@ -50,30 +50,6 @@ optional = false longname = "file name of GRB information" type = "string" -[blocks.options.grb6] -block = "options" -description = "keyword to specify that record corresponds to a binary grid file." -reader = "urword" -optional = false -longname = "grb keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.grb6_filename] -block = "options" -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'." -reader = "urword" -optional = false -longname = "file name of GRB information" -type = "string" - [blocks.options.xorigin] block = "options" description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." @@ -281,31 +257,6 @@ optional = false longname = "y-coordinate for vertex" type = "double" -[blocks.vertices.iv] -block = "vertices" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -reader = "urword" -optional = false -longname = "vertex number" -numeric_index = true -type = "integer" - -[blocks.vertices.xv] -block = "vertices" -description = "is the x-coordinate for the vertex." -reader = "urword" -optional = false -longname = "x-coordinate for vertex" -type = "double" - -[blocks.vertices.yv] -block = "vertices" -description = "is the y-coordinate for the vertex." -reader = "urword" -optional = false -longname = "y-coordinate for vertex" -type = "double" - [blocks.cell2d.cell2d] shape = "(nodes)" block = "cell2d" @@ -364,46 +315,3 @@ optional = false longname = "array of vertex numbers" numeric_index = true type = "integer" - -[blocks.cell2d.icell2d] -block = "cell2d" -description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." -reader = "urword" -optional = false -longname = "cell2d number" -numeric_index = true -type = "integer" - -[blocks.cell2d.xc] -block = "cell2d" -description = "is the x-coordinate for the cell center." -reader = "urword" -optional = false -longname = "x-coordinate for cell center" -type = "double" - -[blocks.cell2d.yc] -block = "cell2d" -description = "is the y-coordinate for the cell center." -reader = "urword" -optional = false -longname = "y-coordinate for cell center" -type = "double" - -[blocks.cell2d.ncvert] -block = "cell2d" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -reader = "urword" -optional = false -longname = "number of cell vertices" -type = "integer" - -[blocks.cell2d.icvert] -shape = "(ncvert)" -block = "cell2d" -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." -reader = "urword" -optional = false -longname = "array of vertex numbers" -numeric_index = true -type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.yaml index f1c0bca8..2658858d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disu.yaml @@ -48,28 +48,6 @@ blocks: optional: false longname: file name of GRB information type: string - grb6: - block: options - description: keyword to specify that record corresponds to a binary grid file. - reader: urword - optional: false - longname: grb keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - grb6_filename: - block: options - 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'. - reader: urword - optional: false - longname: file name of GRB information - type: string xorigin: block: options description: x-position of the origin used for model grid vertices. This value should be provided @@ -322,29 +300,6 @@ blocks: optional: false longname: y-coordinate for vertex type: double - iv: - block: vertices - description: is the vertex number. Records in the VERTICES block must be listed in consecutive - order from 1 to NVERT. - reader: urword - optional: false - longname: vertex number - numeric_index: true - type: integer - xv: - block: vertices - description: is the x-coordinate for the vertex. - reader: urword - optional: false - longname: x-coordinate for vertex - type: double - yv: - block: vertices - description: is the y-coordinate for the vertex. - reader: urword - optional: false - longname: y-coordinate for vertex - type: double cell2d: cell2d: shape: (nodes) @@ -403,44 +358,3 @@ blocks: longname: array of vertex numbers numeric_index: true type: integer - icell2d: - block: cell2d - description: is the cell2d number. Records in the CELL2D block must be listed in consecutive order - from 1 to NODES. - reader: urword - optional: false - longname: cell2d number - numeric_index: true - type: integer - xc: - block: cell2d - description: is the x-coordinate for the cell center. - reader: urword - optional: false - longname: x-coordinate for cell center - type: double - yc: - block: cell2d - description: is the y-coordinate for the cell center. - reader: urword - optional: false - longname: y-coordinate for cell center - type: double - ncvert: - block: cell2d - description: is the number of vertices required to define the cell. There may be a different number - of vertices for each cell. - reader: urword - optional: false - longname: number of cell vertices - type: integer - icvert: - shape: (ncvert) - block: cell2d - 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. - reader: urword - optional: false - longname: array of vertex numbers - numeric_index: true - type: integer diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.json index d3c1c312..eb58dc71 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.json @@ -57,30 +57,6 @@ } } }, - "grb6": { - "block": "options", - "description": "keyword to specify that record corresponds to a binary grid file.", - "reader": "urword", - "optional": false, - "longname": "grb keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "grb6_filename": { - "block": "options", - "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'.", - "reader": "urword", - "optional": false, - "longname": "file name of GRB information", - "type": "string" - }, "xorigin": { "block": "options", "description": "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space.", @@ -167,32 +143,6 @@ "type": "string" } } - }, - "ncf6": { - "block": "options", - "description": "keyword to specify that record corresponds to a NetCDF configuration (NCF) file.", - "reader": "urword", - "optional": false, - "longname": "ncf keyword", - "extended": true, - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ncf6_filename": { - "block": "options", - "description": "defines a NetCDF configuration (NCF) input file.", - "reader": "urword", - "optional": false, - "longname": "file name of NCF information", - "extended": true, - "type": "string" } }, "dimensions": { @@ -298,31 +248,6 @@ } } } - }, - "iv": { - "block": "vertices", - "description": "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT.", - "reader": "urword", - "optional": false, - "longname": "vertex number", - "numeric_index": true, - "type": "integer" - }, - "xv": { - "block": "vertices", - "description": "is the x-coordinate for the vertex.", - "reader": "urword", - "optional": false, - "longname": "x-coordinate for vertex", - "type": "double" - }, - "yv": { - "block": "vertices", - "description": "is the y-coordinate for the vertex.", - "reader": "urword", - "optional": false, - "longname": "y-coordinate for vertex", - "type": "double" } }, "cell2d": { @@ -388,49 +313,6 @@ } } } - }, - "icell2d": { - "block": "cell2d", - "description": "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last.", - "reader": "urword", - "optional": false, - "longname": "cell2d number", - "numeric_index": true, - "type": "integer" - }, - "xc": { - "block": "cell2d", - "description": "is the x-coordinate for the cell center.", - "reader": "urword", - "optional": false, - "longname": "x-coordinate for cell center", - "type": "double" - }, - "yc": { - "block": "cell2d", - "description": "is the y-coordinate for the cell center.", - "reader": "urword", - "optional": false, - "longname": "y-coordinate for cell center", - "type": "double" - }, - "ncvert": { - "block": "cell2d", - "description": "is the number of vertices required to define the cell. There may be a different number of vertices for each cell.", - "reader": "urword", - "optional": false, - "longname": "number of cell vertices", - "type": "integer" - }, - "icvert": { - "shape": "(ncvert)", - "block": "cell2d", - "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.", - "reader": "urword", - "optional": false, - "longname": "array of vertex numbers", - "numeric_index": true, - "type": "integer" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.toml index 885cdb6e..4ac1c772 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.toml @@ -53,30 +53,6 @@ optional = false longname = "file name of GRB information" type = "string" -[blocks.options.grb6] -block = "options" -description = "keyword to specify that record corresponds to a binary grid file." -reader = "urword" -optional = false -longname = "grb keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.grb6_filename] -block = "options" -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'." -reader = "urword" -optional = false -longname = "file name of GRB information" -type = "string" - [blocks.options.xorigin] block = "options" description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." @@ -162,32 +138,6 @@ longname = "file name of NCF information" extended = true type = "string" -[blocks.options.ncf6] -block = "options" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." -reader = "urword" -optional = false -longname = "ncf keyword" -extended = true -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ncf6_filename] -block = "options" -description = "defines a NetCDF configuration (NCF) input file." -reader = "urword" -optional = false -longname = "file name of NCF information" -extended = true -type = "string" - [blocks.dimensions.nlay] block = "dimensions" description = "is the number of layers in the model grid." @@ -283,31 +233,6 @@ optional = false longname = "y-coordinate for vertex" type = "double" -[blocks.vertices.iv] -block = "vertices" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -reader = "urword" -optional = false -longname = "vertex number" -numeric_index = true -type = "integer" - -[blocks.vertices.xv] -block = "vertices" -description = "is the x-coordinate for the vertex." -reader = "urword" -optional = false -longname = "x-coordinate for vertex" -type = "double" - -[blocks.vertices.yv] -block = "vertices" -description = "is the y-coordinate for the vertex." -reader = "urword" -optional = false -longname = "y-coordinate for vertex" -type = "double" - [blocks.cell2d.cell2d] shape = "(ncpl)" block = "cell2d" @@ -366,46 +291,3 @@ optional = false longname = "array of vertex numbers" numeric_index = true type = "integer" - -[blocks.cell2d.icell2d] -block = "cell2d" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -reader = "urword" -optional = false -longname = "cell2d number" -numeric_index = true -type = "integer" - -[blocks.cell2d.xc] -block = "cell2d" -description = "is the x-coordinate for the cell center." -reader = "urword" -optional = false -longname = "x-coordinate for cell center" -type = "double" - -[blocks.cell2d.yc] -block = "cell2d" -description = "is the y-coordinate for the cell center." -reader = "urword" -optional = false -longname = "y-coordinate for cell center" -type = "double" - -[blocks.cell2d.ncvert] -block = "cell2d" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -reader = "urword" -optional = false -longname = "number of cell vertices" -type = "integer" - -[blocks.cell2d.icvert] -shape = "(ncvert)" -block = "cell2d" -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." -reader = "urword" -optional = false -longname = "array of vertex numbers" -numeric_index = true -type = "integer" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.yaml index bb263d41..1f9714c8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-disv.yaml @@ -50,28 +50,6 @@ blocks: optional: false longname: file name of GRB information type: string - grb6: - block: options - description: keyword to specify that record corresponds to a binary grid file. - reader: urword - optional: false - longname: grb keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - grb6_filename: - block: options - 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'. - reader: urword - optional: false - longname: file name of GRB information - type: string xorigin: block: options description: x-position of the origin used for model grid vertices. This value should be provided @@ -165,29 +143,6 @@ blocks: longname: file name of NCF information extended: true type: string - ncf6: - block: options - description: keyword to specify that record corresponds to a NetCDF configuration (NCF) file. - reader: urword - optional: false - longname: ncf keyword - extended: true - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ncf6_filename: - block: options - description: defines a NetCDF configuration (NCF) input file. - reader: urword - optional: false - longname: file name of NCF information - extended: true - type: string dimensions: nlay: block: dimensions @@ -287,29 +242,6 @@ blocks: optional: false longname: y-coordinate for vertex type: double - iv: - block: vertices - description: is the vertex number. Records in the VERTICES block must be listed in consecutive - order from 1 to NVERT. - reader: urword - optional: false - longname: vertex number - numeric_index: true - type: integer - xv: - block: vertices - description: is the x-coordinate for the vertex. - reader: urword - optional: false - longname: x-coordinate for vertex - type: double - yv: - block: vertices - description: is the y-coordinate for the vertex. - reader: urword - optional: false - longname: y-coordinate for vertex - type: double cell2d: cell2d: shape: (ncpl) @@ -369,45 +301,3 @@ blocks: longname: array of vertex numbers numeric_index: true type: integer - icell2d: - block: cell2d - description: is the CELL2D number. Records in the CELL2D block must be listed in consecutive order - from the first to the last. - reader: urword - optional: false - longname: cell2d number - numeric_index: true - type: integer - xc: - block: cell2d - description: is the x-coordinate for the cell center. - reader: urword - optional: false - longname: x-coordinate for cell center - type: double - yc: - block: cell2d - description: is the y-coordinate for the cell center. - reader: urword - optional: false - longname: y-coordinate for cell center - type: double - ncvert: - block: cell2d - description: is the number of vertices required to define the cell. There may be a different number - of vertices for each cell. - reader: urword - optional: false - longname: number of cell vertices - type: integer - icvert: - shape: (ncvert) - block: cell2d - 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. - reader: urword - optional: false - longname: array of vertex numbers - numeric_index: true - type: integer diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.json index fd49935f..2e3505a3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.json @@ -89,30 +89,6 @@ } } }, - "ts6": { - "block": "options", - "description": "keyword to specify that record corresponds to a time-series file.", - "reader": "urword", - "optional": false, - "longname": "head keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ts6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file name of time series information", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -144,22 +120,6 @@ "type": "string" } } - }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" } }, "dimensions": { @@ -173,69 +133,6 @@ } }, "period": { - "iper": { - "shape": "(nper, nnodes)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, - "stress_period_data": { - "shape": "(nper, nnodes)", - "block": "period", - "reader": "urword", - "mf6internal": "spd", - "type": "list", - "children": { - "stress_period_data": { - "shape": "(maxbound)", - "block": "period", - "reader": "urword", - "mf6internal": "spd", - "type": "record", - "children": { - "cellid": { - "shape": "(ncelldim)", - "block": "period", - "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.", - "reader": "urword", - "longname": "cell identifier", - "type": "integer" - }, - "senerrate": { - "block": "period", - "description": "is the energy source loading rate. A positive value indicates addition of energy and a negative value indicates removal of energy. 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.", - "reader": "urword", - "time_series": true, - "longname": "energy source loading rate", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "period", - "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.", - "reader": "urword", - "optional": true, - "time_series": true, - "mf6internal": "auxvar", - "longname": "auxiliary variables", - "type": "double" - }, - "boundname": { - "block": "period", - "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.", - "reader": "urword", - "optional": true, - "longname": "energy source loading name", - "type": "string" - } - } - } - } - }, "senerrate": { "shape": "(nper, nnodes)", "block": "period", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.toml index 4b6a021c..d1b299f3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.toml @@ -85,30 +85,6 @@ optional = false longname = "file name of time series information" type = "string" -[blocks.options.ts6] -block = "options" -description = "keyword to specify that record corresponds to a time-series file." -reader = "urword" -optional = false -longname = "head keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ts6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of time series information" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -139,22 +115,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.dimensions.maxbound] block = "dimensions" description = "integer value specifying the maximum number of source cells that will be specified for use during any stress period." @@ -163,65 +123,6 @@ optional = false longname = "maximum number of sources" type = "integer" -[blocks.period.iper] -shape = "(nper, nnodes)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.stress_period_data] -shape = "(nper, nnodes)" -block = "period" -reader = "urword" -mf6internal = "spd" -type = "list" - -[blocks.period.stress_period_data.children.stress_period_data] -shape = "(maxbound)" -block = "period" -reader = "urword" -mf6internal = "spd" -type = "record" - -[blocks.period.stress_period_data.children.stress_period_data.children.cellid] -shape = "(ncelldim)" -block = "period" -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." -reader = "urword" -longname = "cell identifier" -type = "integer" - -[blocks.period.stress_period_data.children.stress_period_data.children.senerrate] -block = "period" -description = "is the energy source loading rate. A positive value indicates addition of energy and a negative value indicates removal of energy. 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." -reader = "urword" -time_series = true -longname = "energy source loading rate" -type = "double" - -[blocks.period.stress_period_data.children.stress_period_data.children.aux] -shape = "(naux)" -block = "period" -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." -reader = "urword" -optional = true -time_series = true -mf6internal = "auxvar" -longname = "auxiliary variables" -type = "double" - -[blocks.period.stress_period_data.children.stress_period_data.children.boundname] -block = "period" -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." -reader = "urword" -optional = true -longname = "energy source loading name" -type = "string" - [blocks.period.senerrate] shape = "(nper, nnodes)" block = "period" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.yaml index 612e3f12..9bfde31d 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-esl.yaml @@ -91,28 +91,6 @@ blocks: optional: false longname: file name of time series information type: string - ts6: - block: options - description: keyword to specify that record corresponds to a time-series file. - reader: urword - optional: false - longname: head keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ts6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of time series information - type: string obs_filerecord: block: options reader: urword @@ -142,22 +120,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string dimensions: maxbound: block: dimensions @@ -168,78 +130,6 @@ blocks: longname: maximum number of sources type: integer period: - iper: - shape: (nper, nnodes) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - stress_period_data: - shape: (nper, nnodes) - block: period - reader: urword - mf6internal: spd - type: list - children: - stress_period_data: - shape: (maxbound) - block: period - reader: urword - mf6internal: spd - type: record - children: - cellid: - shape: (ncelldim) - block: period - 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. - reader: urword - longname: cell identifier - type: integer - senerrate: - block: period - description: is the energy source loading rate. A positive value indicates addition of energy - and a negative value indicates removal of energy. 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. - reader: urword - time_series: true - longname: energy source loading rate - type: double - aux: - shape: (naux) - block: period - 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. - reader: urword - optional: true - time_series: true - mf6internal: auxvar - longname: auxiliary variables - type: double - boundname: - block: period - 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. - reader: urword - optional: true - longname: energy source loading name - type: string senerrate: shape: (nper, nnodes) block: period diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.json index 5d4be831..b6960ffd 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.json @@ -64,28 +64,6 @@ } } } - }, - "flowtype": { - "block": "packagedata", - "description": "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package from a previous model run. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If GWFMOVER is specified, the file must be a mover file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package.", - "reader": "urword", - "longname": "flow type", - "type": "string" - }, - "filein": { - "block": "packagedata", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "fname": { - "block": "packagedata", - "description": "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run.", - "reader": "urword", - "longname": "file name", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.toml index b8b368cc..42ef7d28 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.toml @@ -56,25 +56,3 @@ description = "is the name of the file containing flows. The path to the file s reader = "urword" longname = "file name" type = "string" - -[blocks.packagedata.flowtype] -block = "packagedata" -description = "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package from a previous model run. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If GWFMOVER is specified, the file must be a mover file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package." -reader = "urword" -longname = "flow type" -type = "string" - -[blocks.packagedata.filein] -block = "packagedata" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.packagedata.fname] -block = "packagedata" -description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." -reader = "urword" -longname = "file name" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.yaml index dad74ed2..80b615d5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-fmi.yaml @@ -66,28 +66,3 @@ blocks: reader: urword longname: file name type: string - flowtype: - block: packagedata - description: is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress - package from a previous model run. If GWFBUDGET is specified, then the corresponding file must - be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, - the file must be a binary grid file. If GWFMOVER is specified, the file must be a mover file. If - an advanced GWF stress package name appears then the corresponding file must be the budget file - saved by a LAK, SFR, MAW or UZF Package. - reader: urword - longname: flow type - type: string - filein: - block: packagedata - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - fname: - block: packagedata - description: is the name of the file containing flows. The path to the file should be included - if the file is not located in the folder where the program was run. - reader: urword - longname: file name - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.json index 08a5935a..27a332ec 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.json @@ -102,22 +102,6 @@ } } }, - "temperature": { - "block": "options", - "description": "keyword to specify that record corresponds to temperature.", - "reader": "urword", - "optional": false, - "longname": "stage keyword", - "type": "keyword" - }, - "tempfile": { - "block": "options", - "description": "name of the binary output file to write temperature information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budget_filerecord": { "block": "options", "reader": "urword", @@ -150,30 +134,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the binary output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -206,22 +166,6 @@ } } }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "ts_filerecord": { "block": "options", "reader": "urword", @@ -254,30 +198,6 @@ } } }, - "ts6": { - "block": "options", - "description": "keyword to specify that record corresponds to a time-series file.", - "reader": "urword", - "optional": false, - "longname": "head keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ts6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file name of time series information", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -309,22 +229,6 @@ "type": "string" } } - }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" } }, "packagedata": { @@ -390,171 +294,9 @@ } } } - }, - "lakeno": { - "block": "packagedata", - "description": "integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once.", - "reader": "urword", - "longname": "lake number for this entry", - "numeric_index": true, - "type": "integer" - }, - "strt": { - "block": "packagedata", - "description": "real value that defines the starting temperature for the lake.", - "reader": "urword", - "longname": "starting lake temperature", - "type": "double" - }, - "ktf": { - "block": "packagedata", - "description": "is the thermal conductivity of the material between the aquifer cell and the lake. The thickness of the material is defined by the variable RBTHCND.", - "reader": "urword", - "longname": "boundary thermal conductivity", - "type": "double" - }, - "rbthcnd": { - "block": "packagedata", - "description": "real value that defines the thickness of the lakebed material through which conduction occurs. Must be greater than 0.", - "reader": "urword", - "longname": "streambed thickness", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "packagedata", - "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.", - "reader": "urword", - "time_series": true, - "optional": true, - "longname": "auxiliary variables", - "type": "double" - }, - "boundname": { - "block": "packagedata", - "description": "name of the lake 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.", - "reader": "urword", - "optional": true, - "longname": "lake name", - "type": "string" } }, "period": { - "iper": { - "shape": "(nper)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, - "lakeperioddata": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "list", - "children": { - "lakeperioddata": { - "type": "record", - "block": "period", - "reader": "urword", - "children": { - "lakeno": { - "block": "period", - "description": "integer value that defines the lake number associated with the specified PERIOD data on the line. LAKENO must be greater than zero and less than or equal to NLAKES.", - "reader": "urword", - "longname": "lake number for this entry", - "numeric_index": true, - "type": "integer" - }, - "laksetting": { - "block": "period", - "description": "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated temperature of the lake.", - "reader": "urword", - "type": "union", - "children": { - "temperature": { - "block": "period", - "description": "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. 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.", - "time_series": true, - "reader": "urword", - "longname": "lake temperature", - "type": "string" - }, - "status": { - "block": "period", - "description": "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value.", - "reader": "urword", - "longname": "lake temperature status", - "type": "string" - }, - "rainfall": { - "block": "period", - "description": "real or character value that defines the rainfall temperature for the lake. 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.", - "reader": "urword", - "time_series": true, - "longname": "rainfall temperature", - "type": "string" - }, - "evaporation": { - "block": "period", - "description": "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach.", - "reader": "urword", - "time_series": true, - "longname": "evaporation temperature", - "type": "string" - }, - "runoff": { - "block": "period", - "description": "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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.", - "reader": "urword", - "time_series": true, - "longname": "runoff temperature", - "type": "string" - }, - "ext-inflow": { - "block": "period", - "description": "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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.", - "reader": "urword", - "time_series": true, - "longname": "ext-inflow temperature", - "type": "string" - }, - "auxiliaryrecord": { - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - } - } - } - } - } - } - }, "lakeno": { "shape": "(nper)", "block": "period", @@ -646,110 +388,6 @@ } } } - }, - "status": { - "shape": "(nper)", - "block": "period", - "description": "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value.", - "reader": "urword", - "longname": "lake temperature status", - "type": "string" - }, - "temperature": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. 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.", - "time_series": true, - "reader": "urword", - "longname": "lake temperature", - "type": "string" - }, - "rainfall": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the rainfall temperature for the lake. 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.", - "reader": "urword", - "time_series": true, - "longname": "rainfall temperature", - "type": "string" - }, - "evaporation": { - "shape": "(nper)", - "block": "period", - "description": "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach.", - "reader": "urword", - "time_series": true, - "longname": "evaporation temperature", - "type": "string" - }, - "runoff": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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.", - "reader": "urword", - "time_series": true, - "longname": "runoff temperature", - "type": "string" - }, - "ext-inflow": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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.", - "reader": "urword", - "time_series": true, - "longname": "ext-inflow temperature", - "type": "string" - }, - "auxiliaryrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - }, - "auxiliary": { - "shape": "(nper)", - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "shape": "(nper)", - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "shape": "(nper)", - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.toml index bcfe244d..827f95e1 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.toml @@ -98,22 +98,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.temperature] -block = "options" -description = "keyword to specify that record corresponds to temperature." -reader = "urword" -optional = false -longname = "stage keyword" -type = "keyword" - -[blocks.options.tempfile] -block = "options" -description = "name of the binary output file to write temperature information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budget_filerecord] block = "options" reader = "urword" @@ -144,30 +128,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budget] -block = "options" -description = "keyword to specify that record corresponds to the budget." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.budgetfile] -block = "options" -description = "name of the binary output file to write budget information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budgetcsv_filerecord] block = "options" reader = "urword" @@ -198,22 +158,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budgetcsv] -block = "options" -description = "keyword to specify that record corresponds to the budget CSV." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.budgetcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.ts_filerecord] block = "options" reader = "urword" @@ -244,30 +188,6 @@ optional = false longname = "file name of time series information" type = "string" -[blocks.options.ts6] -block = "options" -description = "keyword to specify that record corresponds to a time-series file." -reader = "urword" -optional = false -longname = "head keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ts6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of time series information" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -298,22 +218,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.packagedata.packagedata] shape = "(maxbound)" block = "packagedata" @@ -373,160 +277,6 @@ optional = true longname = "lake name" type = "string" -[blocks.packagedata.lakeno] -block = "packagedata" -description = "integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." -reader = "urword" -longname = "lake number for this entry" -numeric_index = true -type = "integer" - -[blocks.packagedata.strt] -block = "packagedata" -description = "real value that defines the starting temperature for the lake." -reader = "urword" -longname = "starting lake temperature" -type = "double" - -[blocks.packagedata.ktf] -block = "packagedata" -description = "is the thermal conductivity of the material between the aquifer cell and the lake. The thickness of the material is defined by the variable RBTHCND." -reader = "urword" -longname = "boundary thermal conductivity" -type = "double" - -[blocks.packagedata.rbthcnd] -block = "packagedata" -description = "real value that defines the thickness of the lakebed material through which conduction occurs. Must be greater than 0." -reader = "urword" -longname = "streambed thickness" -type = "double" - -[blocks.packagedata.aux] -shape = "(naux)" -block = "packagedata" -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." -reader = "urword" -time_series = true -optional = true -longname = "auxiliary variables" -type = "double" - -[blocks.packagedata.boundname] -block = "packagedata" -description = "name of the lake 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." -reader = "urword" -optional = true -longname = "lake name" -type = "string" - -[blocks.period.iper] -shape = "(nper)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.lakeperioddata] -shape = "(nper)" -block = "period" -reader = "urword" -type = "list" - -[blocks.period.lakeperioddata.children.lakeperioddata] -type = "record" -block = "period" -reader = "urword" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.lakeno] -block = "period" -description = "integer value that defines the lake number associated with the specified PERIOD data on the line. LAKENO must be greater than zero and less than or equal to NLAKES." -reader = "urword" -longname = "lake number for this entry" -numeric_index = true -type = "integer" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting] -block = "period" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated temperature of the lake." -reader = "urword" -type = "union" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.temperature] -block = "period" -description = "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. 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." -time_series = true -reader = "urword" -longname = "lake temperature" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.status] -block = "period" -description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value." -reader = "urword" -longname = "lake temperature status" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.rainfall] -block = "period" -description = "real or character value that defines the rainfall temperature for the lake. 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." -reader = "urword" -time_series = true -longname = "rainfall temperature" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.evaporation] -block = "period" -description = "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." -reader = "urword" -time_series = true -longname = "evaporation temperature" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.runoff] -block = "period" -description = "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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." -reader = "urword" -time_series = true -longname = "runoff temperature" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.ext-inflow] -block = "period" -description = "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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." -reader = "urword" -time_series = true -longname = "ext-inflow temperature" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.auxiliaryrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.lakeperioddata.children.lakeperioddata.children.laksetting.children.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - [blocks.period.lakeno] shape = "(nper)" block = "period" @@ -614,105 +364,3 @@ reader = "urword" time_series = true longname = "auxiliary variable value" type = "double" - -[blocks.period.status] -shape = "(nper)" -block = "period" -description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value." -reader = "urword" -longname = "lake temperature status" -type = "string" - -[blocks.period.temperature] -shape = "(nper)" -block = "period" -description = "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. 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." -time_series = true -reader = "urword" -longname = "lake temperature" -type = "string" - -[blocks.period.rainfall] -shape = "(nper)" -block = "period" -description = "real or character value that defines the rainfall temperature for the lake. 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." -reader = "urword" -time_series = true -longname = "rainfall temperature" -type = "string" - -[blocks.period.evaporation] -shape = "(nper)" -block = "period" -description = "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." -reader = "urword" -time_series = true -longname = "evaporation temperature" -type = "string" - -[blocks.period.runoff] -shape = "(nper)" -block = "period" -description = "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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." -reader = "urword" -time_series = true -longname = "runoff temperature" -type = "string" - -[blocks.period.ext-inflow] -shape = "(nper)" -block = "period" -description = "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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." -reader = "urword" -time_series = true -longname = "ext-inflow temperature" -type = "string" - -[blocks.period.auxiliaryrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - -[blocks.period.auxiliary] -shape = "(nper)" -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxname] -shape = "(nper)" -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxval] -shape = "(nper)" -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.yaml index 712d4f5f..ab696894 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-lke.yaml @@ -109,20 +109,6 @@ blocks: optional: false longname: file keyword type: string - temperature: - block: options - description: keyword to specify that record corresponds to temperature. - reader: urword - optional: false - longname: stage keyword - type: keyword - tempfile: - block: options - description: name of the binary output file to write temperature information. - reader: urword - optional: false - longname: file keyword - type: string budget_filerecord: block: options reader: urword @@ -150,27 +136,6 @@ blocks: optional: false longname: file keyword type: string - budget: - block: options - description: keyword to specify that record corresponds to the budget. - reader: urword - optional: false - longname: budget keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - budgetfile: - block: options - description: name of the binary output file to write budget information. - reader: urword - optional: false - longname: file keyword - type: string budgetcsv_filerecord: block: options reader: urword @@ -199,21 +164,6 @@ blocks: optional: false longname: file keyword type: string - budgetcsv: - block: options - description: keyword to specify that record corresponds to the budget CSV. - reader: urword - optional: false - longname: budget keyword - type: keyword - budgetcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string ts_filerecord: block: options reader: urword @@ -242,28 +192,6 @@ blocks: optional: false longname: file name of time series information type: string - ts6: - block: options - description: keyword to specify that record corresponds to a time-series file. - reader: urword - optional: false - longname: head keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ts6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of time series information - type: string obs_filerecord: block: options reader: urword @@ -293,22 +221,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string packagedata: packagedata: shape: (maxbound) @@ -376,194 +288,7 @@ blocks: optional: true longname: lake name type: string - lakeno: - block: packagedata - description: integer value that defines the lake number associated with the specified PACKAGEDATA - data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information - must be specified for every lake or the program will terminate with an error. The program will - also terminate with an error if information for a lake is specified more than once. - reader: urword - longname: lake number for this entry - numeric_index: true - type: integer - strt: - block: packagedata - description: real value that defines the starting temperature for the lake. - reader: urword - longname: starting lake temperature - type: double - ktf: - block: packagedata - description: is the thermal conductivity of the material between the aquifer cell and the lake. - The thickness of the material is defined by the variable RBTHCND. - reader: urword - longname: boundary thermal conductivity - type: double - rbthcnd: - block: packagedata - description: real value that defines the thickness of the lakebed material through which conduction - occurs. Must be greater than 0. - reader: urword - longname: streambed thickness - type: double - aux: - shape: (naux) - block: packagedata - 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. - reader: urword - time_series: true - optional: true - longname: auxiliary variables - type: double - boundname: - block: packagedata - description: name of the lake 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. - reader: urword - optional: true - longname: lake name - type: string period: - iper: - shape: (nper) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - lakeperioddata: - shape: (nper) - block: period - reader: urword - type: list - children: - lakeperioddata: - type: record - block: period - reader: urword - children: - lakeno: - block: period - description: integer value that defines the lake number associated with the specified PERIOD - data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. - reader: urword - longname: lake number for this entry - numeric_index: true - type: integer - laksetting: - block: period - description: 'line of information that is parsed into a keyword and values. Keyword values - that can be used to start the LAKSETTING string include: STATUS, TEMPERATURE, RAINFALL, - EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature - associated with the corresponding flow terms. Temperatures cannot be specified for all - flow terms. For example, the Lake Package supports a ''WITHDRAWAL'' flow term. If this - withdrawal term is active, then water will be withdrawn from the lake at the calculated - temperature of the lake.' - reader: urword - type: union - children: - temperature: - block: period - description: real or character value that defines the temperature for the lake. The - specified TEMPERATURE is only applied if the lake is a constant temperature lake. - 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. - time_series: true - reader: urword - longname: lake temperature - type: string - status: - block: period - description: keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, - or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated - for the lake. If a lake is inactive, then there will be no energy fluxes into or - out of the lake and the inactive value will be written for the lake temperature. If - a lake is constant, then the temperature for the lake will be fixed at the user specified - value. - reader: urword - longname: lake temperature status - type: string - rainfall: - block: period - description: real or character value that defines the rainfall temperature for the lake. - 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. - reader: urword - time_series: true - longname: rainfall temperature - type: string - evaporation: - block: period - description: use of the EVAPORATION keyword is allowed in the LKE package; however, - the specified value is not currently used in LKE calculations. Instead, the latent - heat of evaporation is multiplied by the simulated evaporation rate for determining - the thermal energy lost from a stream reach. - reader: urword - time_series: true - longname: evaporation temperature - type: string - runoff: - block: period - description: real or character value that defines the temperature of runoff for the - lake. Users are free to use whatever temperature scale they want, which might include - negative temperatures. 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. - reader: urword - time_series: true - longname: runoff temperature - type: string - ext-inflow: - block: period - description: real or character value that defines the temperature of external inflow - for the lake. Users are free to use whatever temperature scale they want, which might - include negative temperatures. 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. - reader: urword - time_series: true - longname: ext-inflow temperature - type: string - auxiliaryrecord: - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must - match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME - does not match one of the auxiliary variable names defined in the OPTIONS block - the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double lakeno: shape: (nper) block: period @@ -673,119 +398,3 @@ blocks: time_series: true longname: auxiliary variable value type: double - status: - shape: (nper) - block: period - description: keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. - By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If - a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive - value will be written for the lake temperature. If a lake is constant, then the temperature for - the lake will be fixed at the user specified value. - reader: urword - longname: lake temperature status - type: string - temperature: - shape: (nper) - block: period - description: real or character value that defines the temperature for the lake. The specified TEMPERATURE - is only applied if the lake is a constant temperature lake. 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. - time_series: true - reader: urword - longname: lake temperature - type: string - rainfall: - shape: (nper) - block: period - description: real or character value that defines the rainfall temperature for the lake. 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. - reader: urword - time_series: true - longname: rainfall temperature - type: string - evaporation: - shape: (nper) - block: period - description: use of the EVAPORATION keyword is allowed in the LKE package; however, the specified - value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied - by the simulated evaporation rate for determining the thermal energy lost from a stream reach. - reader: urword - time_series: true - longname: evaporation temperature - type: string - runoff: - shape: (nper) - block: period - description: real or character value that defines the temperature of runoff for the lake. Users - are free to use whatever temperature scale they want, which might include negative temperatures. - 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. - reader: urword - time_series: true - longname: runoff temperature - type: string - ext-inflow: - shape: (nper) - block: period - description: real or character value that defines the temperature of external inflow for the lake. Users - are free to use whatever temperature scale they want, which might include negative temperatures. 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. - reader: urword - time_series: true - longname: ext-inflow temperature - type: string - auxiliaryrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one - of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one - of the auxiliary variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double - auxiliary: - shape: (nper) - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - shape: (nper) - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the - auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary - variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - shape: (nper) - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.json index be0ec459..88fd57d0 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.json @@ -63,30 +63,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the binary output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -118,22 +94,6 @@ "type": "string" } } - }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.toml index f4a747b7..0db18fd8 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.toml @@ -59,30 +59,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budget] -block = "options" -description = "keyword to specify that record corresponds to the budget." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.budgetfile] -block = "options" -description = "name of the binary output file to write budget information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budgetcsv_filerecord] block = "options" reader = "urword" @@ -112,19 +88,3 @@ reader = "urword" optional = false longname = "file keyword" type = "string" - -[blocks.options.budgetcsv] -block = "options" -description = "keyword to specify that record corresponds to the budget CSV." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.budgetcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.yaml index 5141d3c8..07f02f69 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mve.yaml @@ -59,27 +59,6 @@ blocks: optional: false longname: file keyword type: string - budget: - block: options - description: keyword to specify that record corresponds to the budget. - reader: urword - optional: false - longname: budget keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - budgetfile: - block: options - description: name of the binary output file to write budget information. - reader: urword - optional: false - longname: file keyword - type: string budgetcsv_filerecord: block: options reader: urword @@ -108,18 +87,3 @@ blocks: optional: false longname: file keyword type: string - budgetcsv: - block: options - description: keyword to specify that record corresponds to the budget CSV. - reader: urword - optional: false - longname: budget keyword - type: keyword - budgetcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.json index a7492475..6ba6ebef 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.json @@ -102,22 +102,6 @@ } } }, - "temperature": { - "block": "options", - "description": "keyword to specify that record corresponds to temperature.", - "reader": "urword", - "optional": false, - "longname": "stage keyword", - "type": "keyword" - }, - "tempfile": { - "block": "options", - "description": "name of the binary output file to write temperature information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budget_filerecord": { "block": "options", "reader": "urword", @@ -150,30 +134,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the binary output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -206,22 +166,6 @@ } } }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "ts_filerecord": { "block": "options", "reader": "urword", @@ -254,30 +198,6 @@ } } }, - "ts6": { - "block": "options", - "description": "keyword to specify that record corresponds to a time-series file.", - "reader": "urword", - "optional": false, - "longname": "head keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ts6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file name of time series information", - "type": "string" - }, "obs_filerecord": { "block": "options", "reader": "urword", @@ -309,22 +229,6 @@ "type": "string" } } - }, - "obs6": { - "block": "options", - "description": "keyword to specify that record corresponds to an observations file.", - "reader": "urword", - "optional": false, - "longname": "obs keyword", - "type": "keyword" - }, - "obs6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "obs6 input filename", - "type": "string" } }, "packagedata": { @@ -390,147 +294,9 @@ } } } - }, - "mawno": { - "block": "packagedata", - "description": "integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once.", - "reader": "urword", - "longname": "well number for this entry", - "numeric_index": true, - "type": "integer" - }, - "strt": { - "block": "packagedata", - "description": "real value that defines the starting temperature for the well.", - "reader": "urword", - "longname": "starting well temperature", - "type": "double" - }, - "ktf": { - "block": "packagedata", - "description": "is the thermal conductivity of the material between the aquifer cell and the feature. The thickness of the material is defined by the variable FTHK.", - "reader": "urword", - "longname": "thermal conductivity of the feature", - "type": "double" - }, - "fthk": { - "block": "packagedata", - "description": "real value that defines the thickness of the material through which conduction occurs. Must be greater than 0.", - "reader": "urword", - "longname": "thickness of the well feature", - "type": "double" - }, - "aux": { - "shape": "(naux)", - "block": "packagedata", - "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.", - "reader": "urword", - "time_series": true, - "optional": true, - "longname": "auxiliary variables", - "type": "double" - }, - "boundname": { - "block": "packagedata", - "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.", - "reader": "urword", - "optional": true, - "longname": "well name", - "type": "string" } }, "period": { - "iper": { - "shape": "(nper)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, - "mweperioddata": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "list", - "children": { - "mweperioddata": { - "type": "record", - "block": "period", - "reader": "urword", - "children": { - "mawno": { - "block": "period", - "description": "integer value that defines the well number associated with the specified PERIOD data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS.", - "reader": "urword", - "longname": "well number for this entry", - "numeric_index": true, - "type": "integer" - }, - "mwesetting": { - "block": "period", - "description": "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWESETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated temperature of the well.", - "reader": "urword", - "type": "union", - "children": { - "temperature": { - "block": "period", - "description": "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. 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.", - "time_series": true, - "reader": "urword", - "longname": "well temperature", - "type": "string" - }, - "status": { - "block": "period", - "description": "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value.", - "reader": "urword", - "longname": "well temperature status", - "type": "string" - }, - "rate": { - "block": "period", - "description": "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. 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.", - "reader": "urword", - "time_series": true, - "longname": "well injection temperature", - "type": "string" - }, - "auxiliaryrecord": { - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - } - } - } - } - } - } - }, "mawno": { "shape": "(nper)", "block": "period", @@ -598,83 +364,6 @@ } } } - }, - "status": { - "shape": "(nper)", - "block": "period", - "description": "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value.", - "reader": "urword", - "longname": "well temperature status", - "type": "string" - }, - "temperature": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. 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.", - "time_series": true, - "reader": "urword", - "longname": "well temperature", - "type": "string" - }, - "rate": { - "shape": "(nper)", - "block": "period", - "description": "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. 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.", - "reader": "urword", - "time_series": true, - "longname": "well injection temperature", - "type": "string" - }, - "auxiliaryrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - }, - "auxiliary": { - "shape": "(nper)", - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "shape": "(nper)", - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "shape": "(nper)", - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.toml index 359f6611..8360251c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.toml @@ -98,22 +98,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.temperature] -block = "options" -description = "keyword to specify that record corresponds to temperature." -reader = "urword" -optional = false -longname = "stage keyword" -type = "keyword" - -[blocks.options.tempfile] -block = "options" -description = "name of the binary output file to write temperature information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budget_filerecord] block = "options" reader = "urword" @@ -144,30 +128,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budget] -block = "options" -description = "keyword to specify that record corresponds to the budget." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.budgetfile] -block = "options" -description = "name of the binary output file to write budget information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budgetcsv_filerecord] block = "options" reader = "urword" @@ -198,22 +158,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budgetcsv] -block = "options" -description = "keyword to specify that record corresponds to the budget CSV." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.budgetcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.ts_filerecord] block = "options" reader = "urword" @@ -244,30 +188,6 @@ optional = false longname = "file name of time series information" type = "string" -[blocks.options.ts6] -block = "options" -description = "keyword to specify that record corresponds to a time-series file." -reader = "urword" -optional = false -longname = "head keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ts6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of time series information" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -298,22 +218,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.packagedata.packagedata] shape = "(maxbound)" block = "packagedata" @@ -373,136 +277,6 @@ optional = true longname = "well name" type = "string" -[blocks.packagedata.mawno] -block = "packagedata" -description = "integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once." -reader = "urword" -longname = "well number for this entry" -numeric_index = true -type = "integer" - -[blocks.packagedata.strt] -block = "packagedata" -description = "real value that defines the starting temperature for the well." -reader = "urword" -longname = "starting well temperature" -type = "double" - -[blocks.packagedata.ktf] -block = "packagedata" -description = "is the thermal conductivity of the material between the aquifer cell and the feature. The thickness of the material is defined by the variable FTHK." -reader = "urword" -longname = "thermal conductivity of the feature" -type = "double" - -[blocks.packagedata.fthk] -block = "packagedata" -description = "real value that defines the thickness of the material through which conduction occurs. Must be greater than 0." -reader = "urword" -longname = "thickness of the well feature" -type = "double" - -[blocks.packagedata.aux] -shape = "(naux)" -block = "packagedata" -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." -reader = "urword" -time_series = true -optional = true -longname = "auxiliary variables" -type = "double" - -[blocks.packagedata.boundname] -block = "packagedata" -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." -reader = "urword" -optional = true -longname = "well name" -type = "string" - -[blocks.period.iper] -shape = "(nper)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.mweperioddata] -shape = "(nper)" -block = "period" -reader = "urword" -type = "list" - -[blocks.period.mweperioddata.children.mweperioddata] -type = "record" -block = "period" -reader = "urword" - -[blocks.period.mweperioddata.children.mweperioddata.children.mawno] -block = "period" -description = "integer value that defines the well number associated with the specified PERIOD data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS." -reader = "urword" -longname = "well number for this entry" -numeric_index = true -type = "integer" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting] -block = "period" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWESETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated temperature of the well." -reader = "urword" -type = "union" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.temperature] -block = "period" -description = "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. 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." -time_series = true -reader = "urword" -longname = "well temperature" -type = "string" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.status] -block = "period" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value." -reader = "urword" -longname = "well temperature status" -type = "string" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.rate] -block = "period" -description = "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. 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." -reader = "urword" -time_series = true -longname = "well injection temperature" -type = "string" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.auxiliaryrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.mweperioddata.children.mweperioddata.children.mwesetting.children.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - [blocks.period.mawno] shape = "(nper)" block = "period" @@ -566,78 +340,3 @@ reader = "urword" time_series = true longname = "auxiliary variable value" type = "double" - -[blocks.period.status] -shape = "(nper)" -block = "period" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value." -reader = "urword" -longname = "well temperature status" -type = "string" - -[blocks.period.temperature] -shape = "(nper)" -block = "period" -description = "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. 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." -time_series = true -reader = "urword" -longname = "well temperature" -type = "string" - -[blocks.period.rate] -shape = "(nper)" -block = "period" -description = "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. 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." -reader = "urword" -time_series = true -longname = "well injection temperature" -type = "string" - -[blocks.period.auxiliaryrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - -[blocks.period.auxiliary] -shape = "(nper)" -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxname] -shape = "(nper)" -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxval] -shape = "(nper)" -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.yaml index f13aaea9..56495f81 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-mwe.yaml @@ -109,20 +109,6 @@ blocks: optional: false longname: file keyword type: string - temperature: - block: options - description: keyword to specify that record corresponds to temperature. - reader: urword - optional: false - longname: stage keyword - type: keyword - tempfile: - block: options - description: name of the binary output file to write temperature information. - reader: urword - optional: false - longname: file keyword - type: string budget_filerecord: block: options reader: urword @@ -150,27 +136,6 @@ blocks: optional: false longname: file keyword type: string - budget: - block: options - description: keyword to specify that record corresponds to the budget. - reader: urword - optional: false - longname: budget keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - budgetfile: - block: options - description: name of the binary output file to write budget information. - reader: urword - optional: false - longname: file keyword - type: string budgetcsv_filerecord: block: options reader: urword @@ -199,21 +164,6 @@ blocks: optional: false longname: file keyword type: string - budgetcsv: - block: options - description: keyword to specify that record corresponds to the budget CSV. - reader: urword - optional: false - longname: budget keyword - type: keyword - budgetcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string ts_filerecord: block: options reader: urword @@ -242,28 +192,6 @@ blocks: optional: false longname: file name of time series information type: string - ts6: - block: options - description: keyword to specify that record corresponds to a time-series file. - reader: urword - optional: false - longname: head keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ts6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of time series information - type: string obs_filerecord: block: options reader: urword @@ -293,22 +221,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string packagedata: packagedata: shape: (maxbound) @@ -376,162 +288,7 @@ blocks: optional: true longname: well name type: string - mawno: - block: packagedata - description: integer value that defines the well number associated with the specified PACKAGEDATA - data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information - must be specified for every well or the program will terminate with an error. The program will - also terminate with an error if information for a well is specified more than once. - reader: urword - longname: well number for this entry - numeric_index: true - type: integer - strt: - block: packagedata - description: real value that defines the starting temperature for the well. - reader: urword - longname: starting well temperature - type: double - ktf: - block: packagedata - description: is the thermal conductivity of the material between the aquifer cell and the feature. - The thickness of the material is defined by the variable FTHK. - reader: urword - longname: thermal conductivity of the feature - type: double - fthk: - block: packagedata - description: real value that defines the thickness of the material through which conduction occurs. Must - be greater than 0. - reader: urword - longname: thickness of the well feature - type: double - aux: - shape: (naux) - block: packagedata - 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. - reader: urword - time_series: true - optional: true - longname: auxiliary variables - type: double - boundname: - block: packagedata - 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. - reader: urword - optional: true - longname: well name - type: string period: - iper: - shape: (nper) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - mweperioddata: - shape: (nper) - block: period - reader: urword - type: list - children: - mweperioddata: - type: record - block: period - reader: urword - children: - mawno: - block: period - description: integer value that defines the well number associated with the specified PERIOD - data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. - reader: urword - longname: well number for this entry - numeric_index: true - type: integer - mwesetting: - block: period - description: 'line of information that is parsed into a keyword and values. Keyword values - that can be used to start the MWESETTING string include: STATUS, TEMPERATURE, RAINFALL, - EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature - of associated with the corresponding flow terms. Temperatures cannot be specified for - all flow terms. For example, the Multi-Aquifer Well Package supports a ''WITHDRAWAL'' - flow term. If this withdrawal term is active, then water will be withdrawn from the well - at the calculated temperature of the well.' - reader: urword - type: union - children: - temperature: - block: period - description: real or character value that defines the temperature for the well. The - specified TEMPERATURE is only applied if the well is a constant temperature well. - 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. - time_series: true - reader: urword - longname: well temperature - type: string - status: - block: period - description: keyword option to define well status. STATUS can be ACTIVE, INACTIVE, - or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated - for the well. If a well is inactive, then there will be no solute mass fluxes into - or out of the well and the inactive value will be written for the well temperature. If - a well is constant, then the temperature for the well will be fixed at the user specified - value. - reader: urword - longname: well temperature status - type: string - rate: - block: period - description: real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ - for the well. 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. - reader: urword - time_series: true - longname: well injection temperature - type: string - auxiliaryrecord: - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must - match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME - does not match one of the auxiliary variable names defined in the OPTIONS block - the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double mawno: shape: (nper) block: period @@ -609,87 +366,3 @@ blocks: time_series: true longname: auxiliary variable value type: double - status: - shape: (nper) - block: period - description: keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. - By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If - a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive - value will be written for the well temperature. If a well is constant, then the temperature for - the well will be fixed at the user specified value. - reader: urword - longname: well temperature status - type: string - temperature: - shape: (nper) - block: period - description: real or character value that defines the temperature for the well. The specified TEMPERATURE - is only applied if the well is a constant temperature well. 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. - time_series: true - reader: urword - longname: well temperature - type: string - rate: - shape: (nper) - block: period - description: real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ - for the well. 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. - reader: urword - time_series: true - longname: well injection temperature - type: string - auxiliaryrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one - of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one - of the auxiliary variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double - auxiliary: - shape: (nper) - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - shape: (nper) - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the - auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary - variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - shape: (nper) - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.json index 92b870e1..7e97f02b 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.json @@ -83,15 +83,6 @@ } } }, - "netcdf_mesh2d": { - "block": "options", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "extended": true, - "type": "keyword" - }, "nc_structured_filerecord": { "block": "options", "description": "NetCDF structured fileout record.", @@ -129,42 +120,6 @@ } } }, - "netcdf_structured": { - "block": "options", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "mf6internal": "netcdf_struct", - "extended": true, - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ncmesh2dfile": { - "block": "options", - "description": "name of the NetCDF ugrid layered mesh output file.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "extended": true, - "type": "string" - }, - "ncstructfile": { - "block": "options", - "description": "name of the NetCDF structured output file.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "extended": true, - "type": "string" - }, "nc_filerecord": { "block": "options", "description": "NetCDF filerecord", @@ -200,33 +155,6 @@ "type": "string" } } - }, - "netcdf": { - "block": "options", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "reader": "urword", - "optional": false, - "longname": "netcdf keyword", - "extended": true, - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "netcdf_filename": { - "block": "options", - "description": "defines a NetCDF input file.", - "reader": "urword", - "optional": false, - "longname": "netcdf input filename", - "mf6internal": "netcdf_fname", - "extended": true, - "type": "string" } }, "packages": { @@ -269,28 +197,6 @@ } } } - }, - "ftype": { - "block": "packages", - "description": "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase.", - "reader": "urword", - "longname": "package type", - "type": "string" - }, - "fname": { - "block": "packages", - "description": "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run.", - "reader": "urword", - "longname": "file name", - "type": "string" - }, - "pname": { - "block": "packages", - "description": "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWE Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters.", - "reader": "urword", - "optional": true, - "longname": "user name for package", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.toml index 60750c1b..ca0fd19f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.toml @@ -79,15 +79,6 @@ longname = "file keyword" extended = true type = "string" -[blocks.options.netcdf_mesh2d] -block = "options" -description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -reader = "urword" -optional = false -longname = "budget keyword" -extended = true -type = "keyword" - [blocks.options.nc_structured_filerecord] block = "options" description = "NetCDF structured fileout record." @@ -123,42 +114,6 @@ longname = "file keyword" extended = true type = "string" -[blocks.options.netcdf_structured] -block = "options" -description = "keyword to specify that record corresponds to a structured NetCDF file." -reader = "urword" -optional = false -longname = "budget keyword" -mf6internal = "netcdf_struct" -extended = true -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ncmesh2dfile] -block = "options" -description = "name of the NetCDF ugrid layered mesh output file." -reader = "urword" -optional = false -longname = "file keyword" -extended = true -type = "string" - -[blocks.options.ncstructfile] -block = "options" -description = "name of the NetCDF structured output file." -reader = "urword" -optional = false -longname = "file keyword" -extended = true -type = "string" - [blocks.options.nc_filerecord] block = "options" description = "NetCDF filerecord" @@ -193,33 +148,6 @@ mf6internal = "netcdf_fname" extended = true type = "string" -[blocks.options.netcdf] -block = "options" -description = "keyword to specify that record corresponds to a NetCDF input file." -reader = "urword" -optional = false -longname = "netcdf keyword" -extended = true -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.netcdf_filename] -block = "options" -description = "defines a NetCDF input file." -reader = "urword" -optional = false -longname = "netcdf input filename" -mf6internal = "netcdf_fname" -extended = true -type = "string" - [blocks.packages.packages] block = "packages" reader = "urword" @@ -255,25 +183,3 @@ reader = "urword" optional = true longname = "user name for package" type = "string" - -[blocks.packages.ftype] -block = "packages" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase." -reader = "urword" -longname = "package type" -type = "string" - -[blocks.packages.fname] -block = "packages" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -reader = "urword" -longname = "file name" -type = "string" - -[blocks.packages.pname] -block = "packages" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWE Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -reader = "urword" -optional = true -longname = "user name for package" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.yaml index 61cb1f34..b5afbc24 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-nam.yaml @@ -80,14 +80,6 @@ blocks: longname: file keyword extended: true type: string - netcdf_mesh2d: - block: options - description: keyword to specify that record corresponds to a layered mesh NetCDF file. - reader: urword - optional: false - longname: budget keyword - extended: true - type: keyword nc_structured_filerecord: block: options description: NetCDF structured fileout record. @@ -120,38 +112,6 @@ blocks: longname: file keyword extended: true type: string - netcdf_structured: - block: options - description: keyword to specify that record corresponds to a structured NetCDF file. - reader: urword - optional: false - longname: budget keyword - mf6internal: netcdf_struct - extended: true - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ncmesh2dfile: - block: options - description: name of the NetCDF ugrid layered mesh output file. - reader: urword - optional: false - longname: file keyword - extended: true - type: string - ncstructfile: - block: options - description: name of the NetCDF structured output file. - reader: urword - optional: false - longname: file keyword - extended: true - type: string nc_filerecord: block: options description: NetCDF filerecord @@ -183,30 +143,6 @@ blocks: mf6internal: netcdf_fname extended: true type: string - netcdf: - block: options - description: keyword to specify that record corresponds to a NetCDF input file. - reader: urword - optional: false - longname: netcdf keyword - extended: true - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - netcdf_filename: - block: options - description: defines a NetCDF input file. - reader: urword - optional: false - longname: netcdf input filename - mf6internal: netcdf_fname - extended: true - type: string packages: packages: block: packages @@ -250,30 +186,3 @@ blocks: optional: true longname: user name for package type: string - ftype: - block: packages - description: is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwe}. - Ftype may be entered in any combination of uppercase and lowercase. - reader: urword - longname: package type - type: string - fname: - block: packages - description: is the name of the file containing the package input. The path to the file should - be included if the file is not located in the folder where the program was run. - reader: urword - longname: file name - type: string - pname: - block: packages - description: is the user-defined name for the package. PNAME is restricted to 16 characters. No - spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress - packages only. These names may be useful for labeling purposes when multiple stress packages - of the same type are located within a single GWE Model. If PNAME is specified for a stress package, - then PNAME will be used in the flow budget table in the listing file; it will also be used for - the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all - upper case letters. - reader: urword - optional: true - longname: user name for package - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-oc.json index f39810d7..f676e4c6 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwe-oc.json @@ -39,30 +39,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -96,22 +72,6 @@ } } }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "temperature_filerecord": { "block": "options", "reader": "urword", @@ -146,23 +106,6 @@ } } }, - "temperature": { - "block": "options", - "description": "keyword to specify that record corresponds to temperature.", - "reader": "urword", - "optional": false, - "longname": "temperature keyword", - "type": "keyword" - }, - "temperaturefile": { - "block": "options", - "description": "name of the output file to write temperature information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "mf6internal": "tempfile", - "type": "string" - }, "temperatureprintrecord": { "block": "options", "reader": "urword", @@ -187,93 +130,9 @@ "type": "keyword" } } - }, - "print_format": { - "block": "options", - "description": "keyword to specify format for printing to the listing file.", - "reader": "urword", - "optional": false, - "longname": "keyword to indicate that a print format follows", - "type": "keyword" - }, - "formatrecord": { - "block": "options", - "reader": "urword", - "optional": false, - "type": "record", - "children": { - "columns": { - "block": "options", - "description": "number of columns for writing data.", - "reader": "urword", - "longname": "number of columns", - "type": "integer" - }, - "width": { - "block": "options", - "description": "width for writing each number.", - "reader": "urword", - "longname": "width for each number", - "type": "integer" - }, - "digits": { - "block": "options", - "description": "number of digits to use for writing a number.", - "reader": "urword", - "longname": "number of digits", - "type": "integer" - }, - "format": { - "block": "options", - "description": "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC.", - "reader": "urword", - "optional": false, - "longname": "write format", - "type": "string" - } - } - }, - "columns": { - "block": "options", - "description": "number of columns for writing data.", - "reader": "urword", - "longname": "number of columns", - "type": "integer" - }, - "width": { - "block": "options", - "description": "width for writing each number.", - "reader": "urword", - "longname": "width for each number", - "type": "integer" - }, - "digits": { - "block": "options", - "description": "number of digits to use for writing a number.", - "reader": "urword", - "longname": "number of digits", - "type": "integer" - }, - "format": { - "block": "options", - "description": "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC.", - "reader": "urword", - "optional": false, - "longname": "write format", - "type": "string" } }, "period": { - "iper": { - "shape": "(nper)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, "saverecord": { "shape": "(nper)", "block": "period", @@ -338,15 +197,6 @@ } } }, - "save": { - "shape": "(nper)", - "block": "period", - "description": "keyword to indicate that information will be saved this stress period.", - "reader": "urword", - "optional": false, - "longname": "keyword to save", - "type": "keyword" - }, "printrecord": { "shape": "(nper)", "block": "period", @@ -410,99 +260,6 @@ } } } - }, - "print": { - "shape": "(nper)", - "block": "period", - "description": "keyword to indicate that information will be printed this stress period.", - "reader": "urword", - "optional": false, - "longname": "keyword to save", - "type": "keyword" - }, - "rtype": { - "shape": "(nper)", - "block": "period", - "description": "type of information to save or print. Can be BUDGET or TEMPERATURE.", - "reader": "urword", - "optional": false, - "longname": "record type", - "type": "string" - }, - "ocsetting": { - "shape": "(nper)", - "block": "period", - "description": "specifies the steps for which the data will be saved.", - "reader": "urword", - "type": "union", - "children": { - "all": { - "block": "period", - "description": "keyword to indicate save for all time steps in period.", - "reader": "urword", - "type": "keyword" - }, - "first": { - "block": "period", - "description": "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "keyword" - }, - "last": { - "block": "period", - "description": "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "keyword" - }, - "frequency": { - "block": "period", - "description": "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "integer" - }, - "steps": { - "shape": "($ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'.", - "reader": "urword", - "longname": "head limit", - "type": "string" - }, - "shutoffrecord": { - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "shut_off": { - "block": "period", - "description": "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used.", - "reader": "urword", - "longname": "shut off well", - "type": "keyword" - }, - "minrate": { - "block": "period", - "description": "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate.", - "reader": "urword", - "longname": "minimum shutoff rate", - "type": "double" - }, - "maxrate": { - "block": "period", - "description": "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE.", - "reader": "urword", - "longname": "maximum shutoff rate", - "type": "double" - } - } - }, - "rate_scalingrecord": { - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "rate_scaling": { - "block": "period", - "description": "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero.", - "reader": "urword", - "longname": "rate scaling", - "type": "keyword" - }, - "pump_elevation": { - "block": "period", - "description": "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well.", - "reader": "urword", - "longname": "pump elevation", - "type": "double" - }, - "scaling_length": { - "block": "period", - "description": "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced.", - "reader": "urword", - "type": "double" - } - } - }, - "auxiliaryrecord": { - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - } - } - } - } - } - } - }, "ifno": { "shape": "(nper)", "block": "period", @@ -1029,263 +616,6 @@ } } } - }, - "status": { - "shape": "(nper)", - "block": "period", - "description": "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE.", - "reader": "urword", - "longname": "well status", - "type": "string" - }, - "flowing_wellrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "flowing_well": { - "block": "period", - "description": "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation.", - "reader": "urword", - "longname": "well is a flowing well", - "type": "keyword" - }, - "fwelev": { - "block": "period", - "description": "elevation used to determine whether or not the well is flowing.", - "reader": "urword", - "longname": "flowing well elevation", - "type": "double" - }, - "fwcond": { - "block": "period", - "description": "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV).", - "reader": "urword", - "longname": "well flowing well conductance", - "type": "double" - }, - "fwrlen": { - "block": "period", - "description": "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates.", - "reader": "urword", - "longname": "flowing well reduction length", - "type": "double" - } - } - }, - "flowing_well": { - "shape": "(nper)", - "block": "period", - "description": "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation.", - "reader": "urword", - "longname": "well is a flowing well", - "type": "keyword" - }, - "fwelev": { - "shape": "(nper)", - "block": "period", - "description": "elevation used to determine whether or not the well is flowing.", - "reader": "urword", - "longname": "flowing well elevation", - "type": "double" - }, - "fwcond": { - "shape": "(nper)", - "block": "period", - "description": "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV).", - "reader": "urword", - "longname": "well flowing well conductance", - "type": "double" - }, - "fwrlen": { - "shape": "(nper)", - "block": "period", - "description": "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates.", - "reader": "urword", - "longname": "flowing well reduction length", - "type": "double" - }, - "rate": { - "shape": "(nper)", - "block": "period", - "description": "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero.", - "reader": "urword", - "time_series": true, - "longname": "well pumping rate", - "type": "double" - }, - "well_head": { - "shape": "(nper)", - "block": "period", - "description": "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate with an error if WELL_HEAD is less than the bottom of the well.", - "reader": "urword", - "time_series": true, - "longname": "well head", - "type": "double" - }, - "head_limit": { - "shape": "(nper)", - "block": "period", - "description": "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'.", - "reader": "urword", - "longname": "head limit", - "type": "string" - }, - "shutoffrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "shut_off": { - "block": "period", - "description": "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used.", - "reader": "urword", - "longname": "shut off well", - "type": "keyword" - }, - "minrate": { - "block": "period", - "description": "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate.", - "reader": "urword", - "longname": "minimum shutoff rate", - "type": "double" - }, - "maxrate": { - "block": "period", - "description": "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE.", - "reader": "urword", - "longname": "maximum shutoff rate", - "type": "double" - } - } - }, - "shut_off": { - "shape": "(nper)", - "block": "period", - "description": "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used.", - "reader": "urword", - "longname": "shut off well", - "type": "keyword" - }, - "minrate": { - "shape": "(nper)", - "block": "period", - "description": "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate.", - "reader": "urword", - "longname": "minimum shutoff rate", - "type": "double" - }, - "maxrate": { - "shape": "(nper)", - "block": "period", - "description": "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE.", - "reader": "urword", - "longname": "maximum shutoff rate", - "type": "double" - }, - "rate_scalingrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "rate_scaling": { - "block": "period", - "description": "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero.", - "reader": "urword", - "longname": "rate scaling", - "type": "keyword" - }, - "pump_elevation": { - "block": "period", - "description": "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well.", - "reader": "urword", - "longname": "pump elevation", - "type": "double" - }, - "scaling_length": { - "block": "period", - "description": "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced.", - "reader": "urword", - "type": "double" - } - } - }, - "rate_scaling": { - "shape": "(nper)", - "block": "period", - "description": "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero.", - "reader": "urword", - "longname": "rate scaling", - "type": "keyword" - }, - "pump_elevation": { - "shape": "(nper)", - "block": "period", - "description": "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well.", - "reader": "urword", - "longname": "pump elevation", - "type": "double" - }, - "scaling_length": { - "shape": "(nper)", - "block": "period", - "description": "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced.", - "reader": "urword", - "type": "double" - }, - "auxiliaryrecord": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "auxiliary": { - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" - } - } - }, - "auxiliary": { - "shape": "(nper)", - "block": "period", - "description": "keyword for specifying auxiliary variable.", - "reader": "urword", - "type": "keyword" - }, - "auxname": { - "shape": "(nper)", - "block": "period", - "description": "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.", - "reader": "urword", - "type": "string" - }, - "auxval": { - "shape": "(nper)", - "block": "period", - "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.", - "reader": "urword", - "time_series": true, - "longname": "auxiliary variable value", - "type": "double" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.toml index eadc2a2b..f5091f22 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.toml @@ -82,22 +82,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.head] -block = "options" -description = "keyword to specify that record corresponds to head." -reader = "urword" -optional = false -longname = "head keyword" -type = "keyword" - -[blocks.options.headfile] -block = "options" -description = "name of the binary output file to write head information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budget_filerecord] block = "options" reader = "urword" @@ -128,30 +112,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budget] -block = "options" -description = "keyword to specify that record corresponds to the budget." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.budgetfile] -block = "options" -description = "name of the binary output file to write budget information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budgetcsv_filerecord] block = "options" reader = "urword" @@ -182,22 +142,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budgetcsv] -block = "options" -description = "keyword to specify that record corresponds to the budget CSV." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.budgetcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.no_well_storage] block = "options" description = "keyword that deactivates inclusion of well storage contributions to the multi-aquifer well package continuity equation." @@ -268,22 +212,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.maw_flow_reduce_csv] -block = "options" -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." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.mfrcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.ts_filerecord] block = "options" reader = "urword" @@ -314,30 +242,6 @@ optional = false longname = "file name of time series information" type = "string" -[blocks.options.ts6] -block = "options" -description = "keyword to specify that record corresponds to a time-series file." -reader = "urword" -optional = false -longname = "head keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ts6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of time series information" -type = "string" - [blocks.options.obs_filerecord] block = "options" reader = "urword" @@ -368,22 +272,6 @@ optional = false longname = "obs6 input filename" type = "string" -[blocks.options.obs6] -block = "options" -description = "keyword to specify that record corresponds to an observations file." -reader = "urword" -optional = false -longname = "obs keyword" -type = "keyword" - -[blocks.options.obs6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "obs6 input filename" -type = "string" - [blocks.options.mover] block = "options" description = "keyword to indicate that this instance of the MAW Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." @@ -472,67 +360,6 @@ optional = true longname = "well name" type = "string" -[blocks.packagedata.ifno] -block = "packagedata" -description = "integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error. The program will also terminate with an error if information for a multi-aquifer well is specified more than once." -reader = "urword" -longname = "well number for this entry" -numeric_index = true -type = "integer" - -[blocks.packagedata.radius] -block = "packagedata" -description = "radius for the multi-aquifer well. The program will terminate with an error if the radius is less than or equal to zero." -reader = "urword" -longname = "well radius" -type = "double" - -[blocks.packagedata.bottom] -block = "packagedata" -description = "bottom elevation of the multi-aquifer well. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, BOTTOM is set to the cell bottom in the lowermost GWF cell connection in cases where the specified well bottom is above the bottom of this GWF cell. If CONDEQN is MEAN, BOTTOM is set to the lowermost GWF cell connection screen bottom in cases where the specified well bottom is above this value. The bottom elevation defines the lowest well head that will be simulated when the NEWTON UNDER_RELAXATION option is specified in the GWF model name file. The bottom elevation is also used to calculate volumetric storage in the well." -reader = "urword" -longname = "well bottom" -type = "double" - -[blocks.packagedata.strt] -block = "packagedata" -description = "starting head for the multi-aquifer well. The program will terminate with an error if the starting head is less than the specified well bottom." -reader = "urword" -longname = "starting head" -type = "double" - -[blocks.packagedata.condeqn] -block = "packagedata" -description = "character string that defines the conductance equation that is used to calculate the saturated conductance for the multi-aquifer well. Possible multi-aquifer well CONDEQN strings include: SPECIFIED--character keyword to indicate the multi-aquifer well saturated conductance will be specified. THIEM--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the Thiem equation, which considers the cell top and bottom, aquifer hydraulic conductivity, and effective cell and well radius. SKIN--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using the cell top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. CUMULATIVE--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using a combination of the Thiem and SKIN equations. MEAN--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the aquifer and screen top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. The CUMULATIVE conductance equation is identical to the SKIN LOSSTYPE in the Multi-Node Well (MNW2) package for MODFLOW-2005. The program will terminate with an error condition if CONDEQN is SKIN or CUMULATIVE and the calculated saturated conductance is less than zero; if an error condition occurs, it is suggested that the THIEM or MEAN conductance equations be used for these multi-aquifer wells." -reader = "urword" -longname = "conductance equation" -type = "string" - -[blocks.packagedata.ngwfnodes] -block = "packagedata" -description = "integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be greater than zero." -reader = "urword" -longname = "number of connected GWF cells" -type = "integer" - -[blocks.packagedata.aux] -shape = "(naux)" -block = "packagedata" -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." -reader = "urword" -time_series = true -optional = true -longname = "auxiliary variables" -type = "double" - -[blocks.packagedata.boundname] -block = "packagedata" -description = "name of the multi-aquifer 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." -reader = "urword" -optional = true -longname = "well name" -type = "string" - [blocks.connectiondata.connectiondata] block = "connectiondata" reader = "urword" @@ -595,134 +422,63 @@ reader = "urword" longname = "skin radius" type = "double" -[blocks.connectiondata.ifno] -block = "connectiondata" -description = "integer value that defines the feature (well) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error. The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once." -reader = "urword" -longname = "well number for this entry" -numeric_index = true -type = "integer" - -[blocks.connectiondata.icon] -block = "connectiondata" -description = "integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." -reader = "urword" -longname = "connection number" -numeric_index = true -type = "integer" - -[blocks.connectiondata.cellid] -shape = "(ncelldim)" -block = "connectiondata" -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." -reader = "urword" -longname = "cell identifier" -type = "integer" - -[blocks.connectiondata.scrn_top] -block = "connectiondata" -description = "value that defines the top elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_TOP can be any value and is set to the top of the cell. If CONDEQN is MEAN, SCRN_TOP is set to the multi-aquifer well connection cell top if the specified value is greater than the cell top. The program will terminate with an error if the screen top is less than the screen bottom." -reader = "urword" -longname = "screen top" -type = "double" - -[blocks.connectiondata.scrn_bot] -block = "connectiondata" -description = "value that defines the bottom elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_BOT can be any value and is set to the bottom of the cell. If CONDEQN is MEAN, SCRN_BOT is set to the multi-aquifer well connection cell bottom if the specified value is less than the cell bottom. The program will terminate with an error if the screen bottom is greater than the screen top." -reader = "urword" -longname = "screen bottom" -type = "double" - -[blocks.connectiondata.hk_skin] -block = "connectiondata" -description = "value that defines the skin (filter pack) hydraulic conductivity (if CONDEQN for the multi-aquifer well is SKIN, CUMULATIVE, or MEAN) or conductance (if CONDEQN for the multi-aquifer well is SPECIFIED) for each GWF node connected to the multi-aquifer well (NGWFNODES). If CONDEQN is SPECIFIED, HK_SKIN must be greater than or equal to zero. HK_SKIN can be any value if CONDEQN is THIEM. Otherwise, HK_SKIN must be greater than zero. If CONDEQN is SKIN, the contrast between the cell transmissivity (the product of geometric mean horizontal hydraulic conductivity and the cell thickness) and the well transmissivity (the product of HK_SKIN and the screen thicknesses) must be greater than one in node CELLID or the program will terminate with an error condition; if an error condition occurs, it is suggested that the HK_SKIN be reduced to a value less than K11 and K22 in node CELLID or the THIEM or MEAN conductance equations be used for these multi-aquifer wells." -reader = "urword" -longname = "skin data" -type = "double" - -[blocks.connectiondata.radius_skin] -block = "connectiondata" -description = "real value that defines the skin radius (filter pack radius) for the multi-aquifer well. RADIUS_SKIN can be any value if CONDEQN is SPECIFIED or THIEM. If CONDEQN is SKIN, CUMULATIVE, or MEAN, the program will terminate with an error if RADIUS_SKIN is less than or equal to the RADIUS for the multi-aquifer well." -reader = "urword" -longname = "skin radius" -type = "double" - -[blocks.period.iper] -shape = "(nper)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.perioddata] +[blocks.period.ifno] shape = "(nper)" block = "period" -reader = "urword" -type = "list" - -[blocks.period.perioddata.children.perioddata] -type = "record" -block = "period" -reader = "urword" - -[blocks.period.perioddata.children.perioddata.children.ifno] -block = "period" description = "integer value that defines the well number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." reader = "urword" longname = "well number for this entry" numeric_index = true type = "integer" -[blocks.period.perioddata.children.perioddata.children.mawsetting] +[blocks.period.mawsetting] +shape = "(nper)" block = "period" description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: STATUS, FLOWING_WELL, RATE, WELL_HEAD, HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY." reader = "urword" type = "union" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.status] +[blocks.period.mawsetting.children.status] block = "period" description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." reader = "urword" longname = "well status" type = "string" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.flowing_wellrecord] +[blocks.period.mawsetting.children.flowing_wellrecord] block = "period" reader = "urword" type = "record" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.flowing_wellrecord.children.flowing_well] +[blocks.period.mawsetting.children.flowing_wellrecord.children.flowing_well] block = "period" description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." reader = "urword" longname = "well is a flowing well" type = "keyword" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.flowing_wellrecord.children.fwelev] +[blocks.period.mawsetting.children.flowing_wellrecord.children.fwelev] block = "period" description = "elevation used to determine whether or not the well is flowing." reader = "urword" longname = "flowing well elevation" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.flowing_wellrecord.children.fwcond] +[blocks.period.mawsetting.children.flowing_wellrecord.children.fwcond] block = "period" description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." reader = "urword" longname = "well flowing well conductance" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.flowing_wellrecord.children.fwrlen] +[blocks.period.mawsetting.children.flowing_wellrecord.children.fwrlen] block = "period" description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." reader = "urword" longname = "flowing well reduction length" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.rate] +[blocks.period.mawsetting.children.rate] block = "period" description = "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero." reader = "urword" @@ -730,7 +486,7 @@ time_series = true longname = "well pumping rate" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.well_head] +[blocks.period.mawsetting.children.well_head] block = "period" description = "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate with an error if WELL_HEAD is less than the bottom of the well." reader = "urword" @@ -738,231 +494,76 @@ time_series = true longname = "well head" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.head_limit] +[blocks.period.mawsetting.children.head_limit] block = "period" description = "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'." reader = "urword" longname = "head limit" type = "string" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.shutoffrecord] +[blocks.period.mawsetting.children.shutoffrecord] block = "period" reader = "urword" type = "record" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.shutoffrecord.children.shut_off] +[blocks.period.mawsetting.children.shutoffrecord.children.shut_off] block = "period" description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." reader = "urword" longname = "shut off well" type = "keyword" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.shutoffrecord.children.minrate] +[blocks.period.mawsetting.children.shutoffrecord.children.minrate] block = "period" description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." reader = "urword" longname = "minimum shutoff rate" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.shutoffrecord.children.maxrate] +[blocks.period.mawsetting.children.shutoffrecord.children.maxrate] block = "period" description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." reader = "urword" longname = "maximum shutoff rate" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.rate_scalingrecord] +[blocks.period.mawsetting.children.rate_scalingrecord] block = "period" reader = "urword" type = "record" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.rate_scalingrecord.children.rate_scaling] +[blocks.period.mawsetting.children.rate_scalingrecord.children.rate_scaling] block = "period" description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." reader = "urword" longname = "rate scaling" type = "keyword" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.rate_scalingrecord.children.pump_elevation] +[blocks.period.mawsetting.children.rate_scalingrecord.children.pump_elevation] block = "period" description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." reader = "urword" longname = "pump elevation" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.rate_scalingrecord.children.scaling_length] +[blocks.period.mawsetting.children.rate_scalingrecord.children.scaling_length] block = "period" description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." reader = "urword" type = "double" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.auxiliaryrecord] +[blocks.period.mawsetting.children.auxiliaryrecord] block = "period" reader = "urword" type = "record" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.auxiliaryrecord.children.auxiliary] +[blocks.period.mawsetting.children.auxiliaryrecord.children.auxiliary] block = "period" description = "keyword for specifying auxiliary variable." reader = "urword" type = "keyword" -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.perioddata.children.perioddata.children.mawsetting.children.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - -[blocks.period.ifno] -shape = "(nper)" -block = "period" -description = "integer value that defines the well number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." -reader = "urword" -longname = "well number for this entry" -numeric_index = true -type = "integer" - -[blocks.period.mawsetting] -shape = "(nper)" -block = "period" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: STATUS, FLOWING_WELL, RATE, WELL_HEAD, HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY." -reader = "urword" -type = "union" - -[blocks.period.mawsetting.children.status] -block = "period" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." -reader = "urword" -longname = "well status" -type = "string" - -[blocks.period.mawsetting.children.flowing_wellrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.mawsetting.children.flowing_wellrecord.children.flowing_well] -block = "period" -description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." -reader = "urword" -longname = "well is a flowing well" -type = "keyword" - -[blocks.period.mawsetting.children.flowing_wellrecord.children.fwelev] -block = "period" -description = "elevation used to determine whether or not the well is flowing." -reader = "urword" -longname = "flowing well elevation" -type = "double" - -[blocks.period.mawsetting.children.flowing_wellrecord.children.fwcond] -block = "period" -description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." -reader = "urword" -longname = "well flowing well conductance" -type = "double" - -[blocks.period.mawsetting.children.flowing_wellrecord.children.fwrlen] -block = "period" -description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." -reader = "urword" -longname = "flowing well reduction length" -type = "double" - -[blocks.period.mawsetting.children.rate] -block = "period" -description = "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero." -reader = "urword" -time_series = true -longname = "well pumping rate" -type = "double" - -[blocks.period.mawsetting.children.well_head] -block = "period" -description = "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate with an error if WELL_HEAD is less than the bottom of the well." -reader = "urword" -time_series = true -longname = "well head" -type = "double" - -[blocks.period.mawsetting.children.head_limit] -block = "period" -description = "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'." -reader = "urword" -longname = "head limit" -type = "string" - -[blocks.period.mawsetting.children.shutoffrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.mawsetting.children.shutoffrecord.children.shut_off] -block = "period" -description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." -reader = "urword" -longname = "shut off well" -type = "keyword" - -[blocks.period.mawsetting.children.shutoffrecord.children.minrate] -block = "period" -description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." -reader = "urword" -longname = "minimum shutoff rate" -type = "double" - -[blocks.period.mawsetting.children.shutoffrecord.children.maxrate] -block = "period" -description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." -reader = "urword" -longname = "maximum shutoff rate" -type = "double" - -[blocks.period.mawsetting.children.rate_scalingrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.mawsetting.children.rate_scalingrecord.children.rate_scaling] -block = "period" -description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." -reader = "urword" -longname = "rate scaling" -type = "keyword" - -[blocks.period.mawsetting.children.rate_scalingrecord.children.pump_elevation] -block = "period" -description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." -reader = "urword" -longname = "pump elevation" -type = "double" - -[blocks.period.mawsetting.children.rate_scalingrecord.children.scaling_length] -block = "period" -description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." -reader = "urword" -type = "double" - -[blocks.period.mawsetting.children.auxiliaryrecord] -block = "period" -reader = "urword" -type = "record" - -[blocks.period.mawsetting.children.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.mawsetting.children.auxiliaryrecord.children.auxname] +[blocks.period.mawsetting.children.auxiliaryrecord.children.auxname] block = "period" description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." reader = "urword" @@ -975,252 +576,3 @@ reader = "urword" time_series = true longname = "auxiliary variable value" type = "double" - -[blocks.period.status] -shape = "(nper)" -block = "period" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." -reader = "urword" -longname = "well status" -type = "string" - -[blocks.period.flowing_wellrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.flowing_wellrecord.children.flowing_well] -block = "period" -description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." -reader = "urword" -longname = "well is a flowing well" -type = "keyword" - -[blocks.period.flowing_wellrecord.children.fwelev] -block = "period" -description = "elevation used to determine whether or not the well is flowing." -reader = "urword" -longname = "flowing well elevation" -type = "double" - -[blocks.period.flowing_wellrecord.children.fwcond] -block = "period" -description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." -reader = "urword" -longname = "well flowing well conductance" -type = "double" - -[blocks.period.flowing_wellrecord.children.fwrlen] -block = "period" -description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." -reader = "urword" -longname = "flowing well reduction length" -type = "double" - -[blocks.period.flowing_well] -shape = "(nper)" -block = "period" -description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." -reader = "urword" -longname = "well is a flowing well" -type = "keyword" - -[blocks.period.fwelev] -shape = "(nper)" -block = "period" -description = "elevation used to determine whether or not the well is flowing." -reader = "urword" -longname = "flowing well elevation" -type = "double" - -[blocks.period.fwcond] -shape = "(nper)" -block = "period" -description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." -reader = "urword" -longname = "well flowing well conductance" -type = "double" - -[blocks.period.fwrlen] -shape = "(nper)" -block = "period" -description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." -reader = "urword" -longname = "flowing well reduction length" -type = "double" - -[blocks.period.rate] -shape = "(nper)" -block = "period" -description = "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero." -reader = "urword" -time_series = true -longname = "well pumping rate" -type = "double" - -[blocks.period.well_head] -shape = "(nper)" -block = "period" -description = "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate with an error if WELL_HEAD is less than the bottom of the well." -reader = "urword" -time_series = true -longname = "well head" -type = "double" - -[blocks.period.head_limit] -shape = "(nper)" -block = "period" -description = "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'." -reader = "urword" -longname = "head limit" -type = "string" - -[blocks.period.shutoffrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.shutoffrecord.children.shut_off] -block = "period" -description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." -reader = "urword" -longname = "shut off well" -type = "keyword" - -[blocks.period.shutoffrecord.children.minrate] -block = "period" -description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." -reader = "urword" -longname = "minimum shutoff rate" -type = "double" - -[blocks.period.shutoffrecord.children.maxrate] -block = "period" -description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." -reader = "urword" -longname = "maximum shutoff rate" -type = "double" - -[blocks.period.shut_off] -shape = "(nper)" -block = "period" -description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." -reader = "urword" -longname = "shut off well" -type = "keyword" - -[blocks.period.minrate] -shape = "(nper)" -block = "period" -description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." -reader = "urword" -longname = "minimum shutoff rate" -type = "double" - -[blocks.period.maxrate] -shape = "(nper)" -block = "period" -description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." -reader = "urword" -longname = "maximum shutoff rate" -type = "double" - -[blocks.period.rate_scalingrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.rate_scalingrecord.children.rate_scaling] -block = "period" -description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." -reader = "urword" -longname = "rate scaling" -type = "keyword" - -[blocks.period.rate_scalingrecord.children.pump_elevation] -block = "period" -description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." -reader = "urword" -longname = "pump elevation" -type = "double" - -[blocks.period.rate_scalingrecord.children.scaling_length] -block = "period" -description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." -reader = "urword" -type = "double" - -[blocks.period.rate_scaling] -shape = "(nper)" -block = "period" -description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." -reader = "urword" -longname = "rate scaling" -type = "keyword" - -[blocks.period.pump_elevation] -shape = "(nper)" -block = "period" -description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." -reader = "urword" -longname = "pump elevation" -type = "double" - -[blocks.period.scaling_length] -shape = "(nper)" -block = "period" -description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." -reader = "urword" -type = "double" - -[blocks.period.auxiliaryrecord] -shape = "(nper)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.auxiliaryrecord.children.auxiliary] -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxiliaryrecord.children.auxname] -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxiliaryrecord.children.auxval] -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" - -[blocks.period.auxiliary] -shape = "(nper)" -block = "period" -description = "keyword for specifying auxiliary variable." -reader = "urword" -type = "keyword" - -[blocks.period.auxname] -shape = "(nper)" -block = "period" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -reader = "urword" -type = "string" - -[blocks.period.auxval] -shape = "(nper)" -block = "period" -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." -reader = "urword" -time_series = true -longname = "auxiliary variable value" -type = "double" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.yaml index 923e6bdd..3702b73e 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-maw.yaml @@ -90,20 +90,6 @@ blocks: optional: false longname: file keyword type: string - head: - block: options - description: keyword to specify that record corresponds to head. - reader: urword - optional: false - longname: head keyword - type: keyword - headfile: - block: options - description: name of the binary output file to write head information. - reader: urword - optional: false - longname: file keyword - type: string budget_filerecord: block: options reader: urword @@ -131,27 +117,6 @@ blocks: optional: false longname: file keyword type: string - budget: - block: options - description: keyword to specify that record corresponds to the budget. - reader: urword - optional: false - longname: budget keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - budgetfile: - block: options - description: name of the binary output file to write budget information. - reader: urword - optional: false - longname: file keyword - type: string budgetcsv_filerecord: block: options reader: urword @@ -180,21 +145,6 @@ blocks: optional: false longname: file keyword type: string - budgetcsv: - block: options - description: keyword to specify that record corresponds to the budget CSV. - reader: urword - optional: false - longname: budget keyword - type: keyword - budgetcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string no_well_storage: block: options description: keyword that deactivates inclusion of well storage contributions to the multi-aquifer @@ -280,24 +230,6 @@ blocks: optional: false longname: file keyword type: string - maw_flow_reduce_csv: - block: options - 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. - reader: urword - optional: false - longname: budget keyword - type: keyword - mfrcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string ts_filerecord: block: options reader: urword @@ -326,28 +258,6 @@ blocks: optional: false longname: file name of time series information type: string - ts6: - block: options - description: keyword to specify that record corresponds to a time-series file. - reader: urword - optional: false - longname: head keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ts6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of time series information - type: string obs_filerecord: block: options reader: urword @@ -377,22 +287,6 @@ blocks: optional: false longname: obs6 input filename type: string - obs6: - block: options - description: keyword to specify that record corresponds to an observations file. - reader: urword - optional: false - longname: obs keyword - type: keyword - obs6_filename: - block: options - 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. - reader: urword - optional: false - longname: obs6 input filename - type: string mover: block: options description: keyword to indicate that this instance of the MAW Package can be used with the Water @@ -513,94 +407,6 @@ blocks: optional: true longname: well name type: string - ifno: - block: packagedata - description: integer value that defines the feature (well) number associated with the specified - PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. - Multi-aquifer well information must be specified for every multi-aquifer well or the program will - terminate with an error. The program will also terminate with an error if information for a multi-aquifer - well is specified more than once. - reader: urword - longname: well number for this entry - numeric_index: true - type: integer - radius: - block: packagedata - description: radius for the multi-aquifer well. The program will terminate with an error if the - radius is less than or equal to zero. - reader: urword - longname: well radius - type: double - bottom: - block: packagedata - description: bottom elevation of the multi-aquifer well. If CONDEQN is SPECIFIED, THIEM, SKIN, or - CUMULATIVE, BOTTOM is set to the cell bottom in the lowermost GWF cell connection in cases where - the specified well bottom is above the bottom of this GWF cell. If CONDEQN is MEAN, BOTTOM is - set to the lowermost GWF cell connection screen bottom in cases where the specified well bottom - is above this value. The bottom elevation defines the lowest well head that will be simulated - when the NEWTON UNDER_RELAXATION option is specified in the GWF model name file. The bottom elevation - is also used to calculate volumetric storage in the well. - reader: urword - longname: well bottom - type: double - strt: - block: packagedata - description: starting head for the multi-aquifer well. The program will terminate with an error - if the starting head is less than the specified well bottom. - reader: urword - longname: starting head - type: double - condeqn: - block: packagedata - description: 'character string that defines the conductance equation that is used to calculate the - saturated conductance for the multi-aquifer well. Possible multi-aquifer well CONDEQN strings - include: SPECIFIED--character keyword to indicate the multi-aquifer well saturated conductance - will be specified. THIEM--character keyword to indicate the multi-aquifer well saturated conductance - will be calculated using the Thiem equation, which considers the cell top and bottom, aquifer - hydraulic conductivity, and effective cell and well radius. SKIN--character keyword to indicate - that the multi-aquifer well saturated conductance will be calculated using the cell top and bottom, - aquifer and screen hydraulic conductivity, and well and skin radius. CUMULATIVE--character keyword - to indicate that the multi-aquifer well saturated conductance will be calculated using a combination - of the Thiem and SKIN equations. MEAN--character keyword to indicate the multi-aquifer well saturated - conductance will be calculated using the aquifer and screen top and bottom, aquifer and screen - hydraulic conductivity, and well and skin radius. The CUMULATIVE conductance equation is identical - to the SKIN LOSSTYPE in the Multi-Node Well (MNW2) package for MODFLOW-2005. The program will - terminate with an error condition if CONDEQN is SKIN or CUMULATIVE and the calculated saturated - conductance is less than zero; if an error condition occurs, it is suggested that the THIEM or - MEAN conductance equations be used for these multi-aquifer wells.' - reader: urword - longname: conductance equation - type: string - ngwfnodes: - block: packagedata - description: integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer - well. NGWFNODES must be greater than zero. - reader: urword - longname: number of connected GWF cells - type: integer - aux: - shape: (naux) - block: packagedata - 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. - reader: urword - time_series: true - optional: true - longname: auxiliary variables - type: double - boundname: - block: packagedata - description: name of the multi-aquifer 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. - reader: urword - optional: true - longname: well name - type: string connectiondata: connectiondata: block: connectiondata @@ -692,307 +498,7 @@ blocks: reader: urword longname: skin radius type: double - ifno: - block: connectiondata - description: integer value that defines the feature (well) number associated with the specified - CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. - Multi-aquifer well connection information must be specified for every multi-aquifer well connection - to the GWF model (NGWFNODES) or the program will terminate with an error. The program will also - terminate with an error if connection information for a multi-aquifer well connection to the GWF - model is specified more than once. - reader: urword - longname: well number for this entry - numeric_index: true - type: integer - icon: - block: connectiondata - description: integer value that defines the GWF connection number for this multi-aquifer well connection - entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well - IFNO. - reader: urword - longname: connection number - numeric_index: true - type: integer - cellid: - shape: (ncelldim) - block: connectiondata - 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. - reader: urword - longname: cell identifier - type: integer - scrn_top: - block: connectiondata - description: value that defines the top elevation of the screen for the multi-aquifer well connection. - If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_TOP can be any value and is set to the - top of the cell. If CONDEQN is MEAN, SCRN_TOP is set to the multi-aquifer well connection cell - top if the specified value is greater than the cell top. The program will terminate with an error - if the screen top is less than the screen bottom. - reader: urword - longname: screen top - type: double - scrn_bot: - block: connectiondata - description: value that defines the bottom elevation of the screen for the multi-aquifer well connection. - If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_BOT can be any value and is set to the - bottom of the cell. If CONDEQN is MEAN, SCRN_BOT is set to the multi-aquifer well connection cell - bottom if the specified value is less than the cell bottom. The program will terminate with an - error if the screen bottom is greater than the screen top. - reader: urword - longname: screen bottom - type: double - hk_skin: - block: connectiondata - description: value that defines the skin (filter pack) hydraulic conductivity (if CONDEQN for the - multi-aquifer well is SKIN, CUMULATIVE, or MEAN) or conductance (if CONDEQN for the multi-aquifer - well is SPECIFIED) for each GWF node connected to the multi-aquifer well (NGWFNODES). If CONDEQN - is SPECIFIED, HK_SKIN must be greater than or equal to zero. HK_SKIN can be any value if CONDEQN - is THIEM. Otherwise, HK_SKIN must be greater than zero. If CONDEQN is SKIN, the contrast between - the cell transmissivity (the product of geometric mean horizontal hydraulic conductivity and the - cell thickness) and the well transmissivity (the product of HK_SKIN and the screen thicknesses) - must be greater than one in node CELLID or the program will terminate with an error condition; - if an error condition occurs, it is suggested that the HK_SKIN be reduced to a value less than - K11 and K22 in node CELLID or the THIEM or MEAN conductance equations be used for these multi-aquifer - wells. - reader: urword - longname: skin data - type: double - radius_skin: - block: connectiondata - description: real value that defines the skin radius (filter pack radius) for the multi-aquifer - well. RADIUS_SKIN can be any value if CONDEQN is SPECIFIED or THIEM. If CONDEQN is SKIN, CUMULATIVE, - or MEAN, the program will terminate with an error if RADIUS_SKIN is less than or equal to the - RADIUS for the multi-aquifer well. - reader: urword - longname: skin radius - type: double period: - iper: - shape: (nper) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - perioddata: - shape: (nper) - block: period - reader: urword - type: list - children: - perioddata: - type: record - block: period - reader: urword - children: - ifno: - block: period - description: integer value that defines the well number associated with the specified PERIOD - data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. - reader: urword - longname: well number for this entry - numeric_index: true - type: integer - mawsetting: - block: period - description: 'line of information that is parsed into a keyword and values. Keyword values - that can be used to start the MAWSETTING string include: STATUS, FLOWING_WELL, RATE, WELL_HEAD, - HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY.' - reader: urword - type: union - children: - status: - block: period - description: keyword option to define well status. STATUS can be ACTIVE, INACTIVE, - or CONSTANT. By default, STATUS is ACTIVE. - reader: urword - longname: well status - type: string - flowing_wellrecord: - block: period - reader: urword - type: record - children: - flowing_well: - block: period - description: keyword to indicate the well is a flowing well. The FLOWING_WELL option - can be used to simulate flowing wells when the simulated well head exceeds the - specified drainage elevation. - reader: urword - longname: well is a flowing well - type: keyword - fwelev: - block: period - description: elevation used to determine whether or not the well is flowing. - reader: urword - longname: flowing well elevation - type: double - fwcond: - block: period - description: conductance used to calculate the discharge of a free flowing well. Flow - occurs when the head in the well is above the well top elevation (FWELEV). - reader: urword - longname: well flowing well conductance - type: double - fwrlen: - block: period - description: length used to reduce the conductance of the flowing well. When the - head in the well drops below the well top plus the reduction length, then the - conductance is reduced. This reduction length can be used to improve the stability - of simulations with flowing wells so that there is not an abrupt change in flowing - well rates. - reader: urword - longname: flowing well reduction length - type: double - rate: - block: period - description: is the volumetric pumping rate for the multi-aquifer well. A positive value - indicates recharge and a negative value indicates discharge (pumping). RATE only applies - to active (STATUS is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero. - reader: urword - time_series: true - longname: well pumping rate - type: double - well_head: - block: period - description: is the head in the multi-aquifer well. WELL_HEAD is only applied to constant - head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate with an error if WELL_HEAD is less - than the bottom of the well. - reader: urword - time_series: true - longname: well head - type: double - head_limit: - block: period - description: is the limiting water level (head) in the well, which is the minimum of - the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied - to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be - deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on - the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for - MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility - with previous versions of MODFLOW but use of the RATE_SCALING option instead of the - HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'. - reader: urword - longname: head limit - type: string - shutoffrecord: - block: period - reader: urword - type: record - children: - shut_off: - block: period - description: keyword for activating well shut off capability. Subsequent values - define the minimum and maximum pumping rate that a well must exceed to shutoff - or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied - to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If - HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value - equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available - in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has - been included to facilitate backward compatibility with previous versions of MODFLOW - but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. - By default, SHUT_OFF is not used. - reader: urword - longname: shut off well - type: keyword - minrate: - block: period - description: is the minimum rate that a well must exceed to shutoff a well during - a stress period. The well will shut down during a time step if the flow rate to - the well from the aquifer is less than MINRATE. If a well is shut down during - a time step, reactivation of the well cannot occur until the next time step to - reduce oscillations. MINRATE must be less than maxrate. - reader: urword - longname: minimum shutoff rate - type: double - maxrate: - block: period - description: is the maximum rate that a well must exceed to reactivate a well during - a stress period. The well will reactivate during a timestep if the well was shutdown - during the previous time step and the flow rate to the well from the aquifer exceeds - maxrate. Reactivation of the well cannot occur until the next time step if a well - is shutdown to reduce oscillations. maxrate must be greater than MINRATE. - reader: urword - longname: maximum shutoff rate - type: double - rate_scalingrecord: - block: period - reader: urword - type: record - children: - rate_scaling: - block: period - description: activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION - and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING - can be used for extraction or injection wells. For extraction wells, the extraction - rate will start to decrease once the head in the well lowers to a level equal - to the pump elevation plus the scaling length. If the head in the well drops - below the pump elevation, then the extraction rate is calculated to be zero. For - an injection well, the injection rate will begin to decrease once the head in - the well rises above the specified pump elevation. If the head in the well rises - above the pump elevation plus the scaling length, then the injection rate will - be set to zero. - reader: urword - longname: rate scaling - type: keyword - pump_elevation: - block: period - description: is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION - should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well. - reader: urword - longname: pump elevation - type: double - scaling_length: - block: period - description: height above the pump elevation (SCALING_LENGTH). If the simulated - well head is below this elevation (pump elevation plus the scaling length), then - the pumping rate is reduced. - reader: urword - type: double - auxiliaryrecord: - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must - match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME - does not match one of the auxiliary variable names defined in the OPTIONS block - the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double ifno: shape: (nper) block: period @@ -1186,304 +692,3 @@ blocks: time_series: true longname: auxiliary variable value type: double - status: - shape: (nper) - block: period - description: keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. - By default, STATUS is ACTIVE. - reader: urword - longname: well status - type: string - flowing_wellrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - flowing_well: - block: period - description: keyword to indicate the well is a flowing well. The FLOWING_WELL option can be - used to simulate flowing wells when the simulated well head exceeds the specified drainage - elevation. - reader: urword - longname: well is a flowing well - type: keyword - fwelev: - block: period - description: elevation used to determine whether or not the well is flowing. - reader: urword - longname: flowing well elevation - type: double - fwcond: - block: period - description: conductance used to calculate the discharge of a free flowing well. Flow occurs - when the head in the well is above the well top elevation (FWELEV). - reader: urword - longname: well flowing well conductance - type: double - fwrlen: - block: period - description: length used to reduce the conductance of the flowing well. When the head in the - well drops below the well top plus the reduction length, then the conductance is reduced. This - reduction length can be used to improve the stability of simulations with flowing wells so - that there is not an abrupt change in flowing well rates. - reader: urword - longname: flowing well reduction length - type: double - flowing_well: - shape: (nper) - block: period - description: keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used - to simulate flowing wells when the simulated well head exceeds the specified drainage elevation. - reader: urword - longname: well is a flowing well - type: keyword - fwelev: - shape: (nper) - block: period - description: elevation used to determine whether or not the well is flowing. - reader: urword - longname: flowing well elevation - type: double - fwcond: - shape: (nper) - block: period - description: conductance used to calculate the discharge of a free flowing well. Flow occurs when - the head in the well is above the well top elevation (FWELEV). - reader: urword - longname: well flowing well conductance - type: double - fwrlen: - shape: (nper) - block: period - description: length used to reduce the conductance of the flowing well. When the head in the well - drops below the well top plus the reduction length, then the conductance is reduced. This reduction - length can be used to improve the stability of simulations with flowing wells so that there is - not an abrupt change in flowing well rates. - reader: urword - longname: flowing well reduction length - type: double - rate: - shape: (nper) - block: period - description: is the volumetric pumping rate for the multi-aquifer well. A positive value indicates - recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS - is ACTIVE) multi-aquifer wells. 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 RATE for each multi-aquifer well is zero. - reader: urword - time_series: true - longname: well pumping rate - type: double - well_head: - shape: (nper) - block: period - description: is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS - is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. 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. The program will terminate - with an error if WELL_HEAD is less than the bottom of the well. - reader: urword - time_series: true - longname: well head - type: double - head_limit: - shape: (nper) - block: period - description: is the limiting water level (head) in the well, which is the minimum of the well RATE - or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE - $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string - `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} - package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility - with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT - option is recommended. By default, HEAD_LIMIT is `OFF'. - reader: urword - longname: head limit - type: string - shutoffrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - shut_off: - block: period - description: keyword for activating well shut off capability. Subsequent values define the - minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, - respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) - and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can - be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on - the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. - The SHUT_OFF option has been included to facilitate backward compatibility with previous versions - of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. - By default, SHUT_OFF is not used. - reader: urword - longname: shut off well - type: keyword - minrate: - block: period - description: is the minimum rate that a well must exceed to shutoff a well during a stress period. - The well will shut down during a time step if the flow rate to the well from the aquifer is - less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot - occur until the next time step to reduce oscillations. MINRATE must be less than maxrate. - reader: urword - longname: minimum shutoff rate - type: double - maxrate: - block: period - description: is the maximum rate that a well must exceed to reactivate a well during a stress - period. The well will reactivate during a timestep if the well was shutdown during the previous - time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of - the well cannot occur until the next time step if a well is shutdown to reduce oscillations. - maxrate must be greater than MINRATE. - reader: urword - longname: maximum shutoff rate - type: double - shut_off: - shape: (nper) - block: period - description: keyword for activating well shut off capability. Subsequent values define the minimum - and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, - during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT - is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying - a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available - in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included - to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING - option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used. - reader: urword - longname: shut off well - type: keyword - minrate: - shape: (nper) - block: period - description: is the minimum rate that a well must exceed to shutoff a well during a stress period. - The well will shut down during a time step if the flow rate to the well from the aquifer is less - than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur - until the next time step to reduce oscillations. MINRATE must be less than maxrate. - reader: urword - longname: minimum shutoff rate - type: double - maxrate: - shape: (nper) - block: period - description: is the maximum rate that a well must exceed to reactivate a well during a stress period. - The well will reactivate during a timestep if the well was shutdown during the previous time step - and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot - occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater - than MINRATE. - reader: urword - longname: maximum shutoff rate - type: double - rate_scalingrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - rate_scaling: - block: period - description: activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH - must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used - for extraction or injection wells. For extraction wells, the extraction rate will start to - decrease once the head in the well lowers to a level equal to the pump elevation plus the - scaling length. If the head in the well drops below the pump elevation, then the extraction - rate is calculated to be zero. For an injection well, the injection rate will begin to decrease - once the head in the well rises above the specified pump elevation. If the head in the well - rises above the pump elevation plus the scaling length, then the injection rate will be set - to zero. - reader: urword - longname: rate scaling - type: keyword - pump_elevation: - block: period - description: is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION - should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well. - reader: urword - longname: pump elevation - type: double - scaling_length: - block: period - description: height above the pump elevation (SCALING_LENGTH). If the simulated well head is - below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced. - reader: urword - type: double - rate_scaling: - shape: (nper) - block: period - description: activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH - must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for - extraction or injection wells. For extraction wells, the extraction rate will start to decrease - once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If - the head in the well drops below the pump elevation, then the extraction rate is calculated to - be zero. For an injection well, the injection rate will begin to decrease once the head in the - well rises above the specified pump elevation. If the head in the well rises above the pump elevation - plus the scaling length, then the injection rate will be set to zero. - reader: urword - longname: rate scaling - type: keyword - pump_elevation: - shape: (nper) - block: period - description: is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should - not be less than the bottom elevation (BOTTOM) of the multi-aquifer well. - reader: urword - longname: pump elevation - type: double - scaling_length: - shape: (nper) - block: period - description: height above the pump elevation (SCALING_LENGTH). If the simulated well head is below - this elevation (pump elevation plus the scaling length), then the pumping rate is reduced. - reader: urword - type: double - auxiliaryrecord: - shape: (nper) - block: period - reader: urword - type: record - children: - auxiliary: - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one - of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one - of the auxiliary variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double - auxiliary: - shape: (nper) - block: period - description: keyword for specifying auxiliary variable. - reader: urword - type: keyword - auxname: - shape: (nper) - block: period - description: name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the - auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary - variable names defined in the OPTIONS block the data are ignored. - reader: urword - type: string - auxval: - shape: (nper) - block: period - 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. - reader: urword - time_series: true - longname: auxiliary variable value - type: double diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.json index f7d4311b..5428d6d2 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.json @@ -63,30 +63,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -118,22 +94,6 @@ "type": "string" } } - }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" } }, "dimensions": { @@ -186,107 +146,9 @@ } } } - }, - "mname": { - "block": "packages", - "description": "name of model containing the package. Model names are assigned by the user in the simulation name file.", - "reader": "urword", - "optional": true, - "type": "string" - }, - "pname": { - "block": "packages", - "description": "is the name of a package that may be included in a subsequent stress period block. The package name is assigned in the name file for the GWF Model. Package names are optionally provided in the name file. If they are not provided by the user, then packages are assigned a default value, which is the package acronym followed by a hyphen and the package number. For example, the first Drain Package is named DRN-1. The second Drain Package is named DRN-2, and so forth.", - "reader": "urword", - "optional": false, - "type": "string" } }, "period": { - "iper": { - "shape": "(nper)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, - "perioddata": { - "shape": "(nper)", - "block": "period", - "reader": "urword", - "type": "list", - "children": { - "perioddata": { - "shape": "(maxbound)", - "block": "period", - "reader": "urword", - "type": "record", - "children": { - "mname1": { - "block": "period", - "description": "name of model containing the package, PNAME1.", - "reader": "urword", - "optional": true, - "type": "string" - }, - "pname1": { - "block": "period", - "description": "is the package name for the provider. The package PNAME1 must be designated to provide water through the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block.", - "reader": "urword", - "longname": "provider package name", - "type": "string" - }, - "id1": { - "block": "period", - "description": "is the identifier for the provider. For the standard boundary packages, the provider identifier is the number of the boundary as it is listed in the package input file. (Note that the order of these boundaries may change by stress period, which must be accounted for in the Mover Package.) So the first well has an identifier of one. The second is two, and so forth. For the advanced packages, the identifier is the reach number (SFR Package), well number (MAW Package), or UZF cell number. For the Lake Package, ID1 is the lake outlet number. Thus, outflows from a single lake can be routed to different streams, for example.", - "reader": "urword", - "longname": "provider reach", - "numeric_index": true, - "type": "integer" - }, - "mname2": { - "block": "period", - "description": "name of model containing the package, PNAME2.", - "reader": "urword", - "optional": true, - "type": "string" - }, - "pname2": { - "block": "period", - "description": "is the package name for the receiver. The package PNAME2 must be designated to receive water from the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block.", - "reader": "urword", - "longname": "receiver package name", - "type": "string" - }, - "id2": { - "block": "period", - "description": "is the identifier for the receiver. The receiver identifier is the reach number (SFR Package), Lake number (LAK Package), well number (MAW Package), or UZF cell number.", - "reader": "urword", - "longname": "receiver reach", - "numeric_index": true, - "type": "integer" - }, - "mvrtype": { - "block": "period", - "description": "is the character string signifying the method for determining how much water will be moved. Supported values are 'FACTOR' 'EXCESS' 'THRESHOLD' and 'UPTO'. These four options determine how the receiver flow rate, $Q_R$, is calculated. These options mirror the options defined for the cprior variable in the SFR package, with the term 'FACTOR' being functionally equivalent to the 'FRACTION' option for cprior.", - "reader": "urword", - "longname": "mover type", - "type": "string" - }, - "value": { - "block": "period", - "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$.", - "reader": "urword", - "longname": "mover value", - "type": "double" - } - } - } - } - }, "mname1": { "shape": "(nper)", "block": "period", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.toml index 7f9161d5..72ad46c3 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.toml @@ -59,30 +59,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budget] -block = "options" -description = "keyword to specify that record corresponds to the budget." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.budgetfile] -block = "options" -description = "name of the output file to write budget information." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.options.budgetcsv_filerecord] block = "options" reader = "urword" @@ -113,22 +89,6 @@ optional = false longname = "file keyword" type = "string" -[blocks.options.budgetcsv] -block = "options" -description = "keyword to specify that record corresponds to the budget CSV." -reader = "urword" -optional = false -longname = "budget keyword" -type = "keyword" - -[blocks.options.budgetcsvfile] -block = "options" -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." -reader = "urword" -optional = false -longname = "file keyword" -type = "string" - [blocks.dimensions.maxmvr] block = "dimensions" description = "integer value specifying the maximum number of water mover entries that will specified for any stress period." @@ -173,100 +133,6 @@ reader = "urword" optional = false type = "string" -[blocks.packages.mname] -block = "packages" -description = "name of model containing the package. Model names are assigned by the user in the simulation name file." -reader = "urword" -optional = true -type = "string" - -[blocks.packages.pname] -block = "packages" -description = "is the name of a package that may be included in a subsequent stress period block. The package name is assigned in the name file for the GWF Model. Package names are optionally provided in the name file. If they are not provided by the user, then packages are assigned a default value, which is the package acronym followed by a hyphen and the package number. For example, the first Drain Package is named DRN-1. The second Drain Package is named DRN-2, and so forth." -reader = "urword" -optional = false -type = "string" - -[blocks.period.iper] -shape = "(nper)" -block = "period" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -block_variable = true -reader = "urword" -optional = false -longname = "stress period number" -type = "integer" - -[blocks.period.perioddata] -shape = "(nper)" -block = "period" -reader = "urword" -type = "list" - -[blocks.period.perioddata.children.perioddata] -shape = "(maxbound)" -block = "period" -reader = "urword" -type = "record" - -[blocks.period.perioddata.children.perioddata.children.mname1] -block = "period" -description = "name of model containing the package, PNAME1." -reader = "urword" -optional = true -type = "string" - -[blocks.period.perioddata.children.perioddata.children.pname1] -block = "period" -description = "is the package name for the provider. The package PNAME1 must be designated to provide water through the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." -reader = "urword" -longname = "provider package name" -type = "string" - -[blocks.period.perioddata.children.perioddata.children.id1] -block = "period" -description = "is the identifier for the provider. For the standard boundary packages, the provider identifier is the number of the boundary as it is listed in the package input file. (Note that the order of these boundaries may change by stress period, which must be accounted for in the Mover Package.) So the first well has an identifier of one. The second is two, and so forth. For the advanced packages, the identifier is the reach number (SFR Package), well number (MAW Package), or UZF cell number. For the Lake Package, ID1 is the lake outlet number. Thus, outflows from a single lake can be routed to different streams, for example." -reader = "urword" -longname = "provider reach" -numeric_index = true -type = "integer" - -[blocks.period.perioddata.children.perioddata.children.mname2] -block = "period" -description = "name of model containing the package, PNAME2." -reader = "urword" -optional = true -type = "string" - -[blocks.period.perioddata.children.perioddata.children.pname2] -block = "period" -description = "is the package name for the receiver. The package PNAME2 must be designated to receive water from the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." -reader = "urword" -longname = "receiver package name" -type = "string" - -[blocks.period.perioddata.children.perioddata.children.id2] -block = "period" -description = "is the identifier for the receiver. The receiver identifier is the reach number (SFR Package), Lake number (LAK Package), well number (MAW Package), or UZF cell number." -reader = "urword" -longname = "receiver reach" -numeric_index = true -type = "integer" - -[blocks.period.perioddata.children.perioddata.children.mvrtype] -block = "period" -description = "is the character string signifying the method for determining how much water will be moved. Supported values are 'FACTOR' 'EXCESS' 'THRESHOLD' and 'UPTO'. These four options determine how the receiver flow rate, $Q_R$, is calculated. These options mirror the options defined for the cprior variable in the SFR package, with the term 'FACTOR' being functionally equivalent to the 'FRACTION' option for cprior." -reader = "urword" -longname = "mover type" -type = "string" - -[blocks.period.perioddata.children.perioddata.children.value] -block = "period" -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$." -reader = "urword" -longname = "mover value" -type = "double" - [blocks.period.mname1] shape = "(nper)" block = "period" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.yaml index 3dd7a9c8..67b2742c 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-mvr.yaml @@ -60,27 +60,6 @@ blocks: optional: false longname: file keyword type: string - budget: - block: options - description: keyword to specify that record corresponds to the budget. - reader: urword - optional: false - longname: budget keyword - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - budgetfile: - block: options - description: name of the output file to write budget information. - reader: urword - optional: false - longname: file keyword - type: string budgetcsv_filerecord: block: options reader: urword @@ -109,21 +88,6 @@ blocks: optional: false longname: file keyword type: string - budgetcsv: - block: options - description: keyword to specify that record corresponds to the budget CSV. - reader: urword - optional: false - longname: budget keyword - type: keyword - budgetcsvfile: - block: options - 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. - reader: urword - optional: false - longname: file keyword - type: string dimensions: maxmvr: block: dimensions @@ -174,117 +138,7 @@ blocks: reader: urword optional: false type: string - mname: - block: packages - description: name of model containing the package. Model names are assigned by the user in the - simulation name file. - reader: urword - optional: true - type: string - pname: - block: packages - description: is the name of a package that may be included in a subsequent stress period block. The - package name is assigned in the name file for the GWF Model. Package names are optionally provided - in the name file. If they are not provided by the user, then packages are assigned a default - value, which is the package acronym followed by a hyphen and the package number. For example, - the first Drain Package is named DRN-1. The second Drain Package is named DRN-2, and so forth. - reader: urword - optional: false - type: string period: - iper: - shape: (nper) - block: period - description: integer value specifying the starting stress period number for which the data specified - in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater - than zero. The IPER value assigned to a stress period block must be greater than the IPER value - assigned for the previous PERIOD block. The information specified in the PERIOD block will continue - to apply for all subsequent stress periods, unless the program encounters another PERIOD block. - block_variable: true - reader: urword - optional: false - longname: stress period number - type: integer - perioddata: - shape: (nper) - block: period - reader: urword - type: list - children: - perioddata: - shape: (maxbound) - block: period - reader: urword - type: record - children: - mname1: - block: period - description: name of model containing the package, PNAME1. - reader: urword - optional: true - type: string - pname1: - block: period - description: is the package name for the provider. The package PNAME1 must be designated - to provide water through the MVR Package by specifying the keyword 'MOVER' in its OPTIONS - block. - reader: urword - longname: provider package name - type: string - id1: - block: period - description: is the identifier for the provider. For the standard boundary packages, the - provider identifier is the number of the boundary as it is listed in the package input - file. (Note that the order of these boundaries may change by stress period, which must - be accounted for in the Mover Package.) So the first well has an identifier of one. The - second is two, and so forth. For the advanced packages, the identifier is the reach number - (SFR Package), well number (MAW Package), or UZF cell number. For the Lake Package, ID1 - is the lake outlet number. Thus, outflows from a single lake can be routed to different - streams, for example. - reader: urword - longname: provider reach - numeric_index: true - type: integer - mname2: - block: period - description: name of model containing the package, PNAME2. - reader: urword - optional: true - type: string - pname2: - block: period - description: is the package name for the receiver. The package PNAME2 must be designated - to receive water from the MVR Package by specifying the keyword 'MOVER' in its OPTIONS - block. - reader: urword - longname: receiver package name - type: string - id2: - block: period - description: is the identifier for the receiver. The receiver identifier is the reach number - (SFR Package), Lake number (LAK Package), well number (MAW Package), or UZF cell number. - reader: urword - longname: receiver reach - numeric_index: true - type: integer - mvrtype: - block: period - description: is the character string signifying the method for determining how much water - will be moved. Supported values are 'FACTOR' 'EXCESS' 'THRESHOLD' and 'UPTO'. These - four options determine how the receiver flow rate, $Q_R$, is calculated. These options - mirror the options defined for the cprior variable in the SFR package, with the term 'FACTOR' - being functionally equivalent to the 'FRACTION' option for cprior. - reader: urword - longname: mover type - type: string - value: - block: period - 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$. - reader: urword - longname: mover value - type: double mname1: shape: (nper) block: period diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.json index 7dcf63ae..2ca77827 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.json @@ -63,21 +63,6 @@ } } }, - "newton": { - "block": "options", - "description": "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson terms for groundwater exchanges. Cells will not dry when this option is used. By default, the Newton-Raphson formulation is not applied.", - "reader": "urword", - "longname": "keyword to activate Newton-Raphson formulation", - "type": "keyword" - }, - "under_relaxation": { - "block": "options", - "description": "keyword that indicates whether the groundwater head in a cell will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied.", - "reader": "urword", - "optional": true, - "longname": "keyword to activate Newton-Raphson UNDER_RELAXATION option", - "type": "keyword" - }, "nc_mesh2d_filerecord": { "block": "options", "description": "NetCDF layered mesh fileout record.", @@ -114,15 +99,6 @@ } } }, - "netcdf_mesh2d": { - "block": "options", - "description": "keyword to specify that record corresponds to a layered mesh NetCDF file.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "extended": true, - "type": "keyword" - }, "nc_structured_filerecord": { "block": "options", "description": "NetCDF structured fileout record.", @@ -160,42 +136,6 @@ } } }, - "netcdf_structured": { - "block": "options", - "description": "keyword to specify that record corresponds to a structured NetCDF file.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "mf6internal": "netcdf_struct", - "extended": true, - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "ncmesh2dfile": { - "block": "options", - "description": "name of the NetCDF ugrid layered mesh output file.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "extended": true, - "type": "string" - }, - "ncstructfile": { - "block": "options", - "description": "name of the NetCDF structured output file.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "extended": true, - "type": "string" - }, "nc_filerecord": { "block": "options", "description": "NetCDF filerecord", @@ -231,33 +171,6 @@ "type": "string" } } - }, - "netcdf": { - "block": "options", - "description": "keyword to specify that record corresponds to a NetCDF input file.", - "reader": "urword", - "optional": false, - "longname": "netcdf keyword", - "extended": true, - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "netcdf_filename": { - "block": "options", - "description": "defines a NetCDF input file.", - "reader": "urword", - "optional": false, - "longname": "netcdf input filename", - "mf6internal": "netcdf_fname", - "extended": true, - "type": "string" } }, "packages": { @@ -300,28 +213,6 @@ } } } - }, - "ftype": { - "block": "packages", - "description": "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase.", - "reader": "urword", - "longname": "package type", - "type": "string" - }, - "fname": { - "block": "packages", - "description": "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run.", - "reader": "urword", - "longname": "file name", - "type": "string" - }, - "pname": { - "block": "packages", - "description": "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters.", - "reader": "urword", - "optional": true, - "longname": "user name for package", - "type": "string" } } } diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.toml index 3c8b9438..704e319a 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.toml @@ -59,21 +59,6 @@ optional = true longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" type = "keyword" -[blocks.options.newton] -block = "options" -description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson terms for groundwater exchanges. Cells will not dry when this option is used. By default, the Newton-Raphson formulation is not applied." -reader = "urword" -longname = "keyword to activate Newton-Raphson formulation" -type = "keyword" - -[blocks.options.under_relaxation] -block = "options" -description = "keyword that indicates whether the groundwater head in a cell will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." -reader = "urword" -optional = true -longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" -type = "keyword" - [blocks.options.nc_mesh2d_filerecord] block = "options" description = "NetCDF layered mesh fileout record." @@ -108,15 +93,6 @@ longname = "file keyword" extended = true type = "string" -[blocks.options.netcdf_mesh2d] -block = "options" -description = "keyword to specify that record corresponds to a layered mesh NetCDF file." -reader = "urword" -optional = false -longname = "budget keyword" -extended = true -type = "keyword" - [blocks.options.nc_structured_filerecord] block = "options" description = "NetCDF structured fileout record." @@ -152,42 +128,6 @@ longname = "file keyword" extended = true type = "string" -[blocks.options.netcdf_structured] -block = "options" -description = "keyword to specify that record corresponds to a structured NetCDF file." -reader = "urword" -optional = false -longname = "budget keyword" -mf6internal = "netcdf_struct" -extended = true -type = "keyword" - -[blocks.options.fileout] -block = "options" -description = "keyword to specify that an output filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.ncmesh2dfile] -block = "options" -description = "name of the NetCDF ugrid layered mesh output file." -reader = "urword" -optional = false -longname = "file keyword" -extended = true -type = "string" - -[blocks.options.ncstructfile] -block = "options" -description = "name of the NetCDF structured output file." -reader = "urword" -optional = false -longname = "file keyword" -extended = true -type = "string" - [blocks.options.nc_filerecord] block = "options" description = "NetCDF filerecord" @@ -222,33 +162,6 @@ mf6internal = "netcdf_fname" extended = true type = "string" -[blocks.options.netcdf] -block = "options" -description = "keyword to specify that record corresponds to a NetCDF input file." -reader = "urword" -optional = false -longname = "netcdf keyword" -extended = true -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.netcdf_filename] -block = "options" -description = "defines a NetCDF input file." -reader = "urword" -optional = false -longname = "netcdf input filename" -mf6internal = "netcdf_fname" -extended = true -type = "string" - [blocks.packages.packages] block = "packages" reader = "urword" @@ -284,25 +197,3 @@ reader = "urword" optional = true longname = "user name for package" type = "string" - -[blocks.packages.ftype] -block = "packages" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase." -reader = "urword" -longname = "package type" -type = "string" - -[blocks.packages.fname] -block = "packages" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -reader = "urword" -longname = "file name" -type = "string" - -[blocks.packages.pname] -block = "packages" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -reader = "urword" -optional = true -longname = "user name for package" -type = "string" diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.yaml index 5aaab3ae..11c97808 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-nam.yaml @@ -66,24 +66,6 @@ blocks: optional: true longname: keyword to activate Newton-Raphson UNDER_RELAXATION option type: keyword - newton: - block: options - description: keyword that activates the Newton-Raphson formulation for groundwater flow between - connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson - terms for groundwater exchanges. Cells will not dry when this option is used. By default, the - Newton-Raphson formulation is not applied. - reader: urword - longname: keyword to activate Newton-Raphson formulation - type: keyword - under_relaxation: - block: options - description: keyword that indicates whether the groundwater head in a cell will be under-relaxed - when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson - UNDER_RELAXATION is not applied. - reader: urword - optional: true - longname: keyword to activate Newton-Raphson UNDER_RELAXATION option - type: keyword nc_mesh2d_filerecord: block: options description: NetCDF layered mesh fileout record. @@ -115,14 +97,6 @@ blocks: longname: file keyword extended: true type: string - netcdf_mesh2d: - block: options - description: keyword to specify that record corresponds to a layered mesh NetCDF file. - reader: urword - optional: false - longname: budget keyword - extended: true - type: keyword nc_structured_filerecord: block: options description: NetCDF structured fileout record. @@ -155,38 +129,6 @@ blocks: longname: file keyword extended: true type: string - netcdf_structured: - block: options - description: keyword to specify that record corresponds to a structured NetCDF file. - reader: urword - optional: false - longname: budget keyword - mf6internal: netcdf_struct - extended: true - type: keyword - fileout: - block: options - description: keyword to specify that an output filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - ncmesh2dfile: - block: options - description: name of the NetCDF ugrid layered mesh output file. - reader: urword - optional: false - longname: file keyword - extended: true - type: string - ncstructfile: - block: options - description: name of the NetCDF structured output file. - reader: urword - optional: false - longname: file keyword - extended: true - type: string nc_filerecord: block: options description: NetCDF filerecord @@ -218,30 +160,6 @@ blocks: mf6internal: netcdf_fname extended: true type: string - netcdf: - block: options - description: keyword to specify that record corresponds to a NetCDF input file. - reader: urword - optional: false - longname: netcdf keyword - extended: true - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - netcdf_filename: - block: options - description: defines a NetCDF input file. - reader: urword - optional: false - longname: netcdf input filename - mf6internal: netcdf_fname - extended: true - type: string packages: packages: block: packages @@ -285,30 +203,3 @@ blocks: optional: true longname: user name for package type: string - ftype: - block: packages - description: is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwf}. - Ftype may be entered in any combination of uppercase and lowercase. - reader: urword - longname: package type - type: string - fname: - block: packages - description: is the name of the file containing the package input. The path to the file should - be included if the file is not located in the folder where the program was run. - reader: urword - longname: file name - type: string - pname: - block: packages - description: is the user-defined name for the package. PNAME is restricted to 16 characters. No - spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress - packages only. These names may be useful for labeling purposes when multiple stress packages - of the same type are located within a single GWF Model. If PNAME is specified for a stress package, - then PNAME will be used in the flow budget table in the listing file; it will also be used for - the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all - upper case letters. - reader: urword - optional: true - longname: user name for package - type: string diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.json index 247ed3d6..038afb6f 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.json @@ -73,23 +73,6 @@ } } }, - "variablecv": { - "block": "options", - "description": "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation.", - "reader": "urword", - "longname": "keyword to activate VARIABLECV option", - "mf6internal": "ivarcv", - "type": "keyword" - }, - "dewatered": { - "block": "options", - "description": "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top.", - "reader": "urword", - "optional": true, - "longname": "keyword to activate DEWATERED option", - "mf6internal": "idewatcv", - "type": "keyword" - }, "perched": { "block": "options", "description": "keyword to indicate that when a cell is overlying a dewatered convertible cell, the head difference used in Darcy's Law is equal to the head in the overlying cell minus the bottom elevation of the overlying cell. If not specified, then the default is to use the head difference between the two cells.", @@ -140,39 +123,6 @@ } } }, - "rewet": { - "block": "options", - "description": "activates model rewetting. Rewetting is off by default.", - "reader": "urword", - "optional": false, - "longname": "keyword to activate rewetting", - "mf6internal": "irewet", - "type": "keyword" - }, - "wetfct": { - "block": "options", - "description": "is a keyword and factor that is included in the calculation of the head that is initially established at a cell when that cell is converted from dry to wet.", - "reader": "urword", - "optional": false, - "longname": "wetting factor to use for rewetting", - "type": "double" - }, - "iwetit": { - "block": "options", - "description": "is a keyword and iteration interval for attempting to wet cells. Wetting is attempted every IWETIT iteration. This applies to outer iterations and not inner iterations. If IWETIT is specified as zero or less, then the value is changed to 1.", - "reader": "urword", - "optional": false, - "longname": "interval to use for rewetting", - "type": "integer" - }, - "ihdwet": { - "block": "options", - "description": "is a keyword and integer flag that determines which equation is used to define the initial head at cells that become wet. If IHDWET is 0, h = BOT + WETFCT (hm - BOT). If IHDWET is not 0, h = BOT + WETFCT (THRESH).", - "reader": "urword", - "optional": false, - "longname": "flag to determine wetting equation", - "type": "integer" - }, "xt3doptions": { "block": "options", "description": "none", @@ -200,23 +150,6 @@ } } }, - "xt3d": { - "block": "options", - "description": "keyword indicating that the XT3D formulation will be used. If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix. Use of XT3D will substantially increase the computational effort, but will result in improved accuracy for anisotropic conductivity fields and for unstructured grids in which the CVFD requirement is violated. XT3D requires additional information about the shapes of grid cells. If XT3D is active and the DISU Package is used, then the user will need to provide in the DISU Package the angldegx array in the CONNECTIONDATA block and the VERTICES and CELL2D blocks.", - "reader": "urword", - "longname": "keyword to activate XT3D", - "mf6internal": "ixt3d", - "type": "keyword" - }, - "rhs": { - "block": "options", - "description": "If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix.", - "reader": "urword", - "optional": true, - "longname": "keyword to XT3D on right hand side", - "mf6internal": "ixt3drhs", - "type": "keyword" - }, "highest_cell_saturation": { "block": "options", "description": "keyword indicating that the maximum cell bottom will be used to calculate the saturation used to calculate the horizontal conductance between cells. This option is intended to prevent flow from leaving a dry cell and is based on~cite{painter2008robust}. This option is only applied when the Newton-Raphson formulation is used, A warning will be issued if this option is specified and the Newton-Raphson formulation is not specified in the GWF name file. This option, in combination with the AMT-HMK ALTERNATIVE_CELL_AVERAGING option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4).", @@ -294,30 +227,6 @@ } } }, - "tvk6": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "tvk keyword", - "type": "keyword" - }, - "filein": { - "block": "options", - "description": "keyword to specify that an input filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "tvk6_filename": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file name of TVK information", - "type": "string" - }, "export_array_ascii": { "block": "options", "description": "keyword that specifies input griddata arrays should be written to layered ascii output files.", diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.toml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.toml index 332d3771..91cee5c5 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.toml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.toml @@ -69,23 +69,6 @@ longname = "keyword to activate DEWATERED option" mf6internal = "idewatcv" type = "keyword" -[blocks.options.variablecv] -block = "options" -description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." -reader = "urword" -longname = "keyword to activate VARIABLECV option" -mf6internal = "ivarcv" -type = "keyword" - -[blocks.options.dewatered] -block = "options" -description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." -reader = "urword" -optional = true -longname = "keyword to activate DEWATERED option" -mf6internal = "idewatcv" -type = "keyword" - [blocks.options.perched] block = "options" description = "keyword to indicate that when a cell is overlying a dewatered convertible cell, the head difference used in Darcy's Law is equal to the head in the overlying cell minus the bottom elevation of the overlying cell. If not specified, then the default is to use the head difference between the two cells." @@ -134,39 +117,6 @@ optional = false longname = "flag to determine wetting equation" type = "integer" -[blocks.options.rewet] -block = "options" -description = "activates model rewetting. Rewetting is off by default." -reader = "urword" -optional = false -longname = "keyword to activate rewetting" -mf6internal = "irewet" -type = "keyword" - -[blocks.options.wetfct] -block = "options" -description = "is a keyword and factor that is included in the calculation of the head that is initially established at a cell when that cell is converted from dry to wet." -reader = "urword" -optional = false -longname = "wetting factor to use for rewetting" -type = "double" - -[blocks.options.iwetit] -block = "options" -description = "is a keyword and iteration interval for attempting to wet cells. Wetting is attempted every IWETIT iteration. This applies to outer iterations and not inner iterations. If IWETIT is specified as zero or less, then the value is changed to 1." -reader = "urword" -optional = false -longname = "interval to use for rewetting" -type = "integer" - -[blocks.options.ihdwet] -block = "options" -description = "is a keyword and integer flag that determines which equation is used to define the initial head at cells that become wet. If IHDWET is 0, h = BOT + WETFCT (hm - BOT). If IHDWET is not 0, h = BOT + WETFCT (THRESH)." -reader = "urword" -optional = false -longname = "flag to determine wetting equation" -type = "integer" - [blocks.options.xt3doptions] block = "options" description = "none" @@ -192,23 +142,6 @@ longname = "keyword to XT3D on right hand side" mf6internal = "ixt3drhs" type = "keyword" -[blocks.options.xt3d] -block = "options" -description = "keyword indicating that the XT3D formulation will be used. If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix. Use of XT3D will substantially increase the computational effort, but will result in improved accuracy for anisotropic conductivity fields and for unstructured grids in which the CVFD requirement is violated. XT3D requires additional information about the shapes of grid cells. If XT3D is active and the DISU Package is used, then the user will need to provide in the DISU Package the angldegx array in the CONNECTIONDATA block and the VERTICES and CELL2D blocks." -reader = "urword" -longname = "keyword to activate XT3D" -mf6internal = "ixt3d" -type = "keyword" - -[blocks.options.rhs] -block = "options" -description = "If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix." -reader = "urword" -optional = true -longname = "keyword to XT3D on right hand side" -mf6internal = "ixt3drhs" -type = "keyword" - [blocks.options.highest_cell_saturation] block = "options" description = "keyword indicating that the maximum cell bottom will be used to calculate the saturation used to calculate the horizontal conductance between cells. This option is intended to prevent flow from leaving a dry cell and is based on~cite{painter2008robust}. This option is only applied when the Newton-Raphson formulation is used, A warning will be issued if this option is specified and the Newton-Raphson formulation is not specified in the GWF name file. This option, in combination with the AMT-HMK ALTERNATIVE_CELL_AVERAGING option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4)." @@ -284,30 +217,6 @@ optional = false longname = "file name of TVK information" type = "string" -[blocks.options.tvk6] -block = "options" -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." -reader = "urword" -optional = false -longname = "tvk keyword" -type = "keyword" - -[blocks.options.filein] -block = "options" -description = "keyword to specify that an input filename is expected next." -reader = "urword" -optional = false -longname = "file keyword" -type = "keyword" - -[blocks.options.tvk6_filename] -block = "options" -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." -reader = "urword" -optional = false -longname = "file name of TVK information" -type = "string" - [blocks.options.export_array_ascii] block = "options" description = "keyword that specifies input griddata arrays should be written to layered ascii output files." diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.yaml b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.yaml index abf4ccd3..39dd26db 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.yaml +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-npf.yaml @@ -89,29 +89,6 @@ blocks: longname: keyword to activate DEWATERED option mf6internal: idewatcv type: keyword - variablecv: - block: options - description: keyword to indicate that the vertical conductance will be calculated using the saturated - thickness and properties of the overlying cell and the thickness and properties of the underlying - cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated - using only the saturated thickness and properties of the overlying cell if the head in the underlying - cell is below its top. If these keywords are not specified, then the default condition is to - calculate the vertical conductance at the start of the simulation using the initial head and the - cell properties. The vertical conductance remains constant for the entire simulation. - reader: urword - longname: keyword to activate VARIABLECV option - mf6internal: ivarcv - type: keyword - dewatered: - block: options - description: If the DEWATERED keyword is specified, then the vertical conductance is calculated - using only the saturated thickness and properties of the overlying cell if the head in the underlying - cell is below its top. - reader: urword - optional: true - longname: keyword to activate DEWATERED option - mf6internal: idewatcv - type: keyword perched: block: options description: keyword to indicate that when a cell is overlying a dewatered convertible cell, the @@ -163,40 +140,6 @@ blocks: optional: false longname: flag to determine wetting equation type: integer - rewet: - block: options - description: activates model rewetting. Rewetting is off by default. - reader: urword - optional: false - longname: keyword to activate rewetting - mf6internal: irewet - type: keyword - wetfct: - block: options - description: is a keyword and factor that is included in the calculation of the head that is initially - established at a cell when that cell is converted from dry to wet. - reader: urword - optional: false - longname: wetting factor to use for rewetting - type: double - iwetit: - block: options - description: is a keyword and iteration interval for attempting to wet cells. Wetting is attempted - every IWETIT iteration. This applies to outer iterations and not inner iterations. If IWETIT is - specified as zero or less, then the value is changed to 1. - reader: urword - optional: false - longname: interval to use for rewetting - type: integer - ihdwet: - block: options - description: is a keyword and integer flag that determines which equation is used to define the - initial head at cells that become wet. If IHDWET is 0, h = BOT + WETFCT (hm - BOT). If IHDWET - is not 0, h = BOT + WETFCT (THRESH). - reader: urword - optional: false - longname: flag to determine wetting equation - type: integer xt3doptions: block: options description: none @@ -229,30 +172,6 @@ blocks: longname: keyword to XT3D on right hand side mf6internal: ixt3drhs type: keyword - xt3d: - block: options - description: keyword indicating that the XT3D formulation will be used. If the RHS keyword is also - included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword - is excluded, then the XT3D terms will be put into the coefficient matrix. Use of XT3D will substantially - increase the computational effort, but will result in improved accuracy for anisotropic conductivity - fields and for unstructured grids in which the CVFD requirement is violated. XT3D requires additional - information about the shapes of grid cells. If XT3D is active and the DISU Package is used, then - the user will need to provide in the DISU Package the angldegx array in the CONNECTIONDATA block - and the VERTICES and CELL2D blocks. - reader: urword - longname: keyword to activate XT3D - mf6internal: ixt3d - type: keyword - rhs: - block: options - description: If the RHS keyword is also included, then the XT3D additional terms will be added to - the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the - coefficient matrix. - reader: urword - optional: true - longname: keyword to XT3D on right hand side - mf6internal: ixt3drhs - type: keyword highest_cell_saturation: block: options description: keyword indicating that the maximum cell bottom will be used to calculate the saturation @@ -342,29 +261,6 @@ blocks: optional: false longname: file name of TVK information type: string - tvk6: - block: options - 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. - reader: urword - optional: false - longname: tvk keyword - type: keyword - filein: - block: options - description: keyword to specify that an input filename is expected next. - reader: urword - optional: false - longname: file keyword - type: keyword - tvk6_filename: - block: options - 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. - reader: urword - optional: false - longname: file name of TVK information - type: string export_array_ascii: block: options description: keyword that specifies input griddata arrays should be written to layered ascii output diff --git a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-oc.json b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-oc.json index 439ec37a..59137505 100644 --- a/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-oc.json +++ b/autotest/dfns/__snapshots__/v2.0.0.dev1/gwf-oc.json @@ -39,30 +39,6 @@ } } }, - "budget": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "fileout": { - "block": "options", - "description": "keyword to specify that an output filename is expected next.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "keyword" - }, - "budgetfile": { - "block": "options", - "description": "name of the output file to write budget information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "budgetcsv_filerecord": { "block": "options", "reader": "urword", @@ -96,22 +72,6 @@ } } }, - "budgetcsv": { - "block": "options", - "description": "keyword to specify that record corresponds to the budget CSV.", - "reader": "urword", - "optional": false, - "longname": "budget keyword", - "type": "keyword" - }, - "budgetcsvfile": { - "block": "options", - "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.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "head_filerecord": { "block": "options", "reader": "urword", @@ -145,22 +105,6 @@ } } }, - "head": { - "block": "options", - "description": "keyword to specify that record corresponds to head.", - "reader": "urword", - "optional": false, - "longname": "head keyword", - "type": "keyword" - }, - "headfile": { - "block": "options", - "description": "name of the output file to write head information.", - "reader": "urword", - "optional": false, - "longname": "file keyword", - "type": "string" - }, "headprintrecord": { "block": "options", "reader": "urword", @@ -185,93 +129,9 @@ "type": "keyword" } } - }, - "print_format": { - "block": "options", - "description": "keyword to specify format for printing to the listing file.", - "reader": "urword", - "optional": false, - "longname": "keyword to indicate that a print format follows", - "type": "keyword" - }, - "formatrecord": { - "block": "options", - "reader": "urword", - "optional": false, - "type": "record", - "children": { - "columns": { - "block": "options", - "description": "number of columns for writing data.", - "reader": "urword", - "longname": "number of columns", - "type": "integer" - }, - "width": { - "block": "options", - "description": "width for writing each number.", - "reader": "urword", - "longname": "width for each number", - "type": "integer" - }, - "digits": { - "block": "options", - "description": "number of digits to use for writing a number.", - "reader": "urword", - "longname": "number of digits", - "type": "integer" - }, - "format": { - "block": "options", - "description": "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC.", - "reader": "urword", - "optional": false, - "longname": "write format", - "type": "string" - } - } - }, - "columns": { - "block": "options", - "description": "number of columns for writing data.", - "reader": "urword", - "longname": "number of columns", - "type": "integer" - }, - "width": { - "block": "options", - "description": "width for writing each number.", - "reader": "urword", - "longname": "width for each number", - "type": "integer" - }, - "digits": { - "block": "options", - "description": "number of digits to use for writing a number.", - "reader": "urword", - "longname": "number of digits", - "type": "integer" - }, - "format": { - "block": "options", - "description": "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC.", - "reader": "urword", - "optional": false, - "longname": "write format", - "type": "string" } }, "period": { - "iper": { - "shape": "(nper)", - "block": "period", - "description": "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block.", - "block_variable": true, - "reader": "urword", - "optional": false, - "longname": "stress period number", - "type": "integer" - }, "saverecord": { "shape": "(nper)", "block": "period", @@ -336,15 +196,6 @@ } } }, - "save": { - "shape": "(nper)", - "block": "period", - "description": "keyword to indicate that information will be saved this stress period.", - "reader": "urword", - "optional": false, - "longname": "keyword to save", - "type": "keyword" - }, "printrecord": { "shape": "(nper)", "block": "period", @@ -408,99 +259,6 @@ } } } - }, - "print": { - "shape": "(nper)", - "block": "period", - "description": "keyword to indicate that information will be printed this stress period.", - "reader": "urword", - "optional": false, - "longname": "keyword to save", - "type": "keyword" - }, - "rtype": { - "shape": "(nper)", - "block": "period", - "description": "type of information to save or print. Can be BUDGET or HEAD.", - "reader": "urword", - "optional": false, - "longname": "record type", - "type": "string" - }, - "ocsetting": { - "shape": "(nper)", - "block": "period", - "description": "specifies the steps for which the data will be saved.", - "reader": "urword", - "type": "union", - "children": { - "all": { - "block": "period", - "description": "keyword to indicate save for all time steps in period.", - "reader": "urword", - "type": "keyword" - }, - "first": { - "block": "period", - "description": "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "keyword" - }, - "last": { - "block": "period", - "description": "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "keyword" - }, - "frequency": { - "block": "period", - "description": "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps.", - "reader": "urword", - "type": "integer" - }, - "steps": { - "shape": "( Fields: var_["type"] = "keystring" elif _type.startswith("record"): - var_["type"] = _type + var_["fields"] = _fields() + var_["type"] = "record" # for now, we can tell a var is an array if its type # is scalar and it has a shape. once we have proper diff --git a/modflow_devtools/dfn/migrate_to_v2_0_0_dev1.py b/modflow_devtools/dfn/migrate_to_v2_0_0_dev1.py index 7fefed87..2e6f580f 100644 --- a/modflow_devtools/dfn/migrate_to_v2_0_0_dev1.py +++ b/modflow_devtools/dfn/migrate_to_v2_0_0_dev1.py @@ -22,11 +22,11 @@ def map_period_block(block: Fields) -> Fields: block = dict(block) fields = list(block.values()) - if cast(str, fields[0]["type"]) == "list": - assert len(fields) == 1 - recarray_name = fields[0]["name"] + list_field = next((f for f in fields if cast(str, f.get("type")) == "list"), None) + if list_field is not None: + recarray_name = list_field["name"] block.pop(recarray_name, None) - item = next(iter((fields[0]["children"] or {}).values())) + item = next(iter((list_field["children"] or {}).values())) columns = dict(item["children"] or {}) else: recarray_name = None @@ -192,7 +192,11 @@ def _record_fields() -> Fields: def to_v2_0_0_dev1(name: str, fields: OMD, meta: list[str]) -> Dfn: blocks: dict[str, Fields] = { - block_name: {field["name"]: _map_field(fields, cast(Field, field)) for field in block} + block_name: { + field["name"]: _map_field(fields, cast(Field, field)) + for field in block + if field.get("in_record") != "true" + } for block_name, block in groupby(fields.values(multi=True), lambda field: field["block"]) } diff --git a/modflow_devtools/dfn/schema.py b/modflow_devtools/dfn/schema.py index 78004824..746425c8 100644 --- a/modflow_devtools/dfn/schema.py +++ b/modflow_devtools/dfn/schema.py @@ -18,6 +18,9 @@ from warnings import warn from boltons.dictutils import OMD +from boltons.iterutils import remap + +from modflow_devtools.misc import drop_none_or_empty SchemaVersion = Literal["1", "2.0.0.dev0", "2.0.0.dev1"] """DFN format version number.""" @@ -270,10 +273,12 @@ def load( from modflow_devtools.dfn.migrate_to_v2_0_0_dev0 import to_v2_0_0_dev0 data = to_v2_0_0_dev0(name=name, fields=fields, meta=meta, refs=refs) + data = remap(data, visit=drop_none_or_empty) case "2.0.0.dev1": from modflow_devtools.dfn.migrate_to_v2_0_0_dev1 import to_v2_0_0_dev1 data = to_v2_0_0_dev1(name=name, fields=fields, meta=meta) + data = remap(data, visit=drop_none_or_empty) case _: raise ValueError( f"Unsupported schema version '{schema_version!r}' requested, " diff --git a/modflow_devtools/dfn2toml.py b/modflow_devtools/dfn2toml.py index 929acc31..4d68c7c7 100644 --- a/modflow_devtools/dfn2toml.py +++ b/modflow_devtools/dfn2toml.py @@ -1,5 +1,6 @@ """Convert DFNs to TOML (v1.1 schema). Compatibility shim for consumers of the old API.""" +import shutil from os import PathLike from pathlib import Path @@ -23,10 +24,21 @@ def _strip_field_name(data): return data -def convert(indir: str | PathLike, outdir: str | PathLike) -> None: +def convert(indir: str | PathLike, outdir: str | PathLike, copy: bool = True) -> None: + """ + Convert DFN files to the 2.0.0.dev0 schema version. Deprecated. + + The ``copy`` parameter is a backwards-compatibility hack. This + function only converts the schema if ``False``. By default, it + just copies DFNs to ``outdir``. As of modflow-devtools 1.10.0, + ``Dfn.load()`` does its own conversion. + """ outdir = Path(outdir) outdir.mkdir(parents=True, exist_ok=True) - for dfn in Dfn.load_all(Path(indir), schema_version="2.0.0.dev0").values(): # type: ignore - with (outdir / f"{dfn['name']}.toml").open("wb") as f: - data = remap(dfn, visit=drop_none_or_empty) - tomli_w.dump(_strip_field_name(data), f) + if copy: + shutil.copytree(indir, outdir, dirs_exist_ok=True) + else: + for dfn in Dfn.load_all(Path(indir), schema_version="2.0.0.dev0").values(): # type: ignore + with (outdir / f"{dfn['name']}.toml").open("wb") as f: + data = remap(dfn, visit=drop_none_or_empty) + tomli_w.dump(_strip_field_name(data), f)