flopy.mf6.modflow.mfutlncf module

class ModflowUtlncf(parent_package, loading_package=False, wkt=None, deflate=None, shuffle=None, chunk_time=None, chunk_face=None, chunk_z=None, chunk_y=None, chunk_x=None, modflow6_attr_off=None, ncpl=None, latitude=None, longitude=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowUtlncf defines a NCF package.

Parameters:

  • wkt ([string]) – is the coordinate reference system (crs) well-known text (wkt) string. ignored if latitude and longitude griddata arrays have been provided for netcdf_structured export type.

  • deflate (integer) – is the variable deflate level (0=min, 9=max) in the netcdf file. defining this parameter activates per-variable compression at the level specified.

  • shuffle (keyword) – is the keyword used to turn on the netcdf variable shuffle filter when the deflate option is also set. the shuffle filter has the effect of storing the first byte of all of a variable’s values in a chunk contiguously, followed by all the second bytes, etc. this can be an optimization for compression with certain types of data.

  • chunk_time (integer) – is the keyword used to provide a data chunk size for the time dimension in a netcdf_mesh2d or netcdf_structured output file. must be used in combination with the the chunk_face parameter (netcdf_mesh2d) or the chunk_z, chunk_y, and chunk_x parameter set (netcdf_structured) to have an effect.

  • chunk_face (integer) – is the keyword used to provide a data chunk size for the face dimension in a netcdf_mesh2d output file. must be used in combination with the the chunk_time parameter to have an effect.

  • chunk_z (integer) – is the keyword used to provide a data chunk size for the z dimension in a netcdf_structured output file. must be used in combination with the the chunk_time, chunk_x and chunk_y parameter set to have an effect.

  • chunk_y (integer) – is the keyword used to provide a data chunk size for the y dimension in a netcdf_structured output file. must be used in combination with the the chunk_time, chunk_x and chunk_z parameter set to have an effect.

  • chunk_x (integer) – is the keyword used to provide a data chunk size for the x dimension in a netcdf_structured output file. must be used in combination with the the chunk_time, chunk_y and chunk_z parameter set to have an effect.

  • modflow6_attr_off (keyword) – is the keyword used to turn off internal input tagging in the model netcdf file. tagging adds internal modflow 6 attribute(s) to variables which facilitate identification. currently this applies to gridded arrays.

  • ncpl (integer) – is the number of cells in a projected plane layer.

  • latitude ([double precision]) – cell center latitude. only supported for netcdf_structured export type.

  • longitude ([double precision]) – cell center longitude. only supported for netcdf_structured export type.

dfn = [['header'], ['block options', 'name wkt', 'type string', 'shape lenbigline', 'reader urword', 'optional true'], ['block options', 'name deflate', 'type integer', 'reader urword', 'optional true'], ['block options', 'name shuffle', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name chunk_time', 'type integer', 'reader urword', 'optional true'], ['block options', 'name chunk_face', 'type integer', 'reader urword', 'optional true'], ['block options', 'name chunk_z', 'type integer', 'reader urword', 'optional true'], ['block options', 'name chunk_y', 'type integer', 'reader urword', 'optional true'], ['block options', 'name chunk_x', 'type integer', 'reader urword', 'optional true'], ['block options', 'name modflow6_attr_off', 'type keyword', 'reader urword', 'optional true', 'mf6internal attr_off'], ['block dimensions', 'name ncpl', 'type integer', 'optional true', 'reader urword'], ['block griddata', 'name latitude', 'type double precision', 'shape (ncpl)', 'optional true', 'reader readarray'], ['block griddata', 'name longitude', 'type double precision', 'shape (ncpl)', 'optional true', 'reader readarray']]
dfn_file_name = 'utl-ncf.dfn'
latitude = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
longitude = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
package_abbr = 'utlncf'
wkt = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
class UtlncfPackages(model_or_sim, parent, pkg_type, filerecord, package=None, package_class=None)[source]

Bases: MFChildPackages

UtlncfPackages is a container class for the ModflowUtlncf class.

initialize()[source]

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

append_package()[source]

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

append_package(wkt=None, deflate=None, shuffle=None, chunk_time=None, chunk_face=None, chunk_z=None, chunk_y=None, chunk_x=None, modflow6_attr_off=None, ncpl=None, latitude=None, longitude=None, filename=None, pname=None)[source]
initialize(wkt=None, deflate=None, shuffle=None, chunk_time=None, chunk_face=None, chunk_z=None, chunk_y=None, chunk_x=None, modflow6_attr_off=None, ncpl=None, latitude=None, longitude=None, filename=None, pname=None)[source]
package_abbr = 'utlncfpackages'