Functions
	generate_particles_in_plume (str file_path="InitTracers.dat", int num_x=8, int num_y=8, float x_min=0.46, float x_max=0.54, float y_min=0.11, float y_max=0.29, int round_decimals=6)
	Generates a .dat file with particles on a uniform grid inside a rectangular plume.

Variables
	parser

dict	interpolation_methods

	default

	help

dict	integration_schemes

	min_depth

	degrees_of_freedom

	end_time

	args = parser.parse_args()

list	size = [1.0, 1.0]

list	offset = [0.0, 0.0]

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

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

	project

float	time_in_between_plots = 0.0

	dimensions

	min_end_time

	max_end_time

	first_plot_time_stamp

	periodic_BC

str	initial_conditions

str	boundary_conditions

str	compute_primitive_variables

str	max_eigenvalue

str	flux

str	source_term

	fv_solver

dict	tracer_attributes

	tracer_particles

	file_path

	num_x

	num_y

	x_min

	x_max

	y_min

	y_max

	init_tracers

	descend_invocation_order

	tracing_action_set

	mode

	make

	True

	make_clean_first

	throw_away_data_after_build

Function Documentation

◆ generate_particles_in_plume()

fv-tracers-volcanic-plume-rise.generate_particles_in_plume	(	str	file_path = "InitTracers.dat",
		int	num_x = 8,
		int	num_y = 8,
		float	x_min = 0.46,
		float	x_max = 0.54,
		float	y_min = 0.11,
		float	y_max = 0.29,
		int	round_decimals = 6 )

Generates a .dat file with particles on a uniform grid inside a rectangular plume.

Parameters: file_path (str): Path to save the .dat file. num_x (int): Number of points along x (>=1). num_y (int): Number of points along y (>=1). x_min (float): Minimum x of the plume. x_max (float): Maximum x of the plume. y_min (float): Minimum y of the plume. y_max (float): Maximum y of the plume. round_decimals (int): Decimal places for rounding/printing.

Definition at line 15 of file fv-tracers-volcanic-plume-rise.py.

Variable Documentation

◆ args

fv-tracers-volcanic-plume-rise.args = parser.parse_args()

Definition at line 101 of file fv-tracers-volcanic-plume-rise.py.

◆ boundary_conditions

fv-tracers-volcanic-plume-rise.boundary_conditions

Initial value:

=  """
  if (x(1) >= DomainSize[1] - 0.001) {
    // Top boundary (outflow - zero gradient)
    Qoutside[0] = RHO_AMBIENT;
    Qoutside[1] = 0.0;
    Qoutside[2] = 0.0;
    Qoutside[3] = P0 / (GAMMA - 1.0);
  } else if (x(1) <= DomainOffset[1] + 0.001) {
    // Bottom boundary (reflective)
    Qoutside[0] = Qinside[0];
    Qoutside[1] = Qinside[1];
    Qoutside[2] = -Qinside[2];
    Qoutside[3] = Qinside[3];
  } else if (x(0) <= DomainOffset[0] + 0.001 || x(0) >= DomainSize[0] - 0.001) {
    // Left and right boundaries (outflow - zero gradient)
    Qoutside[0] = Qinside[0];
    Qoutside[1] = Qinside[1];
    Qoutside[2] = Qinside[2];
    Qoutside[3] = Qinside[3];
  }
"""

Definition at line 187 of file fv-tracers-volcanic-plume-rise.py.

◆ compute_primitive_variables

str fv-tracers-volcanic-plume-rise.compute_primitive_variables

Initial value:

=  r"""
  const auto irho = 1.0 / Q[Shortcuts::rho];
  const auto u0 = Q[Shortcuts::rhoU] * irho;
  const auto u1 = Q[Shortcuts::rhoV] * irho;
 
  const auto uSq = u0 * u0 + u1 * u1;
  const auto u_n = (normal == 0) ? u0 : u1;
 
  const auto internalE = Q[Shortcuts::rhoE] - 0.5 * Q[Shortcuts::rho] * uSq;
  const auto p = (GAMMA - 1.0) * internalE;
"""

Definition at line 209 of file fv-tracers-volcanic-plume-rise.py.

◆ default

fv-tracers-volcanic-plume-rise.default

Definition at line 78 of file fv-tracers-volcanic-plume-rise.py.

◆ degrees_of_freedom

fv-tracers-volcanic-plume-rise.degrees_of_freedom

Definition at line 97 of file fv-tracers-volcanic-plume-rise.py.

◆ descend_invocation_order

fv-tracers-volcanic-plume-rise.descend_invocation_order

Definition at line 305 of file fv-tracers-volcanic-plume-rise.py.

◆ dimensions

fv-tracers-volcanic-plume-rise.dimensions

Definition at line 122 of file fv-tracers-volcanic-plume-rise.py.

◆ end_time

fv-tracers-volcanic-plume-rise.end_time

Definition at line 98 of file fv-tracers-volcanic-plume-rise.py.

◆ file_path

fv-tracers-volcanic-plume-rise.file_path

Definition at line 291 of file fv-tracers-volcanic-plume-rise.py.

