t_save Struct Reference

#include <save.h>

Collaboration diagram for t_save:

Public Member Functions
	t_save ()
	~t_save ()
void	SaveLineListFree (long i)
void	SaveAverageFree (long i)
string	chGridDelimeter (long n)
void	SetSaveHeaderNeeded (bool lgVal)
bool	lgSaveTitle (int ipPun) const
void	SaveTitleDone (int ipPun)
bool	lgSaveHeader (int ipPun) const
void	SaveHeaderDone (int ipPun)

Public Attributes
long	nLineList [LIMPUN]
vector< LineID >	LineList [LIMPUN]
bool	lgLineListRatio [LIMPUN]
long	nAverageList [LIMPUN]
vector< string >	chAverageType [LIMPUN]
vector< int >	nAverageIonList [LIMPUN]
vector< int >	nAverage2ndPar [LIMPUN]
SaveParams	params [LIMPUN]
vector< string >	chFileName
long	ipSaveGrid
bool	lgNoClobber [LIMPUN]
bool	lgPrtOldStyleLogs [LIMPUN]
bool	lgPunConv_noclobber
bool	lgDROn_noclobber
bool	lgDTOn_noclobber
bool	lgPunPoint_noclobber
bool	lgioRecom_noclobber
bool	lgQHSaveFile_noclobber
bool	lgTraceConvergeBase_noclobber
bool	lgSaveGrid_noclobber
bool	lgRealSave [LIMPUN]
bool	lgEmergent [LIMPUN]
bool	lgCumulative [LIMPUN]
bool	lgSubtrCont
bool	lgPrtIsotropicCont [LIMPUN]
long int	nsave
char	chSave [LIMPUN][5]
diatomics *	whichDiatomToPrint [LIMPUN]
char	chOpcTyp [LIMPUN][5]
bool	lgSaveToSeparateFiles [LIMPUN]
bool	lg_separate_iterations [LIMPUN]
bool	lgPunContinuum
realnum	punarg [LIMPUN][3]
string	optname [LIMPUN]
bool	lgSaveEveryZone [LIMPUN]
long int	nSaveEveryZone [LIMPUN]
char	chSaveArgs [LIMPUN][5]
vector< string >	chSaveSpecies [LIMPUN]
bool	lgPunLstIter [LIMPUN]
bool	lgFITS [LIMPUN]
bool	lgXSPEC [LIMPUN]
int	FITStype [LIMPUN]
bool	lgPunchFits
const char *	chConSavEnr [LIMPUN]
long int	ipConPun
bool	lgHashEndIter [LIMPUN]
string	chHashString
bool	lgFLUSH
bool	lgLuminosityOld
string	chGridPrefix
string	chFilenamePrefix
string	chRedirectPrefix
string	chOutputFile
char	chPunRltType [7]
FILE *	ipPoint
bool	lgPunPoint
bool	lgPunConv
FILE *	ipPunConv
bool	lgSDSOn
FILE *	ipSDSFile
FILE *	ipDRout
bool	lgDROn
bool	lgDRPLst
bool	lgDRHash
FILE *	ipDTout
bool	lgDTOn
bool	lgDTPLst
bool	lgDTHash
bool	lgTraceConvergeBase
bool	lgTraceConvergeBaseHash
FILE *	ipTraceConvergeBase
FILE *	ioRecom
bool	lgioRecom
long int	LinEvery
bool	lgLinEvery
long int	ncSaveSkip
realnum	WeakHeatCool
realnum	Resolution
realnum	ResolutionAbs
string	chSpeciesDominantRates [LIMPUN]
Energy	emisfreq [LIMPUN]
long	ipEmisFreq [LIMPUN]
bool	lgSaveDataWn
bool	lgSaveDataGf
bool	lgSaveDataRates
vector< string >	contSaveSpeciesLabel
vector< adjPseudoCont >	setPseudoCont
string	SpeciesBandFile [LIMPUN]
save_img_matrix	img_matrix

Private Attributes
bool	p_lgSaveTitleDone [LIMPUN]
bool	p_lgSaveHeaderDone [LIMPUN]
bool	p_lgSaveHeaderNeeded

Constructor & Destructor Documentation

