User:Mburton/HydroGeoSphere Simulation Control: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
Line 1: Line 1:
__NOINDEX__
__NOINDEX__
{{Current development}}
{{Current development}}
Many of the inputs required for a HydroGeoSphere simulation are configured in the ''Simulation Control'' dialog, which is accessed by right-clicking on the simulation in the Project Explorer. This includes, but is not limited to: time stepping, output, zones, and initial conditions. The following is a full list of parameters available in the ''Simulation Control'' dialog.
{{TOC bottom}}
{{TOCright}}
Many of the inputs required for a HydroGeoSphere simulation are configured in the ''Simulation Control'' dialog, which is accessed by right-clicking on the simulation in the Project Explorer. The data input options include, but are not limited to: time stepping, output, zones, and initial conditions. The following is a full list of parameters available in the ''Simulation Control'' dialog.
[[File:HGS sim control.png|thumb|500 px|''HydroGeoSphere Simulation Control'' dialog]]
[[File:HGS sim control.png|thumb|500 px|HydroGeoSphere ''Simulation Control'' dialog]]


==General Tab==
==General Tab==
The ''General'' Tab in the ''Simulation Control'' dialog for the HydroGeoSphere model is where general settings for the input data on the other tabs of the ''Simulation Control'' dialog are defined.
The ''General'' tab in the ''Simulation Control'' dialog for the HydroGeoSphere model is where general settings for the input data on the other tabs of the ''Simulation Control'' dialog are defined. This tab gives GMS a general framework for the HydroGeoSphere simulation, the details of which can be refined on other tabs.
* ''Description'' – this purpose of this textbox is to enter a description that will appear at the top of the GROK file.
* ''Description'' – this purpose of this textbox is to enter a description that will appear at the top of the grok file.
* ''Transient flow'' – this checkbox adds a time-stepping, transient flow solution.
* ''Transient flow'' – this checkbox adds a time-stepping, transient flow solution.
* ''Unsaturated'' – this checkbox adds a variably-saturated flow solution.
* ''Unsaturated'' – this checkbox adds a variably-saturated flow solution.
* ''Finite difference''
'''Finite difference'''
** ''Finite difference mode'' – uses the finite difference approach rather than default finite element method.
* ''Finite difference mode'' – uses the finite difference approach rather than default finite element method.
** ''Control volume'' – uses the control-volume finite difference approach instead of the default standard finite difference approach. This option results in a conservative scheme with better numerical stability than the default approach.
* ''Control volume'' – uses the control-volume finite difference approach instead of the default standard finite difference approach. This option results in a conservative scheme with better numerical stability than the default approach.
* ''Domains''
'''Domains'''
** ''Porous media'' – include the porous media domain. This option is always on.
* ''Porous media'' – include the porous media domain. This option is always on.
** ''Surface flow'' – includes the surface flow domain.
* ''Surface flow'' – include the surface flow domain.
*** ''Dual nodes for surface flow'' – use the dual-node approach to define the discrete surface flow domain. This option is always on.
** ''Dual nodes for surface flow'' – use the dual-node approach to define the discrete surface flow domain. This option is always on.
** ''ET'' – includes the ET (evapotranspiration) domain.
* ''ET'' – include the ET (evapotranspiration) domain.


==Units Tab==
==Units Tab==
The default units in a HydroGeoSphere model are kilogram-metre-second. The ''Units'' tab  in the ''Simulation Control'' dialog is where the units for mass, length, time, and gravitational acceleration are defined.
The default units in a HydroGeoSphere model are kilogram-metre-second. The ''Units'' tab  in the ''Simulation Control'' dialog is where the units for mass, length, time, and the value for gravitational acceleration are defined.


