GlobalAdaptiveTimeStep.py

Go to the documentation of this file.

# This file is part of the ExaHyPE2 project. For conditions of distribution and 
# use, please see the copyright notice at www.peano-framework.org
from exahype2.solvers.PDETerms    import PDETerms
from exahype2.solvers.rkfd.SeparateSweeps import SeparateSweeps
 
import jinja2
 
from .kernels import create_compute_kernel_for_FD4
 
from exahype2.solvers.rkfd.kernels import create_abstract_solver_declarations
from exahype2.solvers.rkfd.kernels import create_abstract_solver_definitions
from exahype2.solvers.rkfd.kernels import create_solver_declarations
from exahype2.solvers.rkfd.kernels import create_solver_definitions
#
from exahype2.solvers.rkfd.kernels import SolverVariant
from exahype2.solvers.rkfd.kernels import KernelVariant
 
from exahype2.solvers.rkfd.AdaptiveTimeSteppingCodeSnippets import AdaptiveTimeSteppingCodeSnippets
 
 
class GlobalAdaptiveTimeStep( SeparateSweeps ):
  def __init__(self, 
    name, patch_size, rk_order, unknowns, auxiliary_variables, min_meshcell_h, max_meshcell_h, time_step_relaxation,
    reconstruction_with_rk=False,
    flux=PDETerms.User_Defined_Implementation, 
    ncp=PDETerms.None_Implementation, 
    point_source=PDETerms.None_Implementation,
    boundary_conditions=PDETerms.User_Defined_Implementation,
    refinement_criterion=PDETerms.Empty_Implementation,
    initial_conditions=PDETerms.User_Defined_Implementation,
    source_term=PDETerms.None_Implementation,
    eigenvalues=PDETerms.User_Defined_Implementation, 
    plot_grid_properties=False, KOSigma=8.0
  ):
    """!
    
    Construct solver
    
    time_step_relaxation: Float
      Calibration factor of CFL condition. The Runge-Kutta order is multiplied 
      with this value following the formula for Cockburn-Shu damping. However, 
      also the actual polynomial order has to enter the chosen time step size
      through an additional @f$ p^{-2} @f$ scaling. We expect the user to 
      incorporate such an additional scaling within time_step_relaxation.
      
    """
 
    if reconstruction_with_rk:
      self._reconstruction_stages_reconstruction_stages=rk_order
    else:
      self._reconstruction_stages_reconstruction_stages=0
 
    super(GlobalAdaptiveTimeStep,self).__init__(name, 
                                             patch_size, 
                                             3, #overlap, 
                                             rk_order, 
                                             unknowns, 
                                             auxiliary_variables, 
                                             min_meshcell_h, 
                                             max_meshcell_h, 
                                             plot_grid_properties,
                                             kernel_namespace="fd4"
                                             ) 
 
    self._time_step_relaxation = time_step_relaxation
    self._compute_eigenvalue_compute_eigenvalue                  = True
 
    self._KO_Sigma                            = KOSigma
    
    self.set_implementationset_implementation(flux=flux, 
      ncp=ncp, 
      eigenvalues=eigenvalues, 
      boundary_conditions=boundary_conditions, 
      refinement_criterion=refinement_criterion, 
      initial_conditions=initial_conditions, 
      source_term=source_term )
 
 
  def set_implementation(self,
    flux=None, ncp=None, source_term=None, eigenvalues=None,
    boundary_conditions=None,refinement_criterion=None,initial_conditions=None,
    memory_location         = None,
    additional_action_set_includes = "",
    additional_user_includes       = "",
    KOSigma                 = None
  ):
    """
      If you pass in User_Defined, then the generator will create C++ stubs
      that you have to befill manually. If you pass in None_Implementation, it
      will create nop, i.e. no implementation or defaults. Any other string
      is copied 1:1 into the implementation. If you pass in None, then the
      set value so far won't be overwritten.
 
      Please note that not all options are supported by all solvers.
 
      This routine should be the very last invoked by the constructor.
    """
    super(GlobalAdaptiveTimeStep,self).set_implementation(  
      flux, ncp, source_term, eigenvalues,
      boundary_conditions, refinement_criterion, initial_conditions, memory_location, additional_action_set_includes, additional_user_includes)
 
    if not                  KOSigma==None:  self._KO_Sigma                                  = KOSigma
 
    self._compute_kernel_call_compute_kernel_call = create_compute_kernel_for_FD4(
      self._flux_implementation_flux_implementation, 
      self._ncp_implementation_ncp_implementation, 
      self._source_term_implementation_source_term_implementation, 
      compute_max_eigenvalue_of_next_time_step = True,
      solver_variant                           = SolverVariant.WithVirtualFunctions,
      kernel_variant                           = KernelVariant.PatchWiseAoSHeap,
      KOSigma                                  = self._KO_Sigma
    )
 
    solver_code_snippets = AdaptiveTimeSteppingCodeSnippets(self._time_step_relaxation, adaptive_starting_timeStep_size="soft")
 
    self._abstract_solver_user_declarations_abstract_solver_user_declarations  = create_abstract_solver_declarations(self._flux_implementation_flux_implementation, self._ncp_implementation_ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation_source_term_implementation, False)
    self._abstract_solver_user_declarations_abstract_solver_user_declarations += solver_code_snippets.create_abstract_solver_user_declarations()
    self._abstract_solver_user_definitions_abstract_solver_user_definitions   = create_abstract_solver_definitions(self._flux_implementation_flux_implementation, self._ncp_implementation_ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation_source_term_implementation, False)
    self._abstract_solver_user_definitions_abstract_solver_user_definitions  += solver_code_snippets.create_abstract_solver_user_definitions()
 
    self._compute_time_step_size_compute_time_step_size              = solver_code_snippets.create_compute_time_step_size()
    self._compute_new_time_step_size_compute_new_time_step_size          = solver_code_snippets.create_compute_new_time_step_size()
 
    self._solver_user_declarations_solver_user_declarations           = create_solver_declarations(self._flux_implementation_flux_implementation, self._ncp_implementation_ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation_source_term_implementation, False)
    self._solver_user_definitions_solver_user_definitions            = create_solver_definitions(self._flux_implementation_flux_implementation, self._ncp_implementation_ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation_source_term_implementation, False)
 
    self._start_time_step_implementation_start_time_step_implementation     = solver_code_snippets.create_start_time_step_implementation()
    self._finish_time_step_implementation_finish_time_step_implementation    = solver_code_snippets.create_finish_time_step_implementation()
    self._constructor_implementation_constructor_implementation         = solver_code_snippets.create_abstract_solver_constructor_statements()
    
    self.create_action_setscreate_action_sets()
 
 
  @property
  def user_action_set_includes(self):
    return super(GlobalAdaptiveTimeStep, self).user_action_set_includes + """
#include "exahype2/fd/fd4/FD4.h"
"""
 
 
  def add_entries_to_text_replacement_dictionary(self, d):
    d["RECONSTRUCTION_STAGES"]=self._reconstruction_stages_reconstruction_stages