HYDRADInterface

class synthesizAR.interfaces.hydrad.HYDRADInterface(output_dir, base_config=None, hydrad_dir=None, heating_model=None, use_gravity=True, use_magnetic_field=True, use_initial_conditions=False, maximum_chromosphere_ratio=None, interpolate_to_norm=True)

Bases: object

Interface to the HYDrodynamics and RADiation (HYDRAD) code

Configure, interpolate, and load results for HYDRAD simulations for each loop in the magnetic skeleton. Note that if you want to just use a preexisting HYDRAD simulation, the simulations should just be placed in the output_dir directory with the name of each subdirectory corresponding to the appropriate loop. If you do this, all other input parameters besides interpolate_to_norm can be omitted.

Parameters:

• output_dir (pathlike) – Root directory to place all of the HYDRAD results in. Subdirectories will be named according to the name of each loop.

• base_config (dict, optional) – Dictionary of configuration options for the HYDRAD model.

• hydrad_dir (pathlike, optional) – Path to a “clean copy” of HYDRAD.

• heating_model (object, optional) – Instance of a heating model class that describes when and where the heating should occur along the loop

• use_gravity (bool, optional) – If true, use the loop coordinates to determine the gravitational stratification

• use_magnetic_field (bool, optional) – If true, use the magnetic field profile to determine the loop expansion factor

• use_initial_conditions (bool, optional) – If true, use only the hydrostatic initial conditions as the model

• maximum_chromosphere_ratio (float, optional) – Maximum allowed ratio between the loop length and the total chromosphere depth. If specified, general.footpoint_height will be set to this ratio times the loop length if 2 * general.footpoint_height / length is greater than this ratio.

• interpolate_to_norm (bool, optional) – If True, the loop quantities are interpolated using the coordinates normalized by the loop length. In cases where the length of the simulated loop does not match that of the geometric loop model, using this option will “stretch” or “squash” the simulated solution appropriately. Typically, it is best to use this as the HYDRAD loop lengths will not exactly match those in the skeleton geometry.

Attributes Summary

hydrad_dir
name

Methods Summary

configure_gravity_fit(loop)
configure_input(loop, **kwargs)
configure_magnetic_field_fit(loop)
load_results(loop[, emission_model])

Attributes Documentation

hydrad_dir

name = 'HYDRAD'

Methods Documentation

configure_gravity_fit(loop)

configure_input(loop, **kwargs)

configure_magnetic_field_fit(loop)

load_results(loop, emission_model=None)