* '''Units''' – a dropdown menu that converts the default values into the specified system. It does not convert properties specified in any GROK, MPROPS, etc. files.
'''Units''' – a dropdown menu that converts the default values into the specified system. It does not convert properties specified in any grok, porous media properties (.mprops), etc. files.
** ''Kilogram-metre-second''
* ''Kilogram-metre-second''
** ''Kilogram-metre-minute''
* ''Kilogram-metre-minute''
** ''Kilogram-metre-hour''
* ''Kilogram-metre-hour''
** ''Kilogram-metre-day''
* ''Kilogram-metre-day''
** ''Kilogram-metre-year''
* ''Kilogram-metre-year''
** ''Kilogram-centimetre-second''
* ''Kilogram-centimetre-second''
** ''Kilogram-centimetre-minute''
* ''Kilogram-centimetre-minute''
** ''Kilogram-centimetre-hour''
* ''Kilogram-centimetre-hour''
** ''Kilogram-centimetre-day''
* ''Kilogram-centimetre-day''
** ''Kilogram-centimetre-year''
* ''Kilogram-centimetre-year''
*'''Gravitational acceleration''' – set a default gravitational acceleration value.
'''Gravitational acceleration''' – set a default gravitational acceleration value.


==Saturated Flow Tab==
==Saturated Flow Tab==
HydroGeoSphere defaults to saturated flow for the flow simulation. The ''Saturated Flow'' tab of the Simulation Control dialog is where the default values for saturated flow can be modified.
HydroGeoSphere defaults to saturated flow for the flow simulation. The ''Saturated flow'' tab of the ''Simulation Control'' dialog is where the default values for saturated flow can be modified.
* ''No fluid mass balance'' – this checkbox suppresses the calculation of fluid mass balance information, which is, by default, computed at each time step.
* ''No fluid mass balance'' – this checkbox suppresses the calculation of fluid mass balance information, which is, by default, computed at each time step.
* ''Flow solver maximum iterations'' – maximum number of flow solver iterations, defaults to 2000.
* ''Flow solver maximum iterations'' – maximum number of flow solver iterations, defaults to 2000.
Line 43: Line 43:


==Variably Saturated Flow Tab==
==Variably Saturated Flow Tab==
The Variably Saturated Flow tab in the Simulation Control dialog of the HydroGeoSphere model is where the factors determining relative permeability are set. HydroGeoSphere defaults to the upstream weighting scheme with a factor value of 1.0.
The ''Variably saturated flow'' tab in the ''Simulation Control'' dialog of the HydroGeoSphere model is where the factors determining relative permeability are set. HydroGeoSphere defaults to the upstream weighting scheme with a factor value of 1.0.
* ''Upstream weighting factor'' – defaults to 1.0. This value should be in the range of 0.5 (central weighting) and 1.0 (upstream weighting).
* ''Upstream weighting factor'' – defaults to 1.0. This value should be in the range of 0.5 (central weighting) and 1.0 (upstream weighting).
* ''Newton iteration parameters''
'''Newton iteration parameters'''
** ''Remove negative coefficients'' – forces negative inter-nodal conductance to zero.
* ''Remove negative coefficients'' – forces negative inter-nodal conductance to zero.
** ''No nodal flow check'' – turns off nodal flow check, which is on by default.
* ''No nodal flow check'' – turns off nodal flow check, which is on by default.
** ''Nodal flow check tolerance'' – defaults to 10^-2. This is used to set constraints to the nodal flow error.
* ''Nodal flow check tolerance'' – defaults to 10^-2. This is used to set constraints to the nodal flow error.
** ''Underrelaxation factor'' – factor for the Newton iteration. This defaults to one, but can range from zero to one.
* ''Underrelaxation factor'' – factor for the Newton iteration. This defaults to one, but can range from zero to one.


==Time Stepping Tab==
==Time Stepping Tab==
The ''Time Stepping'' tab of the ''Simulation Control'' dialog is where the time step values for the HydroGeoSphere model can be modified.
The ''Time stepping'' tab of the ''Simulation Control'' dialog is where the time step values for the HydroGeoSphere model can be modified.
* ''General timestep settings''
 
