Applied Field descriptions

Warning

This section is currently in development.

Constant fields

pydantic model picmistandard.PICMI_ConstantAppliedField

Describes a constant applied field

Parameters

parameter Bx: float | None = None

Constant Bx field [T]

parameter By: float | None = None

Constant By field [T]

parameter Bz: float | None = None

Constant Bz field [T]

parameter Ex: float | None = None

Constant Ex field [V/m]

parameter Ey: float | None = None

Constant Ey field [V/m]

parameter Ez: float | None = None

Constant Ez field [V/m]

parameter lower_bound: list[float | None] [Optional]

Lower bound of the region where the field is applied [m].

parameter upper_bound: list[float | None] [Optional]

Upper bound of the region where the field is applied [m]

Analytic fields

pydantic model picmistandard.PICMI_AnalyticAppliedField

Describes an analytic applied field

The expressions should be in terms of the position and time, written as ‘x’, ‘y’, ‘z’, ‘t’. Parameters can be used in the expression with the values given as additional keyword arguments. Expressions should be relative to the lab frame.

Parameters

parameter Bx_expression: Expression | None = None

Analytic expression describing Bx field [T]

parameter By_expression: Expression | None = None

Analytic expression describing By field [T]

parameter Bz_expression: Expression | None = None

Analytic expression describing Bz field [T]

parameter Ex_expression: Expression | None = None

Analytic expression describing Ex field [V/m]

parameter Ey_expression: Expression | None = None

Analytic expression describing Ey field [V/m]

parameter Ez_expression: Expression | None = None

Analytic expression describing Ez field [V/m]

parameter lower_bound: list[float | None] [Optional]

Lower bound of the region where the field is applied [m].

parameter upper_bound: list[float | None] [Optional]

Upper bound of the region where the field is applied [m]

parameter user_defined_kw: dict [Optional]

Constants referenced in the expressions, collected from otherwise-unrecognized keyword arguments.

Refecting mirrors

pydantic model picmistandard.PICMI_Mirror

Describes a perfectly reflecting mirror, where the E and B fields are zeroed out in a plane of finite thickness.

Only one of the [x,y,z]_front_location should be specified. The mirror will be set perpendicular to the respective direction and infinite in the others. The depth of the mirror will be the maximum of the specified depth and number_of_cells, or the code’s default value if neither are specified.

Parameters

parameter depth: float | None = None

Depth of the mirror [m]

parameter number_of_cells: int | None = None

Minimum number of cells zeroed out

parameter x_front_location: float | None = None

Location in x of the front of the mirror [m]

parameter y_front_location: float | None = None

Location in y of the front of the mirror [m]

parameter z_front_location: float | None = None

Location in z of the front of the mirror [m]

Fields from files

pydantic model picmistandard.PICMI_LoadAppliedField

The E and B fields read from file are applied to the particles directly. (They are not affected by the field solver.) The expected format is the file is OpenPMD with axes (x,y,z) in Cartesian, or (r,z) in Cylindrical geometry.

Parameters

parameter load_B: bool = True

If False, do not load magnetic field

parameter load_E: bool = True

If False, do not load electric field

parameter read_fields_from_path: str [Required]

Path to file with field data

pydantic model picmistandard.PICMI_LoadGriddedField

The data read in is used to initialize the E and B fields on the grid at the start of the simulation. The expected format is the file is OpenPMD with axes (x,y,z) in Cartesian, or (r,z) in Cylindrical geometry.

Parameters

parameter load_B: bool = True

If False, do not load magnetic field

parameter load_E: bool = True

If False, do not load electric field

parameter read_fields_from_path: str [Required]

Path to file with field data