/home66/gary/public_html/cloudy/c10_branch/source/cddrive.cpp File Reference

#include "cddefines.h"
#include "trace.h"
#include "conv.h"
#include "init.h"
#include "lines.h"
#include "pressure.h"
#include "prt.h"
#include "colden.h"
#include "dense.h"
#include "radius.h"
#include "struc.h"
#include "mole.h"
#include "elementnames.h"
#include "mean.h"
#include "phycon.h"
#include "called.h"
#include "parse.h"
#include "input.h"
#include "taulines.h"
#include "version.h"
#include "thermal.h"
#include "optimize.h"
#include "grid.h"
#include "timesc.h"
#include "cloudy.h"
#include "warnings.h"
#include "lines_service.h"
#include "cddrive.h"
#include "noexec.h"
#include <sys/time.h>
#include <sys/resource.h>

Include dependency graph for cddrive.cpp:

Go to the source code of this file.

Functions
int	cdDrive ()
void	cdPrtWL (FILE *io, realnum wl)
void	cdReasonGeo (FILE *ioOUT)
void	cdWarnings (FILE *ioPNT)
void	cdCautions (FILE *ioOUT)
void	cdTimescales (double TTherm, double THRecom, double *TH2)
void	cdSurprises (FILE *ioOUT)
void	cdNotes (FILE *ioOUT)
double	cdCooling_last ()
void	cdVersion (char chString[])
void	cdDate (char chString[])
double	cdHeating_last ()
double	cdEDEN_last ()
void	cdNoExec ()
STATIC void	cdClock (struct timeval *clock_dat)
void	cdSetExecTime ()
double	cdExecTime ()
void	cdPrintCommands (FILE *ioOUT)
long int	cdEmis (char chLabel, realnum wavelength, double emiss)
long int	cdEmis (char chLabel, realnum wavelength, double emiss, bool lgEmergent)
void	cdEmis_ip (long int ipLine, double *emiss, bool lgEmergent)
int	cdColm (const char chLabel, long int ion, double theocl)
void	cdErrors (FILE *ioOUT)
void	cdDepth_depth (double cdDepth[])
void	cdPressure_depth (double TotalPressure[], double GasPressure[], double RadiationPressure[])
void	cdPressure_last (double PresTotal, double PresGas, double *PresRad)
long int	cdnZone ()
double	cdTemp_last ()
int	cdIonFrac (const char chLabel, long int IonStage, double fracin, const char *chWeight, bool lgDensity)
long	debugLine (realnum wavelength)
long int	cdLine (const char chLabel, realnum wavelength, double relint, double *absint)
long int	cdLine (const char chLabel, realnum wavelength, double relint, double *absint, bool lgEmergent)
void	cdLine_ip (long int ipLine, double relint, double absint)
void	cdLine_ip (long int ipLine, double relint, double absint, bool lgEmergent)
void	cdNwcns (bool lgAbort_ret, long int NumberWarnings, long int NumberCautions, long int NumberNotes, long int NumberSurprises, long int NumberTempFailures, long int NumberPresFailures, long int NumberIonFailures, long int *NumberNeFailures)
void	cdOutput (const char filename, const char mode)
void	cdInput (const char filename, const char mode)
void	cdTalk (bool lgTOn)
double	cdB21cm ()
int	cdTemp (const char chLabel, long int IonStage, double TeMean, const char *chWeight)
int	cdRead (const char *chInputLine)
void	cdClosePunchFiles ()
Variables
static bool	lgCalled = false
static struct timeval	before

Function Documentation

double cdB21cm ( )

cdB21cm returns B as measured by 21 cm assumes tangled field weighted by n(H0)/T

Definition at line 1483 of file cddrive.cpp.

References DEBUG_ENTRY, mean, SMALLFLOAT, and t_mean::TempB_HarMean.

Referenced by PrtFinal().

void cdCautions ( FILE * )

produces list of cautions

Definition at line 224 of file cddrive.cpp.

References t_warnings::chCaunln, DEBUG_ENTRY, t_warnings::ncaun, and warnings.

Referenced by cdErrors(), SaveLineIntensity(), SaveResults(), and ShowMe().

STATIC void cdClock ( struct timeval * clock_dat )