** ''Initial time'' – defaults to 0. This can be used to index the times from an earlier run if the simulation needs to be restarted.
'''General timestep settings'''
** ''Initial timestep'' – used to assign a new value for the initial time step, which normally defaults to 0.01.
* ''Initial time'' – defaults to 0. This can be used to index the times from an earlier run if the simulation needs to be restarted.
** ''Maximum timestep'' – used to assign a new value as the maximum size for a time step. The maximum timestep defaults to 10^25.
* ''Initial timestep'' – used to assign a new value for the initial time step, which normally defaults to 0.01.
** ''Minimum timestep'' – used to assign a new value as the minimum size for a time step. This defaults to 10^-10. If the time step size is smaller than the default, HydroGeoSphere will stop.
* ''Maximum timestep'' – used to assign a new value as the maximum size for a time step. The maximum timestep defaults to 10^25.
** ''Time varying maximum timestep'' – this allows the creation of a table to create a dataset where the maximum time step will vary depending on the time unit.
* ''Minimum timestep'' – used to assign a new value as the minimum size for a time step. This defaults to 10^-10. If the time step size is smaller than the default, HydroGeoSphere will stop.
** ''Target times'' – allows for the creation of a list of target times to add to a current list of target times.
* ''Time varying maximum timestep'' – this allows the creation of a table to create a dataset where the maximum time step will vary depending on the time unit.
** ''Minimum timestep multiplier'' – used to assign a new value for the minimum time step multiplier, which defaults to 0.5.
* ''Target times'' – allows for the creation of a list of target times to add to a current list of target times.
** ''Maximum timestep multiplier'' – used to assign a new value for the maximum time step multiplier, which defaults to 2.
* ''Minimum timestep multiplier'' – used to assign a new value for the minimum time step multiplier, which defaults to 0.5.
** ''Jacobian epsilon'' – the shift in the pressure head used to numerically compute the derivatives in the Jacobian matrix.
* ''Maximum timestep multiplier'' – used to assign a new value for the maximum time step multiplier, which defaults to 2.
** ''Minimum relaxation factor for convergence'' – defaults to 0.95. Convergence of the Newton iteration can only be achieved when the computed relaxation factor is larger than the minimum value.
* ''Jacobian epsilon'' – the shift in the pressure head used to numerically compute the derivatives in the Jacobian matrix.
** ''Newton maximum iterations'' – defaults to 15. If this number is exceeded during a time step, then the current time step length is reduced by half and a new solution is attempted.
* ''Minimum relaxation factor for convergence'' – defaults to 0.95. Convergence of the Newton iteration can only be achieved when the computed relaxation factor is larger than the minimum value.
** ''Newton minimum iterations'' – defaults to 0. Convergence of the Newton iteration can only be achieved only after it has performed the minimum number of iterations.
* ''Newton maximum iterations'' – defaults to 15. If this number is exceeded during a time step, then the current time step length is reduced by half and a new solution is attempted.
** ''Newton absolute convergence criteria'' – defaults to 10^-5. Convergence of the Newton iteration in achieved when the maximum absolute nodal change in pressure head over the domain for one Newton iteration is less than this value.
* ''Newton minimum iterations'' – defaults to 0. Convergence of the Newton iteration can only be achieved only after it has performed the minimum number of iterations.
** ''Newton residual convergence criteria'' – defaults to 10^-8. Convergence of the Newton iteration is achieved when the maximum absolute nodal residual over the domain for one Newton iteration is less than this value.
* ''Newton absolute convergence criteria'' – defaults to 10^-5. Convergence of the Newton iteration in achieved when the maximum absolute nodal change in pressure head over the domain for one Newton iteration is less than this value.
** ''Newton maximum update for head'' – defaults to 1.0. This value is used to calculate the underrelaxation factor in the equation.
* ''Newton residual convergence criteria'' – defaults to 10^-8. Convergence of the Newton iteration is achieved when the maximum absolute nodal residual over the domain for one Newton iteration is less than this value.
** ''Newton maximum update for depth'' – update equations are the same as those for "Newton maximum update for head", but are applied to water depth.
* ''Newton maximum update for head'' – defaults to 1.0. This value is used to calculate the underrelaxation factor in the equation.
** ''Newton absolute maximum residual'' – if after any iteration of the Euclidean norm of the Newton residual exceeds this, then the Newton iteration is restarted with a smaller time step. by default this tolerance is set to zero, which is treated the same as infinity.
* ''Newton maximum update for depth'' – update equations are the same as those for "Newton maximum update for head", but are applied to water depth.
** ''Newton maximum residual increase'' – defaults to 10^30. If after any iteration the Newton residual increases by a factor of more than this, then the Newton iteration is restarted with a smaller time step.
* ''Newton absolute maximum residual'' – if after any iteration of the Euclidean norm of the Newton residual exceeds this, then the Newton iteration is restarted with a smaller time step. by default this tolerance is set to zero, which is treated the same as infinity.
* ''Adaptive timestep settings''
* ''Newton maximum residual increase'' – defaults to 10^30. If after any iteration the Newton residual increases by a factor of more than this, then the Newton iteration is restarted with a smaller time step.
** ''Head control'' – maximum allowed change in nodal head during any time step.
'''Adaptive timestep settings'''
** ''Water depth control'' – maximum allowed change in surface water depth during any time step.
* ''Head control'' – maximum allowed change in nodal head during any time step.
** ''Saturation control'' – maximum allowed change in nodal saturation during any time step.
* ''Water depth control'' – maximum allowed change in surface water depth during any time step.
** ''Newton iteration control'' – maximum allowed change in Newton-Raphson iterations during any time step.
* ''Saturation control'' – maximum allowed change in nodal saturation during any time step.
* ''Newton iteration control'' – maximum allowed change in Newton-Raphson iterations during any time step.


