flopy.mf6.modflow.mfgwfnam module

class ModflowGwfnam(model, loading_package=False, list=None, print_input=None, print_flows=None, save_flows=None, newtonoptions=None, nc_mesh2d_filerecord=None, nc_structured_filerecord=None, nc_filerecord=None, packages=None, filename=None, pname=None, **kwargs)

Bases: MFPackage

ModflowGwfnam defines a NAM package.

Parameters:

• list (string) – is name of the listing file to create for this gwf model. if not specified, then the name of the list file will be the basename of the gwf model name file and the ‘.lst’ extension. for example, if the gwf name file is called ‘my.model.nam’ then the list file will be called ‘my.model.lst’.

• print_input (keyword) – 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 (keyword) – 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 (keyword) – keyword to indicate that all model package flow terms will be written to the file specified with ‘budget fileout’ in output control.

• newtonoptions ((newton, under_relaxation)) –

  none * newton : keyword

  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.

  • under_relaxationkeyword

    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.

• nc_mesh2d_filerecord ((ncmesh2dfile)) –

  netcdf layered mesh fileout record. * ncmesh2dfile : string

  name of the netcdf ugrid layered mesh output file.

• nc_structured_filerecord ((ncstructfile)) –

  netcdf structured fileout record. * ncstructfile : string

  name of the netcdf structured output file.

• nc_filerecord ((netcdf_filename)) –

  netcdf filerecord * netcdf_filename : string

  defines a netcdf input file.

• packages (list) –

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 options', 'name nc_mesh2d_filerecord', 'type record netcdf_mesh2d fileout ncmesh2dfile', 'shape', 'reader urword', 'tagged true', 'optional true', 'mf6internal ncmesh2drec'], ['block options', 'name netcdf_mesh2d', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false', 'extended true'], ['block options', 'name nc_structured_filerecord', 'type record netcdf_structured fileout ncstructfile', 'shape', 'reader urword', 'tagged true', 'optional true', 'mf6internal ncstructrec'], ['block options', 'name netcdf_structured', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false', 'mf6internal netcdf_struct', 'extended true'], ['block options', 'name fileout', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name ncmesh2dfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false', 'extended true'], ['block options', 'name ncstructfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false', 'extended true'], ['block options', 'name nc_filerecord', 'type record netcdf filein netcdf_filename', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name netcdf', 'type keyword', 'in_record true', 'reader urword', 'tagged true', 'optional false', 'extended true'], ['block options', 'name filein', 'type keyword', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name netcdf_filename', 'type string', 'preserve_case true', 'in_record true', 'reader urword', 'optional false', 'tagged false', 'mf6internal netcdf_fname', 'extended 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']]

dfn_file_name = 'gwf-nam.dfn'

nc_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

nc_mesh2d_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

nc_structured_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

newtonoptions = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

package_abbr = 'gwfnam'

packages = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>