flopy.mf6.modflow.mfnam module

class ModflowNam(simulation, loading_package=False, continue_=None, nocheck=None, memory_print_option=None, profile_option=None, maxerrors=None, print_input=None, hpc_data=None, tdis6=None, models=None, exchanges=None, mxiter=None, solutiongroup=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowNam defines a NAM package.

Parameters:

  • continue (keyword) – keyword flag to indicate that the simulation should continue even if one or more solutions do not converge.

  • nocheck (keyword) – keyword flag to indicate that the model input check routines should not be called prior to each time step. checks are performed by default.

  • memory_print_option (string) – is a flag that controls printing of detailed memory manager usage to the end of the simulation list file. none means do not print detailed information. summary means print only the total memory for each simulation component. all means print information for each variable stored in the memory manager. none is default if memory_print_option is not specified.

  • profile_option (string) – is a flag that controls performance profiling and reporting. none disables profiling. summary means to measure and print a coarse performance profile. detail means collect and print information with the highest resolution available. none is default if profile_option is not specified.

  • maxerrors (integer) – maximum number of errors that will be stored and printed.

  • print_input (keyword) – keyword to activate printing of simulation input summaries to the simulation list file (mfsim.lst). with this keyword, input summaries will be written for those packages that support newer input data model routines. not all packages are supported yet by the newer input data model routines.

  • hpc_data (record hpc6 filein hpc6_filename) – Contains data for the hpc package. Data can be passed as a dictionary to the hpc package with variable names as keys and package data as values. Data for the hpc_data variable is also acceptable. See hpc package documentation for more information.

  • tdis6 (string) – is the name of the temporal discretization (tdis) input file.

  • models (list) – is the list of model types, model name files, and model names.

  • exchanges (list) – is the list of exchange types, exchange files, and model names.

  • mxiter (integer) – is the maximum number of outer iterations for this solution group. the default value is 1. if there is only one solution in the solution group, then mxiter must be 1.

  • solutiongroup (list) – is the list of solution types and models in the solution.

dfn = [['header'], ['block options', 'name continue', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name nocheck', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name memory_print_option', 'type string', 'reader urword', 'optional true', 'mf6internal prmem'], ['block options', 'name profile_option', 'type string', 'reader urword', 'optional true', 'mf6internal prprof'], ['block options', 'name maxerrors', 'type integer', 'reader urword', 'optional true'], ['block options', 'name print_input', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name hpc_filerecord', 'type record hpc6 filein hpc6_filename', 'shape', 'reader urword', 'tagged true', 'optional true', 'construct_package hpc', 'construct_data hpc_data', 'parameter_name hpc_data'], ['block options', 'name hpc6', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false', 'extended true'], ['block options', 'name filein', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name hpc6_filename', 'type string', 'preserve_case true', 'in_record true', 'reader urword', 'optional false', 'tagged false', 'extended true'], ['block timing', 'name tdis6', 'preserve_case true', 'type string', 'reader urword', 'optional'], ['block models', 'name models', 'type recarray mtype mfname mname', 'reader urword', 'optional'], ['block models', 'name mtype', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block models', 'name mfname', 'in_record true', 'type string', 'preserve_case true', 'tagged false', 'reader urword'], ['block models', 'name mname', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block exchanges', 'name exchanges', 'type recarray exgtype exgfile exgmnamea exgmnameb', 'reader urword', 'optional'], ['block exchanges', 'name exgtype', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block exchanges', 'name exgfile', 'in_record true', 'type string', 'preserve_case true', 'tagged false', 'reader urword'], ['block exchanges', 'name exgmnamea', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block exchanges', 'name exgmnameb', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block solutiongroup', 'name group_num', 'type integer', 'block_variable True', 'in_record true', 'tagged false', 'shape', 'reader urword'], ['block solutiongroup', 'name mxiter', 'type integer', 'reader urword', 'optional true'], ['block solutiongroup', 'name solutiongroup', 'type recarray slntype slnfname slnmnames', 'reader urword'], ['block solutiongroup', 'name slntype', 'type string', 'valid ims6 ems6', 'in_record true', 'tagged false', 'reader urword'], ['block solutiongroup', 'name slnfname', 'type string', 'preserve_case true', 'in_record true', 'tagged false', 'reader urword'], ['block solutiongroup', 'name slnmnames', 'type string', 'in_record true', 'shape (:)', 'tagged false', 'reader urword']]
dfn_file_name = 'sim-nam.dfn'
exchanges = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
hpc_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
models = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
package_abbr = 'nam'
solutiongroup = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>