FieldlineProcessor#

class corona_lab.build_corona.FieldlineProcessor(radius, mass, period, mean_ptc_mass=<Quantity 8.36766431e-28 kg>, verbose=False)[source]#

Bases: object

Class processing closed and open magnetic field lines, finding stable points and prominences, for corona modeling.

Parameters:

  • radius (~astropy.units.Quantity) – Stellar radius.

  • mass (~astropy.units.Quantity) – Stellar mass.

  • period (~astropy.units.Quantity) – Stellar rotation period.

  • mean_ptc_mass (~astropy.units.Quantity, optional) – Mean particle mass, default is 0.5 * (proton mass + electron mass).

  • verbose (bool, optional) – If True, prints verbose output. Default is False.

Methods Summary

build_model_corona(closed_fieldlines, ...[, ...])

Construct a model corona from closed and open field lines.

find_prominences(fieldline)

Identify stable points and determine prominence mass along a closed magnetic field line.

process_wind_fieldline(fieldline)

Process an open (stellar wind) magnetic field line.

Methods Documentation

build_model_corona(closed_fieldlines, open_fieldlines, rss, kappa_power, T_cor, T_prom, dtheta, dphi, distance=None)[source]#

Construct a model corona from closed and open field lines.

Parameters:

  • closed_fieldlines (list of ~astropy.table.QTable) – List of closed magnetic field lines.

  • open_fieldlines (list of ~astropy.table.QTable) – List of open magnetic field lines.

  • rss (~astropy.units.Quantity) – Source surface radius.

  • kappa_power (float) – Power-law index for pressure scaling (used in 10^-kappa_power).

  • T_cor (~astropy.units.Quantity) – Coronal temperature.

  • T_prom (~astropy.units.Quantity) – Prominence temperature.

  • dtheta (~astropy.units.Quantity) – Angular resolution in theta.

  • dphi (~astropy.units.Quantity) – Angular resolution in phi.

  • distance (~astropy.units.Quantity, optional) – Distance to the star, used for converting to observables.

Returns:

model_corona – Modeled corona containing processed field lines and associated metadata. Ready for synthetic data creation.

Return type:

~corona.ModelCorona

find_prominences(fieldline)[source]#

Identify stable points and determine prominence mass along a closed magnetic field line.

Parameters:

fieldline (~astropy.table.QTable) – Table representing the closed field line. Required columns: “radius”, “theta”, “phi”, “ds”, “Bmag”, “Brad”, “Btheta”, “Bphi”. Optional columns: “s_pos” (path position)

Returns:

fieldline – Modified field line table with prominence information added, including: “proms”, “Rhoprom”, “Mprom”, and cross-sectional/volumetric columns.

Return type:

~astropy.table.QTable

process_wind_fieldline(fieldline)[source]#

Process an open (stellar wind) magnetic field line. Note: This function contains minimal processing, and so should be overwritten for modelling that includes real treatment of the wind,

Parameters:

fieldline (~astropy.table.QTable) – Table representing the open field line. Required columns: “radius”, “theta”, “phi”, “ds”, “Bmag”, “Brad”, “Btheta”, “Bphi”. Optional columns: “s_pos” (path position)

Returns:

fieldline – Table with wind-related quantities added and placeholder prominence fields.

Return type:

~astropy.table.QTable