==Output Tab==
==Output Tab==
The Output tab of the Simulation Control dialog is where a set of output times are added so that the HydroGeoSphere model can include them as part of the target time list.
The ''Output'' tab of the ''Simulation Control'' dialog is where a set of output times are added so that the HydroGeoSphere model knows to include them as part of the target time list.
* ''Output times'' – listed items are added to the current set of output times.
* ''Output times'' – listed items are added to the current set of output times.


==Zones Tab==
==Zones Tab==
The Zones tab of the Simulation Control dialog for the import of data that contains certain element zone numbers for use in the HydroGeoSphere model.
The ''Zones'' tab of the ''Simulation Control'' dialog is used to import data that contains certain element zone numbers for use in the HydroGeoSphere model.
* ''Read porous media zones from file'' – import a data set containing the element zone numbers for the porous media domain.
* ''Read porous media zones from file'' – import a data set containing the element zone numbers for the porous media domain.
* ''Read surface flow zones from file'' – import a data set containing the element zone numbers for the surface flow domain.
* ''Read surface flow zones from file'' – import a data set containing the element zone numbers for the surface flow domain.
Line 89: Line 90:


==Initial Conditions Tab==
==Initial Conditions Tab==
The Initial Conditions tab of the Simulation Control dialog is where the initial head values for the HydroGeoSphere model are assigned. The iterative solver uses initial head values as a starting point for both steady-state and transient problems.
The ''Initial conditions'' tab of the ''Simulation Control'' dialog is where the initial head values for the HydroGeoSphere model are assigned. The iterative solver uses initial head values as a starting point for both steady-state and transient problems.


* '''Head'''
'''Head'''
** ''Initial head''
* ''Initial head''
** ''Initial head depth to water table''
* ''Initial head depth to water table''
** ''Initial head surface elevation''
* ''Initial head surface elevation''
** ''Initial head from file'' – import an initial head value set from a file.
* ''Initial head from file'' – import an initial head value set from a file.
* '''Water depth'''
'''Water depth'''
** ''Initial water depth''
* ''Initial water depth''
** ''Initial water depth from file'' – import an initial water depth value set from a file.
* ''Initial water depth from file'' – import an initial water depth value set from a file.


