Skip to content

uofs-simlab/HydroTrixi.jl

Repository files navigation

HydroTrixi.jl

CI docs-dev

HydroTrixi.jl is an adaptive discontinuous spectral-element solver for hydrologic problems. It builds upon the parabolic spatial discretization capabilities in Trixi.jl (Ranocha et al. 2022) and the time integration methods in SciML, adding the following technical features to support the solution of the Richards equation in one spatial dimension:

  • Mixed and pressure-head formulations of the Richards equation, including constitutive constraints and capacity-weighted temporal operators
  • Flexible parabolic boundary conditions allowing penalty-type numerical fluxes that depend on the inner and outer solution and flux values
  • Solver flux output method (SFOM) diagnostics for time-integrated boundary fluxes, following Ireson et al. (2023)
  • Tools to facilitate problem setup and visualization, with examples for standard hydrologic benchmark cases

Installation

If you have not yet installed Julia, please follow the instructions for your operating system. HydroTrixi.jl works with Julia v1.10 and newer. We recommend using the latest stable release.

Install and run HydroTrixi.jl from a local clone:

git clone https://github.com/uofs-simlab/HydroTrixi.jl.git
cd HydroTrixi.jl
julia --project=.

Then instantiate dependencies in the Julia REPL:

julia> using Pkg

julia> Pkg.instantiate()

Optional sanity check:

julia> Pkg.test()

Visualization is optional. Loading CairoMakie and LaTeXStrings activates the plotting extension.

Worked examples and tutorials are provided in the documentation.

References

Acknowledgements

The developers of this package acknowledge funding support from the Cooperative Institute for Research to Operations in Hydrology (CIROH).

About

HydroTrixi.jl: High-order numerical methods for hydrologic models

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Contributors

Languages