Interactions

Warning

This section is currently in development.

Field ionization

class picmistandard.PICMI_FieldIonization(*, model: str, ionized_species: PICMI_Species | PICMI_MultiSpecies, product_species: PICMI_Species | PICMI_MultiSpecies, **extra_data: Any)[source]

Base class for all PICMI classes using Pydantic for validation and extensibility.

This class allows code-specific extensions (e.g., warpx_* kwargs) via Pydantic’s extra fields mechanism while maintaining type safety for standard attributes.

Implementation specific documentation

Field ionization on an ion species.

field model: str [Required]

Ionization model, e.g. ‘ADK’

field ionized_species: PICMI_Species | PICMI_MultiSpecies [Required]

Species that is ionized

field product_species: PICMI_Species | PICMI_MultiSpecies [Required]

Species in which ionized electrons are stored