Variables
string	define_radial_dam

string	initial_conditions

string	boundary_conditions

string	refinement_criterion

string	limiting_criterion

	parser = exahype2.ArgumentParser()

	min_depth

	end_time

	args = parser.parse_args()

dictionary	constants

list	size = [10.0, 10.0]

tuple	max_h = (1.1 * min(size) / (3.0**args.min_depth))

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

	aderdg_solver

	flux

	ncp

	max_eigenvalue

	is_linear

	False

	polynomials

	fv_solver

	riemann_solver

	limiting_solver

	project

float	time_in_between_plots = 0.0

	dimensions

	offset

	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

Variable Documentation

◆ aderdg_solver

radial-dam-break.aderdg_solver

Initial value:

 =  exahype2.solvers.aderdg.GlobalAdaptiveTimeStep(
     name="ADERDGSolver",
     order=args.degrees_of_freedom,
     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=args.time_step_relaxation,
 )

Definition at line 78 of file radial-dam-break.py.

◆ args

radial-dam-break.args = parser.parse_args()

Definition at line 67 of file radial-dam-break.py.

◆ boundary_conditions

radial-dam-break.boundary_conditions

Initial value:

 =  """
   Qoutside[Shortcuts::h]  = Qinside[Shortcuts::h];
   Qoutside[Shortcuts::hu] = -Qinside[Shortcuts::hu];
   Qoutside[Shortcuts::hv] = -Qinside[Shortcuts::hv];
   Qoutside[Shortcuts::z]  = Qinside[Shortcuts::z];
 """

Definition at line 47 of file radial-dam-break.py.

◆ const_type

radial-dam-break.const_type

Definition at line 161 of file radial-dam-break.py.

◆ const_val

radial-dam-break.const_val

Definition at line 161 of file radial-dam-break.py.

◆ constants

dictionary radial-dam-break.constants

Initial value:

 =  {
     "g": [9.81, "double"],
     "hThreshold": [1e-5, "double"],
 }

Definition at line 69 of file radial-dam-break.py.

◆ define_radial_dam

string radial-dam-break.define_radial_dam

Initial value:

 =  """
   constexpr double DAM_RADIUS = 1.0;
  
   const double domainSizeHalfX = DomainSize[0] / 2.0;
   const double domainSizeHalfY = DomainSize[1] / 2.0;
  
   const double distanceFromOrigin = std::sqrt(
     (x[0] - domainSizeHalfX) * (x[0] - domainSizeHalfX) +
     (x[1] - domainSizeHalfY) * (x[1] - domainSizeHalfY)
   );
  
   const bool isInsideDam = distanceFromOrigin <= DAM_RADIUS;
   const bool isOutsideDam = distanceFromOrigin > DAM_RADIUS;
   const bool isDryRing = distanceFromOrigin >= 2 * DAM_RADIUS and distanceFromOrigin <= 3 * DAM_RADIUS;
 """

Definition at line 13 of file radial-dam-break.py.

◆ dimensions

radial-dam-break.dimensions

Definition at line 144 of file radial-dam-break.py.

◆ end_time

radial-dam-break.end_time

Definition at line 65 of file radial-dam-break.py.

◆ False

radial-dam-break.False

Definition at line 100 of file radial-dam-break.py.

◆ first_plot_time_stamp

radial-dam-break.first_plot_time_stamp

Definition at line 149 of file radial-dam-break.py.

◆ flux

radial-dam-break.flux

Definition at line 92 of file radial-dam-break.py.

◆ fv_solver

radial-dam-break.fv_solver

Initial value:

 =  exahype2.solvers.fv.godunov.GlobalAdaptiveTimeStep(
     name="FVSolver",
     patch_size=args.degrees_of_freedom * 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=args.time_step_relaxation,
 )

Definition at line 102 of file radial-dam-break.py.

◆ initial_conditions

radial-dam-break.initial_conditions