t_save()

t_save::t_save ( )

inline

References FITStype, ipSaveGrid, lgFITS, lgXSPEC, LIMPUN, nAverageList, nLineList, p_lgSaveHeaderDone, p_lgSaveHeaderNeeded, and p_lgSaveTitleDone.

~t_save()

t_save::~t_save ( )

inline

References LIMPUN, SaveAverageFree(), and SaveLineListFree().

Here is the call graph for this function:

Member Function Documentation

chGridDelimeter()

string t_save::chGridDelimeter ( long n )

inline

References chHashString.

lgSaveHeader()

bool t_save::lgSaveHeader ( int ipPun ) const

inline

is it OK to save header now?

References ipPun, p_lgSaveHeaderDone, and p_lgSaveHeaderNeeded.

lgSaveTitle()

bool t_save::lgSaveTitle ( int ipPun ) const

inline

is it OK to save title now?

References ipPun, p_lgSaveHeaderNeeded, and p_lgSaveTitleDone.

SaveAverageFree()

void t_save::SaveAverageFree ( long i )

inline

References chAverageType, chSaveSpecies, nAverage2ndPar, nAverageIonList, and nAverageList.

Referenced by ~t_save().

SaveHeaderDone()

void t_save::SaveHeaderDone ( int ipPun )

inline

References ipPun, and p_lgSaveHeaderDone.

SaveLineListFree()

void t_save::SaveLineListFree ( long i )

inline

References LineList.

Referenced by ~t_save().

SaveTitleDone()

void t_save::SaveTitleDone ( int ipPun )

inline

References ipPun, and p_lgSaveTitleDone.

SetSaveHeaderNeeded()

void t_save::SetSaveHeaderNeeded ( bool lgVal )

inline

References p_lgSaveHeaderNeeded.

Member Data Documentation

chAverageType

vector<string> t_save::chAverageType[LIMPUN]

chAverageType is label for type of average

Referenced by SaveAverageFree().

chConSavEnr

const char* t_save::chConSavEnr[LIMPUN]

chConPunEnr - units of continuum in save output

chFileName

vector<string> t_save::chFileName

the filename is needed during the file gathering phase in grid runs

chFilenamePrefix

string t_save::chFilenamePrefix

this is a prefix that will be set at the start of all save file names normally an empty string, set with PUNCH PREFIX command or -p flag

chGridPrefix

string t_save::chGridPrefix

this is a prefix that will be used at the start of all file names when doing an MPI grid run, normally an empty string, set with -g flag

chHashString

string t_save::chHashString

this is the hash string, normally a set of hash marks, can be reset with set save hash command

Referenced by chGridDelimeter().

chOpcTyp

char t_save::chOpcTyp[LIMPUN][5]

which opacity to save out

chOutputFile

string t_save::chOutputFile

this is the name of the main output file we are writing to it is set by calling cdOutput()

chPunRltType

char t_save::chPunRltType[7]

set with save line intensities and save results commands, says whether results arrays produced by routine PunResults1Line should be column or array

chRedirectPrefix

string t_save::chRedirectPrefix

this is the prefix that will be set at the start of the input and output file normally an empty string, set with -p or -r flag

chSave

char t_save::chSave[LIMPUN][5]

chSave - what is it we want to save? set in GetPunch, used in DoPunch

chSaveArgs

char t_save::chSaveArgs[LIMPUN][5]

set of optional arguments for save command, but as a string

chSaveSpecies

vector<string> t_save::chSaveSpecies[LIMPUN]

Referenced by SaveAverageFree().

chSpeciesDominantRates

string t_save::chSpeciesDominantRates[LIMPUN]

contSaveSpeciesLabel

vector<string> t_save::contSaveSpeciesLabel

Parameters for saving the pseudocontinuum

emisfreq

Energy t_save::emisfreq[LIMPUN]

FITStype

int t_save::FITStype[LIMPUN]

which FITS type is in this file

Referenced by t_save().

img_matrix

save_img_matrix t_save::img_matrix

ioRecom

FILE* t_save::ioRecom

option to save recombination coefficients to external file

ipConPun

long int t_save::ipConPun

this global variable is index of save command loop in dopunch