{{noindex}}
{{noindex}}
[[Category:Under Development]]
[[Category:Under Development]]
[[Category:HydroGeoSphere]]
[[Category:HydroGeoSphere]]

Revision as of 20:14, 20 September 2023


Many of the inputs required for a HydroGeoSphere simulation are configured in the Simulation Control dialog, which is accessed by right-clicking on the simulation in the Project Explorer. The data input options include, but are not limited to: time stepping, output, zones, and initial conditions. The following is a full list of parameters available in the Simulation Control dialog.

HydroGeoSphere Simulation Control dialog

General Tab

The General tab in the Simulation Control dialog for the HydroGeoSphere model is where general settings for the input data on the other tabs of the Simulation Control dialog are defined. This tab gives GMS a general framework for the HydroGeoSphere simulation, the details of which can be refined on other tabs.

  • Description – this purpose of this textbox is to enter a description that will appear at the top of the grok file.
  • Transient flow – this checkbox adds a time-stepping, transient flow solution.
  • Unsaturated – this checkbox adds a variably-saturated flow solution.

Finite difference

  • Finite difference mode – uses the finite difference approach rather than default finite element method.
  • Control volume – uses the control-volume finite difference approach instead of the default standard finite difference approach. This option results in a conservative scheme with better numerical stability than the default approach.

Domains

  • Porous media – include the porous media domain. This option is always on.
  • Surface flow – include the surface flow domain.
    • Dual nodes for surface flow – use the dual-node approach to define the discrete surface flow domain. This option is always on.
  • ET – include the ET (evapotranspiration) domain.

Units Tab

The default units in a HydroGeoSphere model are kilogram-metre-second. The Units tab in the Simulation Control dialog is where the units for mass, length, time, and the value for gravitational acceleration are defined.

Units – a dropdown menu that converts the default values into the specified system. It does not convert properties specified in any grok, porous media properties (.mprops), etc. files.

  • Kilogram-metre-second
  • Kilogram-metre-minute
  • Kilogram-metre-hour
  • Kilogram-metre-day
  • Kilogram-metre-year
  • Kilogram-centimetre-second
  • Kilogram-centimetre-minute
  • Kilogram-centimetre-hour
  • Kilogram-centimetre-day
  • Kilogram-centimetre-year

Gravitational acceleration – set a default gravitational acceleration value.

Saturated Flow Tab

HydroGeoSphere defaults to saturated flow for the flow simulation. The Saturated flow tab of the Simulation Control dialog is where the default values for saturated flow can be modified.

  • No fluid mass balance – this checkbox suppresses the calculation of fluid mass balance information, which is, by default, computed at each time step.
  • Flow solver maximum iterations – maximum number of flow solver iterations, defaults to 2000.
  • Flow solver convergence criteria – flow solver convergence tolerance.
  • Flow solver detail – controls the level of detail of the solver performance. This defaults to 0-no information, but can also be set to 1-full information.

Variably Saturated Flow Tab

The Variably saturated flow tab in the Simulation Control dialog of the HydroGeoSphere model is where the factors determining relative permeability are set. HydroGeoSphere defaults to the upstream weighting scheme with a factor value of 1.0.

  • Upstream weighting factor – defaults to 1.0. This value should be in the range of 0.5 (central weighting) and 1.0 (upstream weighting).

Newton iteration parameters

  • Remove negative coefficients – forces negative inter-nodal conductance to zero.
  • No nodal flow check – turns off nodal flow check, which is on by default.
  • Nodal flow check tolerance – defaults to 10^-2. This is used to set constraints to the nodal flow error.
  • Underrelaxation factor – factor for the Newton iteration. This defaults to one, but can range from zero to one.

