Extended IDL Help

This page was created by the IDL library routine mk_html_help. For more information on this routine, refer to the IDL Online Help Navigator or type:

     ? mk_html_help

at the IDL command line prompt.

Last modified: Tue Jan 4 12:52:37 2011.


List of Routines


Routine Descriptions

CI_REC_INTERP

[Next Routine] [List of Routines]
 NAME

   CI_REC_INTERP()

 PROJECT

   CHIANTI

 EXPLANATION

   For including ionization and recombination into the level balance, it's
   necessary to interpolate the data stored in the CHIANTI files and, in
   addition, perform extrapolation to lower or higher temperatures.

   This routine performs the interpolation and extrapolation for general
   input arrays.

 INPUTS

   TEMP   Temperature at which rate required. Units: K. Must be a scalar
          quantity.

   RATE_TEMP  Temperatures at which RATE is tabulated. Input as Log (base 10)
              values.

   RATE   The rate coefficient, tabulated at temperatures RATE_TEMP.

 KEYWORDS

   EXTRAP_ABOVE Extrapolation to higher temperatures will only take place
                if this keyword is set.

   EXTRAP_BELOW Extrapolation to lower temperatures will only take place
                if this keyword is set.

 OUTPUT

   The value of the rate coefficient at the temperature TEMP. If no data is
   available at the specified temperature then a value of zero is returned.

 HISTORY

   Ver.1, 29-Jun-2005, Peter Young
       adapted from original code by Enrico Landi

(See ionrec/ci_rec_interp.pro)


DESCALE_BT

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
	Florence (Italy), and the University of Cambridge (UK).
       

 NAME

     DESCALE_BT

  PURPOSE:

     This routine returns ionization energies and cross sections from scaled ionization energies 
     and cross sections using a Burgess-Tully (1992) type scaling developed for ionization
     
     

 INPUTS


    BTE       The scaled energy
    BTCROSS   The scaled cross section
    BTERR     The scaled cross section error
    F         The scaling factor - arbitrary but must be greater than 1.0
    EV1       The ionization potential in the same units as the original scaling
    

 OUTPUTS

    ENERGY    Incident electron energy in the same units as the orginal scaling.
    CROSS_SECTION  The ionization cross section
    CROSS_SECTION_ERROR  Error values for the cross section (not necessary)

 OPTIONAL INPUTS

    NONE 

 KEYWORDS

    NONE 

 CALLS

    NONE

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/descale_bt.pro)


DESCALE_SPLOM

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
	Florence (Italy), and the University of Cambridge (UK).
       

 NAME

     DESCALE_SPLOM	

  PURPOSE:

     This routine returns ionization energies and cross sections from scaled ionization energies 
     and cross sections using a Burgess-Tully (1992) type scaling developed for ionization
     
     

 INPUTS


    SPLOM     A structure returned when a .splom file is read by read_splups
    E_IN      The incident energy (Rydbergs) for which the collision strength is returned
    

 OUTPUTS

    OMEGA    The collision strength.

 OPTIONAL INPUTS

    NONE 

 KEYWORDS

    NONE 

 CALLS

    NONE

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/descale_splom.pro)


GET_IEQ

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT:  CHIANTI

      CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
      Astrophysical Plasmas. It is a collaborative project involving the Naval
      Research Laboratory (USA), the University of Florence (Italy), the
      University of Cambridge and the Rutherford Appleton Laboratory (UK). 

 NAME

      GET_IEQ()

 EXPLANATION

      For a specified ion (IZ, ION) and set of temperatures (TEMP) this 
      routine takes the ion fraction values tabulated in one of the CHIANTI 
      .IONEQ files, interpolates and extracts the values of the ion 
      fraction at the input temperatures.

 INPUTS

      TEMP   The temperature(s) at which the ion fractions are required.

      IZ     The atomic number of the element (e.g., 26 = iron).

      ION    The spectroscopic number of the ion (e.g., 13 = XIII).

 OPTIONAL INPUTS

      IONEQ_LOGT  The temperature output from the READ_IONEQ routine.

      IONEQ_FRAC  The ion fractions from the READ_IONEQ routine.

 OUTPUT

      A vector of same length as the input TEMP containing the ion 
      fractions at these temperatures.

 CALLS

      READ_IONEQ

 HISTORY

      Ver.1, 24-Jul-2002, Peter Young
      v.2, 14-Sept-2005, GDZ
      modified error message.


 VERSION 2 14-Sept-2005

(See ionrec/get_ieq.pro)


