picongpu.pypicongpu.species.operation.momentum.drift
This file is part of the PIConGPU. Copyright 2021-2023 PIConGPU contributors Authors: Hannes Troepgen, Brian Edward Marre License: GPLv3+
Module Contents
Classes
Add drift to a species (momentum) |
- class picongpu.pypicongpu.species.operation.momentum.drift.Drift
Bases:
picongpu.pypicongpu.rendering.RenderedObject
Add drift to a species (momentum)
Note that the drift is specified by a direction (normalized velocity vector) and gamma. Helpers to load from other representations (originating from PICMI) are provided.
- direction_normalized
direction of drift, length of one
- gamma
gamma, the physicists know
- check() None
check attributes for correctness
pass silently if everything is OK, throw error otherwise
- fill_from_velocity(velocity: Tuple[float, float, float]) None
set attributes to represent given velocity vector
computes gamma and direction_normalized for self
- Parameters:
velocity – velocity given as vector
- fill_from_gamma_velocity(gamma_velocity: Tuple[float, float, float]) None
set attributes to represent given velocity vector multiplied with gamma
computes gamma and direction_normalized for self
- Parameters:
velocity – velocity given as vector multiplied with gamma
- 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