Definition at line 442 of file cddrive.cpp.

References cdEXIT, DEBUG_ENTRY, and ioQQQ.

Referenced by cdExecTime(), and cdSetExecTime().

void cdClosePunchFiles ( )

wrapper to close all save files

Definition at line 1855 of file cddrive.cpp.

References CloseSaveFiles(), and DEBUG_ENTRY.

Here is the call graph for this function:

int cdColm	(	const char *	chLabel,
		long int	ion,
		double *	theocl
	)

Definition at line 634 of file cddrive.cpp.

References t_colden::C1Colden, t_colden::C2Colden, t_colden::C3Colden, caps(), cdH2_colden(), t_elementnames::chElementNameShort, t_colden::colden, colden, DEBUG_ENTRY, elementnames, findspecies(), t_colden::He123S, molecule::hevcol, ioQQQ, ipCOL_H2g, ipCOL_H2p, ipCOL_H2s, ipCOL_H3p, ipCOL_HeHp, ipCOL_HMIN, ipHYDROGEN, LIMELM, MAX2, mean, null_mole, t_colden::O1Colden, t_colden::Si2Colden, and t_mean::xIonMean.

Referenced by lgCheckMonitors(), optimize_func(), PrtColumns(), save_average(), save_colden(), and SaveDo().

Here is the call graph for this function:

double cdCooling_last ( )

cdCooling_last The returns the total cooling (erg cm^-3 s^-1) for the last computed zone

Definition at line 331 of file cddrive.cpp.

References t_thermal::ctot, and thermal.

void cdDate ( char chString[] )

cdDate The argument is a string with at least 8 char that will receive a null terminated string with the date of the current version of the code.

Definition at line 359 of file cddrive.cpp.

References Singleton< t_version >::Inst().

Here is the call graph for this function:

void cdDepth_depth ( double cdDepth[] )

returns depth structure of previous model

Parameters:

cdDepth[]

Definition at line 921 of file cddrive.cpp.

References DEBUG_ENTRY, t_struc::depth, nzone, and struc.

int cdDrive ( )

cdDrive This command actually computes a model. It returns 0 if the calculation was successful, and 1 if an error condition was encountered

Definition at line 75 of file cddrive.cpp.

References cdEXIT, cloudy(), DEBUG_ENTRY, grid_do(), InitCoreload(), input, ioQQQ, lgAbort, lgcdInitCalled, t_optimize::lgNoVary, t_optimize::lgOptimr, t_trace::lgTrace, t_optimize::lgVaryOn, t_input::nSave, optimize, and trace.

Referenced by cdMain().

Here is the call graph for this function:

double cdEDEN_last ( )

cdEDEN_last return electron density of last zone

Definition at line 388 of file cddrive.cpp.

References dense, and t_dense::eden.

long int cdEmis	(	char *	chLabel,
		realnum	wavelength,
		double *	emiss,
		bool	lgEmergent
	)

Definition at line 548 of file cddrive.cpp.

References cap4(), caps(), DEBUG_ENTRY, t_tag_LineSv::emslin, INPUT_LINE_LENGTH, LineSave, LineSv, t_LineSave::nsum, and WavlenErrorGet().

Here is the call graph for this function:

long int cdEmis	(	char *	chLabel,
		realnum	wavelength,
		double *	emiss
	)

cdEmis This routine finds the local emissivity for any line. The first argument is the 4 character (null terminated) label as it appears in the standard output. The second argument is float wavelength as it appears in the standard output. The emissivity (erg /cm^3 /s) is returned as the last parameter. cdEms returns the index of the line in the stack if it was found, the negative of the total number of lines in the stack if it could not find the line

Parameters:

	*chLabel	4 char null terminated string label
	wavelength	line wavelength
	*emiss	the vol emissivity of this line in last computed zone
	lgEmergent	intrinsic or emergent emissivities

Returns:: return value will be index of line within stack

Definition at line 531 of file cddrive.cpp.

References cdEmis(), and DEBUG_ENTRY.

Referenced by cdEmis(), and save_line().

Here is the call graph for this function:

void cdEmis_ip	(	long int	ipLine,
		double *	emiss,
		bool	lgEmergent
	)

cdEms_ip obtain the local emissivity for a line with known index