◆ first_plot_time_stamp

fv-tracers-volcanic-plume-rise.first_plot_time_stamp

Definition at line 127 of file fv-tracers-volcanic-plume-rise.py.

◆ flux

fv-tracers-volcanic-plume-rise.flux

Initial value:

=  r"""
  {compute_primitive_variables}
 
  F[Shortcuts::rho] = Q[Shortcuts::rhoU + normal];
 
  F[Shortcuts::rhoU] = Q[Shortcuts::rhoU] * u_n;
  F[Shortcuts::rhoV] = Q[Shortcuts::rhoV] * u_n;
 
  F[Shortcuts::rhoU + normal] += p;
 
  F[Shortcuts::rhoE] = (Q[Shortcuts::rhoE] + p) * u_n;
""".format(
    compute_primitive_variables=compute_primitive_variables
)

Definition at line 231 of file fv-tracers-volcanic-plume-rise.py.

◆ fv_solver

fv-tracers-volcanic-plume-rise.fv_solver

Initial value:

=  exahype2.solvers.fv.godunov.GlobalFixedTimeStep(
    name="FVSolver",
    patch_size=args.degrees_of_freedom,
    unknowns={"rho": 1, "rhoU": 1, "rhoV": 1, "rhoE": 1},
    auxiliary_variables=0,
    min_volume_h=min_h,
    max_volume_h=max_h,
    normalised_time_step_size=0.001,
)

Definition at line 253 of file fv-tracers-volcanic-plume-rise.py.

◆ help

fv-tracers-volcanic-plume-rise.help

Definition at line 79 of file fv-tracers-volcanic-plume-rise.py.

◆ init_tracers

fv-tracers-volcanic-plume-rise.init_tracers

Initial value:

=  exahype2.tracer.InsertParticlesFromFile(
    particle_set=tracer_particles,
    filename="InitTracers.dat",
    scale_factor=1.0,
)

Definition at line 299 of file fv-tracers-volcanic-plume-rise.py.

◆ initial_conditions

fv-tracers-volcanic-plume-rise.initial_conditions

Definition at line 135 of file fv-tracers-volcanic-plume-rise.py.

◆ integration_schemes

dict fv-tracers-volcanic-plume-rise.integration_schemes

Initial value:

=  {
    "Static": 0,  # No integration (static particles)
    "Euler": 1,  # Explicit Euler method (simple but less accurate)
    "SemiEuler": 2,  # Semi-implicit Euler method (better stability)
    "Verlet": 3,  # Velocity Verlet algorithm (good for orbital mechanics)
    "Midpoint": 4,  # Midpoint method (2nd order Runge-Kutta)
    "RK3": 5,  # 3rd order Runge-Kutta method (high accuracy)
    "RK4": 6,  # 4th order Runge-Kutta method (higher accuracy)
}

Definition at line 82 of file fv-tracers-volcanic-plume-rise.py.

◆ interpolation_methods

dict fv-tracers-volcanic-plume-rise.interpolation_methods

Initial value:

=  {
    "None": 0,  # No interpolation (use raw values)
    "Constant": 1,  # Piecewise constant interpolation (nearest neighbor)
    "Linear": 2,  # Piecewise linear interpolation (more accurate)
}

Definition at line 70 of file fv-tracers-volcanic-plume-rise.py.

◆ make

fv-tracers-volcanic-plume-rise.make

Definition at line 331 of file fv-tracers-volcanic-plume-rise.py.

◆ make_clean_first

fv-tracers-volcanic-plume-rise.make_clean_first

Definition at line 331 of file fv-tracers-volcanic-plume-rise.py.

◆ max_eigenvalue

fv-tracers-volcanic-plume-rise.max_eigenvalue

Initial value:

=  r"""
  {compute_primitive_variables}
  const auto speedOfSound = std::sqrt(GAMMA * p * irho);
  auto result = std::fmax(0.0, std::fabs(u_n - speedOfSound));
  result = std::fmax(result, std::fabs(u_n + speedOfSound));
  return result;
""".format(
    compute_primitive_variables=compute_primitive_variables
)

Definition at line 221 of file fv-tracers-volcanic-plume-rise.py.

◆ max_end_time

fv-tracers-volcanic-plume-rise.max_end_time

Definition at line 126 of file fv-tracers-volcanic-plume-rise.py.

◆ max_h

float fv-tracers-volcanic-plume-rise.max_h = 1.1 * min(size) / (3.0**args.min_depth)

Definition at line 105 of file fv-tracers-volcanic-plume-rise.py.

◆ min_depth

fv-tracers-volcanic-plume-rise.min_depth

Definition at line 96 of file fv-tracers-volcanic-plume-rise.py.

◆ min_end_time

fv-tracers-volcanic-plume-rise.min_end_time

Definition at line 125 of file fv-tracers-volcanic-plume-rise.py.

◆ min_h

float fv-tracers-volcanic-plume-rise.min_h = max_h * 3.0 ** (-args.amr_levels)

Definition at line 106 of file fv-tracers-volcanic-plume-rise.py.

◆ mode

fv-tracers-volcanic-plume-rise.mode

