Peano 4
Loading...
Searching...
No Matches
swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius Class Reference

Simple particle with fixed search radius subject to explicit Euler. More...

Inheritance diagram for swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius:
Collaboration diagram for swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius:

Public Member Functions

 __init__ (self, name, cfl_factor, initial_time_step_size, enter_cell_kernel="", touch_particles_of_set_first_time_kernel="", touch_particles_of_set_last_time_kernel="", particles_per_cell=0, min_h=0.005, max_h=0.3)
 Initialise the particle.
 
 touch_particles_of_set_first_time_kernel (self)
 
 touch_particles_of_set_first_time_kernel (self, value)
 
 touch_particles_of_set_last_time_kernel (self)
 
 touch_particles_of_set_last_time_kernel (self, value)
 
 cell_kernel (self)
 
 cell_kernel (self, value)
 
 add_to_reduction (self, value)
 
 algorithm_steps (self)
 The explicit Euler basically consists of two steps per particle.
 
 initialisation_steps (self)
 No particular initialisation required, but we reduce once, so we get the initial stats right before we jump into the time stepping.
 
 readme_descriptor (self)
 Create default readme descriptor.
 
- Public Member Functions inherited from peano4.datamodel.DaStGen2.DaStGen2
 configure (self, namespace, association)
 I always need the MPI aspect, but I can't add the right one before I don't know whether this DaStGen model is used for vertices, faces or cells.
 
 additional_load_and_store_arguments (self)
 
 additional_load_and_store_arguments (self, new_arguments)
 
- Public Member Functions inherited from peano4.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.
 

Data Fields

 velocity
 
 accelerator
 
 cfl_factor
 
 initial_time_step_size
 
 enter_cell_kernel
 
 touch_particles_of_set_first_time_kernel
 
 touch_particles_of_set_last_time_kernel
 
- Data Fields inherited from swift2.particle.Particle.Particle
 particles_per_cell
 
 min_h
 
 max_h
 
 name
 
- Data Fields inherited from peano4.toolbox.particles.Particle.Particle
 name
 
- Data Fields inherited from peano4.datamodel.DaStGen2.DaStGen2
 generator
 
 data
 
 peano4_mpi_and_storage_aspect
 
- Data Fields inherited from peano4.datamodel.DoF.DoF
 association
 
 name
 
 namespace
 

Protected Attributes

 _algorithm_steps
 
- Protected Attributes inherited from swift2.particle.Particle.Particle
 _algorithm_steps
 
 _initialisation_steps
 
- Protected Attributes inherited from peano4.datamodel.DaStGen2.DaStGen2
 _additional_load_and_store_arguments
 
- Protected Attributes inherited from peano4.datamodel.DoF.DoF
 _additional_load_and_store_arguments
 

Private Member Functions

 __setup_algorithm_steps (self)
 Create a repository of algorithmic steps which are then ordered into the actual time stepping sequence.
 

Additional Inherited Members

- Static Public Attributes inherited from swift2.particle.Particle.Particle
str DependencyChecks_Attribute_Prefix = "dependencyChecks"
 
list DependencyChecks_Ifdefs = ["PeanoDebug > 0"]
 
- Static Public Attributes inherited from peano4.datamodel.DaStGen2.DaStGen2
str readme_package_descriptor
 
- Protected Member Functions inherited from swift2.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.
 

Detailed Description

Simple particle with fixed search radius subject to explicit Euler.

Simple particle with a fixed search radius H which moves according to an explicit Euler. By default, the Euler 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. The term fixed means that the search radius does not change throughout the time step. Nothing stops you however to adopt the search radius in-between any two time steps. However, only change the radius in a step which is marked with the AlgorithmStep.Effect.CHANGE_POSITION_OR_INTERACTION_RADIUS.

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.dastgen2.Peano4DoubleArray("myFancyArray","Dimensions") )

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

Force calculation

There is a dedicated algorithmic step to do all the force calculation. This step can be tailored to your needs by setting the strings

  • enter_cell_kernel
  • touch_particles_of_set_first_time_kernel
  • touch_particles_of_set_last_time_kernel

Each of these is unset (None) by default, but you can make it hold any reasonable C++ string. The Swift2ish way to use them is ot use the iterators from ParticleSetIterators.h to run over the relevant particles.

For the two vertex kernels, this would look similar to

touch_vertex_first_time_kernel = "::swift2::kernels::forAllParticles( marker, assignedParticles, myFunctor );"

For the cell, it resembles

::swift2::kernels::forAllParticlePairs( marker, localParticles, activeParticles, myFunction);

The documentation of the actual operators ParticleBinaryOperator and ParticleUnaryOperatorOnVertex for more documentation.

Attributes

name: String To be in line with other conventions, I recommend you start with an uppercase letter. This has to be a valid C++ identifier, i.e. don't use any special symbols besides an underscore.

Attributes

name: String To be in line with other conventions, I recommend you start with an uppercase letter. This has to be a valid C++ identifier, i.e. don't use any special symbols besides an underscore.

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