Parameters:

	ipLine	index of the line in the stack
	*emiss	the vol emissivity of this line in last computed zone
	lgEmergent	intrinsic or emergent emissivities

Definition at line 611 of file cddrive.cpp.

References ASSERT, DEBUG_ENTRY, t_tag_LineSv::emslin, LineSave, LineSv, and t_LineSave::nsum.

Referenced by save_line().

void cdErrors ( FILE * )

cdErrors After the calculation is completed, a summary of all error messages can be be generated by calling this routine. The argument is the output file

Parameters:

[out] *ioOUT output file

Definition at line 855 of file cddrive.cpp.

References cdCautions(), cdNwcns(), cdWarnings(), t_input::chTitle, DEBUG_ENTRY, and input.

Here is the call graph for this function:

double cdExecTime ( )

cdExecTime returns the elapsed time cpu time (sec) that has elapsed since cdInit called cdSetExecTime.

Definition at line 479 of file cddrive.cpp.

References before, cdClock(), cdEXIT, DEBUG_ENTRY, ioQQQ, and lgCalled.

Referenced by cdMain(), PrtFinal(), and SaveDo().

Here is the call graph for this function:

double cdHeating_last ( )

cdHeating_last returns the total heating (erg cm^-3 s^-1) for the last computed zone

Definition at line 374 of file cddrive.cpp.

References t_thermal::htot, and thermal.

void cdInput	(	const char *	filename = `""`,
		const char *	mode = `"r"`
	)

cdInput This tells the code where to get input. The arguments are as for the stdio.h fopen call, but the resulting file pointer is checked for validity. All further input will come from this file. If filename = "", input is switched to stdin (and mode is ignored). If this routine is not called then all input will come from stdin, the standard c input

Definition at line 1452 of file cddrive.cpp.

References AS_LOCAL_ONLY, DEBUG_ENTRY, ioStdin, and open_data().

Referenced by cdMain(), and cdPrepareExit().

Here is the call graph for this function:

int cdIonFrac	(	const char *	chLabel,
		long int	IonStage,
		double *	fracin,
		const char *	chWeight,
		bool	lgDensity
	)

 * cdIonFrac
 * This returns the ionization fraction for any element included in the calculation. 
 * The first parameter is 4 char null terminated string giving the first 4 letters of
 * element name as spelled by Cloudy.  
 * The second parameter is an integer giving the ionization stage, 
 * 1 for atom, 2 for first ion, etc.
 * The third parameter returns the predicted ionization fraction of that ion stage.
 * The last parameter is an 8 character + null string that says either "volume" or "radius",
 * to specify whether the average should be weighted by volume or radius.
 * The return value is 0 if the routine could find the species and
 * non-zero if it failed to find the element

Parameters:

	*chLabel	four char string, null terminated, giving the element name
	IonStage	IonStage is ionization stage, 1 for atom, up to N+1 where N is atomic number
	*fracin	will be fractional ionization
	*chWeight	how to weight the average, must be "VOLUME" or "RADIUS"
	lgDensity	if true then weighting also has electron density, if false then only volume or radius

Definition at line 1017 of file cddrive.cpp.

References caps(), t_elementnames::chElementNameShort, DEBUG_ENTRY, elementnames, INPUT_LINE_LENGTH, ioQQQ, ipHYDROGEN, LIMELM, mean, t_mean::MeanIon(), and pow().

Referenced by DynaPunchTimeDep(), lgCheckMonitors(), and save_average().

Here is the call graph for this function:

long int cdLine	(	const char *	chLabel,
		realnum	wavelength,
		double *	relint,
		double *	absint,
		bool	lgEmergent
	)

Definition at line 1185 of file cddrive.cpp.

References ASSERT, BIGFLOAT, cap4(), t_radius::Conv2PrtInten, DEBUG_ENTRY, fp_equal(), ioQQQ, t_LineSave::ipNormWavL, LineSave, LineSv, t_LineSave::nsum, prt_wl(), radius, t_LineSave::ScaleNormLine, t_tag_LineSv::SumLine, TotalInsanity(), and WavlenErrorGet().

Here is the call graph for this function:

long int cdLine	(	const char *	chLabel,
		realnum	wavelength,
		double *	relint,
		double *	absint
	)

