picongpu.pypicongpu.customuserinput

This file is part of the PIConGPU. Copyright 2024 PIConGPU contributors Authors: Brian Edward Marre License: GPLv3+

Module Contents

Classes

CustomUserInput

container for easy passing of additional input as dict from user script to rendering context of simulation input

class picongpu.pypicongpu.customuserinput.CustomUserInput

Bases: picongpu.pypicongpu.rendering.RenderedObject

container for easy passing of additional input as dict from user script to rendering context of simulation input

if additional

tags: list[str] | None

list of tags

rendering_context: dict[str, Any] | None

accumulation variable of added dictionaries

addToCustomInput(custom_input: dict[str, Any], tag: str)

append dictionary to custom input dictionary

get_tags() → list[str]

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