diff --git a/flopy/mf6/data/dfn/chf-cdb.dfn b/flopy/mf6/data/dfn/chf-cdb.dfn deleted file mode 100644 index e8ca161c0..000000000 --- a/flopy/mf6/data/dfn/chf-cdb.dfn +++ /dev/null @@ -1,183 +0,0 @@ -# --------------------- chf cdb options --------------------- -# flopy multi-package - -block options -name auxiliary -type string -shape (naux) -reader urword -optional true -longname keyword to specify aux variables -description REPLACE auxnames {'{#1}': 'Surface Water Flow'} - -block options -name boundnames -type keyword -shape -reader urword -optional true -longname -description REPLACE boundnames {'{#1}': 'critical depth boundary'} - -block options -name print_input -type keyword -reader urword -optional true -longname print input to listing file -description REPLACE print_input {'{#1}': 'critical depth boundary'} -mf6internal iprpak - -block options -name print_flows -type keyword -reader urword -optional true -longname print calculated flows to listing file -description REPLACE print_flows {'{#1}': 'critical depth boundary'} -mf6internal iprflow - -block options -name save_flows -type keyword -reader urword -optional true -longname save flows to budget file -description REPLACE save_flows {'{#1}': 'critical depth boundary'} -mf6internal ipakcb - -block options -name filein -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname file keyword -description keyword to specify that an input filename is expected next. - -block options -name obs_filerecord -type record obs6 filein obs6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name obs6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname obs keyword -description keyword to specify that record corresponds to an observations file. - -block options -name obs6_filename -type string -preserve_case true -in_record true -tagged false -reader urword -optional false -longname obs6 input filename -description REPLACE obs6_filename {'{#1}': 'Zero-Depth-Gradient Boundary'} - - -# --------------------- chf cdb dimensions --------------------- - -block dimensions -name maxbound -type integer -reader urword -optional false -longname maximum number of critical depth boundaries -description REPLACE maxbound {'{#1}': 'critical depth boundary'} - - -# --------------------- chf cdb period --------------------- - -block period -name iper -type integer -block_variable True -in_record true -tagged false -shape -valid -reader urword -optional false -longname stress period number -description REPLACE iper {} - -block period -name stress_period_data -type recarray cellid idcxs width aux boundname -shape (maxbound) -reader urword -longname -description -mf6internal spd - -block period -name cellid -type integer -shape (ncelldim) -tagged false -in_record true -reader urword -longname cell identifier -description REPLACE cellid {} - -block period -name idcxs -type integer -shape -tagged false -in_record true -reader urword -time_series false -longname cross section identifier -description is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel. -numeric_index true - -block period -name width -type double precision -shape -tagged false -in_record true -reader urword -time_series true -longname width of the zero-depth gradient boundary -description is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. 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. - -block period -name aux -type double precision -in_record true -tagged false -shape (naux) -reader urword -optional true -time_series true -longname auxiliary variables -description REPLACE aux {'{#1}': 'zero-depth-gradient boundary'} -mf6internal auxvar - -block period -name boundname -type string -shape -tagged false -in_record true -reader urword -optional true -longname zero-depth-gradient boundary name -description REPLACE boundname {'{#1}': 'zero-depth-gradient boundary'} diff --git a/flopy/mf6/data/dfn/chf-chd.dfn b/flopy/mf6/data/dfn/chf-chd.dfn deleted file mode 100644 index 3220677fc..000000000 --- a/flopy/mf6/data/dfn/chf-chd.dfn +++ /dev/null @@ -1,208 +0,0 @@ -# --------------------- chf chd options --------------------- -# flopy multi-package - -block options -name auxiliary -type string -shape (naux) -reader urword -optional true -longname keyword to specify aux variables -description REPLACE auxnames {'{#1}': 'Surface Water Flow'} - -block options -name auxmultname -type string -shape -reader urword -optional true -longname name of auxiliary variable for multiplier -description REPLACE auxmultname {'{#1}': 'CHD head value'} - -block options -name boundnames -type keyword -shape -reader urword -optional true -longname -description REPLACE boundnames {'{#1}': 'constant-head'} - -block options -name print_input -type keyword -reader urword -optional true -longname print input to listing file -description REPLACE print_input {'{#1}': 'constant-head'} - -block options -name print_flows -type keyword -reader urword -optional true -longname print CHD flows to listing file -description REPLACE print_flows {'{#1}': 'constant-head'} - -block options -name save_flows -type keyword -reader urword -optional true -longname save CHD flows to budget file -description REPLACE save_flows {'{#1}': 'constant-head'} - -block options -name ts_filerecord -type record ts6 filein ts6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name ts6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname head keyword -description keyword to specify that record corresponds to a time-series file. - -block options -name filein -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname file keyword -description keyword to specify that an input filename is expected next. - -block options -name ts6_filename -type string -preserve_case true -in_record true -reader urword -optional false -tagged false -longname file name of time series information -description REPLACE timeseriesfile {} - -block options -name obs_filerecord -type record obs6 filein obs6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name obs6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname obs keyword -description keyword to specify that record corresponds to an observations file. - -block options -name obs6_filename -type string -preserve_case true -in_record true -tagged false -reader urword -optional false -longname obs6 input filename -description REPLACE obs6_filename {'{#1}': 'constant-head'} - - -# --------------------- chf chd dimensions --------------------- - -block dimensions -name maxbound -type integer -reader urword -optional false -longname maximum number of constant heads -description REPLACE maxbound {'{#1}': 'constant-head'} - - -# --------------------- chf chd period --------------------- - -block period -name iper -type integer -block_variable True -in_record true -tagged false -shape -valid -reader urword -optional false -longname stress period number -description REPLACE iper {} - -block period -name stress_period_data -type recarray cellid head aux boundname -shape (maxbound) -reader urword -longname -description -mf6internal spd - -block period -name cellid -type integer -shape (ncelldim) -tagged false -in_record true -reader urword -longname cell identifier -description REPLACE cellid {} - -block period -name head -type double precision -shape -tagged false -in_record true -reader urword -time_series true -longname head value assigned to constant head -description is the head at the boundary. 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. - -block period -name aux -type double precision -in_record true -tagged false -shape (naux) -reader urword -optional true -time_series true -longname auxiliary variables -description REPLACE aux {'{#1}': 'constant head'} - -block period -name boundname -type string -shape -tagged false -in_record true -reader urword -optional true -longname constant head boundary name -description REPLACE boundname {'{#1}': 'constant head boundary'} diff --git a/flopy/mf6/data/dfn/chf-cxs.dfn b/flopy/mf6/data/dfn/chf-cxs.dfn deleted file mode 100644 index 259cf0492..000000000 --- a/flopy/mf6/data/dfn/chf-cxs.dfn +++ /dev/null @@ -1,100 +0,0 @@ -# --------------------- chf cxs options --------------------- - -block options -name print_input -type keyword -reader urword -optional true -longname print input to listing file -description REPLACE print_input {'{#1}': 'stream reach'} -mf6internal iprpak - -# --------------------- chf cxs dimensions --------------------- - -block dimensions -name nsections -type integer -reader urword -optional false -longname number of reaches -description integer value specifying the number of cross sections that will be defined. There must be NSECTIONS entries in the PACKAGEDATA block. - -block dimensions -name npoints -type integer -reader urword -optional false -longname total number of points defined for all reaches -description integer value specifying the total number of cross-section points defined for all reaches. There must be NPOINTS entries in the CROSSSECTIONDATA block. - -# --------------------- chf cxs packagedata --------------------- - -block packagedata -name packagedata -type recarray idcxs nxspoints -shape (nsections) -reader urword -longname -description - -block packagedata -name idcxs -type integer -shape -tagged false -in_record true -reader urword -longname reach number for this entry -description integer value that defines the cross section number associated with the specified PACKAGEDATA data on the line. IDCXS must be greater than zero and less than or equal to NSECTIONS. Information must be specified for every section or the program will terminate with an error. The program will also terminate with an error if information for a section is specified more than once. -numeric_index true - -block packagedata -name nxspoints -type integer -shape -tagged false -in_record true -reader urword -longname number of points used to define cross section -description integer value that defines the number of points used to define the define the shape of a section. NXSPOINTS must be greater than zero or the program will terminate with an error. NXSPOINTS defines the number of points that must be entered for the reach in the CROSSSECTIONDATA block. The sum of NXSPOINTS for all sections must equal the NPOINTS dimension. - -# --------------------- chf cxs crosssectiondata --------------------- - -block crosssectiondata -name crosssectiondata -type recarray xfraction height manfraction -shape (npoints) -reader urword -longname -description - -block crosssectiondata -name xfraction -type double precision -shape -tagged false -in_record true -reader urword -longname fractional width -description real value that defines the station (x) data for the cross-section as a fraction of the width (WIDTH) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (WIDTH). - -block crosssectiondata -name height -type double precision -shape -tagged false -in_record true -reader urword -longname depth -description real value that is the height relative to the top of the lowest elevation of the streambed (ELEVATION) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero. - -block crosssectiondata -name manfraction -type double precision -shape -tagged false -in_record true -reader urword -optional false -longname Manning's roughness coefficient -description real value that defines the Manning's roughness coefficient data for the cross-section as a fraction of the Manning's roughness coefficient for the reach (MANNINGSN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line. diff --git a/flopy/mf6/data/dfn/chf-dfw.dfn b/flopy/mf6/data/dfn/chf-dfw.dfn deleted file mode 100644 index 8ad8ce00c..000000000 --- a/flopy/mf6/data/dfn/chf-dfw.dfn +++ /dev/null @@ -1,143 +0,0 @@ -# --------------------- chf dfw options --------------------- - -block options -name central_in_space -type keyword -reader urword -optional true -longname use central in space weighting -description keyword to indicate conductance should be calculated using central-in-space weighting instead of the default upstream weighting approach. This option should be used with caution as it does not work well unless all of the stream reaches are saturated. With this option, there is no way for water to flow into a dry reach from connected reaches. -mf6internal icentral - -block options -name length_conversion -type double precision -reader urword -optional true -longname length conversion factor -description real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH\_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH\_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH\_CONVERSION does not need to be specified if LENGTH\_UNITS are meters. -mf6internal lengthconv - -block options -name time_conversion -type double precision -reader urword -optional true -longname time conversion factor -description real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME\_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME\_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME\_CONVERSION does not need to be specified if TIME\_UNITS are seconds. -mf6internal timeconv - -block options -name save_flows -type keyword -reader urword -optional true -longname keyword to save DFW flows -description keyword to indicate that budget flow terms will be written to the file specified with ``BUDGET SAVE FILE'' in Output Control. -mf6internal ipakcb - -block options -name print_flows -type keyword -reader urword -optional true -longname keyword to print DFW flows to listing file -description keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which ``BUDGET PRINT'' is specified in Output Control. If there is no Output Control option and ``PRINT\_FLOWS'' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the DFW Package for models that have a small number of cells. -mf6internal iprflow - -block options -name save_velocity -type keyword -reader urword -optional true -longname keyword to save velocity -description keyword to indicate that x, y, and z components of velocity will be calculated at cell centers and written to the budget file, which is specified with ``BUDGET SAVE FILE'' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable. -mf6internal isavvelocity - -block options -name obs_filerecord -type record obs6 filein obs6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name obs6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname obs keyword -description keyword to specify that record corresponds to an observations file. - -block options -name filein -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname file keyword -description keyword to specify that an input filename is expected next. - -block options -name obs6_filename -type string -preserve_case true -in_record true -tagged false -reader urword -optional false -longname obs6 input filename -description REPLACE obs6_filename {'{#1}': 'DFW'} - -block options -name export_array_ascii -type keyword -reader urword -optional true -mf6internal export_ascii -longname export array variables to layered ascii files. -description keyword that specifies input griddata arrays should be written to layered ascii output files. - -# dev options - -block options -name dev_swr_conductance -type keyword -reader urword -optional true -longname use SWR conductance formulation -description use the conductance formulation in the Surface Water Routing (SWR) Process for MODFLOW-2005. -mf6internal iswrcond - -# --------------------- chf dfw griddata --------------------- - -block griddata -name manningsn -type double precision -shape (nodes) -valid -reader readarray -layered false -optional -longname mannings roughness coefficient -description mannings roughness coefficient - -block griddata -name idcxs -type integer -shape (nodes) -valid -reader readarray -layered false -optional true -longname cross section number -description integer value indication the cross section identifier in the Cross Section Package that applies to the reach. If not provided then reach will be treated as hydraulically wide. -numeric_index true diff --git a/flopy/mf6/data/dfn/chf-disv1d.dfn b/flopy/mf6/data/dfn/chf-disv1d.dfn deleted file mode 100644 index f444341f1..000000000 --- a/flopy/mf6/data/dfn/chf-disv1d.dfn +++ /dev/null @@ -1,199 +0,0 @@ -# --------------------- chf disv1d options --------------------- - -block options -name length_units -type string -reader urword -optional true -longname model length units -description is the length units used for this model. Values can be ``FEET'', ``METERS'', or ``CENTIMETERS''. If not specified, the default is ``UNKNOWN''. - -block options -name nogrb -type keyword -reader urword -optional true -longname do not write binary grid file -description keyword to deactivate writing of the binary grid file. - -block options -name xorigin -type double precision -reader urword -optional true -longname x-position origin of the model grid coordinate system -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. - -block options -name yorigin -type double precision -reader urword -optional true -longname y-position origin of the model grid coordinate system -description y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space. - -block options -name angrot -type double precision -reader urword -optional true -longname rotation angle -description counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space. - -block options -name export_array_ascii -type keyword -reader urword -optional true -mf6internal export_ascii -longname export array variables to layered ascii files. -description keyword that specifies input griddata arrays should be written to layered ascii output files. - -# --------------------- chf disv1d dimensions --------------------- - -block dimensions -name nodes -type integer -reader urword -optional false -longname number of linear features -description is the number of linear cells. - -block dimensions -name nvert -type integer -reader urword -optional true -longname number of columns -description is the total number of (x, y, z) vertex pairs used to characterize the model grid. - -# --------------------- chf disv1d griddata --------------------- - -block griddata -name width -type double precision -shape (nodes) -valid -reader readarray -layered false -optional -longname width -description real value that defines the width for each one-dimensional cell. WIDTH must be greater than zero. If the Cross Section (CXS) Package is used, then the WIDTH value will be multiplied by the specified cross section x-fraction values. - -block griddata -name bottom -type double precision -shape (nodes) -valid -reader readarray -layered false -optional -longname bottom elevation for the one-dimensional cell -description bottom elevation for the one-dimensional cell. - -block griddata -name idomain -type integer -shape (nodes) -reader readarray -layered false -optional true -longname idomain existence array -description is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. - - -# --------------------- chf disv1d vertices --------------------- - -block vertices -name vertices -type recarray iv xv yv -shape (nvert) -reader urword -optional false -longname vertices data -description - -block vertices -name iv -type integer -in_record true -tagged false -reader urword -optional false -longname vertex number -description is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT. -numeric_index true - -block vertices -name xv -type double precision -in_record true -tagged false -reader urword -optional false -longname x-coordinate for vertex -description is the x-coordinate for the vertex. - -block vertices -name yv -type double precision -in_record true -tagged false -reader urword -optional false -longname y-coordinate for vertex -description is the y-coordinate for the vertex. - -# --------------------- chf disv1d cell1d --------------------- - -block cell1d -name cell1d -type recarray icell1d fdc ncvert icvert -shape (nodes) -reader urword -optional false -longname cell1d data -description - -block cell1d -name icell1d -type integer -in_record true -tagged false -reader urword -optional false -longname cell1d number -description is the cell1d number. Records in the cell1d block must be listed in consecutive order from the first to the last. -numeric_index true - -block cell1d -name fdc -type double precision -in_record true -tagged false -reader urword -optional false -longname fractional distance to the cell center -description is the fractional distance to the cell center. FDC is relative to the first vertex in the ICVERT array. In most cases FDC should be 0.5, which would place the center of the line segment that defines the cell. If the value of FDC is 1, the cell center would located at the last vertex. FDC values of 0 and 1 can be used to place the node at either end of the cell which can be useful for cells with boundary conditions. - -block cell1d -name ncvert -type integer -in_record true -tagged false -reader urword -optional false -longname number of cell vertices -description is the number of vertices required to define the cell. There may be a different number of vertices for each cell. - -block cell1d -name icvert -type integer -shape (ncvert) -in_record true -tagged false -reader urword -optional false -longname number of cell vertices -description is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC. -numeric_index true diff --git a/flopy/mf6/data/dfn/chf-flw.dfn b/flopy/mf6/data/dfn/chf-flw.dfn deleted file mode 100644 index 832e66eae..000000000 --- a/flopy/mf6/data/dfn/chf-flw.dfn +++ /dev/null @@ -1,207 +0,0 @@ -# --------------------- chf flw options --------------------- -# flopy multi-package - -block options -name auxiliary -type string -shape (naux) -reader urword -optional true -longname keyword to specify aux variables -description REPLACE auxnames {'{#1}': 'Stream Network Flow'} - -block options -name auxmultname -type string -shape -reader urword -optional true -longname name of auxiliary variable for multiplier -description REPLACE auxmultname {'{#1}': 'flow rate'} - -block options -name boundnames -type keyword -shape -reader urword -optional true -longname -description REPLACE boundnames {'{#1}': 'inflow'} - -block options -name print_input -type keyword -reader urword -optional true -longname print input to listing file -description REPLACE print_input {'{#1}': 'inflow'} - -block options -name print_flows -type keyword -reader urword -optional true -longname print calculated flows to listing file -description REPLACE print_flows {'{#1}': 'inflow'} - -block options -name save_flows -type keyword -reader urword -optional true -longname save well flows to budget file -description REPLACE save_flows {'{#1}': 'inflow'} - -block options -name ts_filerecord -type record ts6 filein ts6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name ts6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname head keyword -description keyword to specify that record corresponds to a time-series file. - -block options -name filein -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname file keyword -description keyword to specify that an input filename is expected next. - -block options -name ts6_filename -type string -preserve_case true -in_record true -reader urword -optional false -tagged false -longname file name of time series information -description REPLACE timeseriesfile {} - -block options -name obs_filerecord -type record obs6 filein obs6_filename -shape -reader urword -tagged true -optional true -longname -description - -block options -name obs6 -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname obs keyword -description keyword to specify that record corresponds to an observations file. - -block options -name obs6_filename -type string -preserve_case true -in_record true -tagged false -reader urword -optional false -longname obs6 input filename -description REPLACE obs6_filename {'{#1}': 'inflow'} - -# --------------------- chf flw dimensions --------------------- - -block dimensions -name maxbound -type integer -reader urword -optional false -longname maximum number of inflow -description REPLACE maxbound {'{#1}': 'inflow'} - - -# --------------------- chf flw period --------------------- - -block period -name iper -type integer -block_variable True -in_record true -tagged false -shape -valid -reader urword -optional false -longname stress period number -description REPLACE iper {} - -block period -name stress_period_data -type recarray cellid q aux boundname -shape (maxbound) -reader urword -longname -description -mf6internal spd - -block period -name cellid -type integer -shape (ncelldim) -tagged false -in_record true -reader urword -longname cell identifier -description REPLACE cellid {} - -block period -name q -type double precision -shape -tagged false -in_record true -reader urword -time_series true -longname well rate -description is the volumetric inflow rate. A positive value indicates inflow to the stream. Negative values are not allows. 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. - -block period -name aux -type double precision -in_record true -tagged false -shape (naux) -reader urword -optional true -time_series true -longname auxiliary variables -description REPLACE aux {'{#1}': 'inflow'} - -block period -name boundname -type string -shape -tagged false -in_record true -reader urword -optional true -longname inflow name -description REPLACE boundname {'{#1}': 'inflow'} diff --git a/flopy/mf6/data/dfn/chf-ic.dfn b/flopy/mf6/data/dfn/chf-ic.dfn deleted file mode 100644 index a483e8db5..000000000 --- a/flopy/mf6/data/dfn/chf-ic.dfn +++ /dev/null @@ -1,22 +0,0 @@ -# --------------------- chf ic options --------------------- - -block options -name export_array_ascii -type keyword -reader urword -optional true -mf6internal export_ascii -longname export array variables to layered ascii files. -description keyword that specifies input griddata arrays should be written to layered ascii output files. - -# --------------------- chf ic griddata --------------------- - -block griddata -name strt -type double precision -shape (nodes) -reader readarray -layered true -longname starting concentration -description is the initial (starting) stage---that is, stage at the beginning of the CHF Model simulation. STRT must be specified for all CHF Model simulations. One value is read for every model reach. -default_value 0.0 diff --git a/flopy/mf6/data/dfn/chf-nam.dfn b/flopy/mf6/data/dfn/chf-nam.dfn deleted file mode 100644 index dd2b16d37..000000000 --- a/flopy/mf6/data/dfn/chf-nam.dfn +++ /dev/null @@ -1,99 +0,0 @@ -# --------------------- chf nam options --------------------- - -block options -name list -type string -reader urword -optional true -preserve_case true -longname name of listing file -description is name of the listing file to create for this CHF model. If not specified, then the name of the list file will be the basename of the CHF model name file and the '.lst' extension. For example, if the CHF name file is called ``my.model.nam'' then the list file will be called ``my.model.lst''. - -block options -name print_input -type keyword -reader urword -optional true -longname print input to listing file -description REPLACE print_input {'{#1}': 'all model stress package'} - -block options -name print_flows -type keyword -reader urword -optional true -longname print calculated flows to listing file -description REPLACE print_flows {'{#1}': 'all model package'} - -block options -name save_flows -type keyword -reader urword -optional true -longname save flows for all packages to budget file -description REPLACE save_flows {'{#1}': 'all model package'} - -block options -name newtonoptions -type record newton under_relaxation -reader urword -optional true -longname newton keyword and options -description none - -block options -name newton -in_record true -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. - -block options -name under_relaxation -in_record true -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. - -# --------------------- chf nam packages --------------------- - -block packages -name packages -type recarray ftype fname pname -reader urword -optional false -longname package list -description - -block packages -name ftype -in_record true -type string -tagged false -reader urword -longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-chf}. Ftype may be entered in any combination of uppercase and lowercase. - -block packages -name fname -in_record true -type string -preserve_case true -tagged false -reader urword -longname file name -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. - -block packages -name pname -in_record true -type string -tagged false -reader urword -optional true -longname user name for package -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 CHF 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. - diff --git a/flopy/mf6/data/dfn/chf-oc.dfn b/flopy/mf6/data/dfn/chf-oc.dfn deleted file mode 100644 index a1d06cb0f..000000000 --- a/flopy/mf6/data/dfn/chf-oc.dfn +++ /dev/null @@ -1,345 +0,0 @@ -# --------------------- chf oc options --------------------- - -block options -name budget_filerecord -type record budget fileout budgetfile -shape -reader urword -tagged true -optional true -longname -description - -block options -name budget -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname budget keyword -description keyword to specify that record corresponds to the budget. - -block options -name fileout -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname file keyword -description keyword to specify that an output filename is expected next. - -block options -name budgetfile -type string -preserve_case true -shape -in_record true -reader urword -tagged false -optional false -longname file keyword -description name of the output file to write budget information. - -block options -name budgetcsv_filerecord -type record budgetcsv fileout budgetcsvfile -shape -reader urword -tagged true -optional true -longname -description - -block options -name budgetcsv -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname budget keyword -description keyword to specify that record corresponds to the budget CSV. - -block options -name budgetcsvfile -type string -preserve_case true -shape -in_record true -reader urword -tagged false -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. - -block options -name qoutflow_filerecord -type record qoutflow fileout qoutflowfile -shape -reader urword -tagged true -optional true -longname -description - -block options -name qoutflow -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname qoutflow keyword -description keyword to specify that record corresponds to qoutflow. - -block options -name qoutflowfile -type string -preserve_case true -shape -in_record true -reader urword -tagged false -optional false -longname file keyword -description name of the output file to write conc information. - -block options -name stage_filerecord -type record stage fileout stagefile -shape -reader urword -tagged true -optional true -longname -description - -block options -name stage -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname stage keyword -description keyword to specify that record corresponds to stage. - -block options -name stagefile -type string -preserve_case true -shape -in_record true -reader urword -tagged false -optional false -longname file keyword -description name of the output file to write stage information. - -block options -name qoutflowprintrecord -type record qoutflow print_format formatrecord -shape -reader urword -optional true -longname -description - -block options -name print_format -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname keyword to indicate that a print format follows -description keyword to specify format for printing to the listing file. - -block options -name formatrecord -type record columns width digits format -shape -in_record true -reader urword -tagged -optional false -longname -description - -block options -name columns -type integer -shape -in_record true -reader urword -tagged true -optional -longname number of columns -description number of columns for writing data. - -block options -name width -type integer -shape -in_record true -reader urword -tagged true -optional -longname width for each number -description width for writing each number. - -block options -name digits -type integer -shape -in_record true -reader urword -tagged true -optional -longname number of digits -description number of digits to use for writing a number. - -block options -name format -type string -shape -in_record true -reader urword -tagged false -optional false -longname write format -description write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC. - -# --------------------- chf oc period --------------------- - -block period -name iper -type integer -block_variable True -in_record true -tagged false -shape -valid -reader urword -optional false -longname stress period number -description REPLACE iper {} - -block period -name saverecord -type record save rtype ocsetting -shape -reader urword -tagged false -optional true -longname -description - -block period -name save -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname keyword to save -description keyword to indicate that information will be saved this stress period. - -block period -name printrecord -type record print rtype ocsetting -shape -reader urword -tagged false -optional true -longname -description - -block period -name print -type keyword -shape -in_record true -reader urword -tagged true -optional false -longname keyword to save -description keyword to indicate that information will be printed this stress period. - -block period -name rtype -type string -shape -in_record true -reader urword -tagged false -optional false -longname record type -description type of information to save or print. Can be BUDGET. - -block period -name ocsetting -type keystring all first last frequency steps -shape -tagged false -in_record true -reader urword -longname -description specifies the steps for which the data will be saved. - -block period -name all -type keyword -shape -in_record true -reader urword -longname -description keyword to indicate save for all time steps in period. - -block period -name first -type keyword -shape -in_record true -reader urword -longname -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. - -block period -name last -type keyword -shape -in_record true -reader urword -longname -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. - -block period -name frequency -type integer -shape -tagged true -in_record true -reader urword -longname -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. - -block period -name steps -type integer -shape ( - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of exchange - entries will be echoed to the listing file immediately after it is - read. - print_flows : boolean - * print_flows (boolean) keyword to indicate that the list of exchange - flow rates will be printed to the listing file for every stress - period in which "SAVE BUDGET" is specified in Output Control. - fixed_conductance : boolean - * fixed_conductance (boolean) keyword to indicate that the product of - the bedleak and cfact input variables in the exchangedata block - represents conductance. This conductance is fixed and does not change - as a function of head in the surface water and groundwater models. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - nexg : integer - * nexg (integer) keyword and integer value specifying the number of - SWF-GWF exchanges. - exchangedata : [cellidm1, cellidm2, bedleak, cfact] - * cellidm1 ((integer, ...)) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * cellidm2 ((integer, ...)) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * bedleak (double) 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. - * cfact (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - obs_filerecord = ListTemplateGenerator(('chfgwf', 'options', - 'obs_filerecord')) - exchangedata = ListTemplateGenerator(('chfgwf', 'exchangedata', - 'exchangedata')) - package_abbr = "chfgwf" - _package_type = "chfgwf" - dfn_file_name = "exg-chfgwf.dfn" - - dfn = [ - ["header", - "multi-package", ], - ["block options", "name print_input", "type keyword", - "reader urword", "optional true", "mf6internal ipr_input"], - ["block options", "name print_flows", "type keyword", - "reader urword", "optional true", "mf6internal ipr_flow"], - ["block options", "name fixed_conductance", "type keyword", - "reader urword", "optional true", "mf6internal ifixedcond"], - ["block options", "name obs_filerecord", - "type record obs6 filein obs6_filename", "shape", "reader urword", - "tagged true", "optional true", "construct_package obs", - "construct_data continuous", "parameter_name observations"], - ["block options", "name obs6", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name filein", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name obs6_filename", "type string", - "preserve_case true", "in_record true", "tagged false", - "reader urword", "optional false"], - ["block dimensions", "name nexg", "type integer", - "reader urword", "optional false"], - ["block exchangedata", "name exchangedata", - "type recarray cellidm1 cellidm2 bedleak cfact", "shape (nexg)", - "reader urword", "optional false"], - ["block exchangedata", "name cellidm1", "type integer", - "in_record true", "tagged false", "reader urword", - "optional false", "numeric_index true"], - ["block exchangedata", "name cellidm2", "type integer", - "in_record true", "tagged false", "reader urword", - "optional false", "numeric_index true"], - ["block exchangedata", "name bedleak", "type double precision", - "in_record true", "tagged false", "reader urword", - "optional false"], - ["block exchangedata", "name cfact", "type double precision", - "in_record true", "tagged false", "reader urword", - "optional false"]] - - def __init__(self, simulation, loading_package=False, exgtype="CHF6-GWF6", - exgmnamea=None, exgmnameb=None, print_input=None, - print_flows=None, fixed_conductance=None, observations=None, - nexg=None, exchangedata=None, filename=None, pname=None, - **kwargs): - super().__init__(simulation, "chfgwf", filename, pname, - loading_package, **kwargs) - - # set up variables - self.exgtype = exgtype - - self.exgmnamea = exgmnamea - - self.exgmnameb = exgmnameb - - simulation.register_exchange_file(self) - - self.print_input = self.build_mfdata("print_input", print_input) - self.print_flows = self.build_mfdata("print_flows", print_flows) - self.fixed_conductance = self.build_mfdata("fixed_conductance", - fixed_conductance) - self._obs_filerecord = self.build_mfdata("obs_filerecord", - None) - self._obs_package = self.build_child_package("obs", observations, - "continuous", - self._obs_filerecord) - self.nexg = self.build_mfdata("nexg", nexg) - self.exchangedata = self.build_mfdata("exchangedata", exchangedata) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfchfic.py b/flopy/mf6/modflow/mfchfic.py deleted file mode 100644 index 26edcf5e1..000000000 --- a/flopy/mf6/modflow/mfchfic.py +++ /dev/null @@ -1,59 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator - - -class ModflowChfic(mfpackage.MFPackage): - """ - ModflowChfic defines a ic package within a chf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - strt : [double] - * strt (double) is the initial (starting) stage---that is, stage at the - beginning of the CHF Model simulation. STRT must be specified for all - CHF Model simulations. One value is read for every model reach. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - strt = ArrayTemplateGenerator(('chf6', 'ic', 'griddata', 'strt')) - package_abbr = "chfic" - _package_type = "ic" - dfn_file_name = "chf-ic.dfn" - - dfn = [ - ["header", ], - ["block options", "name export_array_ascii", "type keyword", - "reader urword", "optional true", "mf6internal export_ascii"], - ["block griddata", "name strt", "type double precision", - "shape (nodes)", "reader readarray", "layered true", - "default_value 0.0"]] - - def __init__(self, model, loading_package=False, export_array_ascii=None, - strt=0.0, filename=None, pname=None, **kwargs): - super().__init__(model, "ic", filename, pname, - loading_package, **kwargs) - - # set up variables - self.export_array_ascii = self.build_mfdata("export_array_ascii", - export_array_ascii) - self.strt = self.build_mfdata("strt", strt) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfchfnam.py b/flopy/mf6/modflow/mfchfnam.py deleted file mode 100644 index ea7774a72..000000000 --- a/flopy/mf6/modflow/mfchfnam.py +++ /dev/null @@ -1,119 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator - - -class ModflowChfnam(mfpackage.MFPackage): - """ - ModflowChfnam defines a nam package within a chf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - list : string - * list (string) is name of the listing file to create for this CHF - model. If not specified, then the name of the list file will be the - basename of the CHF model name file and the '.lst' extension. For - example, if the CHF name file is called "my.model.nam" then the list - file will be called "my.model.lst". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) keyword to indicate that the list of all model - package flow rates will be printed to the listing file for every - stress period time step in which "BUDGET PRINT" is specified in - Output Control. If there is no Output Control option and - "PRINT_FLOWS" is specified, then flow rates are printed for the last - time step of each stress period. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - newtonoptions : [under_relaxation] - * under_relaxation (string) 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. - packages : [ftype, fname, pname] - * ftype (string) is the file type, which must be one of the following - character values shown in table ref{table:ftype-chf}. Ftype may be - entered in any combination of uppercase and lowercase. - * fname (string) 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. - * pname (string) 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 - CHF 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - packages = ListTemplateGenerator(('chf6', 'nam', 'packages', - 'packages')) - package_abbr = "chfnam" - _package_type = "nam" - dfn_file_name = "chf-nam.dfn" - - dfn = [ - ["header", ], - ["block options", "name list", "type string", "reader urword", - "optional true", "preserve_case true"], - ["block options", "name print_input", "type keyword", - "reader urword", "optional true"], - ["block options", "name print_flows", "type keyword", - "reader urword", "optional true"], - ["block options", "name save_flows", "type keyword", - "reader urword", "optional true"], - ["block options", "name newtonoptions", - "type record newton under_relaxation", "reader urword", - "optional true"], - ["block options", "name newton", "in_record true", - "type keyword", "reader urword"], - ["block options", "name under_relaxation", "in_record true", - "type keyword", "reader urword", "optional true"], - ["block packages", "name packages", - "type recarray ftype fname pname", "reader urword", - "optional false"], - ["block packages", "name ftype", "in_record true", "type string", - "tagged false", "reader urword"], - ["block packages", "name fname", "in_record true", "type string", - "preserve_case true", "tagged false", "reader urword"], - ["block packages", "name pname", "in_record true", "type string", - "tagged false", "reader urword", "optional true"]] - - def __init__(self, model, loading_package=False, list=None, - print_input=None, print_flows=None, save_flows=None, - newtonoptions=None, packages=None, filename=None, pname=None, - **kwargs): - super().__init__(model, "nam", filename, pname, - loading_package, **kwargs) - - # set up variables - self.list = self.build_mfdata("list", list) - self.print_input = self.build_mfdata("print_input", print_input) - self.print_flows = self.build_mfdata("print_flows", print_flows) - self.save_flows = self.build_mfdata("save_flows", save_flows) - self.newtonoptions = self.build_mfdata("newtonoptions", newtonoptions) - self.packages = self.build_mfdata("packages", packages) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfchfoc.py b/flopy/mf6/modflow/mfchfoc.py deleted file mode 100644 index 128c7d5f7..000000000 --- a/flopy/mf6/modflow/mfchfoc.py +++ /dev/null @@ -1,226 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator - - -class ModflowChfoc(mfpackage.MFPackage): - """ - ModflowChfoc defines a oc package within a chf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - qoutflow_filerecord : [qoutflowfile] - * qoutflowfile (string) name of the output file to write conc - information. - stage_filerecord : [stagefile] - * stagefile (string) name of the output file to write stage - information. - qoutflowprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) save for each step specified in STEPS. This - keyword may be used in conjunction with other keywords to - print or save results for multiple time steps. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) save for each step specified in STEPS. This - keyword may be used in conjunction with other keywords to - print or save results for multiple time steps. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - budget_filerecord = ListTemplateGenerator(('chf6', 'oc', 'options', - 'budget_filerecord')) - budgetcsv_filerecord = ListTemplateGenerator(('chf6', 'oc', - 'options', - 'budgetcsv_filerecord')) - qoutflow_filerecord = ListTemplateGenerator(('chf6', 'oc', 'options', - 'qoutflow_filerecord')) - stage_filerecord = ListTemplateGenerator(('chf6', 'oc', 'options', - 'stage_filerecord')) - qoutflowprintrecord = ListTemplateGenerator(('chf6', 'oc', 'options', - 'qoutflowprintrecord')) - saverecord = ListTemplateGenerator(('chf6', 'oc', 'period', - 'saverecord')) - printrecord = ListTemplateGenerator(('chf6', 'oc', 'period', - 'printrecord')) - package_abbr = "chfoc" - _package_type = "oc" - dfn_file_name = "chf-oc.dfn" - - dfn = [ - ["header", ], - ["block options", "name budget_filerecord", - "type record budget fileout budgetfile", "shape", "reader urword", - "tagged true", "optional true"], - ["block options", "name budget", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name fileout", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name budgetfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name budgetcsv_filerecord", - "type record budgetcsv fileout budgetcsvfile", "shape", - "reader urword", "tagged true", "optional true"], - ["block options", "name budgetcsv", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name budgetcsvfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name qoutflow_filerecord", - "type record qoutflow fileout qoutflowfile", "shape", - "reader urword", "tagged true", "optional true"], - ["block options", "name qoutflow", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name qoutflowfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name stage_filerecord", - "type record stage fileout stagefile", "shape", "reader urword", - "tagged true", "optional true"], - ["block options", "name stage", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name stagefile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name qoutflowprintrecord", - "type record qoutflow print_format formatrecord", "shape", - "reader urword", "optional true"], - ["block options", "name print_format", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name formatrecord", - "type record columns width digits format", "shape", - "in_record true", "reader urword", "tagged", "optional false"], - ["block options", "name columns", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name width", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name digits", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name format", "type string", "shape", - "in_record true", "reader urword", "tagged false", - "optional false"], - ["block period", "name iper", "type integer", - "block_variable True", "in_record true", "tagged false", "shape", - "valid", "reader urword", "optional false"], - ["block period", "name saverecord", - "type record save rtype ocsetting", "shape", "reader urword", - "tagged false", "optional true"], - ["block period", "name save", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block period", "name printrecord", - "type record print rtype ocsetting", "shape", "reader urword", - "tagged false", "optional true"], - ["block period", "name print", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block period", "name rtype", "type string", "shape", - "in_record true", "reader urword", "tagged false", - "optional false"], - ["block period", "name ocsetting", - "type keystring all first last frequency steps", "shape", - "tagged false", "in_record true", "reader urword"], - ["block period", "name all", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name first", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name last", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name frequency", "type integer", "shape", - "tagged true", "in_record true", "reader urword"], - ["block period", "name steps", "type integer", "shape ( - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of exchange - entries will be echoed to the listing file immediately after it is - read. - print_flows : boolean - * print_flows (boolean) keyword to indicate that the list of exchange - flow rates will be printed to the listing file for every stress - period in which "SAVE BUDGET" is specified in Output Control. - fixed_conductance : boolean - * fixed_conductance (boolean) keyword to indicate that the product of - the bedleak and cfact input variables in the exchangedata block - represents conductance. This conductance is fixed and does not change - as a function of head in the surface water and groundwater models. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - nexg : integer - * nexg (integer) keyword and integer value specifying the number of - SWF-GWF exchanges. - exchangedata : [cellidm1, cellidm2, bedleak, cfact] - * cellidm1 ((integer, ...)) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * cellidm2 ((integer, ...)) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * bedleak (double) 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. - * cfact (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - obs_filerecord = ListTemplateGenerator(('olfgwf', 'options', - 'obs_filerecord')) - exchangedata = ListTemplateGenerator(('olfgwf', 'exchangedata', - 'exchangedata')) - package_abbr = "olfgwf" - _package_type = "olfgwf" - dfn_file_name = "exg-olfgwf.dfn" - - dfn = [ - ["header", - "multi-package", ], - ["block options", "name print_input", "type keyword", - "reader urword", "optional true", "mf6internal ipr_input"], - ["block options", "name print_flows", "type keyword", - "reader urword", "optional true", "mf6internal ipr_flow"], - ["block options", "name fixed_conductance", "type keyword", - "reader urword", "optional true", "mf6internal ifixedcond"], - ["block options", "name obs_filerecord", - "type record obs6 filein obs6_filename", "shape", "reader urword", - "tagged true", "optional true", "construct_package obs", - "construct_data continuous", "parameter_name observations"], - ["block options", "name obs6", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name filein", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name obs6_filename", "type string", - "preserve_case true", "in_record true", "tagged false", - "reader urword", "optional false"], - ["block dimensions", "name nexg", "type integer", - "reader urword", "optional false"], - ["block exchangedata", "name exchangedata", - "type recarray cellidm1 cellidm2 bedleak cfact", "shape (nexg)", - "reader urword", "optional false"], - ["block exchangedata", "name cellidm1", "type integer", - "in_record true", "tagged false", "reader urword", - "optional false", "numeric_index true"], - ["block exchangedata", "name cellidm2", "type integer", - "in_record true", "tagged false", "reader urword", - "optional false", "numeric_index true"], - ["block exchangedata", "name bedleak", "type double precision", - "in_record true", "tagged false", "reader urword", - "optional false"], - ["block exchangedata", "name cfact", "type double precision", - "in_record true", "tagged false", "reader urword", - "optional false"]] - - def __init__(self, simulation, loading_package=False, exgtype="OLF6-GWF6", - exgmnamea=None, exgmnameb=None, print_input=None, - print_flows=None, fixed_conductance=None, observations=None, - nexg=None, exchangedata=None, filename=None, pname=None, - **kwargs): - super().__init__(simulation, "olfgwf", filename, pname, - loading_package, **kwargs) - - # set up variables - self.exgtype = exgtype - - self.exgmnamea = exgmnamea - - self.exgmnameb = exgmnameb - - simulation.register_exchange_file(self) - - self.print_input = self.build_mfdata("print_input", print_input) - self.print_flows = self.build_mfdata("print_flows", print_flows) - self.fixed_conductance = self.build_mfdata("fixed_conductance", - fixed_conductance) - self._obs_filerecord = self.build_mfdata("obs_filerecord", - None) - self._obs_package = self.build_child_package("obs", observations, - "continuous", - self._obs_filerecord) - self.nexg = self.build_mfdata("nexg", nexg) - self.exchangedata = self.build_mfdata("exchangedata", exchangedata) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfolfic.py b/flopy/mf6/modflow/mfolfic.py deleted file mode 100644 index 41922b65d..000000000 --- a/flopy/mf6/modflow/mfolfic.py +++ /dev/null @@ -1,59 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator - - -class ModflowOlfic(mfpackage.MFPackage): - """ - ModflowOlfic defines a ic package within a olf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - strt : [double] - * strt (double) is the initial (starting) stage---that is, stage at the - beginning of the OLF Model simulation. STRT must be specified for all - OLF Model simulations. One value is read for every model reach. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - strt = ArrayTemplateGenerator(('olf6', 'ic', 'griddata', 'strt')) - package_abbr = "olfic" - _package_type = "ic" - dfn_file_name = "olf-ic.dfn" - - dfn = [ - ["header", ], - ["block options", "name export_array_ascii", "type keyword", - "reader urword", "optional true", "mf6internal export_ascii"], - ["block griddata", "name strt", "type double precision", - "shape (nodes)", "reader readarray", "layered true", - "default_value 0.0"]] - - def __init__(self, model, loading_package=False, export_array_ascii=None, - strt=0.0, filename=None, pname=None, **kwargs): - super().__init__(model, "ic", filename, pname, - loading_package, **kwargs) - - # set up variables - self.export_array_ascii = self.build_mfdata("export_array_ascii", - export_array_ascii) - self.strt = self.build_mfdata("strt", strt) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfolfnam.py b/flopy/mf6/modflow/mfolfnam.py deleted file mode 100644 index 51e7523da..000000000 --- a/flopy/mf6/modflow/mfolfnam.py +++ /dev/null @@ -1,119 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator - - -class ModflowOlfnam(mfpackage.MFPackage): - """ - ModflowOlfnam defines a nam package within a olf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - list : string - * list (string) is name of the listing file to create for this OLF - model. If not specified, then the name of the list file will be the - basename of the OLF model name file and the '.lst' extension. For - example, if the OLF name file is called "my.model.nam" then the list - file will be called "my.model.lst". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) keyword to indicate that the list of all model - package flow rates will be printed to the listing file for every - stress period time step in which "BUDGET PRINT" is specified in - Output Control. If there is no Output Control option and - "PRINT_FLOWS" is specified, then flow rates are printed for the last - time step of each stress period. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - newtonoptions : [under_relaxation] - * under_relaxation (string) 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. - packages : [ftype, fname, pname] - * ftype (string) is the file type, which must be one of the following - character values shown in table ref{table:ftype-olf}. Ftype may be - entered in any combination of uppercase and lowercase. - * fname (string) 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. - * pname (string) 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 - OLF 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - packages = ListTemplateGenerator(('olf6', 'nam', 'packages', - 'packages')) - package_abbr = "olfnam" - _package_type = "nam" - dfn_file_name = "olf-nam.dfn" - - dfn = [ - ["header", ], - ["block options", "name list", "type string", "reader urword", - "optional true", "preserve_case true"], - ["block options", "name print_input", "type keyword", - "reader urword", "optional true"], - ["block options", "name print_flows", "type keyword", - "reader urword", "optional true"], - ["block options", "name save_flows", "type keyword", - "reader urword", "optional true"], - ["block options", "name newtonoptions", - "type record newton under_relaxation", "reader urword", - "optional true"], - ["block options", "name newton", "in_record true", - "type keyword", "reader urword"], - ["block options", "name under_relaxation", "in_record true", - "type keyword", "reader urword", "optional true"], - ["block packages", "name packages", - "type recarray ftype fname pname", "reader urword", - "optional false"], - ["block packages", "name ftype", "in_record true", "type string", - "tagged false", "reader urword"], - ["block packages", "name fname", "in_record true", "type string", - "preserve_case true", "tagged false", "reader urword"], - ["block packages", "name pname", "in_record true", "type string", - "tagged false", "reader urword", "optional true"]] - - def __init__(self, model, loading_package=False, list=None, - print_input=None, print_flows=None, save_flows=None, - newtonoptions=None, packages=None, filename=None, pname=None, - **kwargs): - super().__init__(model, "nam", filename, pname, - loading_package, **kwargs) - - # set up variables - self.list = self.build_mfdata("list", list) - self.print_input = self.build_mfdata("print_input", print_input) - self.print_flows = self.build_mfdata("print_flows", print_flows) - self.save_flows = self.build_mfdata("save_flows", save_flows) - self.newtonoptions = self.build_mfdata("newtonoptions", newtonoptions) - self.packages = self.build_mfdata("packages", packages) - self._init_complete = True diff --git a/flopy/mf6/modflow/mfolfoc.py b/flopy/mf6/modflow/mfolfoc.py deleted file mode 100644 index ad0dc3ad7..000000000 --- a/flopy/mf6/modflow/mfolfoc.py +++ /dev/null @@ -1,226 +0,0 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on December 20, 2024 02:43:08 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator - - -class ModflowOlfoc(mfpackage.MFPackage): - """ - ModflowOlfoc defines a oc package within a olf6 model. - - Parameters - ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - qoutflow_filerecord : [qoutflowfile] - * qoutflowfile (string) name of the output file to write conc - information. - stage_filerecord : [stagefile] - * stagefile (string) name of the output file to write stage - information. - qoutflowprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) save for each step specified in STEPS. This - keyword may be used in conjunction with other keywords to - print or save results for multiple time steps. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) save for each step specified in STEPS. This - keyword may be used in conjunction with other keywords to - print or save results for multiple time steps. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. - - """ - budget_filerecord = ListTemplateGenerator(('olf6', 'oc', 'options', - 'budget_filerecord')) - budgetcsv_filerecord = ListTemplateGenerator(('olf6', 'oc', - 'options', - 'budgetcsv_filerecord')) - qoutflow_filerecord = ListTemplateGenerator(('olf6', 'oc', 'options', - 'qoutflow_filerecord')) - stage_filerecord = ListTemplateGenerator(('olf6', 'oc', 'options', - 'stage_filerecord')) - qoutflowprintrecord = ListTemplateGenerator(('olf6', 'oc', 'options', - 'qoutflowprintrecord')) - saverecord = ListTemplateGenerator(('olf6', 'oc', 'period', - 'saverecord')) - printrecord = ListTemplateGenerator(('olf6', 'oc', 'period', - 'printrecord')) - package_abbr = "olfoc" - _package_type = "oc" - dfn_file_name = "olf-oc.dfn" - - dfn = [ - ["header", ], - ["block options", "name budget_filerecord", - "type record budget fileout budgetfile", "shape", "reader urword", - "tagged true", "optional true"], - ["block options", "name budget", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name fileout", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name budgetfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name budgetcsv_filerecord", - "type record budgetcsv fileout budgetcsvfile", "shape", - "reader urword", "tagged true", "optional true"], - ["block options", "name budgetcsv", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name budgetcsvfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name qoutflow_filerecord", - "type record qoutflow fileout qoutflowfile", "shape", - "reader urword", "tagged true", "optional true"], - ["block options", "name qoutflow", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name qoutflowfile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name stage_filerecord", - "type record stage fileout stagefile", "shape", "reader urword", - "tagged true", "optional true"], - ["block options", "name stage", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name stagefile", "type string", - "preserve_case true", "shape", "in_record true", "reader urword", - "tagged false", "optional false"], - ["block options", "name qoutflowprintrecord", - "type record qoutflow print_format formatrecord", "shape", - "reader urword", "optional true"], - ["block options", "name print_format", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block options", "name formatrecord", - "type record columns width digits format", "shape", - "in_record true", "reader urword", "tagged", "optional false"], - ["block options", "name columns", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name width", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name digits", "type integer", "shape", - "in_record true", "reader urword", "tagged true", "optional"], - ["block options", "name format", "type string", "shape", - "in_record true", "reader urword", "tagged false", - "optional false"], - ["block period", "name iper", "type integer", - "block_variable True", "in_record true", "tagged false", "shape", - "valid", "reader urword", "optional false"], - ["block period", "name saverecord", - "type record save rtype ocsetting", "shape", "reader urword", - "tagged false", "optional true"], - ["block period", "name save", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block period", "name printrecord", - "type record print rtype ocsetting", "shape", "reader urword", - "tagged false", "optional true"], - ["block period", "name print", "type keyword", "shape", - "in_record true", "reader urword", "tagged true", - "optional false"], - ["block period", "name rtype", "type string", "shape", - "in_record true", "reader urword", "tagged false", - "optional false"], - ["block period", "name ocsetting", - "type keystring all first last frequency steps", "shape", - "tagged false", "in_record true", "reader urword"], - ["block period", "name all", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name first", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name last", "type keyword", "shape", - "in_record true", "reader urword"], - ["block period", "name frequency", "type integer", "shape", - "tagged true", "in_record true", "reader urword"], - ["block period", "name steps", "type integer", "shape (