GMS:HydroGeoSphere: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
HydroGeoSphere (HGS) is a three-dimensional control-volume finite element simulator created by [https://www.aquanty.com/ Aquanty]. HGS can be used to model the entire terrestrial portion of the hydrologic cycle. It uses a globally-implicit approach to simultaneously solve the 2D diffusive-wave equation for overland/surface water flow and the 3D form of Richards’ equation for variably saturated groundwater flow. GMS allows multiple HGS simulations to exist in a single GMS project.
{{Current development}}


HydroGeoSphere (HGS) is a three-dimensional control-volume finite element simulator created by [https://www.aquanty.com/ Aquanty]. HGS can be used to model the entire terrestrial portion of the hydrologic cycle. It uses a globally-implicit approach to simultaneously solve the 2D diffusive-wave equation for overland/surface water flow and the 3D form of Richards’ equation for variably saturated groundwater flow.
==HydroGeoSphere Simulations==
 
==Graphical Interface==
The GMS interface for HydroGeoSphere contains multiple components. These components include:
The GMS interface for HydroGeoSphere contains multiple components. These components include:
* An unstructured grid (UGrid)
* An unstructured grid (UGrid)
* HGS coverages
* [[GMS:HydroGeoSphere Coverages|HydroGeoSphere coverages]]
* HGS simulation, including the Simulation Control
* HydroGeoSphere simulation, including the [[GMS:HydroGeoSphere Simulation Control|Simulation Control]]
===Working with Simulations===
A simulation can be created by right-clicking on a blank portion of the Project Explorer and choosing the ''New Simulation'' submenu. The ''New Simulation'' menu will have commands to create a new model simulation. Selecting a model will cause a simulation folder [[File:Simulation Folder Icon.svg|16 px]] for the chosen model to appear in the Project Explorer.
 
After a simulation [[File:Simulation Icon.svg|16 px]] has been created, components may be added to the simulation. Components are often created as map coverages, meshes, grids, or scatter sets. The individual map coverages, grids, or scatter sets can be linked to the simulation by clicking on the item in the Project Explorer and dragging it under the simulation item in the Project Explorer. Each simulation in the Project Explorer will show a list of all linked components [[File:Coverage Link.svg|16 px]]. This allows multiple simulations to make use of the same datasets.
 
Components can also be added to a simulation using the right-click ''Apply To'' submenus.
 
Once a simulation exists, future simulations are often similar to one already created. Often it is easier to make a copy of the simulation and make changes where appropriate. A simulation can be copied by right-clicking on the simulation and choosing '''Duplicate'''. All simulations for a model will be listed under the simulation [[File:Simulation Icon.svg|16 px]] for that model. Under the simulation data [[File:Simulation Data Icon.svg|16 px]] item all simulations for all models will be listed—SMS supports using more than one model for a project.
 
:'''''Note:''''' When naming simulations, apostrophes are not allowed in the simulation name. Using an apostrophe in any simulation name may cause an error.
 
The right-click menu for a simulation includes menu commands specific to each model.
 
====Simulation Right-Click Menu Commands====
{{Anchor|Simulation Menu}}
Right-clicking on any simulation object [[File:Simulation Icon.svg|16 px]] in the Project Explorer will bring up a menu for that simulation. Some of the commands are specific for the simulation model type. The simulation right-click menu has the following commands that are used by all simulations.
* '''Rename''' – Allows changing the simulation name.
* '''Duplicate''' – Creates a copy of the selected simulation. All components linked to selected simulation will be linked to the duplicate simulation. Adding, or removing the components in the duplicate simulation will not change the original simulation.
* '''Delete''' – Removes the selected simulation. This command does not delete or modify components linked to the simulation.
* '''Properties''' – Brings up a ''Properties'' dialog that shows which model the simulation is using and what components have been applied.
 
Right-clicking on the simulation folder [[File:Simulation Folder Icon.svg|16 px]] always includes the following commands:
* '''New Simulation''' – This command will create a new simulation of the same model type as the simulation folder.
* '''Simulation Run Queue''' – Opens the [[SMS:Simulations#Simulation_Run_Queue|''Simulation Run Queue'']] dialog.
 
Additional commands appear in the simulation right-click menu depend on the settings in the ''Simulation Menu Preferences'' dialog as described above.
If any of the ''Multiple'' simulation commands are invoked, a dialog appears listing the simulations in this folder with toggle box next to each as shown. The user may then select which simulations should be included in this command.


These optional commands should be self explanatory based on their name. In general, their function can be described as:  
===Creating a New HydroGeoSphere Simulation ===
*A command that says '''Save Simulation''' generates the files for the numeric model simulation run, but does not save the project files.  
[[File:MODFLOW6 Sim.png|thumb|250 px|Example of a MODFLOW 6 simulation in the Project Explorer]]
*A command that says '''Save Project''' saves the project such as mesh and map data, but doesn't generate the files needed for the simulation run. This command is typically used with the ''Save Simulation'' command.
To create a MODFLOW simulation:
*A command that says '''Run Simulation''' runs the simulation. It is necessary to save the simulation files as part of or before using a run command.
# Right-click on an empty space in the Project Explorer, or right-click on "[[File:Project Icon.svg|16 px]] Project" in the Project Explorer, and select ''New Simulation'' | '''HydroGeoSphere'''.
All of the above applies equally to multiple simulations commands and single simulations commands.


==Modeling Notes==
A 3D UGrid of the project area is required. While the project can contain multiple UGrids, only one UGrid can be attached to each HGS simulation. The desired UGrid will need to be linked to the HGS simulation.
*GMS allows multiple HGS simulations to exist in a single GMS project.


==HGS Files==
===HGS Simulation Right-Click Menus===
In the Project Explorer, right-clicking on a HGS simulation brings up a menu with several commands. Some of these commands are common to other Project Explorer In the Project Explorer, right-clicking on HGS simulation brings up a menu with several commands. Some of these commands are common to other Project Explorer right-click menus. Others are unique to the simulation right-click menus. Some of these unique commands are:
*"[[File:Mf6sim data.svg|16 px]] Simulation Data"
**'''Simulation Run Queue''' – Opens the ''Simulation Run Queue'' dialog which shows all current simulation runs.
*"[[File:Hgs-sim-folder icon.png|16 px]] HydroGeoSphere Simulations"
** '''New Simulation''' – Creates a new MODFLOW 6 simulation in the Project Explorer. This simulation will not contain any of the packages in any existing simulations and therefor the packages must be added. Also, creating a new simulation using this method requires linking a UGrid to the simulation.
** '''Save Multiple Simulations''' – Saves all HGS simulations in the project and exports all files needed for the model run.
*[[File:HydroGeoSphere Simulation Icon.png|16 px]] Model
**'''Simulation Control''' – Opens the [[GMS:HydroGeoSphere Simulation Control|''Simulation Control'']] dialog where the HGS simulation parameters are set.
**'''Materials''' – Opens the HGS [[GMS:HydroGeoSphere Materials|''Materials'']] dialog.
**'''Export''' – Saves out the simulation files.
**'''Run grok''' – Opens the ''Run grok.exe'' dialog where GMS will generate the GROK file. The GROK file contains all of the information and instructions required for the HGS simulation.
**'''Run phgs''' – Opens the ''Run phgs.exe'' dialog where the HGS simulation will run.
**'''Run hsplot''' – Opens the ''Run hsplot.exe'' dialog which will post-process the simulation results for viewing.
**'''Solution Plots''' – Opens the ''Solution Plots'' dialog which will display plots generated from the HGS solution.
**'''Save Simulation''' – Saves the simulation and exports all files needed for the model run.
**'''Save Project and Simulation''' – Saves the simulation and exports all files needed for the model run.
**'''Read Solution''' – Loads the solution file for the associated simulation. Requires that the simulation has had a successful run.


==HGS Executables==
Running HGS requires multiple executable. These include:
* grok.exe – A pre-processor that uses the Grok input file containing the information and instructions for the HGS simulation.
* phgs.exe – Performs the model simulation.
* hsplot.exe – A post-processor that generates the simulations results.


==External Links==
==External Links==
Line 56: Line 46:


{{Navbox GMS}}
{{Navbox GMS}}
[[Category:Under Development]]
{{stub}}
[[Category:HydroGeoSphere]]
[[Category:HydroGeoSphere]]
[[Category:External Links]]
[[Category:External Links]]

Revision as of 22:19, 18 April 2024

HydroGeoSphere (HGS) is a three-dimensional control-volume finite element simulator created by Aquanty. HGS can be used to model the entire terrestrial portion of the hydrologic cycle. It uses a globally-implicit approach to simultaneously solve the 2D diffusive-wave equation for overland/surface water flow and the 3D form of Richards’ equation for variably saturated groundwater flow. GMS allows multiple HGS simulations to exist in a single GMS project.

HydroGeoSphere Simulations

The GMS interface for HydroGeoSphere contains multiple components. These components include:

Creating a New HydroGeoSphere Simulation

Example of a MODFLOW 6 simulation in the Project Explorer

To create a MODFLOW simulation:

  1. Right-click on an empty space in the Project Explorer, or right-click on "Project Icon.svg Project" in the Project Explorer, and select New Simulation | HydroGeoSphere.

A 3D UGrid of the project area is required. While the project can contain multiple UGrids, only one UGrid can be attached to each HGS simulation. The desired UGrid will need to be linked to the HGS simulation.

HGS Simulation Right-Click Menus

In the Project Explorer, right-clicking on a HGS simulation brings up a menu with several commands. Some of these commands are common to other Project Explorer In the Project Explorer, right-clicking on HGS simulation brings up a menu with several commands. Some of these commands are common to other Project Explorer right-click menus. Others are unique to the simulation right-click menus. Some of these unique commands are:

  • "Mf6sim data.svg Simulation Data"
    • Simulation Run Queue – Opens the Simulation Run Queue dialog which shows all current simulation runs.
  • "Hgs-sim-folder icon.png HydroGeoSphere Simulations"
    • New Simulation – Creates a new MODFLOW 6 simulation in the Project Explorer. This simulation will not contain any of the packages in any existing simulations and therefor the packages must be added. Also, creating a new simulation using this method requires linking a UGrid to the simulation.
    • Save Multiple Simulations – Saves all HGS simulations in the project and exports all files needed for the model run.
  • HydroGeoSphere Simulation Icon.png Model
    • Simulation Control – Opens the Simulation Control dialog where the HGS simulation parameters are set.
    • Materials – Opens the HGS Materials dialog.
    • Export – Saves out the simulation files.
    • Run grok – Opens the Run grok.exe dialog where GMS will generate the GROK file. The GROK file contains all of the information and instructions required for the HGS simulation.
    • Run phgs – Opens the Run phgs.exe dialog where the HGS simulation will run.
    • Run hsplot – Opens the Run hsplot.exe dialog which will post-process the simulation results for viewing.
    • Solution Plots – Opens the Solution Plots dialog which will display plots generated from the HGS solution.
    • Save Simulation – Saves the simulation and exports all files needed for the model run.
    • Save Project and Simulation – Saves the simulation and exports all files needed for the model run.
    • Read Solution – Loads the solution file for the associated simulation. Requires that the simulation has had a successful run.

HGS Executables

Running HGS requires multiple executable. These include:

  • grok.exe – A pre-processor that uses the Grok input file containing the information and instructions for the HGS simulation.
  • phgs.exe – Performs the model simulation.
  • hsplot.exe – A post-processor that generates the simulations results.

External Links