Skip to content

ref.md

Latest commit

 

History

History
98 lines (72 loc) · 2.19 KB

ref.md

File metadata and controls

98 lines (72 loc) · 2.19 KB
Raw

DispersiveShallowWater.jl API

CurrentModule = DispersiveShallowWater

Modules = [DispersiveShallowWater]
Pages = ["DispersiveShallowWater.jl"]

Model specific equations

Modules = [DispersiveShallowWater]
Pages = Main.EQUATIONS_FILES
Filter = t -> !(t in [DispersiveShallowWater.KdVEquation1D,
                     DispersiveShallowWater.BBMEquation1D,
                     DispersiveShallowWater.BBMBBMEquations1D,
                     DispersiveShallowWater.SvaerdKalischEquations1D,
                     DispersiveShallowWater.SerreGreenNaghdiEquations1D,
                     DispersiveShallowWater.HyperbolicSerreGreenNaghdiEquations1D,
                     DispersiveShallowWater.SainteMarieEquations1D,
                     DispersiveShallowWater.HyperbolicSainteMarieEquations1D])

Linear dispersion relations

Modules = [DispersiveShallowWater]
Pages = ["dispersion_relation.jl"]

Mesh

Modules = [DispersiveShallowWater]
Pages = ["mesh.jl"]

Boundary conditions

Modules = [DispersiveShallowWater]
Pages = ["boundary_conditions.jl"]

Solver

Modules = [DispersiveShallowWater]
Pages = ["solver.jl"]

Semidiscretization

Modules = [DispersiveShallowWater]
Pages = ["semidiscretization.jl"]

Callbacks

Modules = [DispersiveShallowWater]
Pages = Main.CALLBACKS_STEP_FILES

Utilities

Experimental data

Modules = [DispersiveShallowWater]
Pages = ["experimental_data.jl"]

Utilities from DispersiveShallowWater.jl

Modules = [DispersiveShallowWater]
Pages = ["util.jl"]

Utilities from TrixiBase.jl

Be aware that only trixi_include is being exported from DispersiveShallowWater.jl. To access the other TrixiBase.jl functions, you need to either:

  • Use the fully qualified name: DispersiveShallowWater.timer(), DispersiveShallowWater.@trixi_timeit, etc.
  • Import TrixiBase.jl explicitly: using TrixiBase or import TrixiBase
CurrentModule = TrixiBase

Modules = [TrixiBase]