Acoustic.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
import argparse
 
import peano4.api
import exahype2
 
 
class Acoustic:
    """!
    
    Superclass for all kinds of acoustic setups and solver variants
    
    """
    _available_solvers = {
        "RusanovGlobalFixedFV": exahype2.solvers.fv.rusanov.GlobalFixedTimeStep,
        "RusanovGlobalFixedEnclaveFV": exahype2.solvers.fv.rusanov.GlobalFixedTimeStepWithEnclaveTasking,
 
        "RusanovGlobalAdaptiveFV": exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStep,
        "RusanovGlobalAdaptiveEnclaveFV": exahype2.solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking,
 
        "RusanovGlobalFixedADERDG": exahype2.solvers.aderdg.GlobalFixedTimeStep,
        "RusanovGlobalAdaptiveADERDG": exahype2.solvers.aderdg.GlobalAdaptiveTimeStep,
    }
 
    def setup_parser(self):
        parser = argparse.ArgumentParser(
            description="ExaHyPE 2 - Acoustic Application Script"
        )
 
        parser.add_argument(
            "-s",
            "--solver",
            choices=self._available_solvers.keys(),
            help="|".join(self._available_solvers.keys()),
        )
        parser.add_argument(
            "-d",
            "--dimensions",
            type=int,
            help="Number of space dimensions.",
        )
        parser.add_argument(
            "-dt",
            "--time-step-size",
            type=float,
            default=0.01,
            help="Time step size for fixed time-stepping.",
        )
        parser.add_argument(
            "-cfl",
            "--time-step-relaxation",
            type=float,
            default=0.5,
            help="Time step relaxation safety factor for adaptive time-stepping.",
        )
 
        parser.add_argument(
            "-width",
            "--width",
            type=str,
            help="Specify size of domain in meters as [x, y] as string (e.g. [10, 10], [7e6, 4e6]).",
        )
 
        parser.add_argument(
            "-offset",
            "--offset",
            type=str,
            help="Specify offset of domain in meters as [x, y] as string (e.g. [-10, -10], [-7e6, -4e6]).",
        )
 
        parser.add_argument(
            "-stateless",
            "--stateless",
            action="store_true",
            default=False,
            help="Use stateless PDE terms (GPU offloading requires a GPU enabled Peano build and an enclave solver).",
        )
        parser.add_argument(
            "-o",
            "--output",
            type=str,
            default="solution",
            help="Output path for project solution output. The project will create a new folder at the given path. Default is 'solution'.",
        )
 
        parser.add_argument(
            "-pbc-x",
            "--periodic-boundary-conditions-x",
            action="store_true",
            help="Use periodic boundary conditions in the x-axis.",
        )
        parser.add_argument(
            "-pbc-y",
            "--periodic-boundary-conditions-y",
            action="store_true",
            help="Use periodic boundary conditions in the y-axis.",
        )
        parser.add_argument(
            "-pbc-z",
            "--periodic-boundary-conditions-z",
            action="store_true",
            help="Use periodic boundary conditions in the z-axis.",
        )
 
        parser.add_argument(
            "-m",
            "--build-mode",
            choices=peano4.api.output.CompileModes,
            default=peano4.api.output.CompileModes[0], # Release
            help="|".join(peano4.api.output.CompileModes),
        )
 
        parser.add_argument(
            "-et",
            "--end-time",
            type=float,
            default=5.0,
            help="End time of the simulation.",
        )
        parser.add_argument(
            "-ns",
            "--number-of-snapshots",
            type=int,
            default=10,
            help="Number of snapshots (plots).",
        )
 
        parser.add_argument(
            "-ps",
            "--patch-size",
            type=int,
            help="Number of finite volumes per axis (dimension) per patch.",
        )
        parser.add_argument(
            "-rk-order",
            "--rk-order",
            type=int,
            help="Order of time discretisation for Runge-Kutta scheme.",
        )
        parser.add_argument(
            "-dg-order",
            "--dg-order",
            type=int,
            help="Order of space discretisation for Discontinuous Galerkin.",
        )
 
        parser.add_argument(
            "-md",
            "--min-depth",
            type=float,
            default=1,
            help="Determines maximum size of a single cell on each axis.",
        )
        parser.add_argument(
            "-amr",
            "--amr-levels",
            type=int,
            default=0,
            help="Number of AMR grid levels on top of max. size of a cell.",
        )
 
        parser.add_argument(
            "--storage",
            type=str,
            choices=[e.name for e in exahype2.solvers.Storage],
            default="Heap",
            help="The storage scheme to use."
        )
 
        available_load_balancing_strategies = [
            "None",
            "SpreadOut",
            "SpreadOutHierarchically",
            "SpreadOutOnceGridStagnates",
            "RecursiveBipartition",
            "SplitOversizedTree",
            "cascade::SpreadOut_RecursiveBipartition",
            "cascade::SpreadOut_SplitOversizedTree",
        ]
        parser.add_argument(
            "-lbs",
            "--load-balancing-strategy",
            choices=available_load_balancing_strategies,
            default="SpreadOutOnceGridStagnates",
            help="|".join(available_load_balancing_strategies),
        )
        parser.add_argument(
            "-lbq",
            "--load-balancing-quality",
            type=float,
            default=0.99,
            help="The quality of the load balancing.",
        )
        parser.add_argument(
            "--trees",
            type=int,
            default=-1,
            help="Number of trees (partitions) per rank after initial decomposition.",
        )
        parser.add_argument(
            "--threads",
            type=int,
            default=0,
            help="Number of threads per rank.",
        )
        parser.add_argument(
            "-f",
            "--fuse-tasks",
            type=int,
            default=131072,
            help="Number of enclave tasks to fuse into one meta task.",
        )
        parser.add_argument(
            "-timeout",
            "--timeout",
            type=int,
            default=3600,
            help="MPI timeout in seconds.",
        )
        parser.add_argument(
            "-fpe",
            "--fpe",
            action="store_true",
            help="Enable a floating-point exception handler.",
        )
        parser.add_argument(
            "-no-make",
            "--no-make",
            action="store_true",
            help="Do not compile the code after generation.",
        )
 
        parser.add_argument(
            "--peano-dir",
            default="../../../",
            help="Peano directory",
        )
 
        return parser
 
    def setup_solver(self, args):
        solver_params = {
            "name": "Acoustic",
            "unknowns": {"p": 1, "u": 1, "v": 1, "w": 1}
            if args.dimensions == 3
            else {"p": 1, "u": 1, "v": 1},
            "auxiliary_variables": 0,
        }
 
        if args.stateless:
            solver_params.update(
                {
                    "pde_terms_without_state": True,
                }
            )
 
        if "Fixed" in args.solver:
            solver_params.update(
                {
                    "normalised_time_step_size": args.time_step_size,
                }
            )
        elif "Adaptive" in args.solver:
            solver_params.update(
                {
                    "time_step_relaxation": args.time_step_relaxation,
                }
            )
 
        max_h = (1.1 * min(args.width[0:args.dimensions]) / (3.0**args.min_depth))
        min_h = max_h * 3.0 ** (-args.amr_levels)
 
        if "FV" in args.solver:
            solver_params.update(
                {
                    "patch_size": args.patch_size,
                    "max_volume_h": max_h,
                    "min_volume_h": min_h,
                }
            )
            implementation_params = {
                "initial_conditions": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "boundary_conditions": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "refinement_criterion": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "flux": "applications::exahype2::acoustic::flux(Q, faceCentre, volumeH, t, dt, normal, F);",
                "eigenvalues": "applications::exahype2::acoustic::maxEigenvalue(Q, faceCentre, volumeH, t, dt, normal, maxEigenvalue);",
                "source_term": "applications::exahype2::acoustic::sourceTerm(Q, volumeCentre, volumeH, t, dt, S);",
            }
        elif "ADERDG" in args.solver:
            solver_params.update(
                {
                    "order": args.dg_order,
                    "max_cell_h": max_h,
                    "min_cell_h": min_h,
                }
            )
            implementation_params = {
                "initial_conditions": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "boundary_conditions": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "refinement_criterion": exahype2.solvers.PDETerms.User_Defined_Implementation,
                "flux": "applications::exahype2::acoustic::flux(Q, x, h, t, dt, normal, F);",
                "eigenvalues": """
                double lambda[NumberOfUnknowns] = {0.};
                applications::exahype2::acoustic::maxEigenvalue(Q, x, h, t, dt, normal, lambda);
                return *std::max_element(lambda, lambda+NumberOfUnknowns);""",
                "source_term": "applications::exahype2::acoustic::sourceTerm(Q, x, 0.0, t, 0.0, S);",
            }
 
        solver = self._available_solvers[args.solver](**solver_params)
        solver.plot_description = ", ".join(solver_params["unknowns"].keys()) + ", "
        if solver_params["auxiliary_variables"] != 0:
            solver.plot_description += ", ".join(solver_params["auxiliary_variables"].keys())
        solver.set_implementation(**implementation_params)
        solver.switch_storage_scheme(exahype2.solvers.Storage[args.storage], exahype2.solvers.Storage[args.storage])
 
        if "ADERDG" in args.solver:
            solver.add_kernel_optimisations(is_linear = True,)
 
        return solver
 
    def setup_project(self, args, solver):
        project = exahype2.Project(
            namespace=["applications", "exahype2", "acoustic"],
            project_name="Acoustic",
            directory=".",
            executable=f"Acoustic.{args.build_mode}",
        )
 
        project.add_solver(solver)
 
        if args.number_of_snapshots <= 0:
            time_in_between_plots = 0.0
        else:
            time_in_between_plots = args.end_time / args.number_of_snapshots
            project.set_output_path(args.output)
 
        project.set_global_simulation_parameters(
            dimensions=args.dimensions,
            size=args.width[0:args.dimensions],
            offset=args.offset[0:args.dimensions],
            min_end_time=args.end_time,
            max_end_time=args.end_time,
            first_plot_time_stamp=0.0,
            time_in_between_plots=time_in_between_plots,
            periodic_BC=[
                args.periodic_boundary_conditions_x,
                args.periodic_boundary_conditions_y,
                args.periodic_boundary_conditions_z,
            ],
        )
 
        if args.load_balancing_strategy != "None":
            strategy = f"toolbox::loadbalancing::strategies::{args.load_balancing_strategy}"
            assume_periodic_boundary_conditions = any([
                args.periodic_boundary_conditions_x,
                args.periodic_boundary_conditions_y,
                args.periodic_boundary_conditions_z,
            ])
            configuration = (
                f"new ::exahype2::LoadBalancingConfiguration("
                f"{args.load_balancing_quality},"
                f"0,"
                f"{'true' if assume_periodic_boundary_conditions else 'false'},"
                f"{args.trees},"
                f"{args.trees})"
            )
            project.set_load_balancing(strategy, configuration)
 
        project.set_number_of_threads(args.threads)
 
        project.set_multicore_orchestration(
            "tarch::multicore::orchestration::Hardcoded::createFuseAll(%s, 0)"
            % str(args.fuse_tasks)
        )
        project.additional_includes.append("tarch/multicore/orchestration/Hardcoded.h")
 
        project.set_timeout(args.timeout)
 
        project.set_Peano4_installation(args.peano_dir, mode=peano4.api.output.string_to_mode(args.build_mode))
        project = project.generate_Peano4_project(verbose=True)
 
        if args.fpe:
            project.set_fenv_handler("FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW")
 
        return project
 
    def build(self, args, project):
        project.build(
            make=not args.no_make,
            make_clean_first=True,
            throw_away_data_after_build=True,
        )
 
 
if __name__ == "__main__":
    print( "ERROR: Please use one of the subdirectories for a run" )