Initial value:

 =  define_radial_dam + """
   constexpr double INITIAL_WATER_HEIGHT_INSIDE_DAM = 1.1;
   constexpr double INITIAL_WATER_HEIGHT_OUTSIDE_DAM = 1.0;
   constexpr double BATHYMETRY_DRY_RING = 1.2;
  
   for (int i = 0; i < NumberOfUnknowns + NumberOfAuxiliaryVariables; i++) {
     Q[i] = 0.0;
   }
  
   Q[Shortcuts::h] = isInsideDam ? INITIAL_WATER_HEIGHT_INSIDE_DAM : INITIAL_WATER_HEIGHT_OUTSIDE_DAM;
  
   if (isDryRing) {
     Q[Shortcuts::h] = 0.0; // Dry ring
   }
  
   Q[Shortcuts::z] = isDryRing ? BATHYMETRY_DRY_RING : 0.0;
 """

Definition at line 29 of file radial-dam-break.py.

◆ is_linear

radial-dam-break.is_linear

Definition at line 100 of file radial-dam-break.py.

◆ limiting_criterion

string radial-dam-break.limiting_criterion

Initial value:

 =  define_radial_dam + """
   return distanceFromOrigin < DAM_RADIUS * 2; // Everything outside the dam (includes the dry ring) shall be limited
 """

Definition at line 58 of file radial-dam-break.py.

◆ limiting_solver

radial-dam-break.limiting_solver

Initial value:

 =  exahype2.solvers.limiting.StaticLimiting(
     name="LimitingSolver",
     regular_solver=aderdg_solver,
     limiting_solver=fv_solver,
     limiting_criterion_implementation=limiting_criterion
 )

Definition at line 120 of file radial-dam-break.py.

◆ make

radial-dam-break.make

Definition at line 166 of file radial-dam-break.py.

◆ make_clean_first

radial-dam-break.make_clean_first

Definition at line 166 of file radial-dam-break.py.

◆ max_eigenvalue

radial-dam-break.max_eigenvalue

Definition at line 94 of file radial-dam-break.py.

◆ max_end_time

radial-dam-break.max_end_time

Definition at line 148 of file radial-dam-break.py.

◆ max_h

tuple radial-dam-break.max_h = (1.1 * min(size) / (3.0**args.min_depth))

Definition at line 75 of file radial-dam-break.py.

◆ min_depth

radial-dam-break.min_depth

Definition at line 64 of file radial-dam-break.py.

◆ min_end_time

radial-dam-break.min_end_time

Definition at line 147 of file radial-dam-break.py.

◆ min_h

tuple radial-dam-break.min_h = max_h * 3.0 ** (-args.amr_levels)

Definition at line 76 of file radial-dam-break.py.

◆ mode

radial-dam-break.mode

Definition at line 158 of file radial-dam-break.py.

◆ ncp

radial-dam-break.ncp

Definition at line 93 of file radial-dam-break.py.

◆ offset

radial-dam-break.offset

Definition at line 146 of file radial-dam-break.py.

◆ parser

radial-dam-break.parser = exahype2.ArgumentParser()

Definition at line 62 of file radial-dam-break.py.

◆ periodic_BC

radial-dam-break.periodic_BC

Definition at line 151 of file radial-dam-break.py.

◆ polynomials

radial-dam-break.polynomials

Definition at line 100 of file radial-dam-break.py.

◆ project

radial-dam-break.project

Initial value:

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

Definition at line 127 of file radial-dam-break.py.

◆ refinement_criterion

radial-dam-break.refinement_criterion

Initial value:

 =  define_radial_dam + """
   return isInsideDam ? ::exahype2::RefinementCommand::Refine : ::exahype2::RefinementCommand::Keep;
 """

Definition at line 54 of file radial-dam-break.py.

◆ riemann_solver

radial-dam-break.riemann_solver

Definition at line 115 of file radial-dam-break.py.

◆ size

radial-dam-break.size = [10.0, 10.0]

Definition at line 74 of file radial-dam-break.py.

◆ throw_away_data_after_build

radial-dam-break.throw_away_data_after_build

Definition at line 166 of file radial-dam-break.py.

◆ time_in_between_plots

radial-dam-break.time_in_between_plots = 0.0

Definition at line 138 of file radial-dam-break.py.

◆ True

radial-dam-break.True

Definition at line 166 of file radial-dam-break.py.