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  
Lists of emission lines for cdGetLineList
FeII  
Star files
Other data files 
The resolution of the continuum energy mesh 

last reviewed 2002 Dec 15


Overview

This file documents the files included in the Cloudy data distribution.  It is meant as a reminder of the purpose of the various files and is not intended as instructions for setting up the code.  Those instructions are on the web site but are summarized here.


Compiling ancillary files with the *.in input files

Certain sets of ancillary files must be generated before the code will fully 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. These input scripts should be executed after Cloudy has been compiled and is fully functional.  The following gives the script name and says what it does. 

Emergent continua from stellar atmospheres

These need to be compiled before the Atlas, Costar, Rauch, and Werner options on the table star command will function.  This step does not need to be done if these stellar continua are not needed.  The Miscellaneous Commands section of Part I of Hazy explains more about this step - see the section on compiling stellar atmospheres.

compilestars.in - will compile all the stellar atmospheres - this is the only one that need be done if all atmospheres are to be used
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
compilerauch.in - compile only the Rauch stellar atmospheres
compilewerner.in - compiles only the Werner 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 material and 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.

vanhoof_grain_model.pdf - is a document written by Peter van Hoof which describes the file formats esed to specify grain properties.  You need to study this if you want to create your own grains.

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.


The *.ini files

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

c84.ini - makes code behave more like version 84
fast.ini - this includes several commands that make the code run faster, at the expense of a less accurate simulation
honly.ini - hydrogen only init file
hheonly.ini - init file for H, He only
ism.ini turns off level 2 line, and only includes prominent elements for depleted mixture.  NB This does not add grains to the mix even though many elements are strongly depleted.  This is not consistent, and so grains should be added separately


Hummer and Storey Case B data files

The files HS_e1b.dat through HS_e8b.dat, and HS_e1a.dat through HS_e8a.dat  are from Storey P.J., Hummer D.G. 1995, MNRAS 272, 41
http://adc.gsfc.nasa.gov/adc-cgi/cat.pl?/catalogs/6/6064/


Mewe files

The files mewe_fluor.dat and mewe_nelectron.dat are tables 2 and 3 of the atomic data from Kaastra, J.S., & Mewe, R., 1993, A&AS, 97, 443

The file mewe_gbar.dat  is the Mewe data files for g-bar collision strengths.


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.


H2

to be completed ......


Lists of emission lines for cdGetLineList

These are the default lists of emission lines that can be read into arrays of emission lines by calling cdGetLineList.  This is useful when the code is being called as a subroutine of other larger codes, as a way to obtain a list of emission lines whose intensities are to be extracted from the calcualtion.  This process is described in the section of a later part of Hazy on calling Cloudy as a subroutine.  These files are meant to be changed by the user.

BLRLineList.dat, the list of lines that can be entered into an array by calling cdGetLineList
NLRLineList.dat, a  list of lines that can be entered into an array by calling cdGetLineList
strongest.dat - a minimarl list of emission lines
PDRLineList.dat, PDR_H2_LineList.dat, these are list of PDR lines, the second includes many H2 lines from the large molecule


Other data files

behar_uta.dat - these data files are from shell Behar, E., Sako, M, Kahn, S.M., 2001, ApJ, 563, 497-504 and Behar, E., & Netzer, H., 2002, ApJ, 570, 165-170
level1.dat, the main set of level 1 lines, this file is designed to be edited by humans.
level2.dat, the level 2 lines, do not edit this file!


The resolution of the continuum mesh

The file continuum_mesh.dat contains data the defines the continuum mesh used during a calculation.  It is possible to make the continuum have any resolution at all by changing this file.  The continuum resolution largely sets the execution time so be careful.  The file contains documentation of its use.


Visit www.nublado.org for more details, the latest updates, and to get on the mailing list.

Good luck!
Gary J. Ferland