cdLine This routine finds the predicted intensity of any line in the standard output.

Parameters:

	*chLabel	1st parameter is the 4-char label + null terminated label, as it appears in the output.
	wavelength	2nd parameter is the float wavelength in Angstroms, not how it appears in printout. The first four digits must agree with the number in the printout, but the units must be Angstroms. 3rd parameter is the predicted intensity relative to the normalization line. 4th par is the log of the predicted luminosity or intensity of the line (ergs).
	*relint	5th is pointer to relative intensity, a double that is returned
	*absint	6th is pointer to log of absolute intensity
	lEmergent	- emergent or intrinsic intensity

Returns:: return value: The routine returns an index (>0) of the array element within stack if it finds the line, It returns the negative of the total number of lines if it could not find the line. (this is a debugging aid) note that this returns a long int since there are LOTS of lines this also IS NOT the standard C convention for success or failure

Definition at line 1172 of file cddrive.cpp.

References cdLine(), and DEBUG_ENTRY.

Referenced by cdLine(), ConvIterCheck(), Drive_cdLine(), FeIISaveLines(), IterStart(), lgCheckMonitors(), lines(), lines_table(), optimize_func(), PrtComment(), PrtFinal(), PrtLineSum(), save_line(), and SaveDo().

Here is the call graph for this function:

void cdLine_ip	(	long int	ipLine,
		double *	relint,
		double *	absint,
		bool	lgEmergent
	)

cdLine_ip get the predicted line intensity, using index for line in stack

Parameters:

	ipLine
	*relint	linear intensity relative to normalization line
	*absint	log of luminosity or intensity of line
	lgEmergent	- intrinsic or emergent intensity

Definition at line 1359 of file cddrive.cpp.

References ASSERT, t_radius::Conv2PrtInten, DEBUG_ENTRY, t_LineSave::ipNormWavL, LineSave, LineSv, t_LineSave::nsum, radius, t_LineSave::ScaleNormLine, and t_tag_LineSv::SumLine.

void cdLine_ip	(	long int	ipLine,
		double *	relint,
		double *	absint
	)

Definition at line 1349 of file cddrive.cpp.

References cdLine_ip(), and DEBUG_ENTRY.

Referenced by cdLine_ip(), lgCheckMonitors(), and PrtLineSum().

Here is the call graph for this function:

void cdNoExec ( )

cdNoExec This provides option to have the code prepare the initial conditions for a model, but not actually try to compute the model. I use this when setting up a large grid so that I can quickly run through the full grid as a check that the commands are entered properly and the parameters I am going to vary do so properly. The command is then commented out when the grid is properly set up.

Definition at line 402 of file cddrive.cpp.

References DEBUG_ENTRY, t_noexec::lgNoExec, and noexec.

void cdNotes ( FILE * )

produces list of Notes

Definition at line 307 of file cddrive.cpp.

References t_warnings::chNoteln, DEBUG_ENTRY, t_warnings::nnote, and warnings.

void cdNwcns	(	bool *	lgAbort,
		long int *	NumberWarnings,
		long int *	NumberCautions,
		long int *	NumberNotes,
		long int *	NumberSurprises,
		long int *	NumberTempFailures,
		long int *	NumberPresFailures,
		long int *	NumberIonFailures,
		long int *	NumberNeFailures
	)

cdNwcns This command returns the number of warnings, cautions, notes, surprises, assorted types of failures found the last computed model

Parameters:

	*lgAbort	abort status, if non-zero then big problems happened
	*NumberWarnings	the number of warnings
	*NumberCautions	the number of cautions
	*NumberNotes	the number of notes
	*NumberSurprises	the number of surprises
	*NumberTempFailures	the number of temperature convergence failures
	*NumberPresFailures	the number of pressure convergence failures
	*NumberIonFailures	the number of ionization convergence failures
	*NumberNeFailures	the number of electron density convergence failures

Definition at line 1404 of file cddrive.cpp.

References conv, DEBUG_ENTRY, lgAbort, t_warnings::nbang, t_warnings::ncaun, t_conv::nIonFail, t_conv::nNeFail, t_warnings::nnote, t_conv::nPreFail, t_conv::nTeFail, t_warnings::nwarn, and warnings.

