Peano
Loading...
Searching...
No Matches
swift2.particle.AlgorithmStep.AlgorithmStep.Effect Class Reference

What happens in this algorithmic step per particle: More...

Inheritance diagram for swift2.particle.AlgorithmStep.AlgorithmStep.Effect:
Collaboration diagram for swift2.particle.AlgorithmStep.AlgorithmStep.Effect:

Static Public Attributes

int ALTER_GLOBAL_STATE = 0
 
int ALTER_GLOBAL_STATE_AND_MIGHT_RERUN = 1
 
int ALTER_LOCAL_STATE = 2
 
int ALTER_LOCAL_STATE_AND_MIGHT_RERUN = 3
 
int CHANGE_POSITION_OR_INTERACTION_RADIUS = 4
 
int CHANGE_POSITION_OR_INTERACTION_RADIUS_AND_MIGHT_RERUN = 5
 

Detailed Description

What happens in this algorithmic step per particle:

  • ALTER_GLOBAL_STATE is the most generic baseline routine. No local data are changed, but the code (might) alter some global properties. Typical examples are the reduction of the global admissible time step size.
  • ALTER_LOCAL_STATE implies that only the local state of a particle is changed. The code might also modify the global state, but it may not change a particle's position or its search radius, i.e. the spatial topology between particles.
  • CHANGE_POSITION_OR_INTERACTION_RADIUS is the most general update which means that literally any global or local attribute might be modified. However, the graph compilers have to know whether you might ask it to rerun this step. This is important, as this step might change the topology.

Please note that any update of a particle position should happen within touch vertex last time. Otherwise, we'd destroy the particle topology.

By default, any algorithm step runs only once. However, there are variants of each step which can rerun. But the user has to flag this possibility explicitly.

Definition at line 37 of file AlgorithmStep.py.

Field Documentation

◆ ALTER_GLOBAL_STATE

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.ALTER_GLOBAL_STATE = 0
static

Definition at line 64 of file AlgorithmStep.py.

◆ ALTER_GLOBAL_STATE_AND_MIGHT_RERUN

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.ALTER_GLOBAL_STATE_AND_MIGHT_RERUN = 1
static

Definition at line 65 of file AlgorithmStep.py.

◆ ALTER_LOCAL_STATE

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.ALTER_LOCAL_STATE = 2
static

Definition at line 66 of file AlgorithmStep.py.

◆ ALTER_LOCAL_STATE_AND_MIGHT_RERUN

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.ALTER_LOCAL_STATE_AND_MIGHT_RERUN = 3
static

Definition at line 67 of file AlgorithmStep.py.

◆ CHANGE_POSITION_OR_INTERACTION_RADIUS

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.CHANGE_POSITION_OR_INTERACTION_RADIUS = 4
static

Definition at line 68 of file AlgorithmStep.py.

◆ CHANGE_POSITION_OR_INTERACTION_RADIUS_AND_MIGHT_RERUN

int swift2.particle.AlgorithmStep.AlgorithmStep.Effect.CHANGE_POSITION_OR_INTERACTION_RADIUS_AND_MIGHT_RERUN = 5
static

Definition at line 69 of file AlgorithmStep.py.


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