Functions
float	manning_coefficient (float H, float z0=0.003)
	Compute the Manning coefficient n based on the Chezy formulation:

Variables
int	L = 300e3

list	physical_offset = [-39870.0, 0.0]

list	physical_size = [379700.0, L / 3]

	square_side = max(physical_size)

list	offset

list	size = [square_side, square_side]

int	H = 50

float	manning_coefficient_value = manning_coefficient(H)

str	initial_conditions

str	boundary_conditions

str	is_physically_admissible

	parser = exahype2.ArgumentParser()

	min_depth

	end_time

	degrees_of_freedom

	args = parser.parse_args()

dict	constants

float	max_h = 1.1 * min(physical_size) / (3.0**args.min_depth)

float	min_h = max_h * 3.0 ** (-args.amr_levels)

int	dg_order = args.degrees_of_freedom - 1

	aderdg_solver

	flux

	ncp

	max_eigenvalue

	riemann_solver

	source_term

	fv_solver

	limiter_solver

	project

float	time_in_between_plots = 0.0

	dimensions

	min_end_time

	max_end_time

	first_plot_time_stamp

	periodic_BC

	mode

	const_val

	const_type

	make

	True

	make_clean_first

	throw_away_data_after_build

Function Documentation

◆ manning_coefficient()

float meteotsunami-r1.manning_coefficient	(	float	H,
		float	z0 = 0.003 )

Compute the Manning coefficient n based on the Chezy formulation:

C = 18 * log(0.37 * H / z0)
n = H^(1/6) / C

Parameters

H : float Water depth in meters. z0 : float, optional Roughness length in meters (default: 0.003).

Returns

n : float Manning coefficient (dimensionless).

Definition at line 20 of file meteotsunami-r1.py.

Variable Documentation

◆ aderdg_solver

meteotsunami-r1.aderdg_solver

Initial value:

=  exahype2.solvers.aderdg.GlobalAdaptiveTimeStep(
    name="ADERDGSolver",
    order=dg_order,
    unknowns={"h": 1, "hu": 1, "hv": 1, "z": 1},
    auxiliary_variables=0,
    min_cell_h=min_h,
    max_cell_h=max_h,
    time_step_relaxation=0.9,
)

Definition at line 151 of file meteotsunami-r1.py.

◆ args

meteotsunami-r1.args = parser.parse_args()

Definition at line 128 of file meteotsunami-r1.py.

◆ boundary_conditions

meteotsunami-r1.boundary_conditions

Initial value:

=  """
  if (normal == 0) {
    // x-normal: left and right boundary
    // transmissive
    Qoutside[0] = Qinside[0];
    Qoutside[1] = Qinside[1];
    Qoutside[2] = Qinside[2];
    Qoutside[3] = Qinside[3];
  } else if (normal == 1) {
    // y-normal: top and bottom boundary
    // wall boundary
    Qoutside[0] = Qinside[0];
    Qoutside[1] = Qinside[1];
    Qoutside[2] = -Qinside[2];
    Qoutside[3] = Qinside[3];
  }
"""

Definition at line 79 of file meteotsunami-r1.py.

◆ const_type

meteotsunami-r1.const_type

Definition at line 277 of file meteotsunami-r1.py.

◆ const_val

meteotsunami-r1.const_val

Definition at line 277 of file meteotsunami-r1.py.

◆ constants

dict meteotsunami-r1.constants

Initial value:

=  {
    "g": [9.81, "double"],
    "hThreshold": [1e-5, "double"],
    "PhysicalDomainOffsetX": [physical_offset[0], "double"],
    "PhysicalDomainOffsetY": [physical_offset[1], "double"],
    "PhysicalDomainSizeX": [physical_size[0], "double"],
    "PhysicalDomainSizeY": [physical_size[1], "double"],
    "water_density": [1000, "double"],
    "manning_param": [manning_coefficient_value, "double"],
    "corriolis_param": [9.35e-5, "double"],
    "pressure": [100, "double"],
    "speed_pressure": [22.15, "double"],
    "period_pressure": [1800, "double"],
    "background_pressure": [101300, "double"],
}

Definition at line 130 of file meteotsunami-r1.py.

◆ degrees_of_freedom

meteotsunami-r1.degrees_of_freedom

Definition at line 126 of file meteotsunami-r1.py.

◆ dg_order

int meteotsunami-r1.dg_order = args.degrees_of_freedom - 1

Definition at line 149 of file meteotsunami-r1.py.

