Peano

Searching...

No Matches

Initialise degrees of freedom associated with the mesh. More...

Inheritance diagram for api.actionsets.InitVertexDoFs.InitVertexDoFs:

[legend]

Collaboration diagram for api.actionsets.InitVertexDoFs.InitVertexDoFs:

[legend]

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

	get_body_of_operation (self, operation_name)
	Provide C++ code snippet for peano4.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_includes (self)
	Add some additional includes.

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	get_constructor_body (self)
	Define a tailored constructor body.

	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

	get_body_of_getGridControlEvents (self)

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

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

Data Fields
	d

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

	parallel

Static Public Attributes
str	TemplateInitVertex

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

Initialise degrees of freedom associated with the mesh.

This simple action set plugs into the situations where we touch a vertex for the first time throughout a mesh traversal. Of these events, it ignores all those for refined vertices, i.e. it solely handles the unrefined vertices in the spacetree. If focuses on the fine grid. The same is done for the cells and the vertices.

The injected code snippet is simple and basically asks if a vertex will be refined. If not, it invokes the initialisation routine of the solver. For this, the action set has to know the typename and the instance name of the solver. Besides the actual behaviour, the action set also has to include the solver in the first place. This happens in get_includes().

Definition at line 9 of file InitVertexDoFs.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 50 of file InitVertexDoFs.py.

References api.actionsets.InitVertexDoFs.InitVertexDoFs.__init__().

Referenced by api.actionsets.InitVertexDoFs.InitVertexDoFs.__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.InitVertexDoFs.InitVertexDoFs.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.solversteps.ActionSet.ActionSet.

Definition at line 90 of file InitVertexDoFs.py.

◆ get_body_of_operation()

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

Provide C++ code snippet for peano4.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.solversteps.ActionSet.ActionSet.

Definition at line 72 of file InitVertexDoFs.py.

◆ get_includes()

api.actionsets.InitVertexDoFs.InitVertexDoFs.get_includes ( self )

Add some additional includes.

We need the solver repository here as we access hte solver object, and we also need access to all of Peano's d-dimensional for loops.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 116 of file InitVertexDoFs.py.

◆ user_should_modify_template()

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

Definition at line 105 of file InitVertexDoFs.py.

Field Documentation

◆ d

api.actionsets.InitVertexDoFs.InitVertexDoFs.d

Definition at line 64 of file InitVertexDoFs.py.

◆ TemplateInitVertex

str api.actionsets.InitVertexDoFs.InitVertexDoFs.TemplateInitVertex

static

Initial value:

=  """
if ( fineGridVertex{{SOLVER_NAME}}PETScData.getType() != vertexdata::{{SOLVER_NAME}}PETScData::Type::Coarse ) {
  
  tarch::la::Vector<{{VERTEX_CARDINALITY}}, double> value;
  tarch::la::Vector<{{VERTEX_CARDINALITY}}, double> rhs;
 
  // use initVertex to get all the values we want to place
  // into each vertex dof
  repositories::{{SOLVER_INSTANCE}}.initVertex(
    marker.x(),
    marker.h(),
    value,
    rhs
  );
 
  for (int i=0; i<{{VERTEX_CARDINALITY}}; i++)
  {
    fineGridVertex{{SOLVER_NAME}}.setValue(i, value[i]);
    fineGridVertex{{SOLVER_NAME}}.setRhs(i, rhs[i]);
  }
}
"""

Definition at line 27 of file InitVertexDoFs.py.

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

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

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

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ d

◆ TemplateInitVertex

◆ init()