API Reference

MODFLOW 6

FloPy for MODFLOW 6 allows for the construction of multi-model simulations. In order to construct a MODFLOW 6 simulation using FloPy, first construct a simulation (MFSimulation) object. Then construct the MODFLOW 6 models (Modflowgwf and Modflowgwt) and the packages, like TDIS, that are associated with the simulation. Finally, construct the packages that are associated with each of your models.

MODFLOW 6 Base Classes

FloPy for MODFLOW 6 is object oriented code that uses inheritance. The FloPy classes used to define different types models and packages share common code that is defined in these base classes.

Contents:

MODFLOW 6 Simulation

MODFLOW 6 allows you to create simulations that can contain multiple models and packages. The FloPy for MODFLOW 6 simulation classes define functionality that applies to the entire MODFLOW 6 simulation. When using FloPy for MODFLOW 6 the first object you will most likely create is a simulation (MFSimulation) object.

Contents:

MODFLOW 6 Simulation Packages

MODFLOW 6 simulation packages are the packages that are not necessarily tied to a specific model and can apply to the entire simulation or a group of models in the simulation.

Contents:

MODFLOW 6 Models

MODFLOW 6 supports both groundwater flow (mfgwf.ModflowGwf) and groundwater transport (mfgwt.ModflowGwt) models. FloPy for MODFLOW 6 model objects can be constructed after a FloPy simulation (MFSimulation) object has been constructed.

Contents:

MODFLOW 6 Groundwater Flow Model Packages

MODFLOW 6 groundwater flow models support a number of required and optional packages. Once a MODFLOW 6 groundwater flow model object (mfgwf.ModflowGwf) has been constructed various packages associated with the groundwater flow model can be constructed.

Contents:

MODFLOW 6 Groundwater Transport Model Packages

MODFLOW 6 groundwater transport models support a number of required and optional packages. Once a MODFLOW 6 groundwater transport model object (mfgwt.ModflowGwt) has been constructed various packages associated with the groundwater transport model can be constructed.

Contents:

MODFLOW 6 Utility Packages

MODFLOW 6 has several utility packages that can be associated with other packages. This includes the obs package, which can be used to output model results specific to its parent package, and the time series and time array series packages, which can be used to provide time series input for other packages.

Contents:

MODFLOW 6 Utility Functions

MODFLOW 6 has a number of utilities useful for pre- or postprocessing.

Contents:

MODFLOW 6 Data

FloPy for MODFLOW 6 data objects (MFDataArray, MFDataList, MFDataScalar) are automatically constructed by FloPy when you construct a package. These data objects provide an interface for getting MODFLOW 6 data in different formats and setting MODFLOW 6 data.

Contents:

Build MODFLOW 6 Classes

MODFLOW 6 FloPy classes can be rebuild from MODFLOW 6 definition files. This will allow creation of MODFLOW 6 FloPy classes for development versions of MODFLOW 6.

Contents:

Previous Versions of MODFLOW

MODFLOW Base Classes

Contents:

MODFLOW Packages

Contents:

MT3DMS Packages

Contents:

SEAWAT Packages

Contents:

MODPATH 7 Packages

Contents:

MODPATH 6 Packages

Contents:

Flopy Utilities

Model Utilities (including binary file readers)

Contents:

Plotting Utilities

Contents:

Export Utilities

Contents:

PEST Utilities

Contents:

Discretization Utilities

Contents: