Peano 4
Loading...
Searching...
No Matches
swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid Class Reference
Inheritance diagram for swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid:
Collaboration diagram for swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid:

Public Member Functions

 __init__ (self, particle_set, distance_between_particles_along_one_axis, initialisation_call, additional_includes="")
 Wrapper around toolbox tying it to Swift's global properties.
 
 get_action_set_name (self)
 Return unique action set name.
 
- Public Member Functions inherited from peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells
 get_body_of_operation (self, operation_name)
 Return actual C++ code snippets to be inserted into C++ code.
 
 get_body_of_getGridControlEvents (self)
 
 user_should_modify_template (self)
 Is the user allowed to modify the output.
 
 get_includes (self)
 Return include statements that you need.
 
 get_attributes (self)
 Return attributes as copied and pasted into the generated class.
 
 get_constructor_body (self)
 Define a tailored constructor body.
 
- Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
 get_static_initialisations (self, full_qualified_classname)
 
 get_destructor_body (self)
 
 get_body_of_prepareTraversal (self)
 
 get_body_of_unprepareTraversal (self)
 

Additional Inherited Members

- Data Fields inherited from peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells
 d
 
 additional_includes
 
- Data Fields inherited from peano4.solversteps.ActionSet.ActionSet
 descend_invocation_order
 
 parallel
 
- Static Public Attributes inherited from peano4.solversteps.ActionSet.ActionSet
str OPERATION_BEGIN_TRAVERSAL = "beginTraversal"
 
str OPERATION_END_TRAVERSAL = "endTraversal"
 
str OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"
 
str OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"
 
str OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"
 
str OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"
 
str OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"
 
str OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"
 
str OPERATION_CREATE_HANGING_FACE = "createHangingFace"
 
str OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"
 
str OPERATION_CREATE_CELL = "createCell"
 
str OPERATION_DESTROY_CELL = "destroyCell"
 
str OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"
 
str OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"
 
str OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"
 
str OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"
 
str OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"
 
str OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"
 

Detailed Description

Definition at line 6 of file InsertParticlesAlongCartesianGrid.py.

Constructor & Destructor Documentation

◆ __init__()

swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid.__init__ ( self,
particle_set,
distance_between_particles_along_one_axis,
initialisation_call,
additional_includes = "" )

Wrapper around toolbox tying it to Swift's global properties.

Very simplistic wrapper around generic factory mechanism from the toolbox. The script adds references to DomainOffset[2] and DomainSize[2] for example which are defined in Constants.h. This constants file is something that's specific to Swift and not to the particles toolbox.

We do not care at this point, if entries like DomainOffset[2] do exist, i.e. if we run a 3d simulation. These are just inserted into the generated C++ code which then in turn masks entries like DomainSize[2] out if we work with Dimensions==2.

Reimplemented from peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.

Definition at line 9 of file InsertParticlesAlongCartesianGrid.py.

References swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid.__init__().

Referenced by swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid.__init__().

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

Member Function Documentation

◆ get_action_set_name()

swift2.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid.get_action_set_name ( self)

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

Reimplemented from peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.

Definition at line 53 of file InsertParticlesAlongCartesianGrid.py.


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