◆ dimensions

meteotsunami-r1.dimensions

Definition at line 261 of file meteotsunami-r1.py.

◆ end_time

meteotsunami-r1.end_time

Definition at line 125 of file meteotsunami-r1.py.

◆ first_plot_time_stamp

meteotsunami-r1.first_plot_time_stamp

Definition at line 266 of file meteotsunami-r1.py.

◆ flux

meteotsunami-r1.flux

Definition at line 164 of file meteotsunami-r1.py.

◆ fv_solver

meteotsunami-r1.fv_solver

Initial value:

=  exahype2.solvers.fv.godunov.GlobalAdaptiveTimeStep(
    name="FVSolver",
    patch_size=dg_order * 2 + 1,
    unknowns={"h": 1, "hu": 1, "hv": 1},
    auxiliary_variables={"z": 1},
    min_volume_h=min_h,
    max_volume_h=max_h,
    time_step_relaxation=0.9,
)

Definition at line 211 of file meteotsunami-r1.py.

◆ H

int meteotsunami-r1.H = 50

Definition at line 47 of file meteotsunami-r1.py.

◆ initial_conditions

meteotsunami-r1.initial_conditions

Initial value:

=  f"""
  static tarch::reader::NetCDFFieldParser fieldParser(
    "bathymetry/test_R1_dx100_H{H}_b.grd",
    PhysicalDomainSizeX,
    PhysicalDomainSizeY,
    PhysicalDomainOffsetX,
    PhysicalDomainOffsetY,
    "z",
    "x",
    "y"
  );
 
  // TODO: This sampling is needed to make the square domain works without NaNs. However, it gives unphysical solutions.
  // The setup should be a rectangular domain, but this breaks limiting. The limiter needs to be fixed first.
  const double sampleX =
    x(0) < PhysicalDomainOffsetX ? PhysicalDomainOffsetX :
    (x(0) > PhysicalDomainOffsetX + PhysicalDomainSizeX ? PhysicalDomainOffsetX + PhysicalDomainSizeX : x(0));
  const double sampleY =
    x(1) < PhysicalDomainOffsetY ? PhysicalDomainOffsetY :
    (x(1) > PhysicalDomainOffsetY + PhysicalDomainSizeY ? PhysicalDomainOffsetY + PhysicalDomainSizeY : x(1));
 
  const double bathymetry = fieldParser.sampleTopology(sampleX, sampleY);
    Q[Shortcuts::h]  = -std::min(bathymetry, 0.0);
    Q[Shortcuts::hu] = 0.0;
    Q[Shortcuts::hv] = 0.0;
    Q[Shortcuts::z]  = bathymetry;
"""

Definition at line 51 of file meteotsunami-r1.py.

◆ is_physically_admissible

str meteotsunami-r1.is_physically_admissible

Initial value:

=  """
  if (x(0) < PhysicalDomainOffsetX or x(0) > PhysicalDomainOffsetX + PhysicalDomainSizeX) {
    return false;
  }
  if (x(1) < PhysicalDomainOffsetY or x(1) > PhysicalDomainOffsetY + PhysicalDomainSizeY) {
    return false;
  }
 
  if (std::abs(x[0] - DomainOffset[0]) < h[0] or std::abs(x[0] - DomainOffset[0] - DomainSize[0]) < h[0]) {
    return false;
  }
  if (std::abs(x[1] - DomainOffset[1]) < h[1] or std::abs(x[1] - DomainOffset[1] - DomainSize[1]) < h[1]) {
    return false;
  }
 
  if (x(0) - PhysicalDomainOffsetX > 0.85 * PhysicalDomainSizeX) {
    return false;
  }
  if (x(0) - PhysicalDomainOffsetX < 0.15 * PhysicalDomainSizeX) {
    return false;
  }
 
  return true;
"""

Definition at line 97 of file meteotsunami-r1.py.

◆ L

int meteotsunami-r1.L = 300e3

Definition at line 8 of file meteotsunami-r1.py.

◆ limiter_solver

meteotsunami-r1.limiter_solver

Initial value:

=  exahype2.solvers.limiting.StaticLimiting(
    name="LimiterSolver",
    regular_solver=aderdg_solver,
    limiting_solver=fv_solver,
    physical_admissibility_criterion=is_physically_admissible,
)

Definition at line 236 of file meteotsunami-r1.py.

◆ make

meteotsunami-r1.make