ipDRout

FILE* t_save::ipDRout

these control saving choice of dr - this is not really a save command ipDRout is io unit, lgDROn says saving dr logic has been set, and lgDRPLst says to save the last iteration

ipDTout

FILE* t_save::ipDTout

Likewise for saving choice of dt

ipEmisFreq

long t_save::ipEmisFreq[LIMPUN]

ipPoint

FILE* t_save::ipPoint

option to save out pointers with save pointers command ipPoint is save file handle, lgPunPoint says whether we will do it

ipPunConv

FILE* t_save::ipPunConv

ipSaveGrid

long t_save::ipSaveGrid

pointer into chFileName for the name of the SAVE GRID file

Referenced by t_save().

ipSDSFile

FILE* t_save::ipSDSFile

ipTraceConvergeBase

FILE* t_save::ipTraceConvergeBase

lg_separate_iterations

bool t_save::lg_separate_iterations[LIMPUN]

option to not insert end-of-iteration separator - used for save files that create one line per iteration

lgCumulative

bool t_save::lgCumulative[LIMPUN]

cumulative line intensities for time dependent sim

lgDRHash

bool t_save::lgDRHash

lgDROn

bool t_save::lgDROn

lgDROn_noclobber

bool t_save::lgDROn_noclobber

lgDRPLst

bool t_save::lgDRPLst

lgDTHash

bool t_save::lgDTHash

lgDTOn

bool t_save::lgDTOn

lgDTOn_noclobber

bool t_save::lgDTOn_noclobber

lgDTPLst

bool t_save::lgDTPLst

lgEmergent

bool t_save::lgEmergent[LIMPUN]

emergent or intrinsic line intensities

lgFITS

bool t_save::lgFITS[LIMPUN]

flag saying that this save file is in FITS format

Referenced by t_save().

lgFLUSH

bool t_save::lgFLUSH

flush file after every iteration

lgHashEndIter

bool t_save::lgHashEndIter[LIMPUN]

should hash marks be printed after every iteration? default is yes, set no with no hash option on save command

lgioRecom

bool t_save::lgioRecom

lgioRecom_noclobber

bool t_save::lgioRecom_noclobber

lgLineListRatio

bool t_save::lgLineListRatio[LIMPUN]

flag saying whether to take ratio (true) of pairs

lgLinEvery

bool t_save::lgLinEvery

lgLuminosityOld

bool t_save::lgLuminosityOld

in save continuum output, in the luminosity case, use old style of luminosity per inner cloud area rather than true luminosity

lgNoClobber

bool t_save::lgNoClobber[LIMPUN]

option to append instead of overwrite

lgPrtIsotropicCont

bool t_save::lgPrtIsotropicCont[LIMPUN]

option to remove isotropic continua from the output of 'save continuum'

lgPrtOldStyleLogs

bool t_save::lgPrtOldStyleLogs[LIMPUN]

print old style logs

lgPunchFits

bool t_save::lgPunchFits

option to say whether any FITS output should be punched, initialized to false, but turned to true after last grid exec.

lgPunContinuum

bool t_save::lgPunContinuum

flag saying whether any save continuum commands were entered set true in parsecontinuum when save continuum entered, used in PrtComment to warn if continuum punched with no iterations

lgPunConv

bool t_save::lgPunConv

unit number, and flag, for saving reason for continued iterations

lgPunConv_noclobber

bool t_save::lgPunConv_noclobber

these are for some special cases, same purpose as previous no clobber

lgPunLstIter

bool t_save::lgPunLstIter[LIMPUN]

lg flag lgPunLstIter for this save option, do we only want to save on last iteration?

lgPunPoint

bool t_save::lgPunPoint

lgPunPoint_noclobber

bool t_save::lgPunPoint_noclobber

lgQHSaveFile_noclobber

bool t_save::lgQHSaveFile_noclobber

lgRealSave

bool t_save::lgRealSave[LIMPUN]

is this a real save command, or one of the similar options like save dr, which is not done in save files

lgSaveDataGf

bool t_save::lgSaveDataGf

lgSaveDataRates

bool t_save::lgSaveDataRates

lgSaveDataWn

