swe.py

Go to the documentation of this file.

# This file is part of the ExaHyPE2 project. For conditions of distribution and
# use, please see the copyright notice at www.peano-framework.org
import sympy
 
"""
We import the required modules for this project.
We always need the 'peano4' module as this is our core project.
Since we are creating a SymHyPE/ExaHyPE 2 application, we additionally
need to import the 'exahype2' and 'symhype' modules.
"""
import peano4
import exahype2
import symhype
 
"""
The number of finite volumes per axis in one patch.
"""
patch_size = 16
 
"""
The number of levels the mesh is refined.
"""
depth = 5
 
"""
The simulation end time.
"""
end_time = 1.0
 
"""
Choose domain size and offset.
"""
size = [2.0, 2.0]
offset = [0.0, 0.0]
 
"""
Choose how often a snapshot is written.
"""
time_in_between_two_snapshots = end_time / 10
# time_in_between_two_snapshots = 0 # Set to 0 to disable I/O
 
"""
Switch between 'Release', 'Debug', 'Asserts', 'Trace', 'Stats'.
"""
compile_mode = "Release"
 
"""
We first create a new ExaHyPE 2 project.
For this, we specify the (nested) namespaces, the name of our main file and our executable name.
"""
my_project = exahype2.Project(
    namespace=["tutorials", "symhype", "swe"],
    project_name="SWE",
    directory=".",
    executable="SWE",
)
 
"""
Add the solver using named arguments.
This is the way you can add further PDE terms.
This requires the 'BlockStructured' toolbox and 'ExaHyPE' to be built.
"""
my_solver = exahype2.solvers.fv.godunov.GlobalAdaptiveTimeStep(
    name="FVSolver",
    patch_size=patch_size,
    unknowns=2 + 1,  # [h, hu, hv]
    auxiliary_variables=1,  # Bathymetry (b)
    min_volume_h=(1.1 * min(size) / (3.0**depth)),
    max_volume_h=(1.1 * min(size) / (3.0**depth)),
    time_step_relaxation=0.5,
)
 
"""
We want to define our PDE symbolically.
"""
my_pde = symhype.FirstOrderConservativePDEFormulation(
    unknowns=2 + 1, auxiliary_variables=1, dimensions=2
)
h = my_pde.name_Q_entry(0, "h")
hu = my_pde.name_Q_entry(1, "hu")
hv = my_pde.name_Q_entry(2, "hv")
b = my_pde.name_auxiliary_variable(0, "b")
 
# Gravitational constant
g = sympy.symbols("g")
 
# Speed in x-direction
u = hu / h
 
# Speed in y-direction
v = hv / h
 
"""
Define the equation system
"""
# Flux [unknowns, dimensions]
my_pde.F[0, 0] = hu
my_pde.F[1, 0] = hu * u + (g * h**2) / 2
my_pde.F[2, 0] = h * u * v
 
my_pde.F[0, 1] = hv
my_pde.F[1, 1] = h * u * v
my_pde.F[2, 1] = hv * v + (g * h**2) / 2
 
# Eigenvalues [unknowns, dimensions]
my_pde.eigenvalues[0, 0] = u
my_pde.eigenvalues[0, 1] = v
 
my_pde.eigenvalues[1, 0] = u + sympy.sqrt(g * h)
my_pde.eigenvalues[1, 1] = v + sympy.sqrt(g * h)
my_pde.eigenvalues[2, 0] = u - sympy.sqrt(g * h)
my_pde.eigenvalues[2, 1] = v - sympy.sqrt(g * h)
 
# NCP [unknowns, dimensions]
delta_b = my_pde.grad(b)
 
my_pde.ncp[0, 0] = 0.0
my_pde.ncp[1, 0] = g * h * delta_b
my_pde.ncp[2, 0] = 0.0
 
my_pde.ncp[0, 1] = 0.0
my_pde.ncp[1, 1] = 0.0
my_pde.ncp[2, 1] = g * h * delta_b
 
"""
Since 'my_pde' only holds the PDE without initial- or boundary conditions,
we still need to properly define initial- and boundary conditions.
This gives us then a complete description of a 'scenario'.
"""
 
# Initial conditions as specified in the documentation.
my_pde.initial_values[0] = 1.0  # Water height (h)
my_pde.initial_values[1] = 0  # x-momentum (hu)
my_pde.initial_values[2] = 0  # y-momentum (hv)
 
volume_centre = sympy.sqrt((1.0 - my_pde.x[0]) ** 2 + (1.0 - my_pde.x[1]) ** 2)
my_pde.initial_values[3] = sympy.Piecewise(
    (0.0, volume_centre < 0.4), (0.1, True)
)  # Bathymetry (b)
 
# Boundary conditions
my_pde.boundary_values[0] = h
my_pde.boundary_values[1] = -hu
my_pde.boundary_values[2] = -hv
my_pde.boundary_values[3] = b
 
my_pde.substitute_expression(g, 9.81)
 
"""
Specify which implementation our solvers uses.
Here we want to set the implementation we get from our symbolically defined PDE,
i.e., we get the C++ implementation which is generated by SymHyPE.
"""
my_solver.set_implementation(
    initial_conditions=my_pde.implementation_of_initial_conditions(),
    boundary_conditions=my_pde.implementation_of_boundary_conditions(),
    flux=my_pde.implementation_of_flux(),
    max_eigenvalue=my_pde.implementation_of_max_eigenvalue(),
    ncp=my_pde.implementation_of_ncp(),
)
 
"""
To see which variables (unknowns + auxiliary variables) we can visualise,
let's add a plot description for the variables to our solver.
"""
my_solver.plot_description = my_pde.unknown_identifier_for_plotter()
 
"""
Add the solver to our project
"""
my_project.add_solver(my_solver)
 
"""
Configure some global parameters
"""
my_project.set_global_simulation_parameters(
    dimensions=2,  # The dimensionality is fixed for SWE
    size=size,
    offset=offset,
    min_end_time=end_time,
    max_end_time=end_time,
    first_plot_time_stamp=0.0,
    time_in_between_plots=time_in_between_two_snapshots,
    periodic_BC=[False, False, False],
)
 
"""
This defines where the output files should go.
If you omit this, output files are automatically put into the application's folder
"""
my_project.set_output_path("solutions")
 
"""
Configure load balancer for parallel execution.
"""
my_project.set_load_balancer("new ::exahype2::LoadBalancingConfiguration")
 
"""
We need to set the location of our core libraries ('Peano4').
This helps us to resolve any dependencies.
Additionally, we specify the build mode which you can also change to a different mode.
"""
my_project.set_Peano4_installation(
    "../../../", mode=peano4.output.string_to_mode(compile_mode)
)
 
"""
We generate and grab the underlying core project of 'Peano4'.
This gives us access to some functions we want to use to finalise and build this project.
"""
my_project = my_project.generate_Peano4_project(verbose=False)
 
"""
Finally, we want to build our project.
First, all of the necessary glue code is generated in the application folder,
then 'make' is invoked automatically which compiles the generated code and links against our core libraries
and toolboxes which have been built before.
You can also always invoke 'make' yourself to compile, or cleanup with 'make clean'.
"""
my_project.build(make=True, make_clean_first=True, throw_away_data_after_build=True)
 
print("\nPDE is: ")
print(my_pde.__str__())
print(my_solver)
print(my_project)