Simple particle with a fixed interaction radius h which moves according to leapfrog KDK scheme. More...

Inheritance diagram for exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest:

[legend]

Collaboration diagram for exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest:

[legend]

Public Member Functions
	__init__ (self, name, cfl_factor, initial_time_step_size, particle_particle_interaction_over_particle_sets_kernel="", touch_particles_of_set_first_time_kernel="", touch_particles_of_set_last_time_kernel="")
	Initialise the particle.

	algorithm_steps (self)
	Leapfrog consists basically of four steps per particle.

	initialisation_steps (self)
	No particular initialisation required.

Public Member Functions inherited from exaparty.api.particle.Particle.Particle
	readme_descriptor (self)
	Create default readme descriptor.

Public Member Functions inherited from peano4.api.datamodel.DaStGen2.DaStGen2
	configure (self, namespace, association, subdirectory="")
	Configure output.

	additional_load_and_store_arguments (self)

	additional_load_and_store_arguments (self, new_arguments)

	hosts_smart_pointer_attribute (self)
	Does class host a smart pointer attribute.

Public Member Functions inherited from peano4.api.datamodel.DoF.DoF
	get_full_qualified_type (self)

	get_logical_type_name (self)
	What should the data type be called within the data repository, or within action sets.

	get_enumeration_type (self)
	What should the data type be called within the data repository.

	additional_load_and_store_arguments_for_other_dof (self, argument_name, use_dof_association=None)
	You can make Peano's store and load arguments of any DoF depend on other DoFs that you have loaded before.

	subnamespace (self)

Data Fields
	cfl_factor

	initial_time_step_size

	velocity

	accelerator

	v_full

	u_full

	u

	density

	pressure

	soundSpeed

	v_sig_AV

	particle_particle_interaction_over_particle_sets_kernel

	touch_particles_of_set_first_time_kernel

	touch_particles_of_set_last_time_kernel

	name

Data Fields inherited from exaparty.api.particle.Particle.Particle
	particles_per_cell

	min_h

	max_h

	name

Data Fields inherited from peano4.api.toolbox.particles.Particle.Particle
	name

	partid

Data Fields inherited from peano4.api.datamodel.DaStGen2.DaStGen2
	generator

	data

	peano4_mpi_and_storage_aspect

Data Fields inherited from peano4.api.datamodel.DoF.DoF
	association

	name

	namespace

	grid_selector

	subdirectory

Additional Inherited Members
Static Public Attributes inherited from exaparty.api.particle.Particle.Particle
str	DependencyChecks_Attribute_Prefix = "dependencyChecks"

list	DependencyChecks_Ifdefs = ["PeanoDebug > 0"]

Static Public Attributes inherited from peano4.api.datamodel.DaStGen2.DaStGen2
str	readme_package_descriptor

Protected Member Functions inherited from exaparty.api.particle.Particle.Particle
	_dependency_checks_modify_steps (self, steplist, step_type_name, peano4_event_enum)
	Add dependency checks as well as mesh consistency checks to the algorithm steps.

	_add_dependency_checks (self)
	Add dependency (particle consistency) checks.

Protected Attributes inherited from exaparty.api.particle.Particle.Particle
	_algorithm_steps

	_initialisation_steps

Protected Attributes inherited from peano4.api.datamodel.DaStGen2.DaStGen2
	_additional_load_and_store_arguments

Protected Attributes inherited from peano4.api.datamodel.DoF.DoF
	_additional_load_and_store_arguments

Detailed Description

Simple particle with a fixed interaction radius h which moves according to leapfrog KDK scheme.

By default, it uses global time stepping, i.e. the combination of maximum velocity and minimal mesh size determines the time step size of the subsequent time step. Besides the default variables x and h, the particle has the following properties:

a vector a which is the acceleration;
a vector v which is the velocity.

You can add further properties via

   myparticle.data.add_attribute( peano4.api.dastgen2.Peano4DoubleArray("myFancyArray","Dimensions") )

in your code. Or you can create a subclass which adds additional fields after it has called the baseline constructor.

