astronomix.option_classes.simulation_config

Module Contents

Classes

SnapshotSettings	Settings for the snapshot output of the simulation.
BoundarySettings1D
BoundarySettings
SimulationConfig	Configuration object for the simulation. The simulation configuration are parameters defining the simulation where changes necessitate recompilation.

Functions

finalize_config

Finalizes the simulation configuration.

Data

FINITE_VOLUME
FINITE_DIFFERENCE
FORWARDS
BACKWARDS
MINMOD
OSHER
DOUBLE_MINMOD
SUPERBEE
VAN_ALBADA
VAN_ALBADA_PP
UNSPLIT
SPLIT
HLL
HLLC
HLLC_LM
LAX_FRIEDRICHS
HYBRID_HLLC
AM_HLLC
RK2_SSP
MUSCL
RK4_SSP
OPEN_BOUNDARY
REFLECTIVE_BOUNDARY
PERIODIC_BOUNDARY
MHD_JET_BOUNDARY
GAS_STATE
VELOCITY_ONLY
MAGNETIC_FIELD_ONLY
CARTESIAN
CYLINDRICAL
SPHERICAL
VARAXIS
XAXIS
YAXIS
ZAXIS
GHOST_CELLS
PERIODIC_ROLL
SIMPLE_SOURCE_TERM
DONOR_ACCOUNTING
RIEMANN_SPLIT
RIEMANN_SPLIT_UNSTABLE
HALF_SPLIT
IMPLICIT_MIDPOINT
IMPLICIT_EULER
SINGLE_PRECISION
DOUBLE_PRECISION
STATE_TYPE
STATE_TYPE_ALTERED
FIELD_TYPE

API

astronomix.option_classes.simulation_config.FINITE_VOLUME = 0

astronomix.option_classes.simulation_config.FINITE_DIFFERENCE = 1

astronomix.option_classes.simulation_config.FORWARDS = 0

astronomix.option_classes.simulation_config.BACKWARDS = 1

astronomix.option_classes.simulation_config.MINMOD = 0

astronomix.option_classes.simulation_config.OSHER = 1

astronomix.option_classes.simulation_config.DOUBLE_MINMOD = 2

astronomix.option_classes.simulation_config.SUPERBEE = 3

astronomix.option_classes.simulation_config.VAN_ALBADA = 4

astronomix.option_classes.simulation_config.VAN_ALBADA_PP = 5

astronomix.option_classes.simulation_config.UNSPLIT = 0

astronomix.option_classes.simulation_config.SPLIT = 1

astronomix.option_classes.simulation_config.HLL = 0

astronomix.option_classes.simulation_config.HLLC = 1

astronomix.option_classes.simulation_config.HLLC_LM = 2

astronomix.option_classes.simulation_config.LAX_FRIEDRICHS = 3

astronomix.option_classes.simulation_config.HYBRID_HLLC = 4

astronomix.option_classes.simulation_config.AM_HLLC = 5

astronomix.option_classes.simulation_config.RK2_SSP = 0

astronomix.option_classes.simulation_config.MUSCL = 1

astronomix.option_classes.simulation_config.RK4_SSP = 2

astronomix.option_classes.simulation_config.OPEN_BOUNDARY = 0

astronomix.option_classes.simulation_config.REFLECTIVE_BOUNDARY = 1

astronomix.option_classes.simulation_config.PERIODIC_BOUNDARY = 2

astronomix.option_classes.simulation_config.MHD_JET_BOUNDARY = 3

astronomix.option_classes.simulation_config.GAS_STATE = 0

astronomix.option_classes.simulation_config.VELOCITY_ONLY = 1

astronomix.option_classes.simulation_config.MAGNETIC_FIELD_ONLY = 2

astronomix.option_classes.simulation_config.CARTESIAN = 0

astronomix.option_classes.simulation_config.CYLINDRICAL = 1

astronomix.option_classes.simulation_config.SPHERICAL = 2

astronomix.option_classes.simulation_config.VARAXIS = 0

astronomix.option_classes.simulation_config.XAXIS = 1

astronomix.option_classes.simulation_config.YAXIS = 2

astronomix.option_classes.simulation_config.ZAXIS = 3

astronomix.option_classes.simulation_config.GHOST_CELLS = 0

astronomix.option_classes.simulation_config.PERIODIC_ROLL = 1

astronomix.option_classes.simulation_config.SIMPLE_SOURCE_TERM = 0

