picongpu.pypicongpu.util

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

Attributes

attr_cnt

Functions

build_typesafe_property(], name)
unsupported(→ None)	Print a msg that the feature/parameter/thing is unsupported.

Module Contents

picongpu.pypicongpu.util.attr_cnt = 0

picongpu.pypicongpu.util.build_typesafe_property(type_: Union[type, type(typing.List[int])], name: str | None = None) → property

picongpu.pypicongpu.util.unsupported(name: str, value: Any = 1, default: Any = None) → None

Print a msg that the feature/parameter/thing is unsupported.

If 2nd param (value) and 3rd param (default) are set: supress msg if value == default

If 2nd param (value) is set and 3rd is missing: supress msg if value is None

If only 1st param (name) is set: always print msg

Parameters:

• name – name of the feature/parameter/thing that is unsupported

• value – If set: only print warning if this is not None

• default – If set: check value against this param instead of none