jf1uids.fluid_equations.registered_variables

`jf1uids.fluid_equations.registered_variables`#

Module Contents#

Classes#

`StaticIntVector`
`RegisteredVariables`	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.

Functions#

get_registered_variables

Get the registered variables for the simulation.

API#

class jf1uids.fluid_equations.registered_variables.StaticIntVector[source]#

Bases: typing.NamedTuple

x: int = None#

y: int = None#

z: int = None#

class jf1uids.fluid_equations.registered_variables.RegisteredVariables[source]#

Bases: typing.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.

num_vars: int = 3#

density_index: int = 0#

velocity_index: Union[int, jf1uids.fluid_equations.registered_variables.StaticIntVector] = 1#

magnetic_index: Union[int, jf1uids.fluid_equations.registered_variables.StaticIntVector] = None#

pressure_index: int = 2#

wind_density_index: int = None#

wind_density_active: bool = False#

cosmic_ray_n_index: int = None#

cosmic_ray_n_active: bool = False#

jf1uids.fluid_equations.registered_variables.get_registered_variables(config: jf1uids.option_classes.simulation_config.SimulationConfig) → jf1uids.fluid_equations.registered_variables.RegisteredVariables[source]#