You will need to add further properties for any SPH project.

Force calculation

particle_particle_interaction_over_particle_sets_kernel is a C++ string which defines a force between two particles. It has access to three important objects:

localParticles is a container (list) over pointers to local particles
activeParticles is a container (list) over pointers to active particles
marker is a cell marker which identifies the current cell.

Please consult the guidebook for a definition of local and active particles but take into account that the local particles always are a subset of the active particles.

Besides the actual particle-to-particle calculation, i.e. a force calculation, users can also provide kernels that kick in when you touch particles for the first time before you actually compute any particle-particle interaction, and there is a plug-in point what you do just once the particle-particle interaction has terminated. The latter point is reached before we do the actual time stepping. In both plug-in points, you have a vertex marker which gives you the position of the vertex to which a particular is associated, and you have the localParticles. This is a vector of pointers in this particular case.

See also: peano4::datamanagement::CellMarker; peano4::datamanagement::VertexMarker

Definition at line 11 of file DisappearingParticleTest.py.

Constructor & Destructor Documentation

◆ init()

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.__init__	(	self,
		name,
		particles_per_cell,
		min_h,
		max_h = `""`,
		touch_particles_of_set_first_time_kernel = `""`,
		touch_particles_of_set_last_time_kernel = `""`
	)

Initialise the particle.

This is the baseclass for a particle, i.e. we only add the absolute minimum of information to a particle. As we inherit from the toolbox particle, we already have some attributes defined. These are the guys which are not explicitly visible from the code snippet below, i.e. they are introduced by the superclass constructor.

Here's an overview of pre-defined attributes that each and every particle hosts:

A position which is a double vector with Dimension entries.
A search radius which describes the range with which other particles a particle might theoretically interact. The effective interaction might be smaller if a code decides to ignore potential interaction partners, i.e. this is an absolute maximum. The search radius will decide on which resolution level within the tree a particle is held.
A MoveState flag. This flag is essential. We use it later to label those particles that have been moved to avoid that we move particles multiple times.
A flag that indicates if a particle has been updated within a cell. Consult our code release papers: In short, a particle does not uniquely belong to one cell but can belong to many cells. We nevertheless want to update them only once.

See also: exaparty.api.actionsets.UpdateParticleMarker

Reimplemented from exaparty.api.particle.Particle.Particle.

Definition at line 61 of file DisappearingParticleTest.py.

References exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.__init__().

Referenced by exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ algorithm_steps()

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.algorithm_steps ( self )

Leapfrog consists basically of four steps per particle.

We first determine the force. Then we update the velocity by half a timestep and move the particle by a full timestep. Then the force is re-computed and the second half of the velocity update is done. Some variations of this KDK form re-arrange the steps executed per timestep to avoid a second force loop.

Reimplemented from exaparty.api.particle.Particle.Particle.

Definition at line 111 of file DisappearingParticleTest.py.

Referenced by exaparty.api.particle.Particle.Particle._add_dependency_checks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialisation_steps()

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.initialisation_steps ( self )

No particular initialisation required.

Reimplemented from exaparty.api.particle.Particle.Particle.

Definition at line 247 of file DisappearingParticleTest.py.

Field Documentation

◆ accelerator

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.accelerator

Definition at line 77 of file DisappearingParticleTest.py.

◆ cfl_factor

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.cfl_factor

Definition at line 72 of file DisappearingParticleTest.py.

Referenced by exaparty.api.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__setup_algorithm_steps(), exaparty.api.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius._setup_algorithm_steps_dict(), exaparty.api.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps(), exaparty.api.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.readme_descriptor(), and exaparty.api.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.readme_descriptor().

◆ density

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.density

Definition at line 87 of file DisappearingParticleTest.py.

◆ initial_time_step_size

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.initial_time_step_size

Definition at line 73 of file DisappearingParticleTest.py.

Referenced by exaparty.api.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__setup_algorithm_steps(), exaparty.api.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius._setup_algorithm_steps_dict(), exaparty.api.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps(), exaparty.api.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.readme_descriptor(), and exaparty.api.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.readme_descriptor().

