jf1uids.option_classes.simulation_config

Contents

jf1uids.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#

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

OPEN_BOUNDARY

REFLECTIVE_BOUNDARY

PERIODIC_BOUNDARY

MHD_JET_BOUNDARY

GAS_STATE

VELOCITY_ONLY

MAGNETIC_FIELD_ONLY

CARTESIAN

CYLINDRICAL

SPHERICAL

VARAXIS

XAXIS

YAXIS

ZAXIS

SIMPLE_SOURCE_TERM

DONOR_ACCOUNTING

RIEMANN_SPLIT

RIEMANN_SPLIT_UNSTABLE

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.DOUBLE_MINMOD = 2#
jf1uids.option_classes.simulation_config.SUPERBEE = 3#
jf1uids.option_classes.simulation_config.VAN_ALBADA = 4#
jf1uids.option_classes.simulation_config.VAN_ALBADA_PP = 5#
jf1uids.option_classes.simulation_config.UNSPLIT = 0#
jf1uids.option_classes.simulation_config.SPLIT = 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.LAX_FRIEDRICHS = 3#
jf1uids.option_classes.simulation_config.HYBRID_HLLC = 4#
jf1uids.option_classes.simulation_config.AM_HLLC = 5#
jf1uids.option_classes.simulation_config.RK2_SSP = 0#
jf1uids.option_classes.simulation_config.MUSCL = 1#
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.MHD_JET_BOUNDARY = 3#
jf1uids.option_classes.simulation_config.GAS_STATE = 0#
jf1uids.option_classes.simulation_config.VELOCITY_ONLY = 1#
jf1uids.option_classes.simulation_config.MAGNETIC_FIELD_ONLY = 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.SIMPLE_SOURCE_TERM = 0#
jf1uids.option_classes.simulation_config.DONOR_ACCOUNTING = 1#
jf1uids.option_classes.simulation_config.RIEMANN_SPLIT = 2#
jf1uids.option_classes.simulation_config.RIEMANN_SPLIT_UNSTABLE = 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.SnapshotSettings[source]#

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#
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#
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#
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_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 = True#
source_term_aware_timestep: bool = False#
num_timesteps: int = 1000#
differentiation_mode: int = None#
num_checkpoints: int = 100#
return_snapshots: bool = False#
snapshot_settings: jf1uids.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#
wind_config: jf1uids._physics_modules._stellar_wind.stellar_wind_options.WindConfig = 'WindConfig(...)'#
cosmic_ray_config: jf1uids._physics_modules._cosmic_rays.cosmic_ray_options.CosmicRayConfig = 'CosmicRayConfig(...)'#
cooling_config: jf1uids._physics_modules._cooling.cooling_options.CoolingConfig = 'CoolingConfig(...)'#
neural_net_force_config: jf1uids._physics_modules._neural_net_force._neural_net_force_options.NeuralNetForceConfig = 'NeuralNetForceConfig(...)'#
cnn_mhd_corrector_config: jf1uids._physics_modules._cnn_mhd_corrector._cnn_mhd_corrector_options.CNNMHDconfig = 'CNNMHDconfig(...)'#
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.

Contents