IONIZ_CROSS

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
		Florence (Italy), the University of Cambridge and the Rutherford Appleton
		Laboratory (UK).
       

 NAME

     IONIZ_CROSS

  PURPOSE:

     This routine computes the ionization cross section of an ion in cm^2.
     The cross sections are from Dere, K. P., 2007, A&A, submitted

 INPUTS

    GNAME     A string, specifying the ion name in Chianti style.  For example
              'o_6' specifies O VII or O+5.

    ENERGY    Incident electron energy in eV.


 OUTPUTS

    IONIZATION CROSS SECTION     

 OPTIONAL INPUTS

    NONE 

 KEYWORDS

    Z, ION  Z specified the nuclear charge and ion specifies the ionization state in
            Chianti style.  Both must be set.  For example, Z=8 and ION=6 specifies the
            ion 'o_6' 

 CALLS

    SCALE_BT, DESCALE_BT, READ_SPLUPS, DESCALE_SPLOM, QRP

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/ioniz_cross.pro)


IONIZ_RATE

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
               Florence (Italy), the University of Cambridge and the Rutherford Appleton
               Laboratory (UK).


 NAME

     IONIZ_RATE

  PURPOSE:

     This routine computes the ionization rate coefficient of an ion in cm^-3 s^1.
     The rates are from Dere, K. P., 2007, A&A, 466, 771

 INPUTS

    GNAME     A string, specifying the ion name in Chianti style.  For example
              'o_6' specifies O VII or O+5.

    TEMPERATURE    Temperature (K).


 OUTPUTS

    IONIZATION RATE COEFFICIENT (cm^3 s^-1)

 OPTIONAL INPUTS

    NONE

 KEYWORDS

    Z, ION  Z specified the nuclear charge and ion specifies the ionization state in
            Chianti style.  Both must be set.  For example, Z=8 and ION=6 specifies the
            ion 'o_6'

 CALLS

    SCALE_BT, DESCALE_BT, READ_SPLUPS, DESCALE_ALL

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/ioniz_rate.pro)


ION_FRAC_INTERP

[Previous Routine] [Next Routine] [List of Routines]
 NAME

   ION_FRAC_INTERP

 PROJECT

   CHIANTI

 EXPLANATION

   Performs interpolation of an ion fraction array (such as contained in
   the CHIANTI .ioneq files) to yield ion fractions at temperatures TEMP.

   Note that the ion must already have been selected before calling this
   routine, since IONEQ_FRAC is a 1D array. The routine GET_IEQ is an
   alternative if the ion has not been selected.

 INPUTS

   TEMP        Temperature(s) for which ion fractions are required. 
               Units: K.

   IONEQ_LOGT  Log (base 10) of temperature (units: K). A 1D array of
               temperatures for which the ion fraction is defined.

   IONEQ_FRAC  A 1D array of ion fractions at the temperatures defined by
               ioneq_logt

 OUTPUT

   The ion fraction defined at the temperatures TEMP. If values of TEMP lie
   outside the range of the ion fraction or the range of IONEQ_LOGT, then
   values of 0 are returned at these temperatures.

 HISTORY

   Ver.1, 10-Jun-2005, Peter Young

(See ionrec/ion_frac_interp.pro)


MAKE_IONEQ_ALL

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
               Florence (Italy), and the University of Cambridge .


 NAME

     MAKE_IONEQ_ALL

  PURPOSE:

     Calculates the ionization equilibrium for all ions with Z=1->30
     Stores the result in the users home direction.  the file name is specified
     by the variable 'outname', with a default value of 'new.ioneq'

 INPUTS


    TEMPERATURE    Temperature (K).


 OUTPUTS

    None

 OPTIONAL INPUTS

    NONE

 KEYWORDS

    outname

 CALLS


 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 3-March-2009, Ken Dere
    Ver.2, 19-May-2010, Ken Dere
         correct various errors

 VERSION     :  2, 19-May-2010

(See ionrec/make_ioneq_all.pro)


MAX_TEMP

[Previous Routine] [Next Routine] [List of Routines]

 PROJECT:  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory (USA), the University of Florence (Italy), the
       University of Cambridge and the Rutherford Appleton Laboratory (UK). 

 Name        : MAX_TEMP
               
 Purpose     : Calculates temperature at max ionisation ratio for an ion

 Explanation : 
               
 Use         : IDL> print,max_temp(ion)
    
 Inputs      :  ion - the specific ion in the form eg 'Fe_XII' or 'Fe XII'
               
 Opt. Inputs :  None
               
 Outputs     :  Function returns log of max temperature
               
 Opt. Outputs:  None
               
 Keywords    :  ALL - if set produces a plot of all temperatures
                IONEQ_NAME:  	Name of the ionization equilization name to use.
                    	    	If not passed, then the user is prompted for it.
   	    	 QUIET:     	quiet mode.

 Calls       :  Other CHIANTI routines

 Common      :
               
 Restrictions:  None
               
 Side effects:  None
               
 Category    :  Spectral
               
 Prev. Hist. :  None

 Written     :  C D Pike, RAL, 9-Jun-97
               
 Modified    :  V.2 Update element list.  CDP, 18-Jun-99 
                V.3 modified definition of XUVTOP, and allowed selection of
                ionization eq. file. Giulio Del Zanna (DAMTP) 10-Oct-2000

                V.4, Giulio Del Zanna (GDZ)
                   generalized directory concatenation to work for
                   Unix, Windows  and VMS. 

                V.5, I. Ugarte-Urra (IUU) 5-Jan-2009
   	    	    added IONEQ_NAME and QUIET keywords.
 VERSION     :   5, 5-Jan-2009, IUU 