◆ name

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.name

Definition at line 136 of file DisappearingParticleTest.py.

Referenced by solvers.aderdg.kernels.Gemms.Gemms.__repr__(), test_derive_load_store_compute_flag._FakeSubmodel.__repr__(), test_propagate_use_statements._FakeSubmodel.__repr__(), exaparty.api.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__setup_algorithm_steps(), exaparty.api.particle.AlgorithmStep.AlgorithmStep.__str__(), exahype2.api.Solver.Solver.Plotter._add_time_interval_bookkeeping_to_solver(), exaparty.api.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius._setup_algorithm_steps_dict(), exagrype.api.CCZ4Solver.CCZ4Solver._tasks_of_this_solver(), peano4.api.datamodel.DoF.DoF.additional_load_and_store_arguments_for_other_dof(), exaparty.api.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps(), exaparty.api.particle.tests.DastgenTestDummyParticle.DastgenTestDummyParticle.algorithm_steps(), exahype2.api.Solver.Solver.Plotter.create_finish_call(), exahype2.api.Solver.Solver.Plotter.create_is_active_predicate(), peano4.api.solversteps.UserActionSet.UserActionSet.get_action_set_name(), peano4.api.taskgraph.compiler.fuse-steps-illustrations._IllustrationActionSet.get_action_set_name(), test_fuse_steps._FakeActionSet.get_action_set_name(), peano4.api.datamodel.DoF.DoF.get_full_qualified_type(), peano4.api.datamodel.DoF.DoF.get_logical_type_name(), peano4.api.solversteps.Step.Step.get_observer_class_name(), dastgen2.attributes.Enumeration.Enumeration.get_to_string(), and exaparty.api.particle.Particle.Particle.readme_descriptor().

◆ particle_particle_interaction_over_particle_sets_kernel

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.particle_particle_interaction_over_particle_sets_kernel

Definition at line 99 of file DisappearingParticleTest.py.

◆ pressure

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.pressure

Definition at line 88 of file DisappearingParticleTest.py.

◆ soundSpeed

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.soundSpeed

Definition at line 89 of file DisappearingParticleTest.py.

◆ touch_particles_of_set_first_time_kernel

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.touch_particles_of_set_first_time_kernel

Definition at line 102 of file DisappearingParticleTest.py.

Referenced by exaparty.api.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps(), exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.algorithm_steps(), and exaparty.api.particle.tests.testLeapfrogFixedTimeStepSize.testLeapfrogFixedTimeStepSize.algorithm_steps().

◆ touch_particles_of_set_last_time_kernel

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.touch_particles_of_set_last_time_kernel

Definition at line 105 of file DisappearingParticleTest.py.

Referenced by exaparty.api.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps().

◆ u

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.u

Definition at line 86 of file DisappearingParticleTest.py.

◆ u_full

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.u_full

Definition at line 85 of file DisappearingParticleTest.py.

◆ v_full

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.v_full

Definition at line 84 of file DisappearingParticleTest.py.

◆ v_sig_AV

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.v_sig_AV

Definition at line 90 of file DisappearingParticleTest.py.

◆ velocity

exaparty.api.particle.tests.DisappearingParticleTest.DisappearingParticleTest.velocity

Definition at line 76 of file DisappearingParticleTest.py.

Referenced by exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection.get_body_of_operation().

The documentation for this class was generated from the following file:

src/exaparty/api/particle/tests/DisappearingParticleTest.py

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Force calculation

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ algorithm_steps()

◆ initialisation_steps()

Field Documentation

◆ accelerator

◆ cfl_factor

◆ density

◆ initial_time_step_size

◆ name

◆ particle_particle_interaction_over_particle_sets_kernel

◆ pressure

◆ soundSpeed

◆ touch_particles_of_set_first_time_kernel

◆ touch_particles_of_set_last_time_kernel

◆ u

◆ u_full

◆ v_full

◆ v_sig_AV

◆ velocity

◆ init()