picongpu.pypicongpu.laser

This file is part of the PIConGPU. Copyright 2021-2023 PIConGPU contributors Authors: Hannes Troepgen, Brian Edward Marre, Alexander Debus License: GPLv3+

Module Contents

Classes

GaussianLaser

PIConGPU Gaussian Laser

class picongpu.pypicongpu.laser.GaussianLaser

Bases: picongpu.pypicongpu.rendering.RenderedObject

Inheritance diagram of picongpu.pypicongpu.laser.GaussianLaser

PIConGPU Gaussian Laser

Holds Parameters to specify a gaussian laser

class PolarizationType(*args, **kwds)

Bases: enum.Enum

Inheritance diagram of picongpu.pypicongpu.laser.GaussianLaser.PolarizationType

represents a polarization of a laser (for PIConGPU)

LINEAR = 1
CIRCULAR = 2
get_cpp_str() str

retrieve name as used in c++ param files

__repr__()

Return repr(self).

__str__()

Return str(self).

__dir__()

Returns all members and all public methods

__format__(format_spec)

Default object formatter.

__hash__()

Return hash(self).

__reduce_ex__(proto)

Helper for pickle.

__deepcopy__(memo)
__copy__()
name()

The name of the Enum member.

value()

The value of the Enum member.

wavelength

wave length in m

waist

beam waist in m

duration

duration in s (1 sigma)

focus_pos

focus position vector in m

phase

phase in rad, periodic in 2*pi

E0

E0 in V/m

pulse_init

laser will be initialized pulse_init times of duration (unitless)

propagation_direction

propagation direction(normalized vector)

polarization_type

laser polarization

polarization_direction

direction of polarization(normalized vector)

laguerre_modes

array containing the magnitudes of radial Laguerre-modes

laguerre_phases

array containing the phases of radial Laguerre-modes

huygens_surface_positions

Position in cells of the Huygens surface relative to start/ edge(negative numbers) of the total domain

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