MODFLOW6

Read Output

open_hds(hds_path, grb_path[, dry_nan, ...])	Open modflow6 heads (.hds) file.
open_cbc(cbc_path, grb_path[, flowja, ...])	Open modflow6 cell-by-cell (.cbc) file.
read_cbc_headers(cbc_path)	Read all the header data from a cell-by-cell (.cbc) budget file.

Model objects & methods

Modflow6Simulation(name)
Modflow6Simulation.create_time_discretization(...)	Collect all unique times from model packages and additional given times.
Modflow6Simulation.write(**kwargs)
Modflow6Simulation.run([mf6path])	Run Modflow 6 simulation.
Modflow6Simulation.open_flow_budget([...])	Open flow budgets of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_transport_budget([...])	Open transport budgets of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_head([dry_nan, ...])	Open heads of finished simulation, requires that the run method has been called.
Modflow6Simulation.open_concentration([...])	Open concentration of finished simulation, requires that the run method has been called.
Modflow6Simulation.clip_box([time_min, ...])	Clip a simulation by a bounding box (time, layer, y, x).
Modflow6Simulation.split(submodel_labels)	Split a simulation in different partitions using a submodel_labels array.
Modflow6Simulation.regrid_like(...[, validate])	This method creates a new simulation object.
GroundwaterFlowModel(**kwargs)	The GroundwaterFlowModel (GWF) simulates flow of (liquid) groundwater.
GroundwaterFlowModel.mask_all_packages(mask)	This function applies a mask to all packages in a model.
GroundwaterTransportModel(**kwargs)	The GroundwaterTransportModel (GWT) simulates transport of a single solute species flowing in groundwater.
GroundwaterTransportModel.mask_all_packages(mask)	This function applies a mask to all packages in a model.

Discretization

StructuredDiscretization(*_, **__)	Discretization information for structered grids is specified using the file.
VerticesDiscretization(*_, **__)	Discretization by Vertices (DISV).
TimeDiscretization(*_, **__)	Timing for all models of the simulation is controlled by the Temporal Discretization (TDIS) Package.

Model settings

OutputControl(*_, **__)	The Output Control Option determines how and when heads, budgets and/or concentrations are printed to the listing file and/or written to a separate binary output file.
Solution(*_, **__)	Iterative Model Solution.
SolutionPresetSimple(modelnames[, ...])
SolutionPresetModerate(modelnames[, ...])
SolutionPresetComplex(modelnames[, ...])

Flow Packages

Buoyancy(*_, **__)	Buoyancy package.
ConstantHead(*_, **__)	Constant-Head package.
Drainage(*_, **__)	The Drain package is used to simulate head-dependent flux boundaries.
Evapotranspiration(*_, **__)	Evapotranspiration (EVT) Package.
GeneralHeadBoundary(*_, **__)	The General-Head Boundary package is used to simulate head-dependent flux boundaries.
HorizontalFlowBarrierHydraulicCharacteristic(*_, ...)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierMultiplier(*_, **__)	Horizontal Flow Barrier (HFB) package
HorizontalFlowBarrierResistance(*_, **__)	Horizontal Flow Barrier (HFB) package
InitialConditions(*_, **__)	Initial Conditions (IC) Package information is read from the file that is specified by "IC6" as the file type.
NodePropertyFlow(*_, **__)	Node Property Flow package.
Recharge(*_, **__)	Recharge Package.
River(*_, **__)	River package.
SpecificStorage(*_, **__)	Storage Package with specific storage.
StorageCoefficient(*_, **__)	Storage Package with a storage coefficient.
UnsaturatedZoneFlow(*_, **__)	Unsaturated Zone Flow (UZF) package.
Well(*_, **__)	Agnostic WEL package, which accepts x, y and a top and bottom of the well screens.
WellDisStructured(*_, **__)	WEL package for structured discretization (DIS) models .
WellDisVertices(*_, **__)	WEL package for discretization by vertices (DISV) models.

Transport Packages

AdvectionCentral(*_, **__)	The central-in-space weighting scheme is based on a simple distance-weighted linear interpolation between the center of cell n and the center of cell m to calculate solute concentration at the shared face between cell n and cell m.
AdvectionTVD(*_, **__)	An implicit second order TVD scheme.
AdvectionUpstream(*_, **__)	The upstream weighting (first order upwind) scheme sets the concentration at the cellface between two adjacent cells equal to the concentration in the cell where the flow comes from.
ConstantConcentration(*_, **__)	Constant Concentration package.
Dispersion(*_, **__)	Molecular Diffusion and Dispersion.
ImmobileStorageTransfer(*_, **__)	The Immobile Storage and Transfer (IST) package represents an immobile fraction of groundwater.
MobileStorageTransfer(*_, **__)	Mobile Storage.
MassSourceLoading(*_, **__)	Mass Source Loading (SRC) package for structured discretization (DIS) models.
SourceSinkMixing(*_, **__)	param package_names
SourceSinkMixing.from_flow_model(model, species)	Derive a Source and Sink Mixing package from a Groundwater Flow model's boundary conditions (e.g.