Definition at line 11 of file ExplicitEulerFixedSearchRadius.py.

Constructor & Destructor Documentation

◆ __init__()

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__init__ ( self,
name,
particles_per_cell,
min_h,
max_h = "",
touch_particles_of_set_first_time_kernel = "",
touch_particles_of_set_last_time_kernel = "",
particles_per_cell = 0,
min_h = 0.005,
max_h = 0.3 )

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
swift2.actionsets.UpdateParticleMarker

Reimplemented from swift2.particle.Particle.Particle.

Definition at line 95 of file ExplicitEulerFixedSearchRadius.py.

References swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__init__().

Referenced by swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__init__().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ __setup_algorithm_steps()

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__setup_algorithm_steps ( self)
private

Create a repository of algorithmic steps which are then ordered into the actual time stepping sequence.

Definition at line 160 of file ExplicitEulerFixedSearchRadius.py.

References swift2.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.cfl_factor, swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.cfl_factor, swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.cfl_factor, swift2.particle.tests.DisappearingParticleTest.DisappearingParticleTest.cfl_factor, swift2.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.initial_time_step_size, swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.initial_time_step_size, swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.initial_time_step_size, swift2.particle.tests.DisappearingParticleTest.DisappearingParticleTest.initial_time_step_size, dastgen2.attributes.Attribute.Attribute.name(), exahype2.solvers.aderdg.kernelgenerator.utils.matmulConfig.MatmulConfig.name, exahype2.solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells.name(), exahype2.solvers.fv.FV.FV.name(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.name(), peano4.datamodel.DoF.DoF.name, peano4.solversteps.Step.Step.name, peano4.solversteps.UserActionSet.UserActionSet.name, peano4.toolbox.particles.Particle.Particle.name, swift2.particle.AlgorithmStep.AlgorithmStep.name, swift2.particle.Particle.Particle.name, swift2.particle.tests.DisappearingParticleTest.DisappearingParticleTest.name, swift2.particle.tests.testLeapfrogFixedTimeStepSize.testLeapfrogFixedTimeStepSize.name, and convert::data::Variable.name.

Here is the call graph for this function:

◆ add_to_reduction()

◆ algorithm_steps()

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.algorithm_steps ( self)

The explicit Euler basically consists of two steps per particle.

We first determine the force. For this, we need access to the neighbours. The step solely alters the individual particle's state. In the next algorithm step, we need this state, as well as global data (the admissible time step size) to update position and velocity. We also determine the CFL condition here. So we

Reimplemented from swift2.particle.Particle.Particle.

Definition at line 230 of file ExplicitEulerFixedSearchRadius.py.

References swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius._algorithm_steps, swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius._algorithm_steps, swift2.particle.Particle.Particle._algorithm_steps, swift2.particle.SPHLeapfrogFixedSearchRadius.SPHLeapfrogFixedSearchRadius._algorithm_steps, and swift2.particle.tests.testDensityCalculation.testDensityCalculation._algorithm_steps.

Referenced by swift2.particle.Particle.Particle._add_dependency_checks().

Here is the caller graph for this function:

◆ cell_kernel() [1/2]

◆ cell_kernel() [2/2]

◆ initialisation_steps()

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.initialisation_steps ( self)

◆ readme_descriptor()

◆ touch_particles_of_set_first_time_kernel() [1/2]

◆ touch_particles_of_set_first_time_kernel() [2/2]

◆ touch_particles_of_set_last_time_kernel() [1/2]

◆ touch_particles_of_set_last_time_kernel() [2/2]

Field Documentation

◆ _algorithm_steps

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius._algorithm_steps
protected

Definition at line 172 of file ExplicitEulerFixedSearchRadius.py.

Referenced by swift2.particle.SPHLeapfrogFixedSearchRadius.SPHLeapfrogFixedSearchRadius._setup_algorithm_steps(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.add_to_reduction(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.add_to_reduction(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.algorithm_steps(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.algorithm_steps(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.cell_kernel(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.cell_kernel(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.cell_kernel(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.cell_kernel(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.initialisation_steps(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.initialisation_steps(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.touch_particles_of_set_first_time_kernel(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.touch_particles_of_set_first_time_kernel(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.touch_particles_of_set_first_time_kernel(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.touch_particles_of_set_first_time_kernel(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.touch_particles_of_set_last_time_kernel(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.touch_particles_of_set_last_time_kernel(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.touch_particles_of_set_last_time_kernel(), and swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.touch_particles_of_set_last_time_kernel().

◆ accelerator

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.accelerator

Definition at line 115 of file ExplicitEulerFixedSearchRadius.py.

◆ cfl_factor

◆ enter_cell_kernel

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.enter_cell_kernel

Definition at line 124 of file ExplicitEulerFixedSearchRadius.py.

◆ initial_time_step_size

◆ touch_particles_of_set_first_time_kernel

◆ touch_particles_of_set_last_time_kernel

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.touch_particles_of_set_last_time_kernel

◆ velocity

swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.velocity

Definition at line 114 of file ExplicitEulerFixedSearchRadius.py.


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