astronomix.option_classes.simulation_params module

class astronomix.option_classes.simulation_params.SimulationParams(C_cfl: float = 0.4, gravitational_constant: float = 1.0, gamma: float = 1.6666666666666667, minimum_density: float = 1e-14, minimum_pressure: float = 1e-14, dt_max: float = 0.001, t_end: float = 0.2, snapshot_timepoints: array = Array([0.], dtype=float32), turbulent_forcing_params: TurbulentForcingParams = (2.0,), wind_params: WindParams = (0.0, 0.0, 100000.0), cosmic_ray_params: CosmicRayParams = (0.0, 0.1), cooling_params: CoolingParams = (0.76, 0.02, 10000.0, (1.0, 1.0, 100000000.0)), neural_net_force_params: NeuralNetForceParams = (None,), cnn_mhd_corrector_params: CNNMHDconfig = (False, None))

Bases: NamedTuple

Different from the simulation configuration, the simulation parameters do not require recompilation when changed. The simulation can be differentiated with respect to them.

C_cfl: float

The Courant-Friedrichs-Lewy number, a factor in the time step calculation.

cnn_mhd_corrector_params: CNNMHDconfig

The parameters of the CNN MHD corrector module.

cooling_params: CoolingParams

The parameters of the cooling module.

cosmic_ray_params: CosmicRayParams

Cosmic ray parameters

dt_max: float

The maximum time step.

gamma: float

The adiabatic index of the gas.

gravitational_constant: float

Gravitational constant.

minimum_density: float

Minimum allowed density. NOTE: CURRENTLY ONLY USED IN FINITE DIFFERENCE MODE IF config.enforce_positivity IS TRUE.

minimum_pressure: float

Minimum allowed pressure. NOTE: CURRENTLY ONLY USED IN FINITE DIFFERENCE MODE IF config.enforce_positivity IS TRUE.

neural_net_force_params: NeuralNetForceParams

The parameters of the neural network force module.

snapshot_timepoints: array

Snapshot timepoints

t_end: float

The final time of the simulation.

turbulent_forcing_params: TurbulentForcingParams

The parameters of the turbulent forcing module.

wind_params: WindParams

The parameters of the stellar wind module.