Referenced by cdErrors(), and cdMain().

long int cdnZone ( )

cdnZone returns number of zones

Definition at line 994 of file cddrive.cpp.

References nzone.

void cdOutput	(	const char *	filename = `""`,
		const char *	mode = `"w"`
	)

cdOutput This tells the code where to send output. The arguments are as for the stdio.h fopen call, but the resulting file pointer is checked for validity. All further log output will go to this file. If filename = "", output is switched to stdout (and mode is ignored). If this routine is not called then all output will go to stdout, the standard c output

Definition at line 1440 of file cddrive.cpp.

References AS_LOCAL_ONLY, DEBUG_ENTRY, ioQQQ, and open_data().

Referenced by cdMain(), and cdPrepareExit().

Here is the call graph for this function:

void cdPressure_depth	(	double	TotalPressure[],
		double	GasPressure[],
		double	RadiationPressure[]
	)

cdPressure_depth This returns the pressure and its constituents for the last iteration. space was allocated in the calling routine for the vectors - before calling this, cdnZone should have been called to get the number of zones, then space allocated for the arrays

Parameters:

	TotalPressure[]	total pressure, all forms
	GasPressure[]	gas pressure
	RadiationPressure[]	radiation pressure

Definition at line 946 of file cddrive.cpp.

References DEBUG_ENTRY, t_struc::GasPressure, nzone, t_struc::pres_radiation_lines_curr, t_struc::pressure, and struc.

void cdPressure_last	(	double *	TotalPressure,
		double *	GasPressure,
		double *	RadiationPressure
	)

cdPressure_last This returns the pressure and its constituents for the last computed zone.

Parameters:

	*TotalPressure	total pressure, all forms
	*GasPressure	gas pressure
	*RadiationPressure	radiation pressure

Definition at line 973 of file cddrive.cpp.

References DEBUG_ENTRY, t_pressure::pres_radiation_lines_curr, t_pressure::PresGasCurr, pressure, and t_pressure::PresTotlCurr.

void cdPrintCommands ( FILE * )

cdPrintCommands( FILE *) This routine prints all input commands into file whose handle is the argument

Parameters:

*ioOUT

[out] output file handle

Definition at line 511 of file cddrive.cpp.

References t_input::chCardSav, input, and t_input::nSave.

Referenced by ShowMe().

void cdPrtWL	(	FILE *	io,
		realnum	wl
	)

cdPrtWL print line wavelengths in Angstroms in the standard format - a wrapper for prt_wl which must be kept parallel with sprt_wl both of those live in pdt.c

Parameters:

`[out]`	*ioOUT	output file handle
`[in]`	the	emission line wavelength

Definition at line 155 of file cddrive.cpp.

References DEBUG_ENTRY, and prt_wl().

Here is the call graph for this function:

int cdRead ( const char * )

cdRead This sends commands to the code. The normal set of commands described in Part I of Hazy must be entered into a null-terminated string. These strings are then fed to Cloudy with this command. The function returns the number of commands that can still be entered before the command stack is full. The code will stop if you try to continue giving it commands after the command has returned zero. This return value is the opposite of the standard - a non-zero return is normal

Definition at line 1674 of file cddrive.cpp.

References caps(), cdEXIT, t_input::chCardSav, DEBUG_ENTRY, GetQuote(), grid, input, INPUT_LINE_LENGTH, ioQQQ, lgcdInitCalled, t_grid::lgGrid, lgInputComment(), t_optimize::lgNoVary, t_optimize::lgOptimr, t_input::lgSetNoBuffering, t_trace::lgTrace, t_optimize::lgVaryOn, t_grid::nGridCommands, NKRD, nMatch(), t_input::nSave, optimize, strchr_s(), strstr_s(), TotalInsanity(), and trace.

Referenced by cdMain().

Here is the call graph for this function:

void cdReasonGeo ( FILE * )

This prints the reason why the model stopped, and the model geometry, on the io file pointed to by the file handle

Definition at line 173 of file cddrive.cpp.

References t_warnings::chRgcln, DEBUG_ENTRY, and warnings.

void cdSetExecTime ( )

normally called by cdInit, this routine sets initial variables for times

Definition at line 472 of file cddrive.cpp.