Definition at line 280 of file meteotsunami-r1.py.

◆ make_clean_first

meteotsunami-r1.make_clean_first

Definition at line 280 of file meteotsunami-r1.py.

◆ manning_coefficient_value

float meteotsunami-r1.manning_coefficient_value = manning_coefficient(H)

Definition at line 48 of file meteotsunami-r1.py.

◆ max_eigenvalue

meteotsunami-r1.max_eigenvalue

Definition at line 166 of file meteotsunami-r1.py.

◆ max_end_time

meteotsunami-r1.max_end_time

Definition at line 265 of file meteotsunami-r1.py.

◆ max_h

float meteotsunami-r1.max_h = 1.1 * min(physical_size) / (3.0**args.min_depth)

Definition at line 147 of file meteotsunami-r1.py.

◆ min_depth

meteotsunami-r1.min_depth

Definition at line 124 of file meteotsunami-r1.py.

◆ min_end_time

meteotsunami-r1.min_end_time

Definition at line 264 of file meteotsunami-r1.py.

◆ min_h

float meteotsunami-r1.min_h = max_h * 3.0 ** (-args.amr_levels)

Definition at line 148 of file meteotsunami-r1.py.

◆ mode

meteotsunami-r1.mode

Definition at line 274 of file meteotsunami-r1.py.

◆ ncp

meteotsunami-r1.ncp

Definition at line 165 of file meteotsunami-r1.py.

◆ offset

meteotsunami-r1.offset

Initial value:

=  [
    physical_offset[0] - 0.5 * (square_side - physical_size[0]),
    physical_offset[1] - 0.5 * (square_side - physical_size[1]),
]

Definition at line 13 of file meteotsunami-r1.py.

◆ parser

meteotsunami-r1.parser = exahype2.ArgumentParser()

Definition at line 122 of file meteotsunami-r1.py.

◆ periodic_BC

meteotsunami-r1.periodic_BC

Definition at line 268 of file meteotsunami-r1.py.

◆ physical_offset

list meteotsunami-r1.physical_offset = [-39870.0, 0.0]

Definition at line 9 of file meteotsunami-r1.py.

◆ physical_size

list meteotsunami-r1.physical_size = [379700.0, L / 3]

Definition at line 10 of file meteotsunami-r1.py.

◆ project

meteotsunami-r1.project

Initial value:

=  exahype2.Project(
    namespace=["applications", "exahype2", "ShallowWater"],
    project_name="Meteotsunami",
    directory=".",
    executable="ExaHyPE",
)

Definition at line 243 of file meteotsunami-r1.py.

◆ riemann_solver

meteotsunami-r1.riemann_solver

Definition at line 167 of file meteotsunami-r1.py.

◆ size

meteotsunami-r1.size = [square_side, square_side]

Definition at line 17 of file meteotsunami-r1.py.

◆ source_term

meteotsunami-r1.source_term

Definition at line 200 of file meteotsunami-r1.py.

◆ square_side

meteotsunami-r1.square_side = max(physical_size)

Definition at line 11 of file meteotsunami-r1.py.

◆ throw_away_data_after_build

meteotsunami-r1.throw_away_data_after_build

Definition at line 280 of file meteotsunami-r1.py.

◆ time_in_between_plots

meteotsunami-r1.time_in_between_plots = 0.0

Definition at line 255 of file meteotsunami-r1.py.

◆ True

meteotsunami-r1.True

Definition at line 280 of file meteotsunami-r1.py.

Functions

Variables

Function Documentation

◆ manning_coefficient()

Parameters

Returns

Variable Documentation

◆ aderdg_solver

◆ args

◆ boundary_conditions

◆ const_type

◆ const_val

◆ constants

◆ degrees_of_freedom

◆ dg_order

◆ dimensions

◆ end_time

◆ first_plot_time_stamp

◆ flux

◆ fv_solver

◆ H

◆ initial_conditions

◆ is_physically_admissible

◆ L

◆ limiter_solver

◆ make

◆ make_clean_first

◆ manning_coefficient_value

◆ max_eigenvalue

◆ max_end_time

◆ max_h

◆ min_depth

◆ min_end_time

◆ min_h

◆ mode

◆ ncp

◆ offset

◆ parser

◆ periodic_BC

◆ physical_offset

◆ physical_size

◆ project

◆ riemann_solver

◆ size

◆ source_term

◆ square_side

◆ throw_away_data_after_build

◆ time_in_between_plots

◆ True