Patch.py

Go to the documentation of this file.

# This file is part of the Peano project. For conditions of distribution and
# use, please see the copyright notice at www.peano-framework.org
from .PatchToDoubleArray import PatchToDoubleArray
from .DoF                import DoF
 
 
class Patch(DoF):
  """!
  
  Patch implementation of a degree of freedom
  
  Please study the superclass for details.
  
  @image html dof-class-diagram.png
   
  """
  
    
  readme_package_descriptor = """
"""
 
    
  def __init__(self, dim, no_of_unknowns, name, float_type="double"):
    """
      dim should be a two-tuple or a three-tuple of integers, so a construction 
      could look like
      
        cell_data = peano4.datamodel.Patch( (6,6,6), "Fluid" )
 
    """
    super(Patch, self).__init__(name)
    self.dim       = dim
    self.no_of_unknowns = no_of_unknowns
    self.generator = PatchToDoubleArray(self, float_type)
    self.readme_descriptor = """
### Datamodel for """ + name + str(self)
 
 
  def __str__(self):
    return """
Dim:       """ + str(self.dim) + """
Unknowns:  """ + str(self.no_of_unknowns) + """
Generator: """ + str(self.generator) + """
"""    
 
 
  @property
  def additional_load_and_store_arguments(self):
    return self._additional_load_and_store_arguments_additional_load_and_store_arguments
    
 
  @additional_load_and_store_arguments.setter
  def additional_load_and_store_arguments(self,new_arguments):
    for new_argument in new_arguments:
      self.generator.includes += """
#include \"""" + new_argument[1].replace("::","/") + """.h"
"""
    self._additional_load_and_store_arguments_additional_load_and_store_arguments = new_arguments
 
 
  # @todo Does this routine hold an MPIAndStorageAspect instance? Would be reasonable. So why do then generators have a load_store_compute_flag
  # Dann auch @ref tutorials_peano4_mask_out_data_usage Referenzieren!