![]() |
Peano
|
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. | |
![]() | |
get_static_initialisations (self, full_qualified_classname) | |
get_body_of_prepareTraversal (self) | |
get_body_of_unprepareTraversal (self) | |
Data Fields | |
name | |
![]() | |
descend_invocation_order | |
parallel | |
Definition at line 6 of file UserActionSet.py.
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__().
peano4.solversteps.UserActionSet.UserActionSet.get_action_set_name | ( | self | ) |
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.
Reimplemented from peano4.solversteps.ActionSet.ActionSet.
Definition at line 39 of file UserActionSet.py.
References dastgen2.attributes.Attribute.Attribute.name(), exahype2.solvers.aderdg.kernels.Gemms.Gemms.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, convert::data::Variable.name, solvers.api.Solver.Solver.name(), and api.solvers.Solver.Solver.name().
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.
peano4.solversteps.UserActionSet.UserActionSet.get_body_of_getGridControlEvents | ( | self | ) |
Reimplemented from peano4.solversteps.ActionSet.ActionSet.
Definition at line 25 of file UserActionSet.py.
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.
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.
Reimplemented from peano4.solversteps.ActionSet.ActionSet.
Definition at line 17 of file UserActionSet.py.
peano4.solversteps.UserActionSet.UserActionSet.get_destructor_body | ( | self | ) |
Reimplemented from peano4.solversteps.ActionSet.ActionSet.
Definition at line 21 of file UserActionSet.py.
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.
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.
peano4.solversteps.UserActionSet.UserActionSet.name |
Definition at line 9 of file UserActionSet.py.
Referenced by exahype2.solvers.aderdg.kernels.Gemms.Gemms.__repr__(), swift2.particle.ExplicitEulerFixedSearchRadius.ExplicitEulerFixedSearchRadius.__setup_algorithm_steps(), swift2.particle.LeapfrogFixedSearchRadius.LeapfrogFixedSearchRadius.__setup_algorithm_steps(), swift2.particle.AlgorithmStep.AlgorithmStep.__str__(), peano4.datamodel.DoF.DoF.additional_load_and_store_arguments_for_other_dof(), swift2.particle.ExplicitEulerDynamicSearchRadius.ExplicitEulerDynamicSearchRadius.algorithm_steps(), swift2.particle.tests.DastgenTestDummyParticle.DastgenTestDummyParticle.algorithm_steps(), peano4.solversteps.UserActionSet.UserActionSet.get_action_set_name(), peano4.datamodel.DoF.DoF.get_full_qualified_type(), peano4.datamodel.DoF.DoF.get_logical_type_name(), dastgen2.attributes.Enumeration.Enumeration.get_to_string(), and swift2.particle.Particle.Particle.readme_descriptor().