Time Stepping Tab

The Time stepping tab of the Simulation Control dialog is where the time step values for the HydroGeoSphere model can be modified.

General timestep settings

  • Initial time – defaults to 0. This can be used to index the times from an earlier run if the simulation needs to be restarted.
  • Initial timestep – used to assign a new value for the initial time step, which normally defaults to 0.01.
  • Maximum timestep – used to assign a new value as the maximum size for a time step. The maximum timestep defaults to 10^25.
  • Minimum timestep – used to assign a new value as the minimum size for a time step. This defaults to 10^-10. If the time step size is smaller than the default, HydroGeoSphere will stop.
  • Time varying maximum timestep – this allows the creation of a table to create a dataset where the maximum time step will vary depending on the time unit.
  • Target times – allows for the creation of a list of target times to add to a current list of target times.
  • Minimum timestep multiplier – used to assign a new value for the minimum time step multiplier, which defaults to 0.5.
  • Maximum timestep multiplier – used to assign a new value for the maximum time step multiplier, which defaults to 2.
  • Jacobian epsilon – the shift in the pressure head used to numerically compute the derivatives in the Jacobian matrix.
  • Minimum relaxation factor for convergence – defaults to 0.95. Convergence of the Newton iteration can only be achieved when the computed relaxation factor is larger than the minimum value.
  • Newton maximum iterations – defaults to 15. If this number is exceeded during a time step, then the current time step length is reduced by half and a new solution is attempted.
  • Newton minimum iterations – defaults to 0. Convergence of the Newton iteration can only be achieved only after it has performed the minimum number of iterations.
  • Newton absolute convergence criteria – defaults to 10^-5. Convergence of the Newton iteration in achieved when the maximum absolute nodal change in pressure head over the domain for one Newton iteration is less than this value.
  • Newton residual convergence criteria – defaults to 10^-8. Convergence of the Newton iteration is achieved when the maximum absolute nodal residual over the domain for one Newton iteration is less than this value.
  • Newton maximum update for head – defaults to 1.0. This value is used to calculate the underrelaxation factor in the equation.
  • Newton maximum update for depth – update equations are the same as those for "Newton maximum update for head", but are applied to water depth.
  • Newton absolute maximum residual – if after any iteration of the Euclidean norm of the Newton residual exceeds this, then the Newton iteration is restarted with a smaller time step. by default this tolerance is set to zero, which is treated the same as infinity.
  • Newton maximum residual increase – defaults to 10^30. If after any iteration the Newton residual increases by a factor of more than this, then the Newton iteration is restarted with a smaller time step.

Adaptive timestep settings

  • Head control – maximum allowed change in nodal head during any time step.
  • Water depth control – maximum allowed change in surface water depth during any time step.
  • Saturation control – maximum allowed change in nodal saturation during any time step.
  • Newton iteration control – maximum allowed change in Newton-Raphson iterations during any time step.

Output Tab

The Output tab of the Simulation Control dialog is where a set of output times are added so that the HydroGeoSphere model knows to include them as part of the target time list.

  • Output times – listed items are added to the current set of output times.

Zones Tab

The Zones tab of the Simulation Control dialog is used to import data that contains certain element zone numbers for use in the HydroGeoSphere model.

  • Read porous media zones from file – import a data set containing the element zone numbers for the porous media domain.
  • Read surface flow zones from file – import a data set containing the element zone numbers for the surface flow domain.
  • Read ET zones from file – import a data set containing the element zone numbers for the ET domain.

Initial Conditions Tab

The Initial conditions tab of the Simulation Control dialog is where the initial head values for the HydroGeoSphere model are assigned. The iterative solver uses initial head values as a starting point for both steady-state and transient problems.

Head

  • Initial head
  • Initial head depth to water table
  • Initial head surface elevation
  • Initial head from file – import an initial head value set from a file.

Water depth

  • Initial water depth
  • Initial water depth from file – import an initial water depth value set from a file.