Wakeflow Parameters =================== Model Parameters ---------------- +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | Parameter | Type | Default Value | Description | +=========================+==============================+===========================+===============================================================================================+ | ``name`` | ``str`` | ``'default_results_dir'`` | Default results directory. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``system`` | ``str`` | ``'default_parent_dir'`` | Default parent directory of results. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``m_star`` | ``float`` | ``1.0`` | Mass of central star in Solar masses. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``m_planet`` | ``float`` or ``List[float]`` | ``0.1`` | Mass of embedded planet in Jupiter masses. Giving a list generates a model per planet mass. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_outer`` | ``float`` | ``500`` | Outer radius of disk in AU. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_inner`` | ``float`` | ``100`` | Inner radius of disk in AU. Ignored for Cartesian grid. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_planet`` | ``float`` | ``250`` | Orbital radius of planet in AU. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``phi_planet`` | ``float`` | ``0`` | Azimuthal position of the planet in radians. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_ref`` | ``float`` | ``r_planet`` | Reference radius in AU, where ``hr`` and ``dens_ref`` are defined. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_c`` | ``float`` | ``0`` | Critical radius in AU for exponentially tapered disk. Exponential taper not used if set to 0. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``z_max`` | ``float`` | ``3`` | Height of the disk, in units of pressure scale height at ``r_outer``. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``q`` | ``float`` | ``0.25`` | The sound speed is proportional to R^-q. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``p`` | ``float`` | ``1.0`` | The density is proportional to R^-p. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``hr`` | ``float`` | ``0.1`` | The disk aspect ratio at the reference radius. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``dens_ref`` | ``float`` | ``1.0`` | The gas density at the reference radius in g/cm^3 | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``cw_rotation`` | ``bool`` | ``False`` | Does the disk rotate clockwise? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``grid_type`` | ``str`` | ``'cartesian'`` | ``'cartesian'`` or ``'cylindrical'`` or ``'mcfost'``. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``n_x`` | ``int`` | ``400`` | Number of grid points in the x direction. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``n_y`` | ``int`` | ``400`` | Number of grid points in the y direction. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``n_r`` | ``int`` | ``200`` | Number of radial grid points. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``n_phi`` | ``int`` | ``160`` | Number of azimuthal grid points. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``n_z`` | ``int`` | ``50`` | Number of grid points in the z direction. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``r_log`` | ``int`` | ``False`` | Use logarithmically spaced radii? Ignored for ``'mcfost'`` grid. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``make_midplane_plots`` | ``bool`` | ``True`` | Create plots of the perturbations in the disk mid-plane? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``show_midplane_plots`` | ``bool`` | ``True`` | Display plots of the perturbations in the disk mid-plane? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``dimensionless`` | ``bool`` | ``False`` | Return dimensionless results? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``include_planet`` | ``bool`` | ``True`` | Incude the perturbations from the planet? Set to ``False`` to generate unperturbed disk. | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``include_linear`` | ``bool`` | ``True`` | Include the results from the linear regime nearby the planet? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``save_perturbations`` | ``bool`` | ``True`` | Save the calculated perturbations to files? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ | ``save_total`` | ``bool`` | ``True`` | Save the perturbations plus the unperturbed disk together to files? | +-------------------------+------------------------------+---------------------------+-----------------------------------------------------------------------------------------------+ MCFOST Interface Parameters --------------------------- +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | Parameter | Type | Default Value | Description | +=================+===========+===============+==========================================================================+ | ``write_fits`` | ``bool`` | ``False`` | Do you want ``wakeflow`` to write a FITS file to run in ``MCFOST``? | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``inclination`` | ``float`` | ``-225`` | Inclination of the disk in degrees. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``PA`` | ``float`` | ``45`` | Position angle of the disk in degrees. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``PAp`` | ``float`` | ``45`` | Azimuthal angle of the planet from the PA in degrees. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``run_mcfost`` | ``bool`` | ``False`` | Do you want ``wakeflow`` to automatically run ``MCFOST`` on your models? | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``temp_star`` | ``float`` | ``9250`` | Surface temperature of central star in Kelvin. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``distance`` | ``float`` | ``101.5`` | Distance to the system in parsecs. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``v_max`` | ``float`` | ``3.2`` | Maximum magnitude velocity for MCFOST cube in km/s. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ | ``n_v`` | ``int`` | ``40`` | Number of velocity channels for MCFOST cube. | +-----------------+-----------+---------------+--------------------------------------------------------------------------+ Developer Parameters -------------------- +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Default Value | Description | +===========================+===========+===============+==========================================================================================================================================================================================+ | ``adiabatic_index`` | ``float`` | ``1.6666667`` | Adiabatic index of the gas in the disk. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``damping_malpha`` | ``float`` | ``0`` | Artificial damping per Bollati et al. 2021 (NOT IMPLEMENTED). | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``CFL`` | ``float`` | ``0.5`` | Courant safety condition factor for adaptive time stepping in Godunov scheme used to solve Burger's equation during wake propagation. Must be <=0.5 to ensure stability of the solution. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``scale_box`` | ``float`` | ``1.0`` | Radial scale factor for the linear box around the planet. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``scale_box_ang`` | ``float`` | ``1.0`` | Azimuthal scale factor for the linear box around the planet. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``tf_fac`` | ``float`` | ``1.0`` | Scale factor for the final t coordinate before self-similar solution is used in wake propagation. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``show_teta_debug_plots`` | ``bool`` | ``False`` | Show plots of solution in (t,eta) space, including the linear regime (currently not working). | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``box_warp`` | ``bool`` | ``True`` | Should the linear box warp with the disk curvature? Ie. should the local y coordinate remain Cartesian or be interpreted as an arc-length. | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``use_box_IC`` | ``bool`` | ``False`` | Restrict the initial condition for the non-linear evolution to only that included in the linear box? | +---------------------------+-----------+---------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+