Read me for Cloudy data files

Overview  
Compiling ancillary files with the *.in input files  
The *.ini files  
Hummer and Storey Case B data files  
FeII  
Star files


Overview

This file documents the files included in the Cloudy data distribution.  There are several types of definitions here.  

The first describe the purpose of the Cloudy input files that are included in the data distribution.  These have file names ending in *.in.  These are used to 


Compiling ancillary files with the *.in input files

Certain sets of ancillary files must be generated before the code will function.  These include the stellar atmospheres, grain data files, and possibly the opacities.  A series of simple input scripts are included here to do this. Each source be executed after compiling the source.  The following gives the script name and says what it does. 

Emergent continua from stellar atmospheres

These need need to be compiled before the Atlas, Costar, Rauch, and Werner options on the table star command will function.  See Stellar Atmospheres in C96 for more details. 

compilestars.in - will compile all the stellar atmospheres
compile1star.in - will compile only one of the stellar atmospheres (edit the file to determine which one).
compileatlas.in - will compile only the atlas stellar atmospheres
compilecostar.in - will compile only the CoStar stellar atmospheres

(Possibly) compiling the size-distributed grains

Compiled grain opacities must exist before the pgrains command will function.  Compiled opacities are already included in the data files (the *.opc files), so nothing need be done if you are happy with the default setup.  They would need to be recompiled if you change the energy grid of the code, or wish to use a different grain refractive index or size distribution.  Distributed grains are new in C96 and were added in collaboration with Peter van Hoof and Peter G. Martin.  These use optical properties for each grain material (the *.rfi files) and size distribution files (the *.szd files) to create grain opacities (the *.opc files) that are a function of grain size.  The code can then do a more realistic simulation of the grain emission and physics 

compilegrains.in - This will compile all the standard grains.

compile1grain.in - example of compiling a single grain type for the pgrains command to use.

new_grain_model.pdf - written by Peter van Hoof, describes the file formats needed to modify grain properties.

(Possibly) compiling the opacities

compileopac.in 

A large amount of atomic opacity data is generated by the code when it starts up.  If you execute the script compmileopac.in the code will compile the opacities and then save this information to disk.  In later calculation a small amount of time may be saved by reading this file rather than recomputing all the opacities.  This saves about 2 seconds on my PC, where the file is stored on a local SCSI disk.  Note that this option may actually loose time if you have a very fast CPU and the files are on a network drive.  

Compiled opacities are stored as the files opacity.opc and opacity.pnt. .

If the opacities are not compiled by executing this file the code will function normally, and will compute the opacities at each initialization.


The *.ini files

These are a series of files that add commands to the input stream.  They are added by including an init command that names one of the following files.  

c84.ini - makes code behave more like version 84
honly.ini - hydrogen only init file
hheonly.ini - init file for H, He only
ism.ini turns off level 2 lines, only includes prominent elements for depleted mixture.  NB does not add grains to the mix even though many elements are strongly depleted.  NB This is not consistent, and so grains should be added separately


Hummer and Storey Case B data files

The files e1b.dat - e8b.dat

from Storey P.J., Hummer D.G. Mon. Not. R. Astron. Soc. 272, 41 (1995)
http://adc.gsfc.nasa.gov/adc-cgi/cat.pl?/catalogs/6/6064/


The grain properties files, * szd, *.rfi, *.opc

These files specify the size distribution (*.szd) and refractive indices (*.rfi) for the new treatment of grain physics that is used with the pgrains command.  The *.opc files give the actual opacities used by the code.


FeII

Three files contain the data needed to set up the large FeII model ion, described in Verner et al. (1999, ApJS 120, 101.  The data formats are described following the name of the file and the reference for the data it contains.

fe2rad.dat : 

This file contains Einstein transition probabilities.  The original sources were Nahar (1995; A&A 293, 967), Quinet, LeDourneuf, & Zeipppen (1996; A&AS 120, 361), Furh, Martin, & Wiese (1988; J Phys Chem Ref Data 17, Suppl 4), Giridhar & Arellano Ferro (1995; Ref Mexicana Astron Astrofis 31, 23), and the Kurucz (1995; SAO CD ROM 23) data base if nothing else was available.

lower level number
upper level number
lower level statistical weight
upper level statistical weight
Einstein A coefficient, s**(-1)
Energy, cm**(-1)
type of transition (1 - allowed, 2 - semiforbidden, 3 - forbidden)

fe2col.dat : 

This file contains collision data.  These data are from Zhang & Pradhan (1995; A&A 293, 953), Bautista (private communication), and the g-bar approximation (Mewe 1972; A&AS 20, 215).

lower level number in Zhang and Pradhan notation, from 1 to 141
upper level number in Zhang and Pradhan notation, from 2 to 142
collision strengths at 20 temperatures,
1e3,3e3,5e3,7e3,1e4,12e3,15e3,17e3,2e4,25e3,3e4,35e3,4e4,45e3,5e4,6e4,7e4,8e
4,9e4,1e5

fe2nn.dat

nn(142) - actual level numbers for each of Zhang and Pradhan levels

fe2levels.dat

This gives the spectroscopic levels sorted in increasing order within the model atom.

fe2bands.dat

These are the bands that will be entered into the main output created by the code.  This is designed to be edited by a human.  All FeII emission within these bands is co-added and entered as a single emission line.


Star files

This web page describes how to gather all the needed star data files together, and what to then do with them.


Other data files

auger.dat, mewecoef.dat, kalpha.dat, tables of atomic data from the Kaastra & Mewe compilations

BLRLineList.dat, the list of lines that can be entered into an array by calling cdGetLineList

level1.dat, the main set of level 1 lines, edited by humans

level2.dat, the level 2 lines, do not edit this file


Visit http://nimbus.pa.uky.edu/cloudy for details and latest updates. 
Good luck,
Gary J. Ferland