Enumerate the vertices, cells and face entries. More...

Inheritance diagram for api.actionsets.EnumerateDoFs.EnumerateDoFs:

[legend]

Collaboration diagram for api.actionsets.EnumerateDoFs.EnumerateDoFs:

[legend]

Public Member Functions
	__init__ (self, solver, boundary_vertices_hold_data, boundary_faces_hold_data)
	A.

	get_body_of_operation (self, operation_name)
	Provide C++ code snippet for peano4.api.solversteps.ActionSet.OPERATION_TOUCH_VERTEX_FIRST_TIME

	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)
	Define the local map.

	get_constructor_body (self)
	Define body of constructor.

	get_includes (self)
	Consult multigrid.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	TemplateEnumerateVertex

str	TemplateEnumerateFace

str	TemplateEnumerateCell

str	TemplateEndTraversal

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

Enumerate the vertices, cells and face entries.

This is the first step in a typical PETSc algorithm, as discussed on Peano 4 PETSc projects. It has to ensure that each mesh entity hosts the appropriate number of degrees of freedom. It hence strongly depends on the solver chosen, as different solvers place different amounts of data and auxiliary quantities on the mesh entities. The information on data cardinality is queried from the solver objects. The added logic contributed by this action set is if a mesh entity really holds unknowns or not. That is, this action set injects the domain layout and boundary data knowledge into the mesh. This guiding principles of this injection are discussed on Peano's generic boundary condition pages.

Definition at line 9 of file EnumerateDoFs.py.

Constructor & Destructor Documentation

◆ init()

api.actionsets.EnumerateDoFs.EnumerateDoFs.__init__	(	self,
		solver,
		boundary_vertices_hold_data,
		boundary_faces_hold_data
	)

A.

Enumerate vertex-associated degrees of freedom

The initialisation requires a solver object, as we have to know what C++ object this solver will produce, and we need to know how many unknowns we have per vertex.

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 191 of file EnumerateDoFs.py.

References api.actionsets.EnumerateDoFs.EnumerateDoFs.__init__().

Referenced by api.actionsets.EnumerateDoFs.EnumerateDoFs.__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.EnumerateDoFs.EnumerateDoFs.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 246 of file EnumerateDoFs.py.

◆ get_attributes()

api.actionsets.EnumerateDoFs.EnumerateDoFs.get_attributes ( self )

Define the local map.

Every action set has excactly one attribute and that's an instance of petsc::LocalToGlobalMap. Before we run through a local mesh partition, the corresponding observer object will create a copy of the action set for this traversal. In the corresponding constructor, we initialise our thread-local copy of the map with the correct tree number.

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

Definition at line 272 of file EnumerateDoFs.py.

◆ get_body_of_operation()

api.actionsets.EnumerateDoFs.EnumerateDoFs.get_body_of_operation	(	self,
		operation_name
	)

Provide C++ code snippet for peano4.api.solversteps.ActionSet.OPERATION_TOUCH_VERTEX_FIRST_TIME

Only touchVertexFirstTime is an event where this action set actually does something: It inserts the template TemplateInitVertex and replaces it with entries from the dictionary. The latter is befilled in init().

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

Definition at line 219 of file EnumerateDoFs.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.EnumerateDoFs.EnumerateDoFs.get_constructor_body ( self )

Define body of constructor.

Consult the superclass' description of the function for results. I basically initialise the _localMap with the correct tree number.

See also: get_attributes()

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

Definition at line 290 of file EnumerateDoFs.py.

◆ get_includes()

api.actionsets.EnumerateDoFs.EnumerateDoFs.get_includes ( self )

Consult multigrid.petsc.Project for details.

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

Definition at line 308 of file EnumerateDoFs.py.

◆ user_should_modify_template()

api.actionsets.EnumerateDoFs.EnumerateDoFs.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 261 of file EnumerateDoFs.py.

Field Documentation

◆ d

api.actionsets.EnumerateDoFs.EnumerateDoFs.d

Definition at line 209 of file EnumerateDoFs.py.

◆ TemplateEndTraversal

str api.actionsets.EnumerateDoFs.EnumerateDoFs.TemplateEndTraversal

static

Initial value:

=  """
logInfo( 
  "endTraversal()", 
  "vertex dofs=" << _localVertexMap.getTotalNumberOfIndices() <<
  ", face dofs=" << _localFaceMap.getTotalNumberOfIndices() <<
  ", cell dofs=" << _localCellMap.getTotalNumberOfIndices()
);
  
repositories::{{SOLVER_INSTANCE}}.getLocalToGlobalMap().merge( _localVertexMap, ::petsc::LocalToGlobalMap::Type::Vertex );
repositories::{{SOLVER_INSTANCE}}.getLocalToGlobalMap().merge( _localFaceMap,   ::petsc::LocalToGlobalMap::Type::Face );
repositories::{{SOLVER_INSTANCE}}.getLocalToGlobalMap().merge( _localCellMap,   ::petsc::LocalToGlobalMap::Type::Cell );
"""

Definition at line 177 of file EnumerateDoFs.py.

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

◆ TemplateEnumerateCell

str api.actionsets.EnumerateDoFs.EnumerateDoFs.TemplateEnumerateCell

static

Definition at line 144 of file EnumerateDoFs.py.

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

◆ TemplateEnumerateFace

str api.actionsets.EnumerateDoFs.EnumerateDoFs.TemplateEnumerateFace

static

Definition at line 86 of file EnumerateDoFs.py.

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

◆ TemplateEnumerateVertex

str api.actionsets.EnumerateDoFs.EnumerateDoFs.TemplateEnumerateVertex

static

Definition at line 28 of file EnumerateDoFs.py.

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

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

src/mghype/petsc/api/actionsets/EnumerateDoFs.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

◆ TemplateEndTraversal

◆ TemplateEnumerateCell

◆ TemplateEnumerateFace

◆ TemplateEnumerateVertex

◆ init()