4. Code Documentation

The code base is composed of two independent programs and a coupled model and message passing queue management framework. The two programs and the manager all execute in independent processes. Figure pyHS2MF6 framework and queues provides a schematic showing the interaction of the three independent processes and the components of the coupled controller and queue server.

• One independent program is mHSP2 which provides a Python variant of HSPF.

• The other program is pyMF6 which provides a Python-wrapped version of MODFLOW 6.

pyHS2MF6 framework and queues

Coupled model simulation relies on three message passing queues to transmit information among pyMF6, mHSP2, and the Coupled Controller and Queue Server. Spatial mapping, specified by the user as part of coupled model inputs, tells mHSP2 how to map to and from the MODFLOW 6 model grid.

• 4.1. Coupled Model Controller and Queue Server
  • 4.1.1. Main Block for Coupled Mode
  • 4.1.2. Coupled Mode Inputs
  • 4.1.3. Main Block for Standalone Mode
  • 4.1.4. Coupled Mode Logging
• 4.2. mHSP2
  • 4.2.1. Main Block
  • 4.2.2. RCHRES Water Movement and Storage
  • 4.2.3. PERLND Water Movement and Storage
  • 4.2.4. IMPLND Water Movement and Storage
  • 4.2.5. Coupling Specific Methods and Data Structures
  • 4.2.6. HDF5 File Methods and Data Structures
  • 4.2.7. mHSP2 Log File
• 4.3. pyMF6
  • 4.3.1. Python Modules
  • 4.3.2. Customized Fortran Modules