The MODFLOW Application Programming Interface for simulation control and software interoperability. (February 2022)

• Record Type: Journal Article
• Authors: Hughes, Joseph D.; Russcher, Martijn J.; Langevin, Christian D.; Morway, Eric D.; McDonald, Richard R.
• Is Part Of: Environmental modelling & software. Volume 148(2022)
• Publication Date: 2022-02
• Subjects: API Application Programming Interface -- BMI Basic Model Interface -- CCA Common Component Architecture -- CSDMS Community Surface Dynamics Modeling System -- ESMF Earth System Modeling Framework -- EVT Evapotranspiration -- GWF Groundwater Flow -- GWT Groundwater Transport -- HRU Hydrologic Response Unit -- OpenMI Open Modeling Interface -- PRMS Precipitation-Runoff Modeling System -- SFR Streamflow Routing -- UZF Unsaturated Zone Flow -- XMI eXtended Model Interface; MODFLOW 6 -- MODFLOW API -- Basic model interface -- MetaSWAP -- PRMS -- MODSIM; Environmental monitoring -- Computer programs -- Periodicals; Ecology -- Computer simulation -- Periodicals; Digital computer simulation -- Periodicals; Computer software -- Periodicals; Environmental Monitoring -- Periodicals; Computer Simulation -- Periodicals; Environnement -- Surveillance -- Logiciels -- Périodiques; Écologie -- Simulation, Méthodes de -- Périodiques; Simulation par ordinateur -- Périodiques; Logiciels -- Périodiques; Computer software; Digital computer simulation; Ecology -- Computer simulation; Environmental monitoring -- Computer programs; Periodicals; Electronic journals; 363.70015118
• DOI: 10.1016/j.envsoft.2021.105257
• Languages: English
• ISSNs: 1364-8152

Abstract

Abstract: The MODFLOW API allows other programs to control MODFLOW and interactively change variables without having to modify the source code. The MODFLOW API is based on the Basic Model Interface (BMI), which is a set of conventions that define how to initialize a simulation, update the model state by advancing in time, and finalize the run. For many existing MODFLOW coupling applications, the information provided to MODFLOW must be updated multiple times in a time step. As this capability to modify variables within a time step is not defined by the BMI, an extension to BMI was developed. This eXtended Model Interface is part of the MODFLOW API and allows such a tight coupling to other models. Examples are included for a variety of use cases, including new flexibility for users to develop custom packages without modifying the MODFLOW source code and coupling MODFLOW with other models and optimization libraries. Highlights: The MODFLOW API allows other programs to control MODFLOW without modifying MODFLOW. The MODFLOW API is based on the Basic Model Interface and the eXtended Model Interface. The MODFLOW API can be used to develop custom packages without modifying MODFLOW.