picongpu.pypicongpu.simulation
This file is part of the PIConGPU. Copyright 2021-2023 PIConGPU contributors Authors: Hannes Troepgen, Brian Edward Marre License: GPLv3+
Module Contents
Classes
Represents all parameters required to build & run a PIConGPU simulation. |
- class picongpu.pypicongpu.simulation.Simulation
Bases:
picongpu.pypicongpu.rendering.RenderedObject
Represents all parameters required to build & run a PIConGPU simulation.
Most of the individual parameters are delegated to other objects held as attributes.
To run a Simulation object pass it to the Runner (for details see there).
- delta_t_si
Width of a single timestep, given in seconds.
- time_steps
Total number of time steps to be executed.
- grid
Used grid Object
- laser
Used (gaussian) Laser
- solver
Used Solver
- init_manager
init manager holding all species & their information
- typical_ppc
typical number of macro particles spawned per cell, >=1
used for normalization of units
- custom_user_input
object that contains additional user specified input parameters to be used in custom templates
@attention custom user input is global to the simulation
- add_custom_user_input(custom_input: picongpu.pypicongpu.rendering.RenderedObject)
- get_rendering_context() dict
get rendering context representation of this object
delegates work to _get_serialized and invokes checks performed by check_context_for_type(). :raise ValidationError: on schema violiation :raise RuntimeError: on schema not found :return: self as rendering context
- static check_context_for_type(type_to_check: type, context: dict) None
check if the given context is valid for the given type
Raises on error, passes silently if okay.
- Raises:
ValidationError – on schema violiation
RuntimeError – on schema not found