\contentsline {chapter}{\numberline {1}Introduction}{1}
\contentsline {section}{\numberline {1}What is XSTAR?}{2}
\contentsline {section}{\numberline {2}Scope of This Document}{2}
\contentsline {section}{\numberline {3}Acknowledgments}{3}
\contentsline {section}{\numberline {4}Useful addresses}{4}
\contentsline {chapter}{\numberline {2}A Walkthrough of XSTAR}{5}
\contentsline {section}{\numberline {1}XSTAR Model: Spherical cloud}{7}
\contentsline {section}{\numberline {2}xstar Model: H II region}{9}
\contentsline {section}{\numberline {3}xstar Model: Quasar Broad Line Cloud}{11}
\contentsline {chapter}{\numberline {3}An Overview of XSTAR}{13}
\contentsline {section}{\numberline {1}Basic Operation}{13}
\contentsline {subsection}{\numberline {1.1}Important note}{13}
\contentsline {subsection}{\numberline {1.2}Command syntax}{14}
\contentsline {subsection}{\numberline {1.3}Defining input spectra}{14}
\contentsline {subsection}{\numberline {1.4}FITS Files \& Graphical Output}{14}
\contentsline {subsection}{\numberline {1.5}The Atomic Database}{15}
\contentsline {subsection}{\numberline {1.6}Supported Platforms}{15}
\contentsline {subsection}{\numberline {1.7}Installation}{15}
\contentsline {subsection}{\numberline {1.8}Subroutine XSTAR}{15}
\contentsline {section}{\numberline {2}Limitations}{16}
\contentsline {subsection}{\numberline {2.1}Temperature}{16}
\contentsline {subsection}{\numberline {2.2}Density}{16}
\contentsline {subsection}{\numberline {2.3}Column Density}{17}
\contentsline {section}{\numberline {3}Getting help}{17}
\contentsline {chapter}{\numberline {4}User Input to XSTAR}{19}
\contentsline {section}{\numberline {1}Input Parameter Summary}{19}
\contentsline {section}{\numberline {2}Description of XSTAR Parameters}{21}
\contentsline {subsection}{\numberline {2.1}Covering Fraction (cfrac)}{21}
\contentsline {subsection}{\numberline {2.2}Temperature (temperature)}{22}
\contentsline {subsection}{\numberline {2.3}Constant Pressure Switch (lcpres)}{23}
\contentsline {subsection}{\numberline {2.4}Pressure (pressure)}{23}
\contentsline {subsection}{\numberline {2.5}Density (density)}{23}
\contentsline {subsection}{\numberline {2.6}Spectrum (spectrum)}{24}
\contentsline {subsection}{\numberline {2.7}Spectrum File (spectrum\_file)}{24}
\contentsline {subsection}{\numberline {2.8}Spectrum Units (spectun)}{25}
\contentsline {subsection}{\numberline {2.9}Radiation Temperature or Alpha (trad)}{25}
\contentsline {subsection}{\numberline {2.10}Luminosity (luminosity)}{25}
\contentsline {subsection}{\numberline {2.11}column\_density}{25}
\contentsline {subsection}{\numberline {2.12}log of the ionization\_parameter= log($\xi $) or log($\Xi $) (rlogxi)}{26}
\contentsline {subsection}{\numberline {2.13}Abundances}{26}
\contentsline {subsection}{\numberline {2.14}Model Name (modelname)}{27}
\contentsline {section}{\numberline {3}The XSTAR Input Spectral Models}{28}
\contentsline {subsection}{\numberline {3.1}Summary}{28}
\contentsline {subsection}{\numberline {3.2}bbody}{28}
\contentsline {subsection}{\numberline {3.3}bremss}{28}
\contentsline {subsection}{\numberline {3.4}pow}{29}
\contentsline {subsection}{\numberline {3.5}File}{29}
\contentsline {section}{\numberline {4}Direct Editing of the Parameter File}{30}
\contentsline {section}{\numberline {5}Hidden Parameters}{30}
\contentsline {subsection}{\numberline {5.1}Number of Steps (nsteps)}{31}
\contentsline {subsection}{\numberline {5.2}write\_switch (lwrite)}{31}
\contentsline {subsection}{\numberline {5.3}print\_switch (lprint)}{32}
\contentsline {subsection}{\numberline {5.4}Courant Multiplier (emult)}{32}
\contentsline {subsection}{\numberline {5.5}Max Tau for Courant Step (taumax)}{33}
\contentsline {subsection}{\numberline {5.6}Min Electron Abundance (xeemin)}{33}
\contentsline {subsection}{\numberline {5.7}Ion Abundance Criterion for Multilevel Calculation (critf)}{33}
\contentsline {subsection}{\numberline {5.8}Turbulent Velocity (vturbi)}{34}
\contentsline {subsection}{\numberline {5.9}Number of Passes (npass)}{34}
\contentsline {subsection}{\numberline {5.10}Number of Iterations (niter)}{35}
\contentsline {subsection}{\numberline {5.11}Radius Exponent (radexp)}{35}
\contentsline {subsection}{\numberline {5.12}Number of Continuum bins (ncn2)}{36}
\contentsline {subsection}{\numberline {5.13}Loop Control (loopcontrol)}{36}
\contentsline {subsection}{\numberline {5.14}mode}{37}
\contentsline {chapter}{\numberline {5}XSTAR output}{39}
\contentsline {section}{\numberline {1}The Spectral Data File: xout\_spect1.fits}{39}
\contentsline {section}{\numberline {2}The Continuum File: xout\_cont1.fits}{40}
\contentsline {section}{\numberline {3}The Line Lumnosity File: xout\_lines1.fits}{40}
\contentsline {section}{\numberline {4}The Abundances Data File: xout\_abund1.fits}{40}
\contentsline {section}{\numberline {5}Detailed Ionic Information: xoNN\_detail.fits}{41}
\contentsline {section}{\numberline {6}Detailed Line Information: xoNN\_detal2.fits}{41}
\contentsline {section}{\numberline {7}Detailed RRC Information: xoNN\_detal3.fits}{41}
\contentsline {section}{\numberline {8}Detailed Line Information: xoNN\_detal4.fits}{42}
\contentsline {subsection}{\numberline {8.1}XSTAR Run Log: xout\_step.log}{42}
\contentsline {chapter}{\numberline {6}Problems and Pitfalls}{45}
\contentsline {subsection}{\numberline {0.1}Nickel and Iron-peak Eelements}{45}
\contentsline {subsection}{\numberline {0.2}Mtables}{46}
\contentsline {section}{\numberline {1}Execution Time}{46}
\contentsline {section}{\numberline {2}Low Density}{47}
\contentsline {section}{\numberline {3}High Density}{48}
\contentsline {section}{\numberline {4}The Energy Grid}{48}
\contentsline {section}{\numberline {5}The Ionizing Spectrum}{48}
\contentsline {section}{\numberline {6}The use of critf}{49}
\contentsline {section}{\numberline {7}Energy Budget}{49}
\contentsline {section}{\numberline {8}Column Density}{50}
\contentsline {section}{\numberline {9}Notes regarding equivalent widths of unresolved absorption lines in mtables}{50}
\contentsline {subsection}{\numberline {9.1}Bug in version 2.1k}{51}
\contentsline {chapter}{\numberline {7}XSTAR2XSPEC}{53}
\contentsline {section}{\numberline {1}Parameters}{53}
\contentsline {subsection}{\numberline {1.1}Physical Parameters}{54}
\contentsline {subsection}{\numberline {1.2}XSTAR Fixed Parameters}{55}
\contentsline {subsection}{\numberline {1.3}XSTAR2XSPEC Control parameters}{55}
\contentsline {section}{\numberline {2}Running XSTAR2XSPEC}{55}
\contentsline {subsection}{\numberline {2.1}Output}{57}
\contentsline {subsection}{\numberline {2.2}Important Notes on Mtables}{57}
\contentsline {subsection}{\numberline {2.3}Notes on Normalization}{65}
\contentsline {subsection}{\numberline {2.4}Speeding Things Up}{68}
\contentsline {section}{\numberline {3}Examples}{69}
\contentsline {subsection}{\numberline {3.1}Example 1: A grid of coronal models}{69}
\contentsline {subsection}{\numberline {3.2}Example 2: Photoionized Grid}{77}
\contentsline {subsection}{\numberline {3.3}Example 3: Photoionized Grid; Exploring the T-$\xi $ Plane}{82}
\contentsline {chapter}{\numberline {8}WARMABS}{99}
\contentsline {section}{\numberline {1}Installation, warmabs v2.43}{100}
\contentsline {subsection}{\numberline {1.1}Installation}{101}
\contentsline {section}{\numberline {2}Installation, warmabs v2.41 and earlier}{102}
\contentsline {subsection}{\numberline {2.1}Installation}{103}
\contentsline {section}{\numberline {3}warmabs}{104}
\contentsline {section}{\numberline {4}photemis}{105}
\contentsline {section}{\numberline {5}multabs}{105}
\contentsline {section}{\numberline {6}hotabs}{106}
\contentsline {section}{\numberline {7}Creating Your Own pops.fits Files}{106}
\contentsline {section}{\numberline {8}Common block `ewout'}{111}
\contentsline {section}{\numberline {9}Revisions}{115}
\contentsline {section}{\numberline {10}Limitations}{119}
\contentsline {chapter}{\numberline {9}The Physics Behind XSTAR}{121}
\contentsline {section}{\numberline {A}Assumptions}{121}
\contentsline {section}{\numberline {B}Input}{122}
\contentsline {section}{\numberline {C}Elementary Considerations}{123}
\contentsline {section}{\numberline {D}Algorithm}{124}
\contentsline {subsection}{\numberline {D.1}Atomic Level Populations}{124}
\contentsline {subsection}{\numberline {D.2}Radiative Excitation}{125}
\contentsline {subsection}{\numberline {D.3}Atomic Levels}{127}
\contentsline {subsection}{\numberline {D.4}Thermal Equilibrium}{128}
\contentsline {section}{\numberline {E}Heating and Cooling: ``Photon Point of View'' vs. ``Electron Point of View''}{129}
\contentsline {section}{\numberline {F}Recombination Continuum Emission and Escape}{130}
\contentsline {subsection}{\numberline {F.1}Line Emission and Escape}{131}
\contentsline {subsection}{\numberline {F.2}Continuum Emission}{133}
\contentsline {subsection}{\numberline {F.3}Continuum Opacity and Thomson Scattering}{134}
\contentsline {subsection}{\numberline {F.4}Continuum Transfer}{135}
\contentsline {subsection}{\numberline {F.5}Radiation Field Quantities and Transfer Details}{135}
\contentsline {subsection}{\numberline {F.6}Energy Conservation}{139}
\contentsline {subsection}{\numberline {F.7}Algorithm}{141}
\contentsline {section}{\numberline {G}Atomic Processes}{142}
\contentsline {subsection}{\numberline {G.1}Photoionization}{142}
\contentsline {subsection}{\numberline {G.2}Collisional Ionization}{143}
\contentsline {subsection}{\numberline {G.3}Recombination}{143}
\contentsline {subsection}{\numberline {G.4}Collisional Excitation and Radiative Transition Probabilities}{144}
\contentsline {subsection}{\numberline {G.5}Charge Transfer}{144}
\contentsline {chapter}{\numberline {10}Theory of Operation}{145}
\contentsline {section}{\numberline {A}XSTAR}{145}
\contentsline {subsection}{\numberline {A.1}Introduction}{145}
\contentsline {subsection}{\numberline {A.2}Programming Philosophy}{146}
\contentsline {subsection}{\numberline {A.3}List of Subroutines}{147}
\contentsline {subsubsection}{Primary Computational Subroutines}{147}
\contentsline {subsubsection}{Rate Calculation Subroutines}{148}
\contentsline {subsubsection}{Input Subroutines}{150}
\contentsline {subsubsection}{Output Subroutines}{150}
\contentsline {subsubsection}{Atomic Database Subroutines}{151}
\contentsline {subsubsection}{Miscellaneous Subroutines}{151}
\contentsline {subsection}{\numberline {A.4}Units}{153}
\contentsline {subsection}{\numberline {A.5}List of Variable Names}{154}
\contentsline {section}{\numberline {B}Flow Chart}{155}
\contentsline {section}{\numberline {C}XSTAR2XSPEC}{155}
\contentsline {subsection}{\numberline {C.1}xstar2xspec (script)}{156}
\contentsline {subsection}{\numberline {C.2}xstinitable}{156}
\contentsline {subsection}{\numberline {C.3}xstar2table}{156}
\contentsline {chapter}{\numberline {11}The Lexington Benchmarks}{159}
\contentsline {section}{\numberline {A}Introduction}{159}
\contentsline {section}{\numberline {B}Cool H II Region (benchmark 1)}{160}
\contentsline {subsection}{\numberline {B.1} Input:}{160}
\contentsline {section}{\numberline {C}Meudon H II Region (benchmark 2)}{160}
\contentsline {subsection}{\numberline {C.1} Input:}{160}
\contentsline {subsection}{\numberline {C.2}Output:}{160}
\contentsline {section}{\numberline {D}Blister H II Region (benchmark 3)}{161}
\contentsline {subsection}{\numberline {D.1} Input:}{161}
\contentsline {subsection}{\numberline {D.2}Output:}{161}
\contentsline {chapter}{\numberline {12}Troubleshooting}{163}
\contentsline {section}{\numberline {A}XSTAR}{163}
\contentsline {section}{\numberline {B}XSTAR2XSPEC}{163}
\contentsline {section}{\numberline {C}When The Above Doesn't Work}{163}
\contentsline {chapter}{\numberline {13}The Atomic Database}{165}
\contentsline {section}{\numberline {A}General Description}{165}
\contentsline {section}{\numberline {B}Utility Programs}{180}
\contentsline {section}{\numberline {C}Level Labels}{180}
\contentsline {subsection}{\numberline {C.1}Configuration strings}{180}
\contentsline {subsection}{\numberline {C.2}Term strings}{182}
\contentsline {subsection}{\numberline {C.3}Level strings}{182}
\contentsline {chapter}{\numberline {14}Obtaining and Running XSTAR}{183}
\contentsline {section}{\numberline {A}XSTAR as Part of the FTOOLS Package}{183}
\contentsline {section}{\numberline {B}XSTAR as a Standalone Package}{184}
\contentsline {section}{\numberline {C}Subroutine XSTAR}{186}
\contentsline {section}{\numberline {D}The XSTAR Web Site}{187}
\contentsline {chapter}{\numberline {15}Sample Results}{189}
\contentsline {section}{\numberline {A}From ``Photoionization and High Density Plasmas'', T. Kallman and M. Bautista, June 2000, submitted to Ap. J.}{189}
\contentsline {section}{\numberline {B} Sample Results: Low Density }{189}
\contentsline {subsection}{\numberline {B.1}Atomic Rates and Cross Sections}{189}
\contentsline {subsection}{\numberline {B.2}Ionization Balance}{191}
\contentsline {subsection}{\numberline {B.3}Heating and cooling rates}{191}
\contentsline {subsection}{\numberline {B.4}Thermal Balance Calculation}{192}
\contentsline {section}{\numberline {C} Sample Results: High Density }{192}
\contentsline {subsection}{\numberline {C.1}Density dependent recombination rates}{193}
\contentsline {subsection}{\numberline {C.2}Level populations vs. density}{194}
\contentsline {subsection}{\numberline {C.3}Heating-cooling vs. density}{194}
\contentsline {subsection}{\numberline {C.4}Thermal Equilibrium}{195}
\contentsline {subsection}{\numberline {C.5}Ionization distribution, high n}{196}
\contentsline {subsection}{\numberline {C.6}Warm absorber, high density}{196}
\contentsline {subsection}{\numberline {C.7}Recombination emission, high density}{196}
\contentsline {subsection}{\numberline {C.8}The effects of stimulated recombination}{197}
\contentsline {chapter}{\numberline {16}Sample Results, Continued}{215}
\contentsline {chapter}{\numberline {17}Revisions}{227}
\contentsline {section}{\numberline {A}Version 2.1 (June 2000)}{227}
\contentsline {subsection}{\numberline {A.1}Version 2.1a (December 2000)}{228}
\contentsline {subsection}{\numberline {A.2}Version 2.1b (January 2001)}{228}
\contentsline {subsection}{\numberline {A.3}Version 2.1c (May 2001)}{228}
\contentsline {subsection}{\numberline {A.4}Version 2.1d (May 2001)}{229}
\contentsline {subsection}{\numberline {A.5}Version 2.1e (June 2001)}{229}
\contentsline {subsection}{\numberline {A.6}Version 2.1h (June 2002)}{229}
\contentsline {subsection}{\numberline {A.7}Version 2.1j (September 2003)}{230}
\contentsline {subsection}{\numberline {A.8}Version 2.1k (May 2004)}{231}
\contentsline {subsection}{\numberline {A.9}Version 2.1kn3 (April 2005)}{231}
\contentsline {subsection}{\numberline {A.10}Version 2.1kn4 (April 2005)}{232}
\contentsline {subsection}{\numberline {A.11}Version 2.1kn5 (March (?) 2006)}{232}
\contentsline {subsection}{\numberline {A.12}Version 2.1kn6 (June 2006)}{233}
\contentsline {subsection}{\numberline {A.13}Version 2.1kn7 (March 2007)}{233}
\contentsline {subsection}{\numberline {A.14}Version 2.1kn7 (December 2007)}{233}
\contentsline {subsection}{\numberline {A.15}Version 2.1l}{233}
\contentsline {subsection}{\numberline {A.16}Version 2.1ln3}{234}
\contentsline {subsection}{\numberline {A.17}Version 2.1ln4}{234}
\contentsline {subsection}{\numberline {A.18}Version 2.1ln5}{234}
\contentsline {subsection}{\numberline {A.19}Version 2.1ln6}{235}
\contentsline {subsection}{\numberline {A.20}Version 2.1ln7}{235}
\contentsline {subsection}{\numberline {A.21}Version 2.1kn9/v2.1ln9 (November 2008)}{235}
\contentsline {subsection}{\numberline {A.22}Version v2.1ln10 (May 2009)}{235}
\contentsline {subsection}{\numberline {A.23}Version v2.1ln11 (May 2009)}{236}
\contentsline {section}{\numberline {B}Version v2.2.0 (November 2009)}{236}
\contentsline {subsection}{\numberline {B.1}Version v2.2.1 (April 2010)}{237}
\contentsline {subsection}{\numberline {B.2}Version v2.2.1bc (September 2010)}{237}
\contentsline {subsection}{\numberline {B.3}Version v2.2.1bg (May 2011)}{237}
\contentsline {subsection}{\numberline {B.4}Version v2.2.1bh (September 2011)}{238}
\contentsline {subsection}{\numberline {B.5}Version v2.2.1bk (January 2012)}{238}
\contentsline {subsection}{\numberline {B.6}Version v2.2.1bn (July 2012)}{238}
\contentsline {subsection}{\numberline {B.7}Version v2.2.1bn7 (August 2012)}{239}
\contentsline {subsection}{\numberline {B.8}Version v2.2.1bn8 (August 2012)}{239}
\contentsline {subsection}{\numberline {B.9}Version v2.2.1bn10 (August 2012)}{239}
\contentsline {subsection}{\numberline {B.10}Version v2.2.1bn11 (November 2012)}{239}
\contentsline {subsection}{\numberline {B.11}Version v2.2.1bn13 (November 2012)}{239}
\contentsline {subsection}{\numberline {B.12}Version v2.2.1bn14 (April 2013)}{240}
\contentsline {subsection}{\numberline {B.13}Version v2.2.1bn15 (July 2013)}{240}
\contentsline {subsection}{\numberline {B.14}Version v2.2.1bn16 (Sept. 2013)}{240}
\contentsline {subsection}{\numberline {B.15}Version v2.2.1bn17 (Dec. 2013)}{241}
\contentsline {subsection}{\numberline {B.16}Version v2.2.1bn18 (Jan. 2014)}{242}
\contentsline {subsection}{\numberline {B.17}Version v2.2.1bn19 (Mar. 2014)}{243}
\contentsline {subsection}{\numberline {B.18}Version v2.2.1bn20 (Mar. 2014)}{243}
\contentsline {subsection}{\numberline {B.19}Version v2.2.1bn21 (May. 2014)}{243}
\contentsline {subsection}{\numberline {B.20}Version v2.2.1bn22 (September. 2014)}{243}
\contentsline {subsection}{\numberline {B.21}Version v2.2.1bn24 (July. 2015)}{244}
\contentsline {subsection}{\numberline {B.22}Version v2.3 (January. 2016)}{244}
\contentsline {subsection}{\numberline {B.23}Version v2.31 (May. 2016)}{244}
\contentsline {subsection}{\numberline {B.24}Version v2.33 (May. 2016)}{245}
\contentsline {subsection}{\numberline {B.25}Version v2.35 (August 2016)}{245}
\contentsline {subsection}{\numberline {B.26}Version v2.36 (October 2016)}{245}
\contentsline {subsection}{\numberline {B.27}Version v2.37 (October 2016)}{245}
\contentsline {subsection}{\numberline {B.28}Version v2.38 (November 2016)}{246}
\contentsline {subsection}{\numberline {B.29}Version v2.38 (December 2016)}{246}
\contentsline {subsection}{\numberline {B.30}Version v2.39 (March 2017)}{246}
\contentsline {subsection}{\numberline {B.31}Version v2.41 (May 2017)}{247}
\contentsline {subsection}{\numberline {B.32}Version v2.43 (Oct 2017)}{247}
\contentsline {subsection}{\numberline {B.33}Version v2.44 (March 2018)}{248}
\contentsline {subsection}{\numberline {B.34}Version v2.51 (April 2018)}{248}
\contentsline {subsection}{\numberline {B.35}Version v2.52 (June 2018)}{248}
\contentsline {subsection}{\numberline {B.36}Version v2.53 (June 2018)}{248}
\contentsline {subsection}{\numberline {B.37}Version v2.54 (December 2018)}{249}
\contentsline {subsection}{\numberline {B.38}Version v2.54a (January 2020)}{249}
\contentsline {subsection}{\numberline {B.39}Version v2.56f (November 2020)}{249}
\contentsline {subsection}{\numberline {B.40}Version v2.57 (May 2021)}{250}
\contentsline {subsection}{\numberline {B.41}Version v2.58a (July 2021)}{250}
\contentsline {subsection}{\numberline {B.42}Version v2.58b (August 2021)}{250}
\contentsline {subsection}{\numberline {B.43}Version v2.58d (September 2021)}{250}
\contentsline {subsection}{\numberline {B.44}Version v2.58d (December 2021)}{251}