Profile#

class pydrad.parse.Profile(hydrad_root, time: Unit('s'), **kwargs)[source]#

Bases: object

Container for HYDRAD results at a given timestep. Typically accessed through pydrad.parse.Strand

Parameters:
  • hydrad_root (path-like) – Path to HYDRAD directory

  • time (Quantity) – Timestep corresponding to the profile of interest

Attributes Summary

coordinate

Spatial coordinate, \(s\), in the field-aligned direction.

electron_density

Electron density, \(n_e\), as a function of \(s\).

electron_energy_density

Electron energy density, \(E_e\), as a function of \(s\).

electron_mass_density

electron_pressure

Electron pressure, \(P_e=(\gamma - 1)E_e\), as a function of \(s\).

electron_temperature

Electron temperature, \(T_e = P_e / (k_B n_e)\), as a function of \(s\).

grid_centers

Spatial location of the grid centers

grid_edges

Spatial location of the edges of each grid cell, including the rightmost edge

grid_edges_left

Spatial location of the left edge of each grid cell

grid_edges_right

Spatial location of the right edge of each grid cell

grid_widths

Spatial width of each grid cell

hydrogen_density

Hydrogen density, \(n_H=\rho/\bar{m_i}\), as a function of \(s\), where \(\bar{m_i}\) is the average ion mass of a H-He plasma.

hydrogen_energy_density

Hydrogen energy density, \(E_H\), as a function of \(s\).

hydrogen_pressure

Hydrogen pressure, \(P_H = (\gamma - 1)(E_H - \rho v^2/2)\), as a function of \(s\).

hydrogen_temperature

Hydrogen temperature, \(T_H = P_H / (k_B n_H)\), as a function of \(s\).

loop_length

Footpoint-to-footpoint loop length

mass_density

Mass density, \(\rho\), as a function of \(s\).

momentum_density

Momentum density, \(\rho v\), as a function of \(s\).

total_pressure

Total pressure, \(P = P_e + P_H\), as a function of \(s\).

velocity

Bulk velocity, \(v\), as a function of \(s\).

Methods Summary

column_emission_measure([bins, bounds])

Computes the column emission measure, where it is assumed that the loop is confined to a single pixel and oriented along the line of sight.

peek(**kwargs)

Quick look at profiles at a given timestep.

peek_emission_measure(**kwargs)

Quick look at the column emission measure.

spatial_average(quantity[, bounds])

Compute a spatial average of a specific quantity

to_constant_grid(name, grid)

Interpolate a given quantity onto a spatial grid that is the same at each time step.

Attributes Documentation

coordinate#

Spatial coordinate, \(s\), in the field-aligned direction.

An alias for grid_centers.

electron_density#

Electron density, \(n_e\), as a function of \(s\). In nearly all cases, this is equal to hydrogen_density.

electron_energy_density#

Electron energy density, \(E_e\), as a function of \(s\).

Note

This is a conserved quantity in HYDRAD.

electron_mass_density#
electron_pressure#

Electron pressure, \(P_e=(\gamma - 1)E_e\), as a function of \(s\).

electron_temperature#

Electron temperature, \(T_e = P_e / (k_B n_e)\), as a function of \(s\).

grid_centers#

Spatial location of the grid centers

grid_edges#

Spatial location of the edges of each grid cell, including the rightmost edge

grid_edges_left#

Spatial location of the left edge of each grid cell

grid_edges_right#

Spatial location of the right edge of each grid cell

grid_widths#

Spatial width of each grid cell

hydrogen_density#

Hydrogen density, \(n_H=\rho/\bar{m_i}\), as a function of \(s\), where \(\bar{m_i}\) is the average ion mass of a H-He plasma.

hydrogen_energy_density#

Hydrogen energy density, \(E_H\), as a function of \(s\).

Note

This is a conserved quantity in HYDRAD.

hydrogen_pressure#

Hydrogen pressure, \(P_H = (\gamma - 1)(E_H - \rho v^2/2)\), as a function of \(s\).

hydrogen_temperature#

Hydrogen temperature, \(T_H = P_H / (k_B n_H)\), as a function of \(s\).

loop_length#

Footpoint-to-footpoint loop length

mass_density#

Mass density, \(\rho\), as a function of \(s\).

Note

This is a conserved quantity in HYDRAD.

momentum_density#

Momentum density, \(\rho v\), as a function of \(s\).

Note

This is a conserved quantity in HYDRAD.

total_pressure#

Total pressure, \(P = P_e + P_H\), as a function of \(s\).

velocity#

Bulk velocity, \(v\), as a function of \(s\).

Methods Documentation

column_emission_measure(bins: Unit('K') = None, bounds: Unit('cm') = None)[source]#

Computes the column emission measure, where it is assumed that the loop is confined to a single pixel and oriented along the line of sight.

Parameters:

bins (Quantity, optional) – Temperature bin edges, including rightmost edge. If None (default), the bins will be equally-spaced in \(\log{T}\), with a left edge at \(\log{T}=3\), a right edge at \(\log{T}=8\), and a bin width of \(0.05\).

Returns:

  • em (Quantity) – The column emission measure in each bin

  • bins (Quantity) – Temperature bin edges. Note that len(bins)=len(em)+1.

peek(**kwargs)[source]#

Quick look at profiles at a given timestep.

Takes the same keyword arguments as plot_profile.

peek_emission_measure(**kwargs)[source]#

Quick look at the column emission measure.

Takes the same keyword arguments as column_emission_measure and plot_histogram.

spatial_average(quantity, bounds=None)[source]#

Compute a spatial average of a specific quantity

Parameters:
  • quantity (str) – Name of the desired quantity to average

  • bounds (Quantity, optional) – Array of length 2 specifying the range over which to take the spatial average.

to_constant_grid(name, grid)[source]#

Interpolate a given quantity onto a spatial grid that is the same at each time step.

Parameters:
  • name (str)

  • grid (Quantity) – Spatial grid on which to interpolate. If this is unitless, the interpolation is done on a grid normalized by the loop length, i.e. ranging from 0 to 1.