flopy.mf6.modflow.mfgnc module

class GncPackages(model_or_sim, parent, pkg_type, filerecord, package=None, package_class=None)

Bases: MFChildPackages

GncPackages is a container class for the ModflowGnc class.

initialize()

Initializes a new ModflowGnc package removing any sibling child packages attached to the same parent package. See ModflowGnc init documentation for definition of parameters.

append_package()

Adds a new ModflowGnc package to the container. See ModflowGnc init documentation for definition of parameters.

append_package(print_input=None, print_flows=None, explicit=None, numgnc=None, numalphaj=None, gncdata=None, filename=None, pname=None)

initialize(print_input=None, print_flows=None, explicit=None, numgnc=None, numalphaj=None, gncdata=None, filename=None, pname=None)

package_abbr = 'gncpackages'

class ModflowGnc(parent_model_or_package, loading_package=False, print_input=None, print_flows=None, explicit=None, numgnc=None, numalphaj=None, gncdata=None, filename=None, pname=None, **kwargs)

Bases: MFPackage

ModflowGnc defines a GNC package.

Parameters:

• print_input (keyword) – keyword to indicate that the list of gnc information will be written to the listing file immediately after it is read.

• print_flows (keyword) – keyword to indicate that the list of gnc 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.

• explicit (keyword) – keyword to indicate that the ghost node correction is applied in an explicit manner on the right-hand side of the matrix. the explicit approach will likely require additional outer iterations. if the keyword is not specified, then the correction will be applied in an implicit manner on the left-hand side. the implicit approach will likely converge better, but may require additional memory. if the explicit keyword is not specified, then the bicgstab linear acceleration option should be specified within the linear block of the sparse matrix solver.

• numgnc (integer) – is the number of gnc entries.

• numalphaj (integer) – is the number of contributing factors.

• gncdata ([list]) –

dfn = [['header'], ['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 explicit', 'type keyword', 'tagged true', 'reader urword', 'optional true'], ['block dimensions', 'name numgnc', 'type integer', 'reader urword', 'optional false'], ['block dimensions', 'name numalphaj', 'type integer', 'reader urword', 'optional false'], ['block gncdata', 'name gncdata', 'type recarray cellidn cellidm cellidsj alphasj', 'shape (maxbound)', 'reader urword'], ['block gncdata', 'name cellidn', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block gncdata', 'name cellidm', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block gncdata', 'name cellidsj', 'type integer', 'shape (numalphaj)', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block gncdata', 'name alphasj', 'type double precision', 'shape (numalphaj)', 'tagged false', 'in_record true', 'reader urword']]

dfn_file_name = 'gwf-gnc.dfn'

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

package_abbr = 'gnc'