bool t_save::lgSaveDataWn

lgSaveEveryZone

bool t_save::lgSaveEveryZone[LIMPUN]

implement save every option - lgSaveEveryZone true if want to save every zone, nSaveEveryZone is number of zones to save

lgSaveGrid_noclobber

bool t_save::lgSaveGrid_noclobber

lgSaveToSeparateFiles

bool t_save::lgSaveToSeparateFiles[LIMPUN]

this flag tells us whether to save results of a grid to separate files for each grid point or all to the same file. Different for different save commands

lgSDSOn

bool t_save::lgSDSOn

Identify whether Save Data Sources is on

lgSubtrCont

bool t_save::lgSubtrCont

user-defined option to subtract continuum in reported line flux

lgTraceConvergeBase

bool t_save::lgTraceConvergeBase

lgTraceConvergeBase_noclobber

bool t_save::lgTraceConvergeBase_noclobber

lgTraceConvergeBaseHash

bool t_save::lgTraceConvergeBaseHash

lgXSPEC

bool t_save::lgXSPEC[LIMPUN]

flag saying that this save file is in XSPEC format

Referenced by t_save().

LineList

vector<LineID> t_save::LineList[LIMPUN]

LineID's for line list

Referenced by SaveLineListFree().

LinEvery

long int t_save::LinEvery

option to save line intensities every for every zone logical variable says whether LinEvery was set

nAverage2ndPar

vector<int> t_save::nAverage2ndPar[LIMPUN]

nAverage2ndPar is set of second parameters for averages

Referenced by SaveAverageFree().

nAverageIonList

vector<int> t_save::nAverageIonList[LIMPUN]

nAverageIonList is set of ions for averages

Referenced by SaveAverageFree().

nAverageList

long t_save::nAverageList[LIMPUN]

following are for save averages option nAverageList is number of averages, -1 if not defined

Referenced by SaveAverageFree(), and t_save().

ncSaveSkip

long int t_save::ncSaveSkip

set skip sets this variable, which says how many cells to skip in save

nLineList

long t_save::nLineList[LIMPUN]

following are for save LineList option nLineList is number of em lines, -1 if not defined

Referenced by t_save().

nsave

long int t_save::nsave

number of save commands entered

nSaveEveryZone

long int t_save::nSaveEveryZone[LIMPUN]

optname

string t_save::optname[LIMPUN]

punarg is set of optional arguments for the save command

p_lgSaveHeaderDone

bool t_save::p_lgSaveHeaderDone[LIMPUN]

private

flag saying whether the header has been saved already. Used in grid runs so that the header only gets saved once.

Referenced by lgSaveHeader(), SaveHeaderDone(), and t_save().

p_lgSaveHeaderNeeded

bool t_save::p_lgSaveHeaderNeeded

private

flag saying whether a header is needed at all Used in grid runs so that the header only gets saved once.

Referenced by lgSaveHeader(), lgSaveTitle(), SetSaveHeaderNeeded(), and t_save().

p_lgSaveTitleDone

bool t_save::p_lgSaveTitleDone[LIMPUN]

private

flag saying whether the title has been saved already. Used in grid runs so that the title only gets saved once.

Referenced by lgSaveTitle(), SaveTitleDone(), and t_save().

params

SaveParams t_save::params[LIMPUN]

this is the file where we will direct the output

punarg

realnum t_save::punarg[LIMPUN][3]

punarg is set of optional arguments for the save command

Resolution

realnum t_save::Resolution

contrast factor for lines to continuum in save output default is 1 (gives correct line intensities) and changed with set width command (enters width in km/sec)

ResolutionAbs

realnum t_save::ResolutionAbs

setPseudoCont

vector<adjPseudoCont> t_save::setPseudoCont

SpeciesBandFile

string t_save::SpeciesBandFile[LIMPUN]

Parameters for species bands

WeakHeatCool

realnum t_save::WeakHeatCool

threshold for faintest cooling or heating to be punched default is set to 0.05 in scalar, can be reset with 'set weakheatcool'

whichDiatomToPrint

diatomics* t_save::whichDiatomToPrint[LIMPUN]

---

The documentation for this struct was generated from the following file:

• save.h