Definition at line 324 of file fv-tracers-volcanic-plume-rise.py.

◆ num_x

fv-tracers-volcanic-plume-rise.num_x

Definition at line 292 of file fv-tracers-volcanic-plume-rise.py.

◆ num_y

fv-tracers-volcanic-plume-rise.num_y

Definition at line 293 of file fv-tracers-volcanic-plume-rise.py.

◆ offset

fv-tracers-volcanic-plume-rise.offset = [0.0, 0.0]

Definition at line 104 of file fv-tracers-volcanic-plume-rise.py.

◆ parser

fv-tracers-volcanic-plume-rise.parser

Initial value:

=  exahype2.ArgumentParser(
    "ExaHyPE 2 - Finite Volumes Particle Tracing Testing Script"
)

Definition at line 66 of file fv-tracers-volcanic-plume-rise.py.

◆ periodic_BC

fv-tracers-volcanic-plume-rise.periodic_BC

Definition at line 129 of file fv-tracers-volcanic-plume-rise.py.

◆ project

fv-tracers-volcanic-plume-rise.project

Initial value:

=  exahype2.Project(
    namespace=["tests", "exahype2", "fv"],
    project_name=".",
    directory=".",
    executable="ExaHyPE",
)

Definition at line 108 of file fv-tracers-volcanic-plume-rise.py.

◆ size

fv-tracers-volcanic-plume-rise.size = [1.0, 1.0]

Definition at line 103 of file fv-tracers-volcanic-plume-rise.py.

◆ source_term

fv-tracers-volcanic-plume-rise.source_term

Initial value:

=  """
  S[0] = 0.0;
  S[1] = 0.0;
  S[2] = -GRAVITY * Q[0];
  S[3] = -GRAVITY * Q[2];
"""

Definition at line 246 of file fv-tracers-volcanic-plume-rise.py.

◆ throw_away_data_after_build

fv-tracers-volcanic-plume-rise.throw_away_data_after_build

Definition at line 331 of file fv-tracers-volcanic-plume-rise.py.

◆ time_in_between_plots

fv-tracers-volcanic-plume-rise.time_in_between_plots = 0.0

Definition at line 116 of file fv-tracers-volcanic-plume-rise.py.

◆ tracer_attributes

dict fv-tracers-volcanic-plume-rise.tracer_attributes

Initial value:

=  {
    "unknowns": {
        "rho": 1,
        "fluid_u": 1,
        "fluid_v": 1,
        "u": 1,
        "v": 1,
        "a_x": 1,
        "a_y": 1,
        "d": 1,
    }
}

Definition at line 273 of file fv-tracers-volcanic-plume-rise.py.

◆ tracer_particles

fv-tracers-volcanic-plume-rise.tracer_particles

Initial value:

=  fv_solver.add_tracer(
    name="Tracers", particle_attributes=tracer_attributes
)

Definition at line 286 of file fv-tracers-volcanic-plume-rise.py.

◆ tracing_action_set

fv-tracers-volcanic-plume-rise.tracing_action_set

Initial value:

=  exahype2.tracer.FiniteVolumesTracingWithForce(
    tracer_particles,
    fv_solver,
    project,
    integration_scheme=integration_schemes[args.integration],
    interpolation_scheme=interpolation_methods[args.interpolation],
)

Definition at line 308 of file fv-tracers-volcanic-plume-rise.py.

◆ True

fv-tracers-volcanic-plume-rise.True

Definition at line 331 of file fv-tracers-volcanic-plume-rise.py.

◆ x_max

fv-tracers-volcanic-plume-rise.x_max

Definition at line 295 of file fv-tracers-volcanic-plume-rise.py.

◆ x_min

fv-tracers-volcanic-plume-rise.x_min

Definition at line 294 of file fv-tracers-volcanic-plume-rise.py.

◆ y_max

fv-tracers-volcanic-plume-rise.y_max

Definition at line 297 of file fv-tracers-volcanic-plume-rise.py.

◆ y_min

fv-tracers-volcanic-plume-rise.y_min

Definition at line 296 of file fv-tracers-volcanic-plume-rise.py.

Functions

Variables

Function Documentation

◆ generate_particles_in_plume()

Variable Documentation

◆ args

◆ boundary_conditions

◆ compute_primitive_variables

◆ default

◆ degrees_of_freedom

◆ descend_invocation_order

◆ dimensions

◆ end_time

◆ file_path

◆ first_plot_time_stamp

◆ flux

◆ fv_solver

◆ help

◆ init_tracers

◆ initial_conditions

◆ integration_schemes

◆ interpolation_methods

◆ make

◆ make_clean_first

◆ max_eigenvalue

◆ max_end_time

◆ max_h

◆ min_depth

◆ min_end_time

◆ min_h

◆ mode

◆ num_x

◆ num_y

◆ offset

◆ parser

◆ periodic_BC

◆ project

◆ size

◆ source_term

◆ throw_away_data_after_build

◆ time_in_between_plots

◆ tracer_attributes

◆ tracer_particles

◆ tracing_action_set

◆ True

◆ x_max

◆ x_min

◆ y_max

◆ y_min