8.3. CXS models

8.3.1. CXS Beam Plasma Intersection

class cherab.core.model.beam.charge_exchange.BeamCXLine

Calculates emission produced by charge-exchange of plasma ions with beam species.

Parameters:

  • line (Line) – The emission line object.

  • beam (Beam) – The beam object.

  • plasma (Plasma) – The emitting plasma object.

  • atomic_data (AtomicData) – The atomic data provider.

  • lineshape (object) – The spectral line shape class. Must be a subclass of LineShapeModel. Defaults to GaussianLine.

  • lineshape_args (object) – The arguments of spectral line shape class. Defaults is None.

  • lineshape_kwargs (object) – The keyword arguments of spectral line shape class. Defaults is None.

Variables:

line (Line) – The emission line object.

>>> from cherab.core.model import BeamCXLine
>>> from cherab.core.atomic import carbon
>>> from cherab.core.model import ParametrisedZeemanTriplet
>>>
>>> cVI_8_7 = Line(carbon, 5, (8, 7))  # emission line
>>> # define plasma, beam and atomic data, plasma mast contain C6+ ions.
>>> ...
>>> # here we override default line shape class, GaussianLine,
>>> # with ParametrisedZeemanTriplet to take into account Zeeman splitting.
>>> beam_cx_line = BeamCXLine(cVI_8_7, lineshape=ParametrisedZeemanTriplet)
>>> beam.models = [beam_cx_line]
_change()

Called if the plasma, beam or the atomic data source properties change.

If the model caches calculation data that would be invalidated if its source data changes then this method may be overridden to clear the cache.

emission(beam_point, plasma_point, beam_direction, observation_direction, spectrum)

Calculate the emission for a point on the beam in a specified direction.

Models implementing this method must add their spectral response to the supplied spectrum object. The spectrum units are spectral radiance per meter (W/m^3/str/nm).

Parameters:

  • beam_point – Point in beam space.

  • plasma_point – Point in plasma space.

  • beam_direction – Beam axis direction in plasma space.

  • observation_direction – Observation direction in plasma space.

  • spectrum – Spectrum to which emission should be added.

Returns:

Updated Spectrum object.