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.fv.SingleSweep import SingleSweep
 
import jinja2
 
from .kernels import create_abstract_solver_declarations
from .kernels import create_abstract_solver_definitions
from .kernels import create_solver_declarations
from .kernels import create_solver_definitions
from .kernels import create_rusanov_kernel_definitions
from .kernels import create_compute_Riemann_kernel_for_Rusanov_dsl
 
from .kernels import SolverVariant
from .kernels import KernelVariant
 
from exahype2.solvers.fv.AdaptiveTimeSteppingCodeSnippets import AdaptiveTimeSteppingCodeSnippets
 
 
class GlobalAdaptiveTimeStep(SingleSweep):
  def __init__(self,
    name, patch_size, unknowns, auxiliary_variables, min_volume_h, max_volume_h, time_step_relaxation,
    flux=PDETerms.User_Defined_Implementation,
    ncp=PDETerms.None_Implementation,
    eigenvalues=PDETerms.User_Defined_Implementation,
    boundary_conditions=PDETerms.User_Defined_Implementation,
    refinement_criterion=PDETerms.Empty_Implementation,
    initial_conditions=PDETerms.User_Defined_Implementation,
    source_term=PDETerms.None_Implementation,
    plot_grid_properties=False,
    pde_terms_without_state=False, overlap=1
  ):
    super(GlobalAdaptiveTimeStep,self).__init__(name,
                                                patch_size,
                                                overlap,
                                                unknowns,
                                                auxiliary_variables,
                                                min_volume_h,
                                                max_volume_h,
                                                plot_grid_properties,
                                                pde_terms_without_state,
                                                kernel_namespace="rusanov")
    self._time_step_relaxation = time_step_relaxation
 
    self._flux_implementation                 = PDETerms.None_Implementation
    self._ncp_implementation                  = PDETerms.None_Implementation
    self._eigenvalues_implementation          = PDETerms.None_Implementation
    self._source_term_implementation          = PDETerms.None_Implementation
 
    self._compute_eigenvalue                  = True
 
    self.set_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,
    eigenvalues=None,
    boundary_conditions=None,refinement_criterion=None,initial_conditions=None,source_term=None,
    memory_location         = None,
    use_split_loop          = False,
    additional_action_set_includes = "",
    additional_user_includes       = ""
  ):
    """
    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.
    """
    if flux                 is not None:  self._flux_implementation                       = flux
    if ncp                  is not None:  self._ncp_implementation                        = ncp
    if eigenvalues          is not None:  self._eigenvalues_implementation                = eigenvalues
    if source_term          is not None:  self._source_term_implementation                = source_term
 
    create_rusanov_kernel_definitions(self._patch_size,
      self._unknowns,
      self._auxiliary_variables,
      self._flux_implementation,
      self._ncp_implementation,
      self._source_term_implementation,
      compute_max_eigenvalue_of_next_time_step = True
    )
 
    self._compute_kernel_call = create_compute_Riemann_kernel_for_Rusanov_dsl(
      self._flux_implementation,
      self._ncp_implementation,
      self._source_term_implementation,
      compute_max_eigenvalue_of_next_time_step = True,
      solver_variant = SolverVariant.WithVirtualFunctions,
      kernel_variant = KernelVariant.PatchWiseAoS
    )
 
    self._compute_kernel_call_stateless = create_compute_Riemann_kernel_for_Rusanov_dsl(
      self._flux_implementation,
      self._ncp_implementation,
      self._source_term_implementation,
      compute_max_eigenvalue_of_next_time_step = True,
      solver_variant = SolverVariant.Stateless,
      kernel_variant = KernelVariant.PatchWiseAoS
    )
 
    solver_code_snippets = AdaptiveTimeSteppingCodeSnippets(self._time_step_relaxation)
 
    self._abstract_solver_user_declarations  = create_abstract_solver_declarations(self._flux_implementation, self._ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation, self._pde_terms_without_state)
    self._abstract_solver_user_declarations += solver_code_snippets.create_abstract_solver_user_declarations()
    self._abstract_solver_user_definitions   = create_abstract_solver_definitions(self._flux_implementation, self._ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation, self._pde_terms_without_state)
    self._abstract_solver_user_definitions  += solver_code_snippets.create_abstract_solver_user_definitions()
 
    self._solver_user_declarations           = create_solver_declarations(self._flux_implementation, self._ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation, self._pde_terms_without_state)
    self._solver_user_definitions            = create_solver_definitions(self._flux_implementation, self._ncp_implementation, self._eigenvalues_implementation, self._source_term_implementation, self._pde_terms_without_state)
 
    self._compute_time_step_size             = solver_code_snippets.create_compute_time_step_size()
    self._compute_new_time_step_size         = solver_code_snippets.create_compute_new_time_step_size()
 
    self._start_time_step_implementation     = solver_code_snippets.create_start_time_step_implementation()
    self._finish_time_step_implementation    = solver_code_snippets.create_finish_time_step_implementation()
    self._constructor_implementation         = solver_code_snippets.create_abstract_solver_constructor_statements()
 
    super(GlobalAdaptiveTimeStep,self).set_implementation(boundary_conditions, refinement_criterion, initial_conditions, memory_location, use_split_loop, additional_action_set_includes, additional_user_includes)
 
 
  @property
  def user_action_set_includes(self):
    return super(GlobalAdaptiveTimeStep, self).user_action_set_includes + """
#include "kernels/rusanov.h"
"""