picongpu.pypicongpu.grid

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

Module Contents

Classes

BoundaryCondition	Boundary Condition of PIConGPU
Grid3D	PIConGPU 3 dimensional (cartesian) grid

class picongpu.pypicongpu.grid.BoundaryCondition(*args, **kwds)

Bases: enum.Enum

Boundary Condition of PIConGPU

Defines how particles that pass the simulation bounding box are treated.

TODO: implement the other methods supported by PIConGPU (reflecting, thermal)

PERIODIC = 1

ABSORBING = 2

get_cfg_str() → str

Get string equivalent for cfg files :return: string for –periodic

__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.

class picongpu.pypicongpu.grid.Grid3D

Bases: picongpu.pypicongpu.rendering.RenderedObject

PIConGPU 3 dimensional (cartesian) grid

Defined by the dimensions of each cell and the number of cells per axis.

The bounding box is implicitly given as TODO.

cell_size_x_si

Width of individual cell in X direction

cell_size_y_si

Width of individual cell in Y direction

cell_size_z_si

Width of individual cell in Z direction

cell_cnt_x

total number of cells in X direction

cell_cnt_y

total number of cells in Y direction

cell_cnt_z

total number of cells in Z direction

boundary_condition_x

behavior towards particles crossing the X boundary

boundary_condition_y

behavior towards particles crossing the Y boundary

boundary_condition_z

behavior towards particles crossing the Z boundary

n_gpus

number of GPUs in x y and z direction as 3-integer tuple

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