Navigating SimulWave

How to Navigate Through SimulWave

SimulWave UI is composed of 2 main sections, which consist of Wave Container Section and Configuration Section. Read more to learn more on how to navigate through SimulWave UI.

Wave Container

The Wave Container of SimulWave is used to show the simulation result in frames of the wave movement, This section contains:

Wave Panel
The Wave Panel section is where the program provides the render of the simulated wave movement render, in this panel user can see the wave movement and the bathymetry of the simulation,
Control
The Control section is where the user can play or pause the wave movement animation and slide through each frame of the simulation.

Configuration Sidebar

In the Shallow Water Equation, the simulation needs initial conditions and boundary conditions such as the wave amplitude, the horizontal velocity, and the bathymetry shape. Other than the initial and boundary conditions, the computational domains of the simulation are needed to be specified by the user.

To accommodate that, the user can use the Configuration Sidebar section to configure the needed configuration to do the Shallow Water Equation simulation.

Configuration sidebar itself consists of three main sections, which are:

Wave

The Wave tab is where the user is able to change the main configuration needed to simulate the wave, this tab allows the user to change the following configuration of the simulation:

Computational Domain

This section is where the user is able to configure the computational domain used in the Shallow Water Equation simulation.

Wave Simulation

This configuration allows the user to choose between doing a 1D SWE Simulation or 2D SWE Simulation.

Spatial Domain

This configuration allows the user to set the simulation spatial domain. In this section, the user is able to update:

Variable	Description	Type
L	Width of x-axis spatial domain	Float
dx	Step size for the spatial domain in the x-axis	Float
M	Width of y-axis spatial domain	Float
dy	Step size for the spatial domain in the y-axis	Float

Variable

Description

Type

Width of x-axis spatial domain

Float

Step size for the spatial domain in the x-axis

Float

Width of y-axis spatial domain

Float

Step size for the spatial domain in the y-axis

Float

Time Domain

This configuration allows the user to set how long the simulation is, in this section, the user is able to update:

Variable	Description	Type	2D
T	Simulation time	Float
dt	Step size for the simulation time	Float

Variable

Description

Type

Simulation time

Float

Step size for the simulation time

Float

Initial and Boundary Conditions

Initial Condition

This configuration allows the user to set the initial condition of the simulation, in this section, the user is able to update:

Variable	Description	Type
$\eta(x,0)$	Wave Amplitude	Float or Function of $x$
$u(x,0)$	Horizontal Velocity in the $x$ -axis	Float or Function of $x$
$u_1(x,0)$	Layer 1 Horizontal Velocity in the $x$ -axis	Float or Function of $x$
$u_2(x,0)$	Layer 2 Horizontal Velocity in the $x$ -axis	Float or Function of $x$
$u(x,y,0)$	Horizontal Velocity in the $x$ -axis for 2D	Float or Function of $x$ and $y$
$v(x,y,0)$	Vertical Velocity in the $y$ -axis for 2D	Float or Function of $x$ and $y$

Variable

Description

Type

Non-Hydrostatic

$\eta(x,0)$

Wave Amplitude

Float or Function of $x$

$u(x,0)$

Horizontal Velocity in the $x$ -axis

Float or Function of $x$

$u_1(x,0)$

Layer 1 Horizontal Velocity in the $x$ -axis

Float or Function of $x$

$u_2(x,0)$

Layer 2 Horizontal Velocity in the $x$ -axis

Float or Function of $x$

$u(x,y,0)$

Horizontal Velocity in the $x$ -axis for 2D

Float or Function of $x$ and $y$

$v(x,y,0)$

Vertical Velocity in the $y$ -axis for 2D

Float or Function of $x$ and $y$

Boundary Condition

This configuration allows the user to set the boundary condition at each boundary (left or right or front or back), in this section, the user is able to update:

Variable	Description	Type
$\eta(0,t)$	Left Wall Wave Amplitude	Float or Function of $t$
$\eta(L,t)$	Right Wall Wave Amplitude	Float or Function of $t$
$u(0,t)$	Left Wall Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u(L,t)$	Right Wall Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u_1(0,t)$	Left Wall Layer 1 Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u_1(L,t)$	Right Wall Layer 1 Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u_2(0,t)$	Left Wall Layer 2 Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u_2(L,t)$	Right Wall Layer 2 Horizontal Velocity in the $x$ -axis	Float or Function of $t$
$u(0,y,t)$	Left Wall Horizontal Velocity in the $x$ -axis for 2D	Float or Function of $t$ and $y$
$u(L,y,t)$	Right Wall Horizontal Velocity in the $x$ -axis for 2D	Float or Function of $t$ and $y$
$v(x,0,t)$	Front Wall Horizontal Velocity in the $y$ -axis for 2D	Float or Function of $t$ and $x$
$v(x,M,t)$	Back Wall Horizontal Velocity in the $y$ -axis for 2D	Float or Function of $t$ and $x$

