Diagnostics

Warning

This section is currently in development.

Standard PIC diagnostics

pydantic model picmistandard.PICMI_ParticleDiagnostic

Defines the particle diagnostics in the simulation frame

Parameters

parameter data_list: list[str] | None = None

The data to be written out. Possible values ‘position’, ‘momentum’, ‘weighting’. Defaults to the output list of the implementing code.

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter parallelio: bool | None = None

If set to True, particle diagnostics are dumped in parallel

parameter period: int [Required]

Period of time steps that the diagnostic is performed

parameter species: PICMI_AnySpecies | list[PICMI_AnySpecies] | None = None

Species instance (or MultiSpecies instance) or list of them to write out. If not specified, all species are written. Note that the name attribute must be defined for the species.

parameter step_max: int | None = None

Maximum step at which diagnostics could be written (default unbounded)

parameter step_min: int | None = None

Minimum step at which diagnostics could be written (default 0)

parameter write_dir: str | None = None

Directory where data is to be written

pydantic model picmistandard.PICMI_ParticleBoundaryScrapingDiagnostic

Defines the particle diagnostics that are used to collect the particles that are absorbed at the boundaries, throughout the simulation.

Parameters

parameter data_list: list[str] | None = None

The data to be written out. Possible values ‘position’, ‘momentum’, ‘weighting’. Defaults to the output list of the implementing code.

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter parallelio: bool | None = None

If set to True, particle diagnostics are dumped in parallel

parameter period: int [Required]

Period of time steps that the diagnostic is performed

parameter species: PICMI_AnySpecies | list[PICMI_AnySpecies] | None = None

Species instance (or MultiSpecies instance) or list of them to write out. If not specified, all species are written. Note that the name attribute must be defined for the species.

parameter write_dir: str | None = None

Directory where data is to be written

pydantic model picmistandard.PICMI_FieldDiagnostic

Defines the electromagnetic field diagnostics in the simulation frame

Parameters

parameter data_list: list[str] | None = None

List of quantities to write out. Possible values ‘rho’, ‘E’, ‘B’, ‘J’, ‘Ex’ etc. Defaults to the output list of the implementing code.

parameter grid: PICMI_AnyGrid [Required]

Grid object for the diagnostic

parameter lower_bound: list[float] | None = None

Lower corner of diagnostics box in each direction. If not given, will be obtained from grid.

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter number_of_cells: list[int] | None = None

Number of cells in each dimension. If not given, will be obtained from grid.

parameter parallelio: bool | None = None

If set to True, field diagnostics are dumped in parallel

parameter period: int [Required]

Period of time steps that the diagnostic is performed

parameter step_max: int | None = None

Maximum step at which diagnostics could be written (default unbounded)

parameter step_min: int | None = None

Minimum step at which diagnostics could be written (default 0)

parameter upper_bound: list[float] | None = None

Higher corner of diagnostics box in each direction. If not given, will be obtained from grid.

parameter write_dir: str | None = None

Directory where data is to be written

pydantic model picmistandard.PICMI_ElectrostaticFieldDiagnostic

Defines the electrostatic field diagnostics in the simulation frame

Parameters

parameter data_list: list[str] | None = None

List of quantities to write out. Possible values ‘rho’, ‘E’, ‘B’, ‘Ex’ etc. Defaults to the output list of the implementing code.

parameter grid: PICMI_AnyGrid [Required]

Grid object for the diagnostic

parameter lower_bound: list[float] | None = None

Lower corner of diagnostics box in each direction. If not given, will be obtained from grid.

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter number_of_cells: list[int] | None = None

Number of cells in each dimension. If not given, will be obtained from grid.

parameter parallelio: bool | None = None

If set to True, field diagnostics are dumped in parallel

parameter period: int [Required]

Period of time steps that the diagnostic is performed

parameter step_max: int | None = None

Maximum step at which diagnostics could be written (default unbounded)

parameter step_min: int | None = None

Minimum step at which diagnostics could be written (default 0)

parameter upper_bound: list[float] | None = None

Higher corner of diagnostics box in each direction. If not given, will be obtained from grid.

parameter write_dir: str | None = None

Directory where data is to be written

Lab-frame diagnostics

These diagnostics are used when running boosted-frame simulations.

pydantic model picmistandard.PICMI_LabFrameParticleDiagnostic

Defines the particle diagnostics in the lab frame

Parameters

parameter data_list: list[str] | None = None

The data to be written out. Possible values ‘position’, ‘momentum’, ‘weighting’. Defaults to the output list of the implementing code.

parameter dt_snapshots: float [Required]

Time between each snapshot in lab frame

parameter grid: PICMI_AnyGrid [Required]

Grid object for the diagnostic

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter num_snapshots: int [Required]

Number of lab frame snapshots to make

parameter parallelio: bool | None = None

If set to True, particle diagnostics are dumped in parallel

parameter species: PICMI_AnySpecies | list[PICMI_AnySpecies] | None = None

Species instance (or MultiSpecies instance) or list of them to write out. If not specified, all species are written. Note that the name attribute must be defined for the species.

parameter time_start: float = 0.0

Time for the first snapshot in lab frame

parameter write_dir: str | None = None

Directory where data is to be written

pydantic model picmistandard.PICMI_LabFrameFieldDiagnostic

Defines the electromagnetic field diagnostics in the lab frame

Parameters

parameter data_list: list[str] | None = None

List of quantities to write out. Possible values ‘rho’, ‘E’, ‘B’, ‘J’, ‘Ex’ etc. Defaults to the output list of the implementing code.

parameter dt_snapshots: float [Required]

Time between each snapshot in lab frame

parameter grid: PICMI_AnyGrid [Required]

Grid object for the diagnostic

parameter name: str | None = None

Sets the base name for the diagnostic output files

parameter num_snapshots: int [Required]

Number of lab frame snapshots to make

parameter parallelio: bool | None = None

If set to True, field diagnostics are dumped in parallel

parameter time_start: float = 0.0

Time for the first snapshot in lab frame

parameter write_dir: str | None = None

Directory where data is to be written

parameter z_subsampling: int = 1

A factor which is applied on the resolution of the lab frame reconstruction