Particle layouts

Warning

This section is currently in development.

pydantic model picmistandard.PICMI_GriddedLayout[source]

Specifies a gridded layout of particles

Parameters

parameter grid: PICMI_AnyGrid | None = None

Grid object specifying the grid to follow. If not specified, the underlying grid of the code is used.

parameter n_macroparticles_per_cell: list[int] [Required]

Number of particles per cell along each axis (one entry per grid dimension, or a single number in 1D)

Properties

property n_macroparticle_per_cell
pydantic model picmistandard.PICMI_PseudoRandomLayout[source]

Specifies a pseudo-random layout of the particles

Parameters

parameter grid: PICMI_AnyGrid | None = None

Grid object specifying the grid to follow for n_macroparticles_per_cell. If not specified, the underlying grid of the code is used.

parameter n_macroparticles: int | None = None

Total number of macroparticles to load. Either this argument or n_macroparticles_per_cell should be supplied (not both).

parameter n_macroparticles_per_cell: int | None = None

Number of macroparticles to load per cell. Either this argument or n_macroparticles should be supplied (not both).

parameter seed: int | None = None

Pseudo-random number generator seed