Initialise degrees of freedom associated with the cells and Faces. More...

Inheritance diagram for api.actionsets.InitFaceDoFs.InitFaceDoFs:

[legend]

Collaboration diagram for api.actionsets.InitFaceDoFs.InitFaceDoFs:

[legend]

Public Member Functions
	__init__ (self, solver)
	Initialise vertex-associated degrees of freedom.

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_action_set_name (self)
	Configure name of generated C++ action set.

	user_should_modify_template (self)
	The action set that Peano will generate that corresponds to this class should not be modified by users and can safely be overwritten every time we run the Python toolkit.

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_constructor_body (self)
	Define a tailored constructor body.

	get_includes (self)
	Consult petsc.Project for details.

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	get_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

	get_body_of_prepareTraversal (self)

	get_implementation_of_prepareTraversal (self)
	Return the C++ implementation of prepareTraversal()

	get_body_of_unprepareTraversal (self)

	get_implementation_of_unprepareTraversal (self)
	Return the C++ implementation of unprepareTraversal()

	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	get_implementation_of_operation (self, operation_name)
	Return the C++ implementation of an operation.

bool	may_run_in_background_task (self)
	May a task graph compiler move touchCellFirstTime() into a task.

Data Fields
	d

Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order

	parallel

Static Public Attributes
str	TemplateInitFace

Static Public Attributes inherited from peano4.api.solversteps.ActionSet.ActionSet
int	descend_invocation_order = 0

bool	parallel = False

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

Initialise degrees of freedom associated with the cells and Faces.

Much the same as the old code to init DoFs on vertices, except here we also make the call to the localtoglobalmap. ie we both init the degrees of freedom and the global mapping for indices on faces and cells

Definition at line 9 of file InitFaceDoFs.py.

Constructor & Destructor Documentation

◆ init()

api.actionsets.InitFaceDoFs.InitFaceDoFs.__init__	(	self,
		solver
	)

Initialise vertex-associated degrees of freedom.

The initialisation requires a solver object, as we have to know what C++ object this solver will produce.

solver: petsc.solvers.CollocatedLowOrderDiscretisation or similar solver where degrees of freedom are assigned exclusively to the vertices.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 77 of file InitFaceDoFs.py.

References api.actionsets.InitFaceDoFs.InitFaceDoFs.__init__().

Referenced by api.actionsets.InitFaceDoFs.InitFaceDoFs.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

api.actionsets.InitFaceDoFs.InitFaceDoFs.get_action_set_name ( self )

Configure name of generated C++ action set.

This action set will end up in the directory observers with a name that reflects how the observer (initialisation) is mapped onto this action set. The name pattern is ObserverName2ActionSetIdentifier where this routine co-determines the ActionSetIdentifier. We make is reflect the Python class name.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 116 of file InitFaceDoFs.py.

◆ get_attributes()

api.actionsets.InitFaceDoFs.InitFaceDoFs.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.api.solversteps.ActionSet.ActionSet.

Definition at line 141 of file InitFaceDoFs.py.

◆ get_body_of_operation()

api.actionsets.InitFaceDoFs.InitFaceDoFs.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. The snippet is executed if and only if the guard returned by get_guard_of_operation() holds, i.e. the body should not evaluate the guard itself. See the section "Guard and body" in the class documentation.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 99 of file InitFaceDoFs.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation().

Here is the caller graph for this function:

◆ get_constructor_body()

api.actionsets.InitFaceDoFs.InitFaceDoFs.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.api.solversteps.ActionSet.ActionSet.

Definition at line 147 of file InitFaceDoFs.py.

◆ get_includes()

api.actionsets.InitFaceDoFs.InitFaceDoFs.get_includes ( self )

Consult petsc.Project for details.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 151 of file InitFaceDoFs.py.

◆ user_should_modify_template()

api.actionsets.InitFaceDoFs.InitFaceDoFs.user_should_modify_template ( self )

The action set that Peano will generate that corresponds to this class should not be modified by users and can safely be overwritten every time we run the Python toolkit.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 131 of file InitFaceDoFs.py.

Field Documentation

◆ d

api.actionsets.InitFaceDoFs.InitFaceDoFs.d

Definition at line 91 of file InitFaceDoFs.py.

◆ TemplateInitFace

str api.actionsets.InitFaceDoFs.InitFaceDoFs.TemplateInitFace

static

Definition at line 20 of file InitFaceDoFs.py.

Referenced by api.actionsets.InitFaceDoFs.InitFaceDoFs.get_body_of_operation().

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

src/mghype/petsc/api/actionsets/InitFaceDoFs.py

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_operation()

◆ get_constructor_body()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ d

◆ TemplateInitFace

◆ init()