PlotDGDataInPeanoBlockFormat.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 peano4.solversteps.ActionSet import ActionSet
 
import jinja2
 
 
class PlotDGDataInPeanoBlockFormat(ActionSet):
 
  def __init__(self,
               solver,
               variable_name,
               getter,
               plot_predicate = "true"
               ):
    """
    
      Plot the DG mesh
      
    """
    super( PlotDGDataInPeanoBlockFormat, self ).__init__()
    
    self.d = {}
    self.d["SOLVER_INSTANCE"]        = solver.instance_name()
    self.d["SOLVER_NAME"]            = solver.typename()
    self.d[ "VARIABLE" ]             = variable_name
    self.d[ "GETTER" ]               = getter
    self.d["PLOT_PREDICATE"]         = plot_predicate
 
  __Template_Constructor = """
  _writer          = nullptr;
  _dataWriter      = nullptr;
  _treeNumber      = treeNumber;
 
  // An MPI lock (critical section) would be important!
    
  logDebug( "PlotGrid2PlotGridInPeanoBlockFormat1()", "created tree instance for " << treeNumber );
"""
 
 
  def get_constructor_body(self):
    return self.__Template_Constructor.format(**self.d)
 
 
  __Template_EndTraversal = """
  if ( {{PLOT_PREDICATE}} ) {
    assertion(_dataWriter!=nullptr);
    assertion1(_dataWriter!=nullptr,_treeNumber);
    
    _dataWriter->close();
    _writer->writeToFile();
    
    delete _dataWriter;
    delete _writer;
 
    _dataWriter = nullptr;
    _writer      = nullptr;
  }
"""
 
  def get_destructor_body(self):
    return ""
 
 
  def get_body_of_getGridControlEvents(self):
    return "  return std::vector< peano4::grid::GridControlEvent >();\n" 
 
 
  def get_action_set_name(self):
    return __name__.replace(".py", "").replace(".", "_")
 
 
  def user_should_modify_template(self):
    return False
 
 
  Template_TouchCellFirstTime = """ 
if (
  fineGridCell{{SOLVER_NAME}}.getType() == celldata::{{SOLVER_NAME}}::Type::Interior
  and
  {{PLOT_PREDICATE}}
) {
 
  logTraceInWith1Argument("Plot::touchCellFirstTime", fineGridCell{{SOLVER_NAME}}.{{GETTER}}());
  
  int patchIndex = _writer->plotPatch(
    marker.x()-0.5 * marker.h(),
    marker.h()
  );
 
  int valuePatchVertexIndex  = _dataWriter->getFirstVertexWithinPatch(patchIndex);
  int currentDoF = 0;
  /*
  d-dimensional forloop
  */
  dfor(k,repositories::{{SOLVER_INSTANCE}}.PolyDegree+1) {
    double* value = fineGridCell{{SOLVER_NAME}}.{{GETTER}}().data();
    _dataWriter->plotVertex( valuePatchVertexIndex, value+currentDoF );
    valuePatchVertexIndex++;
    currentDoF++;
  }
 
 
 
  logTraceOut("Plot::touchCellFirstTime");
}
"""
 
  templateTouchFaceFirstTime="""
  if (fineGridFace{{SOLVER_NAME}}.getType()!=facedata::{{SOLVER_NAME}}::Type::Coarse)
  {
    logTraceInWith3Arguments("touchFaceFirstTimeOutput", marker.x(), fineGridFace{{SOLVER_NAME}}.getSolution(),fineGridFace{{SOLVER_NAME}}.getProjection());
    logTraceOut("touchFaceFirstTimeOutput");
  }
"""
 
  __Template_BeginTraversal = """
  if ({{PLOT_PREDICATE}}) {
    tarch::mpi::Lock lock( _semaphore );
 
    static int counter = -1;
    counter++;
    
    std::ostringstream snapshotFileName;
    snapshotFileName << "{{SOLVER_NAME}}.{{VARIABLE}}-" << counter ;
 
    if (tarch::mpi::Rank::getInstance().getNumberOfRanks()>1 ) {
      snapshotFileName << "-rank-" << tarch::mpi::Rank::getInstance().getRank();
    }
 
    _writer = new tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter(
      Dimensions, snapshotFileName.str(), "{{SOLVER_NAME}}.{{VARIABLE}}",
      tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter::IndexFileMode::AppendNewData,
      counter
    );
      
    _dataWriter = _writer->createVertexDataWriter( 
      "{{VARIABLE}}", 
      repositories::{{SOLVER_INSTANCE}}.PolyDegree+1,  // nodes per axis                                          
      repositories::{{SOLVER_INSTANCE}}.UnknownsPerCellNode,
      "Solution",
      "Solution as delivered through MF Solver"
    );
 
    _dataWriter->setPrecision(16);
  }
"""
 
 
  def get_body_of_operation(self,operation_name):
    result = "\n"
    if operation_name==ActionSet.OPERATION_TOUCH_CELL_FIRST_TIME:
      result = jinja2.Template( self.Template_TouchCellFirstTime).render(**self.d) 
    if operation_name==ActionSet.OPERATION_BEGIN_TRAVERSAL:
      result = jinja2.Template( self.__Template_BeginTraversal).render(**self.d)             
    if operation_name==ActionSet.OPERATION_END_TRAVERSAL:
      result = jinja2.Template( self.__Template_EndTraversal).render(**self.d)             
    if operation_name==ActionSet.OPERATION_TOUCH_FACE_FIRST_TIME:
      result = jinja2.Template( self.templateTouchFaceFirstTime).render(**self.d) 
    return result
 
 
  def get_attributes(self):
    return """
    static tarch::mpi::BooleanSemaphore                                              _semaphore;
    
    int                _treeNumber;
 
    tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter*                    _writer;
    tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter::VertexDataWriter*  _dataWriter;
    tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter::VertexDataWriter*  _rhsWriter;
"""
 
 
  def get_includes(self):
    return """
#include "tarch/plotter/griddata/blockstructured/PeanoTextPatchFileWriter.h"
#include "tarch/mpi/Lock.h"
#include "tarch/mpi/BooleanSemaphore.h"
#include "tarch/multicore/Lock.h"
#include "tarch/multicore/BooleanSemaphore.h"
#include "peano4/utils/Loop.h"
#include "peano4/parallel/SpacetreeSet.h"
#include "../repositories/SolverRepository.h"
"""
 
 
  def get_static_initialisations(self,full_qualified_classname):
    return """
tarch::mpi::BooleanSemaphore  """ + full_qualified_classname + """::_semaphore;
"""