Last modified: December 2023

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/xsbrnei.html
AHELP for CIAO 4.16 Sherpa

xsbrnei

Context: models

Synopsis

The XSPEC brnei model: velocity-broadened non-equilibrium recombining collisional plasma.

Syntax

xsbrnei

The xsbrnei model is an additive model component.

Description

The model is described at [1] . The set_xsxset and get_xsxset functions are used to set and query the XSPEC XSET parameters, in particular the keyword "NEIVERS".


Example

>>> create_model_component("xsbrnei", "mdl")
>>> print(mdl)

Create a component of the xsbrnei model and display its default parameters. The output is:

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.kT       thawed          0.5       0.0808         79.9        keV
   mdl.kT_init  thawed            1       0.0808         79.9        keV
   mdl.Abundanc frozen            1            0        10000           
   mdl.Tau      thawed        1e+11        1e+08        5e+13     s/cm^3
   mdl.redshift frozen            0       -0.999           10           
   mdl.Velocity frozen            0            0        10000       km/s
   mdl.norm     thawed            1            0        1e+24           

ATTRIBUTES

The attributes for this object are:

Attribute Definition
kT The temperature of the plasma, in keV.
kT_init The initial temperature of the plasma, in keV.
Abundanc The metal abundance of the plasma, as defined by the set_xsabund function.
Tau The ionization timescale in units of s/cm^3.
Redshift The redshift of the plasma.
Velocity Velocity broadening in km/s.
norm The normalization of the model: see [1] for an explanation of the units.

References

Changes in CIAO

Changed in CIAO 4.16

The maximum for the Velocity parameter has been changed from 10^6 to 10^4 km/s.

XSPEC version

CIAO 4.16 comes with support for version 12.13.1e of the XSPEC models. This can be checked with the following:

% python -c 'from sherpa.astro import xspec;
print(xspec.get_xsversion())'
12.13.1e

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

models
xsbvrnei, xsbvvrnei