Global

class narupatools.lammps.globals.Global(key: str)

A global value defined by LAMMPS that can be extracted using extract_global.

Inheritance

Methods

__init__	Initialize self.
define	Define a global that is defined by LAMMPS.
extract	Extract the current value from a LAMMPS instance.

__init__(key: str) → None

Initialize self. See help(type(self)) for accurate signature.

classmethod define(key: str, datatype: Literal[lammps.LAMMPS_INT]) → narupatools.lammps.globals.Global[int]

classmethod define(key: str, datatype: Literal[lammps.LAMMPS_DOUBLE]) → narupatools.lammps.globals.Global[float]

classmethod define(key: str, datatype: Literal[lammps.LAMMPS_STRING]) → narupatools.lammps.globals.Global[str]

Define a global that is defined by LAMMPS.

extract(lammps: narupatools.lammps._wrapper.LAMMPSWrapper) → _TReturnType

Extract the current value from a LAMMPS instance.