ProjectPETScSolutionBackOntoMesh.py

Go to the documentation of this file.

# This file is part of the Peano's PETSc extension. For conditions of distribution and 
# use, please see the copyright notice at www.peano-framework.org
from peano4.solversteps.ActionSet import ActionSet
 
import peano4
import jinja2
 
 
class ProjectPETScSolutionOnCellsBackOntoMesh(ActionSet):
  """!
 
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.
  
  """
  
  
  TemplateTouchCellFirstTime = """
  if ( fineGridCell{{SOLVER_NAME}}PETScData.getType() == celldata::{{SOLVER_NAME}}PETScData::Type::Interior ) {
    logTraceIn( "touchCellFirstTime(...)" );
    
    std::pair<int,int> localIndex( _spacetreeId, fineGridCell{{SOLVER_NAME}}PETScData.getUnknownBaseNumber() );
    int globalIndex = repositories::{{SOLVER_INSTANCE}}.getLocalToGlobalMap().getGlobalIndex(localIndex, ::petsc::LocalToGlobalMap::Type::Cell);
 
    for (int i=0; i<{{CELL_CARDINALITY}}; i++){
      // place values into mesh
      fineGridCell{{SOLVER_NAME}}.setValue( i,
        repositories::{{SOLVER_INSTANCE}}.getLinearEquationSystem().get(globalIndex + i) );
    }
 
    logTraceOut( "touchCellFirstTime(...)" );
  }
"""
  
  def __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.
    
    """
    super( ProjectPETScSolutionOnCellsBackOntoMesh, self ).__init__()
    self.d = {}
    self.d["SOLVER_INSTANCE"]        = solver.instance_name()
    self.d["SOLVER_NAME"]            = solver.typename()
    self.d["CELL_CARDINALITY"]       = solver.number_of_matrix_entries_per_cell
 
 
 
  def 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().
    
    """
    result = ""
    if operation_name==peano4.solversteps.ActionSet.OPERATION_TOUCH_CELL_FIRST_TIME:
      result = jinja2.Template(self.TemplateTouchCellFirstTime).render(**self.d)
      pass 
    return result
 
 
  def 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.
     
    """
    return __name__.replace(".py", "").replace(".", "_")
 
 
  def 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.
    
    """
    return False
 
 
  def get_includes(self):
    """!
   
Consult petsc.Project for details
    
"""    
    return """
#include "../repositories/SolverRepository.h"
"""
 
  def get_attributes(self):
    """!
    
    
    """
    return """
  int _spacetreeId;    
"""
      
  def 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 get_attributes()
    
    """
    return """
  _spacetreeId = treeNumber;
"""
 
 
class ProjectPETScSolutionOnVerticesBackOntoMesh(ActionSet):
  """!
 
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.
  
  """
  
  TemplateTouchVertexFirstTime = """
  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)
      );
    }
  }
"""
 
  
  def __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.
    
    """
    super( ProjectPETScSolutionOnVerticesBackOntoMesh, self ).__init__()
    self.d = {}
    self.d["SOLVER_INSTANCE"]        = solver.instance_name()
    self.d["SOLVER_NAME"]            = solver.typename()
    self.d["VERTEX_CARDINALITY"]     = solver.number_of_matrix_entries_per_vertex
 
 
 
  def 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().
    
    """
    result = ""
    if operation_name==peano4.solversteps.ActionSet.OPERATION_TOUCH_VERTEX_FIRST_TIME:
      result = jinja2.Template(self.TemplateTouchVertexFirstTime).render(**self.d)
      pass 
    return result
 
 
  def 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.
     
    """
    return __name__.replace(".py", "").replace(".", "_")
 
 
  def 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.
    
    """
    return False
 
 
  def get_includes(self):
    """!
   
Consult petsc.Project for details
    
"""    
    return """
#include "../repositories/SolverRepository.h"
"""
 
  def get_attributes(self):
    """!
    
    
    """
    return """
  int _spacetreeId;    
"""
      
  def 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 get_attributes()
    
    """
    return """
  _spacetreeId = treeNumber;
"""