GlobalFixedTimeStep.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_compute_Riemann_kernel_for_Rusanov
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 SolverVariant
from .kernels import KernelVariant
 
from exahype2.solvers.fv.FixedTimeSteppingCodeSnippets import FixedTimeSteppingCodeSnippets
 
 
class GlobalFixedTimeStep(SingleSweep):
  def __init__(self,
    name, patch_size, unknowns, auxiliary_variables, min_volume_h, max_volume_h, normalised_time_step_size,
    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, 
  ):
    """!
 
    Construct a Finite Volume scheme with a Rusanov solver and fixed time step sizes
  
    @param time_step_size: Float
      This is the normalised time step size w.r.t. the coarsest admissible h value. If
      the code employs AMR on top of it and refines further, it will automatically
      downscale the time step size accordingly. So hand in a valid time step size w.r.t.
      to max_volume_h.
       
    @param normalised_time_step_size: Float
      Please consult exahype2.solvers.fv.FixedTimeSteppingCodeSnippets. The logic how 
      this field is translated into a time step size is outsourced into this utility 
      class.
      
    """
    super(GlobalFixedTimeStep,self).__init__(name,
                                             patch_size,
                                             1,    # overlap
                                             unknowns,
                                             auxiliary_variables,
                                             min_volume_h,
                                             max_volume_h,
                                             plot_grid_properties,
                                             pde_terms_without_state,
                                             kernel_namespace="rusanov")
    self._normalised_time_step_size = normalised_time_step_size
 
    self._flux_implementation_flux_implementation                 = PDETerms.None_Implementation
    self._ncp_implementation_ncp_implementation                  = PDETerms.None_Implementation
    self._eigenvalues_implementation_eigenvalues_implementation          = PDETerms.None_Implementation
    self._source_term_implementation_source_term_implementation          = PDETerms.None_Implementation
 
    self._compute_eigenvalue_compute_eigenvalue                  = True
 
    self._user_action_set_includes += """
#include "exahype2/fv/rusanov/rusanov.h"
"""
 
    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,
                         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        = ""
  ):
    """!
 
    Configure implementation
  
    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_implementation                       = flux
    if ncp                  is not None:  self._ncp_implementation_ncp_implementation                        = ncp
    if eigenvalues          is not None:  self._eigenvalues_implementation_eigenvalues_implementation                = eigenvalues
    if source_term          is not None:  self._source_term_implementation_source_term_implementation                = source_term
 
    self._compute_kernel_call_compute_kernel_call = create_compute_Riemann_kernel_for_Rusanov(
      self._flux_implementation_flux_implementation,
      self._ncp_implementation_ncp_implementation,
      self._source_term_implementation_source_term_implementation,
      compute_max_eigenvalue_of_next_time_step = False,
      solver_variant = SolverVariant.WithVirtualFunctions,
      kernel_variant = KernelVariant.PatchWiseAoS
    )
 
    self._compute_kernel_call_stateless_compute_kernel_call_stateless = create_compute_Riemann_kernel_for_Rusanov(
      self._flux_implementation_flux_implementation,
      self._ncp_implementation_ncp_implementation,
      self._source_term_implementation_source_term_implementation,
      compute_max_eigenvalue_of_next_time_step = False,
      solver_variant = SolverVariant.Stateless,
      kernel_variant = KernelVariant.PatchWiseAoS
    )
 
    solver_code_snippets = FixedTimeSteppingCodeSnippets(self._normalised_time_step_size)
 
    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_eigenvalues_implementation, self._source_term_implementation_source_term_implementation, self._pde_terms_without_state)
    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_eigenvalues_implementation, self._source_term_implementation_source_term_implementation, self._pde_terms_without_state)
    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_eigenvalues_implementation, self._source_term_implementation_source_term_implementation, self._pde_terms_without_state)
    self._solver_user_definitions_solver_user_definitions            = create_solver_definitions(self._flux_implementation_flux_implementation, self._ncp_implementation_ncp_implementation, self._eigenvalues_implementation_eigenvalues_implementation, self._source_term_implementation_source_term_implementation, self._pde_terms_without_state)
 
    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()
 
    super(GlobalFixedTimeStep,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(GlobalFixedTimeStep, self).user_action_set_includes + """
#include "exahype2/fv/rusanov/rusanov.h"
"""