jf1uids.option_classes.simulation_config

jf1uids.option_classes.simulation_config#

Module Contents#

Classes#

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#

FORWARDS

BACKWARDS

MINMOD

OSHER

HLL

HLLC

HLLC_LM

OPEN_BOUNDARY

REFLECTIVE_BOUNDARY

PERIODIC_BOUNDARY

CARTESIAN

CYLINDRICAL

SPHERICAL

VARAXIS

XAXIS

YAXIS

ZAXIS

STATE_TYPE

STATE_TYPE_ALTERED

FIELD_TYPE

API#

jf1uids.option_classes.simulation_config.FORWARDS = 0#
jf1uids.option_classes.simulation_config.BACKWARDS = 1#
jf1uids.option_classes.simulation_config.MINMOD = 0#
jf1uids.option_classes.simulation_config.OSHER = 1#
jf1uids.option_classes.simulation_config.HLL = 0#
jf1uids.option_classes.simulation_config.HLLC = 1#
jf1uids.option_classes.simulation_config.HLLC_LM = 2#
jf1uids.option_classes.simulation_config.OPEN_BOUNDARY = 0#
jf1uids.option_classes.simulation_config.REFLECTIVE_BOUNDARY = 1#
jf1uids.option_classes.simulation_config.PERIODIC_BOUNDARY = 2#
jf1uids.option_classes.simulation_config.CARTESIAN = 0#
jf1uids.option_classes.simulation_config.CYLINDRICAL = 1#
jf1uids.option_classes.simulation_config.SPHERICAL = 2#
jf1uids.option_classes.simulation_config.VARAXIS = 0#
jf1uids.option_classes.simulation_config.XAXIS = 1#
jf1uids.option_classes.simulation_config.YAXIS = 2#
jf1uids.option_classes.simulation_config.ZAXIS = 3#
jf1uids.option_classes.simulation_config.STATE_TYPE = None#
jf1uids.option_classes.simulation_config.STATE_TYPE_ALTERED = None#
jf1uids.option_classes.simulation_config.FIELD_TYPE = None#
class jf1uids.option_classes.simulation_config.BoundarySettings1D[source]#

Bases: typing.NamedTuple

left_boundary: int = None#
right_boundary: int = None#
class jf1uids.option_classes.simulation_config.BoundarySettings[source]#

Bases: typing.NamedTuple

x: jf1uids.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'#
y: jf1uids.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'#
z: jf1uids.option_classes.simulation_config.BoundarySettings1D = 'BoundarySettings1D(...)'#
class jf1uids.option_classes.simulation_config.SimulationConfig[source]#

Bases: typing.NamedTuple

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

runtime_debugging: bool = False#
progress_bar: bool = False#
dimensionality: int = 1#
geometry: int = None#
mhd: bool = False#
self_gravity: bool = False#
box_size: float = 1.0#
num_cells: int = 400#
reconstruction_order: int = 1#
limiter: int = None#
riemann_solver: int = None#
num_ghost_cells: int = None#
grid_spacing: float = None#
boundary_settings: Union[types.NoneType, jf1uids.option_classes.simulation_config.BoundarySettings1D, jf1uids.option_classes.simulation_config.BoundarySettings] = None#
fixed_timestep: bool = False#
exact_end_time: bool = False#
source_term_aware_timestep: bool = False#
num_timesteps: int = 1000#
differentiation_mode: int = None#
num_checkpoints: int = 100#
return_snapshots: bool = False#
activate_snapshot_callback: bool = False#
num_snapshots: int = 10#
first_order_fallback: bool = False#
wind_config: jf1uids._physics_modules._stellar_wind.stellar_wind_options.WindConfig = 'WindConfig(...)'#
simplified_cosmic_rays: bool = False#
jf1uids.option_classes.simulation_config.finalize_config(config: jf1uids.option_classes.simulation_config.SimulationConfig, state_shape) → jf1uids.option_classes.simulation_config.SimulationConfig[source]#

Finalizes the simulation configuration.