Variable

Description

Type

Non-Hydrostatic

$\eta(0,t)$

Left Wall Wave Amplitude

Float or Function of $t$

$\eta(L,t)$

Right Wall Wave Amplitude

Float or Function of $t$

$u(0,t)$

Left Wall Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u(L,t)$

Right Wall Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u_1(0,t)$

Left Wall Layer 1 Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u_1(L,t)$

Right Wall Layer 1 Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u_2(0,t)$

Left Wall Layer 2 Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u_2(L,t)$

Right Wall Layer 2 Horizontal Velocity in the $x$ -axis

Float or Function of $t$

$u(0,y,t)$

Left Wall Horizontal Velocity in the $x$ -axis for 2D

Float or Function of $t$ and $y$

$u(L,y,t)$

Right Wall Horizontal Velocity in the $x$ -axis for 2D

Float or Function of $t$ and $y$

$v(x,0,t)$

Front Wall Horizontal Velocity in the $y$ -axis for 2D

Float or Function of $t$ and $x$

$v(x,M,t)$

Back Wall Horizontal Velocity in the $y$ -axis for 2D

Float or Function of $t$ and $x$

Wave Configuration

Approximation Method

This configuration allows the user to select the approximation method for the flux movement in the momentum conservation equation, this configuration has the following options

Average
Upwind

Momentum

SimulWave allows the user to simulate Shallow Water Equation for the linear and non-linear cases, in this case, this configuration allows the user to select the momentum of the simulation with the following options:

Linear
Ignoring the advection term in the calculation
Non-linear
The advection term is included in the calculation

Vertical Velocity

SimulWave allows the user to simulate the Shallow Water Equation by ignoring the hydrodynamics pressure which affects the vertical velocity, in this case, the user can select the following options:

Hydrostatic
Ignoring the hydrodynamics pressure which means the vertical velocity is zero
Non-Hydrostatic
The hydrodynamics pressure is included in the calculation

Wet Dry Type

In some cases, the Wet Dry procedure doesn't work as expected, SimulWave allows users to select between two types of Wet Dry, which are

Type 1 (OR) - Default Value
Type 2 (AND)

Toggle Absorbing Wall

Other than setting the boundary conditions, SimulWave also allows users to set the Absorbing wall to the wall side as desired instead of a hard wall. In this section, the toggle of all sides of the computational domain is available.

Simulate Wave

The simulate Wave button is used for the user to start the simulation calculation process, after the user clicks this button, the simulation process will start and the button will be disabled until it's finished.

Bathymetry

The Bathymetry tab is where the user is able to change the Batyhmetry shape of the simulation, this tab allows the user to change the following configuration of the simulation:

Bathymetry Type

In this section users is able to select between two options, which are as follows,

Linear

For the case of Linear, the user can determine the depth of the Bathymetry from the wave surface. For special cases such as the Non-hydrostatic option on Vertical Velocity, the user is also able to determine the depth of the Bathymetry from two of the layers.

Custom

For the case of the Custom option, the user is able to import the Bathymetry shape and also set if the Bathymetry is a moving Bathymetry or not.

Bathymetry Configuration

In this section, the user is able to determine if they want to render the Bathmetry on the Wave Containeror not by using the toggle beside Display Bathymetry.

Renderer

Simulation Details

In this section, users can see all of the numerical configurations used in the simulation, such as the Computational Domainand the Spatial Domain .

2D Wave Renderer Configuration (2D ONLY)

2D View

SimulWave will render the 2D Wave simulation only in two axes, therefore these options allow the users to select between rendering across

$xz$ -plane
By selecting this the Wave Containerwill render the $x$ -axis of the simulation as the horizontal axis and $z$ -axis of the simulation as the vertical axis.
$yz$ -plane
By selecting this the Wave Containerwill render the $y$ -axis of the simulation as the horizontal axis and $z$ -axis of the simulation as the vertical axis.

At $y$ or $x$

This slider allows the user to view a specific slice of the axis plane.

Axis Configuration

These configurations allow the users to change a few configurations regarding the Wave Container axes,

$x$ Grid Size
Size of one grid size of the $x$ -axis.
$y$ Grid Size
Size of one grid size of the $y$ -axis.
$y$ Axis Limit
The minimum and maximum value of the $y$ -Axis.

Export and Import

In this section, user can import and export procedures regarding the simulations,

Import Configuration

The user will be able to import a predefined configuration for the simulation, for starter, you can use the example configuration available on Examples.

Export Configuration

The user will be able to export the configuration of the simulation into an importable configuration file.

Export Simulation Result

After running the simulation with the Simulate Wave Button, the user then will be able to export the simulation result to be analyzed with the SWELib Python package.

PreviousInstalling SimulWave NextExamples

Last updated 3 months ago