Peano

Searching...

No Matches

Trigger assembly of PETSc matrix and project rhs values from mesh onto rhs vector entries. More...

Inheritance diagram for api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix:

[legend]

Collaboration diagram for api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix:

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

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

Trigger assembly of PETSc matrix and project rhs values from mesh onto rhs vector entries.

Definition at line 22 of file CollocatedLowOrderDiscretisation.py.

Constructor & Destructor Documentation

◆ init()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.__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 113 of file CollocatedLowOrderDiscretisation.py.

References api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.__init__().

Referenced by api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.__init__(), and api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_constructor_body().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.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 159 of file CollocatedLowOrderDiscretisation.py.

◆ get_attributes()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.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 196 of file CollocatedLowOrderDiscretisation.py.

◆ get_body_of_operation()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_body_of_operation	(		self,
			operation_name )

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

We actually do something during touchVertexFirstTime and touchCellFirstTime. We insert the appropriate template into each.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 134 of file CollocatedLowOrderDiscretisation.py.

◆ get_constructor_body()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_constructor_body ( self )

Define body of constructor.

See also: get_attributes()

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 205 of file CollocatedLowOrderDiscretisation.py.

Here is the call graph for this function:

◆ get_includes()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_includes ( self )

Consult petsc.Project for details.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 185 of file CollocatedLowOrderDiscretisation.py.

◆ user_should_modify_template()

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.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 174 of file CollocatedLowOrderDiscretisation.py.

Field Documentation

◆ d

api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.d

Definition at line 129 of file CollocatedLowOrderDiscretisation.py.

◆ TemplateTouchCellFirstTime

str api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.TemplateTouchCellFirstTime

static

Definition at line 28 of file CollocatedLowOrderDiscretisation.py.

Referenced by api.actionsets.ImposeDirichletBoundaryConditions.ImposeDirichletBoundaryConditions.get_body_of_operation(), api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnCellsBackOntoMesh.get_body_of_operation(), api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.get_body_of_operation(), and api.solvers.DiscontinuousGalerkinDiscretisation.AssemblePetscMatrix.get_body_of_operation().

◆ TemplateTouchVertexFirstTime

str api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.TemplateTouchVertexFirstTime

static

Initial value:

= """
//here we send the value, rhs from the mesh to petsc
 
if (fineGridVertex{{SOLVER_NAME}}PETScData.getType() == vertexdata::{{SOLVER_NAME}}PETScData::Type::Interior) {
  //first, get global index
  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);
  
  assertion3(globalIndex>=0, globalIndex, marker.toString(), fineGridVertex{{SOLVER_NAME}}PETScData.toString() );
 
  for (int i=0; i<{{VERTEX_CARDINALITY}}; i++)
  {
    //get the rhs that was present in the mesh
    double rhs = fineGridVertex{{SOLVER_NAME}}.getRhs(i);
 
    //send these to petsc
    repositories::{{SOLVER_INSTANCE}}.getLinearEquationSystem().insert(globalIndex + i, rhs);
  }
 
}
"""

Definition at line 91 of file CollocatedLowOrderDiscretisation.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/solvers/CollocatedLowOrderDiscretisation.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

◆ TemplateTouchCellFirstTime

◆ TemplateTouchVertexFirstTime

◆ init()