astronomix.option_classes.simulation_config.DONOR_ACCOUNTING = 1

astronomix.option_classes.simulation_config.RIEMANN_SPLIT = 2

astronomix.option_classes.simulation_config.RIEMANN_SPLIT_UNSTABLE = 3

astronomix.option_classes.simulation_config.HALF_SPLIT = 4

astronomix.option_classes.simulation_config.IMPLICIT_MIDPOINT = 0

astronomix.option_classes.simulation_config.IMPLICIT_EULER = 1

astronomix.option_classes.simulation_config.SINGLE_PRECISION = 0

astronomix.option_classes.simulation_config.DOUBLE_PRECISION = 1

astronomix.option_classes.simulation_config.STATE_TYPE = None

astronomix.option_classes.simulation_config.STATE_TYPE_ALTERED = None

astronomix.option_classes.simulation_config.FIELD_TYPE = None

class astronomix.option_classes.simulation_config.SnapshotSettings

Bases: typing.NamedTuple

Settings for the snapshot output of the simulation.

return_states: bool = True

return_final_state: bool = False

return_total_mass: bool = False

return_total_energy: bool = False

return_internal_energy: bool = False

return_kinetic_energy: bool = False

return_gravitational_energy: bool = False

return_radial_momentum: bool = False

return_magnetic_divergence: bool = False

class astronomix.option_classes.simulation_config.BoundarySettings1D

Bases: typing.NamedTuple

left_boundary: int = None

right_boundary: int = None

class astronomix.option_classes.simulation_config.BoundarySettings

Bases: typing.NamedTuple

x: astronomix.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'

y: astronomix.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'

z: astronomix.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'

class astronomix.option_classes.simulation_config.SimulationConfig

Bases: typing.NamedTuple

Configuration object for the simulation. The simulation configuration are parameters defining the simulation where changes necessitate recompilation.

solver_mode: int = None

numerical_precision: int = None

runtime_debugging: bool = False

donate_state: bool = False

memory_analysis: bool = False

print_elapsed_time: bool = False

progress_bar: bool = False

dimensionality: int = 1

state_struct: bool = False

geometry: int = None

mhd: bool = False

fv_magnetic_integrator: int = None

enforce_positivity: bool = True

self_gravity: bool = False

self_gravity_version: int = None

box_size: float = 1.0

num_cells: int = 400

reconstruction_order: int = 1

limiter: int = None

riemann_solver: int = None

split: int = None

time_integrator: int = None

num_ghost_cells: int = None

grid_spacing: float = None

boundary_handling: int = None

boundary_settings: Union[types.NoneType, astronomix.option_classes.simulation_config.BoundarySettings1D, astronomix.option_classes.simulation_config.BoundarySettings] = None

fixed_timestep: bool = False

exact_end_time: bool = True

source_term_aware_timestep: bool = False

num_timesteps: int = 1000

use_max_adaptive_timestep: bool = True

differentiation_mode: int = None

num_checkpoints: int = 100

return_snapshots: bool = False

snapshot_settings: astronomix.option_classes.simulation_config.SnapshotSettings = 'SnapshotSettings(...)'

activate_snapshot_callback: bool = False

use_specific_snapshot_timepoints: bool = False

num_snapshots: int = 10

first_order_fallback: bool = False

turbulent_forcing_config: astronomix._physics_modules._turbulent_forcing._turbulent_forcing_options.TurbulentForcingConfig = 'TurbulentForcingConfig(...)'

wind_config: astronomix._physics_modules._stellar_wind.stellar_wind_options.WindConfig = 'WindConfig(...)'

cosmic_ray_config: astronomix._physics_modules._cosmic_rays.cosmic_ray_options.CosmicRayConfig = 'CosmicRayConfig(...)'

cooling_config: astronomix._physics_modules._cooling.cooling_options.CoolingConfig = 'CoolingConfig(...)'

neural_net_force_config: astronomix._physics_modules._neural_net_force._neural_net_force_options.NeuralNetForceConfig = 'NeuralNetForceConfig(...)'

cnn_mhd_corrector_config: astronomix._physics_modules._cnn_mhd_corrector._cnn_mhd_corrector_options.CNNMHDconfig = 'CNNMHDconfig(...)'

astronomix.option_classes.simulation_config.finalize_config(config: astronomix.option_classes.simulation_config.SimulationConfig, state_shape) → astronomix.option_classes.simulation_config.SimulationConfig

Finalizes the simulation configuration.