jf1uids.fluid_equations.registered_variables module

class jf1uids.fluid_equations.registered_variables.RegisteredVariables(num_vars: int = 3, density_index: int = 0, velocity_index: int | StaticIntVector = 1, magnetic_index: int | StaticIntVector = -1, pressure_index: int = 2, wind_density_index: int = -1, wind_density_active: bool = False, cosmic_ray_n_index: int = -1, cosmic_ray_n_active: bool = False)

Bases: NamedTuple

The registered variables are the variables that are stored in the state array. The order of the variables in the state array is important and should be consistent throughout the code.

cosmic_ray_n_active: bool

Alias for field number 8

cosmic_ray_n_index: int

Alias for field number 7

density_index: int

Density index

magnetic_index: int | StaticIntVector

Magnetic field index

num_vars: int

Number of variables

pressure_index: int

Energy index

velocity_index: int | StaticIntVector

Velocity index

wind_density_active: bool

Alias for field number 6

wind_density_index: int

stellar wind density index

class jf1uids.fluid_equations.registered_variables.StaticIntVector(x, y, z)

Bases: NamedTuple

x: int

Alias for field number 0

y: int

Alias for field number 1

z: int

Alias for field number 2

jf1uids.fluid_equations.registered_variables.get_registered_variables(config: SimulationConfig) → RegisteredVariables

Get the registered variables for the simulation.

Parameters:

config – The simulation configuration.

Returns:

The registered variables.