References before, cdClock(), and lgCalled.

Referenced by cdInit().

Here is the call graph for this function:

void cdSurprises ( FILE * )

produces list of surprises

Definition at line 280 of file cddrive.cpp.

References t_warnings::chBangln, DEBUG_ENTRY, t_warnings::nbang, and warnings.

void cdTalk ( bool )

cdTalk tells the code whether or not to produce any of its normal output, If the argument is true (or if it is not called at all) it produces output, produces no output if it is false

Definition at line 1470 of file cddrive.cpp.

References called, cpu, DEBUG_ENTRY, t_cpu::lgMPI_talk(), t_called::lgTalk, and t_called::lgTalkForcedOff.

Here is the call graph for this function:

int cdTemp	(	const char *	chLabel,
		long int	IonStage,
		double *	TeMean,
		const char *	chWeight
	)

Todo:: 2 this should have a last argument like cdIonFrac for whether or not weighting is wrt electron density

Definition at line 1524 of file cddrive.cpp.

References caps(), t_elementnames::chElementNameShort, DEBUG_ENTRY, elementnames, HFLines, INPUT_LINE_LENGTH, ioQQQ, ipH1s, ipH2p, ipH_LIKE, ipHYDROGEN, LIMELM, mean, t_mean::MeanIon(), pow(), SDIV(), SMALLFLOAT, t_mean::TempEdenMean, t_mean::TempH_21cmSpinMean, t_mean::TempHarMean, t_mean::TempIonMean, t_mean::TempMean, and Transitions.

Referenced by DynaPunchTimeDep(), lgCheckMonitors(), optimize_func(), PrtFinal(), save_average(), and timestep_next().

Here is the call graph for this function:

double cdTemp_last ( )

cdTemp_last returns the temperature of the last zone on last iteration

Definition at line 1006 of file cddrive.cpp.

References phycon, and t_phycon::te.

void cdTimescales	(	double *	TTherm,
		double *	THRecom,
		double *	TH2
	)

cdTimescales returns the longest thermal, recombination, and H2 formation timescales that occurred in the previous model

Parameters:

	*TTherm	the thermal cooling timescale
	*THRecom	the hydrogen recombination timescale
	*TH2	the H2 formation timescale

Definition at line 247 of file cddrive.cpp.

References DEBUG_ENTRY, MAX2, t_timesc::time_H2_Dest_longest, t_timesc::time_H2_Form_longest, t_timesc::time_Hrecom_long, t_timesc::time_therm_long, and timesc.

void cdVersion ( char chString[] )

cdVersion The argument is a string with at least 8 characters that will receive a null terminated string with the version number of the code.

Definition at line 344 of file cddrive.cpp.

References Singleton< t_version >::Inst().

Here is the call graph for this function:

void cdWarnings ( FILE * )

These routines produce lists of warnings, cautions, notes, surprises These are the routines that are called by cdErrors. Normally cdErrors and not these routines would be called by the user.

Definition at line 196 of file cddrive.cpp.

References t_warnings::chWarnln, DEBUG_ENTRY, t_warnings::nwarn, and warnings.

Referenced by cdErrors(), optimize_func(), SaveLineIntensity(), SaveResults(), and ShowMe().

long debugLine ( realnum wavelength )

debugLine provides a debugging hook into the main line array loops over whole array and finds every line that matches length, the wavelength, the argument to the function put breakpoint inside if test return value is number of matches, also prints all matches

Parameters:

`[in]`	the	emission line wavelength
`[out]`	the	number of matches

Definition at line 1139 of file cddrive.cpp.

References LineSave, LineSv, t_LineSave::nsum, and WavlenErrorGet().

Here is the call graph for this function:

Variable Documentation

struct timeval before [static]

Definition at line 439 of file cddrive.cpp.

Referenced by cdExecTime(), and cdSetExecTime().

bool lgCalled = false [static]

Definition at line 423 of file cddrive.cpp.

Referenced by cdExecTime(), cdSetExecTime(), ContBandsCreate(), da(), FeIIBandsCreate(), FeIIContCreate(), and ParseTable().

/home66/gary/public_html/cloudy/c10_branch/source/cddrive.cpp File Reference

Functions

Variables

Function Documentation

Variable Documentation