Peano

Searching...

No Matches

Project solution vector from PETSc back onto vertices. More...

Inheritance diagram for api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh:

[legend]

Collaboration diagram for api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh:

[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)
	Consult petsc.Project for details.

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

	get_constructor_body (self)
	Define body of constructor.

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	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)

Data Fields
	d

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

	parallel

Static Public Attributes
str	TemplateTouchVertexFirstTime

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

Project solution vector from PETSc back onto vertices.

This action set works if and only if your PETSc data is associated with the vertices only. If runs over through the mesh. Each mesh vertex has a tree number and a (local) number. We take this tuple and ask the map what the global dof index is. With this index, we ask PETSc what the corresponding entry in the solution vector reads like.

Definition at line 140 of file ProjectPETScSolutionBackOntoMesh.py.

Constructor & Destructor Documentation

◆ init()

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.__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 168 of file ProjectPETScSolutionBackOntoMesh.py.

References api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.__init__().

Referenced by api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.__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.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.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 207 of file ProjectPETScSolutionBackOntoMesh.py.

◆ get_attributes()

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.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 243 of file ProjectPETScSolutionBackOntoMesh.py.

◆ get_body_of_operation()

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.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 TemplateTouchVertexFirstTime and replaces it with entries from the dictionary. The latter is befilled in init().

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 189 of file ProjectPETScSolutionBackOntoMesh.py.

◆ get_constructor_body()

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

Definition at line 252 of file ProjectPETScSolutionBackOntoMesh.py.

◆ get_includes()

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.get_includes ( self )

Consult petsc.Project for details.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 233 of file ProjectPETScSolutionBackOntoMesh.py.

◆ user_should_modify_template()

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.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 222 of file ProjectPETScSolutionBackOntoMesh.py.

Field Documentation

◆ d

api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.d

Definition at line 182 of file ProjectPETScSolutionBackOntoMesh.py.

◆ TemplateTouchVertexFirstTime

str api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.TemplateTouchVertexFirstTime

static

Initial value:

=  """
if (fineGridVertex{{SOLVER_NAME}}PETScData.getType() == vertexdata::{{SOLVER_NAME}}PETScData::Type::Interior) {
  std::pair<int,int> localIndex = std::make_pair(_spacetreeId, fineGridVertex{{SOLVER_NAME}}PETScData.getUnknownBaseNumber());
  int globalIndex = repositories::{{SOLVER_INSTANCE}}.getLocalToGlobalMap().getGlobalIndex(localIndex, ::petsc::LocalToGlobalMap::Type::Vertex);
 
  for (int i=0; i<{{VERTEX_CARDINALITY}}; i++){
    fineGridVertex{{SOLVER_NAME}}.setValue(
      i,
      repositories::{{SOLVER_INSTANCE}}.getLinearEquationSystem().get(globalIndex+i)
    );
  }
}
"""

Definition at line 153 of file ProjectPETScSolutionBackOntoMesh.py.

Referenced by api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.get_body_of_operation(), and api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_body_of_operation().

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

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

◆ TemplateTouchVertexFirstTime

◆ init()