jf1uids.initial_condition_generation.construct_primitive_state module

jf1uids.initial_condition_generation.construct_primitive_state module#

jf1uids.initial_condition_generation.construct_primitive_state.construct_primitive_state(config: SimulationConfig, registered_variables: RegisteredVariables, density: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'], velocity_x: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, velocity_y: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, velocity_z: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, magnetic_field_x: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, magnetic_field_y: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, magnetic_field_z: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, gas_pressure: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, cosmic_ray_pressure: Float[Array, 'num_cells_x'] | Float[Array, 'num_cells_x num_cells_y'] | Float[Array, 'num_cells_x num_cells_y num_cells_z'] | None = None, sharding=None) → Float[Array, 'num_vars num_cells_x'] | Float[Array, 'num_vars num_cells_x num_cells_y'] | Float[Array, 'num_vars num_cells_x num_cells_y num_cells_z'][source]#

Stack the primitive variables into the state array.

IN 1D SET ONLY THE XCOMPONENTS, in 2D SET X AND Y COMPONENTS, in 3D SET X, Y AND Z COMPONENTS

Parameters:

  • config – The simulation configuration.

  • registered_variables – The indices of the variables in the state array.

  • density – The density of the fluid.

  • velocity_x – The x-component of the velocity of the fluid.

  • velocity_y – The y-component of the velocity of the fluid.

  • velocity_z – The z-component of the velocity of the fluid.

  • magnetic_field_x – The x-component of the magnetic field in B / sqrt(mu_0).

  • magnetic_field_y – The y-component of the magnetic field in B / sqrt(mu_0).

  • magnetic_field_z – The z-component of the magnetic field in B / sqrt(mu_0).

  • gas_pressure – The thermal pressure of the fluid.

  • cosmic_ray_pressure – The cosmic ray pressure of the fluid.

Returns:

The state array.

Contents