Peano
Loading...
Searching...
No Matches
peano4.solversteps.UserActionSet.UserActionSet Class Reference
Inheritance diagram for peano4.solversteps.UserActionSet.UserActionSet:
Collaboration diagram for peano4.solversteps.UserActionSet.UserActionSet:

Public Member Functions

 __init__ (self, name, descend_invocation_order=0, parallel=True)
 
 user_should_modify_template (self)
 Is the user allowed to modify the output.
 
 get_constructor_body (self)
 Define a tailored constructor body.
 
 get_destructor_body (self)
 
 get_body_of_getGridControlEvents (self)
 
 get_body_of_operation (self, operation_name)
 Return actual C++ code snippets to be inserted into C++ code.
 
 get_action_set_name (self)
 Returns a description (word) for the mapping which is also used as class name for the generated type.
 
 get_attributes (self)
 Return attributes as copied and pasted into the generated class.
 
 get_includes (self)
 Return include statements that you need.
 
- Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
 get_static_initialisations (self, full_qualified_classname)
 
 get_body_of_prepareTraversal (self)
 
 get_body_of_unprepareTraversal (self)
 

Data Fields

 name
 
- Data Fields inherited from peano4.solversteps.ActionSet.ActionSet
 descend_invocation_order
 
 parallel
 

Additional Inherited Members

- 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 UserActionSet.py.

Constructor & Destructor Documentation

◆ __init__()

peano4.solversteps.UserActionSet.UserActionSet.__init__ ( self,
name,
descend_invocation_order = 0,
parallel = True )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 7 of file UserActionSet.py.

References peano4.solversteps.UserActionSet.UserActionSet.__init__().

Referenced by peano4.solversteps.UserActionSet.UserActionSet.__init__().

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

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

peano4.solversteps.UserActionSet.UserActionSet.get_attributes ( self)

Return attributes as copied and pasted into the generated class.

Please note that action sets are not persistent, i.e. there is one object creation per grid sweep per tree.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 48 of file UserActionSet.py.

◆ get_body_of_getGridControlEvents()

peano4.solversteps.UserActionSet.UserActionSet.get_body_of_getGridControlEvents ( self)

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 25 of file UserActionSet.py.

◆ get_body_of_operation()

peano4.solversteps.UserActionSet.UserActionSet.get_body_of_operation ( self,
operation_name )

Return actual C++ code snippets to be inserted into C++ code.

See class' string constants starting with OPERATION_ for possible values of operation_name.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 29 of file UserActionSet.py.

◆ get_constructor_body()

peano4.solversteps.UserActionSet.UserActionSet.get_constructor_body ( self)

Define a tailored constructor body.

By default, the constructor of an action set is empty. If you you assign attributes to your action set, you however might want to initialise them here. We do not support initialisation lists, to all has to be done via setters unless you create attributes on the heap.

The constructor's signature will look similar to

   EnumerateAndInitSolution2petsc_actionsets_InitVertexDoFs0(int treeNumber);

where the treeNumber is -1 if this is the global instance of the action set owned by a rank, or a number greater or equal 0 if this action set is a clone of the glocal action set that's used by one tree traversal.

See also
get_attributes() to add attributes to your action set

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 17 of file UserActionSet.py.

◆ get_destructor_body()

peano4.solversteps.UserActionSet.UserActionSet.get_destructor_body ( self)

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 21 of file UserActionSet.py.

◆ get_includes()

peano4.solversteps.UserActionSet.UserActionSet.get_includes ( self)

Return include statements that you need.

All of these includes will eventually end up in the header of the generated C++ code.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 52 of file UserActionSet.py.

◆ user_should_modify_template()

peano4.solversteps.UserActionSet.UserActionSet.user_should_modify_template ( self)

Is the user allowed to modify the output.

Return whether you expect the user to modify the generated code. If this is the case, then the API places the generated output in the directory actions. Otherwise, it goes into the observer directory and will be overwritten in each and every Python run.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 13 of file UserActionSet.py.

Field Documentation

◆ name


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