(See ionrec/max_temp.pro)


PLOT_IONEQ

[Previous Routine] [Next Routine] [List of Routines]

 PROJECT:  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory (USA), the University of Florence (Italy), the
       University of Cambridge and the Rutherford Appleton Laboratory (UK). 
                   
 Name        : PLOT_IONEQ
               
 Purpose     : Plots the ionisation equilibrium values for an element.

 Explanation : 
               
 Use         : IDL> plot_ioneq, element [ ion=ion]
    
 Inputs      : element - the element name
               
 Opt. Inputs : Ion (as keyword)
               
 Outputs     : None
               
 Opt. Outputs: a postscript file.
               
 Keywords    : ION_RANGE - specify range of ions. E.g., ion_range=[5,8] 
                    means V to VIII inclusive.
               IONEQ_NAME:  Name of the ionization equilization name to use.
                    If not passed, then the user is prompted for it.
               NOT_INTERACTIVE Avoid interactive use.

 Calls       :  Other CHIANTI routines

 Common      :
               
 Restrictions:  None
               
 Side effects:  None
               
 Category    :  Spectral
               
 Prev. Hist. :  None

 Written     :  C D Pike, RAL, 9-Jun-97
               
 Modified    :  V.2. Update element list. modified definition of XUVTOP, and
               allowed selection of ionization eq. file and creation of
               postscript file. 
               Giulio Del Zanna  (DAMTP) 10-Oct-2000 

       V.3, Giulio Del Zanna (GDZ)
                   generalized directory concatenation to work for
                   Unix, Windows  and VMS. 

       V 4, 15-July-2002, GDZ 
         Added keywords ioneq_name, not_interactive

       V.5, 9-Feb-2005, Peter Young
            Changed ion= keyword to ion_range=

 VERSION     :    5, 9-Feb-2005


(See ionrec/plot_ioneq.pro)


RECOMB_RATE

[Previous Routine] [Next Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
		Florence (Italy), the University of Cambridge and the Rutherford Appleton
		Laboratory (UK).
       

 NAME

     RECOMB_RATE

  PURPOSE:

     This routine computes the ionization rate coefficient of an ion in cm^-3 s^1.
     The rates are from Dere, K. P., 2007, A&A, submitted

 INPUTS

    GNAME     A string, specifying the ion name in Chianti style.  For example
              'o_6' specifies O VII or O+5.

    TEMPERATURE    Temperature (K).


 OUTPUTS

    RECOMBINATION RATE COEFFICIENT (cm^3 s^-1)     

 OPTIONAL INPUTS

    NONE 

 KEYWORDS

    Z, ION  Z specified the nuclear charge and ion specifies the ionization state in
            Chianti style.  Both must be set.  For example, Z=8 and ION=6 specifies the
            ion 'o_6' 

 CALLS

    NONE

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/recomb_rate.pro)


SCALE_BT

[Previous Routine] [List of Routines]
 PROJECT     :  CHIANTI

       CHIANTI is an Atomic Database Package for Spectroscopic Diagnostics of
       Astrophysical Plasmas. It is a collaborative project involving the Naval
       Research Laboratory, George Mason University (USA), the University of
	Florence (Italy), and the University of Cambridge(UK).
       

 NAME

     SCALE_BT

  PURPOSE:

     This routine scales ionization energies and cross sections using
     a Burgess-Tully (1992) type scaling developed for ionization
     

 INPUTS


    ENERGY    Incident electron energy.
    CROSS_SECTION  The ionization cross section
    CROSS_SECTION_ERROR  Error values for the cross section (not necessary)
    F         The scaling factor - arbitrary but must be greater than 1.0
    EV1       The ionization potential in the same units as the energy
    

 OUTPUTS

    BTE       The scaled energy
    BTCROSS   The scaled cross section
    BTERR     The scaled cross section error

 OPTIONAL INPUTS

    NONE 

 KEYWORDS

    NONE 

 CALLS

    NONE

 COMMON BLOCKS

    NONE

 PROGRAMMING NOTES

    NONE

 MODIFICATION HISTORY

    Ver.1, 17-Nov-2006, Ken Dere

 VERSION     :  1, 17-Nov-2006

(See ionrec/scale_bt.pro)