cloudy trunk
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
t_save Struct Reference

#include <save.h>

Collaboration diagram for t_save:
Collaboration graph
[legend]

Public Member Functions

 t_save ()
 
 ~t_save ()
 
void SaveLineListFree (long i)
 
void SaveAverageFree (long i)
 

Data Fields

long nLineList [LIMPUN]
 
vector< char * > chLineListLabel [LIMPUN]
 
vector< realnumwlLineList [LIMPUN]
 
bool lgLineListRatio [LIMPUN]
 
long nAverageList [LIMPUN]
 
vector< char * > chAverageType [LIMPUN]
 
vector< char * > chAverageSpeciesLabel [LIMPUN]
 
vector< int > nAverageIonList [LIMPUN]
 
vector< int > nAverage2ndPar [LIMPUN]
 
FILE * ipPnunit [LIMPUN]
 
bool lgNoClobber [LIMPUN]
 
bool lgPunConv_noclobber
 
bool lgDROn_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]
 
long int nsave
 
char chSave [LIMPUN][5]
 
diatomicswhichDiatomToPrint [LIMPUN]
 
char chOpcTyp [LIMPUN][5]
 
char chHeader [LIMPUN][MAX_HEADER_SIZE]
 
const char * chNONSENSE
 
bool lgSaveToSeparateFiles [LIMPUN]
 
bool lg_separate_iterations [LIMPUN]
 
bool lgPunHeader [LIMPUN]
 
bool lgPunContinuum
 
realnum punarg [LIMPUN][3]
 
string optname [LIMPUN]
 
bool lgSaveEveryZone [LIMPUN]
 
long int nSaveEveryZone [LIMPUN]
 
char chSaveArgs [LIMPUN][5]
 
char chSaveSpecies [LIMPUN][CHARS_SPECIES]
 
bool lgPunLstIter [LIMPUN]
 
bool lgFITS [LIMPUN]
 
int FITStype [LIMPUN]
 
bool lgPunchFits
 
const char * chConPunEnr [LIMPUN]
 
long int ipConPun
 
bool lgHashEndIter [LIMPUN]
 
char chHashString [INPUT_LINE_LENGTH]
 
bool lgFLUSH
 
string chGridPrefix
 
string chFilenamePrefix
 
string chRedirectPrefix
 
string chOutputFile
 
char chPunRltType [7]
 
FILE * ipPoint
 
bool lgPunPoint
 
bool lgPunConv
 
FILE * ipPunConv
 
FILE * ipDRout
 
bool lgDROn
 
bool lgDRPLst
 
bool lgDRHash
 
bool lgTraceConvergeBase
 
bool lgTraceConvergeBaseHash
 
FILE * ipTraceConvergeBase
 
FILE * ioRecom
 
bool lgioRecom
 
long int LinEvery
 
bool lgLinEvery
 
long int ncSaveSkip
 
realnum WeakHeatCool
 
realnum Resolution
 
realnum ResolutionAbs
 
char chSpeciesDominantRates [LIMPUN][CHARS_SPECIES]
 
Energy emisfreq [LIMPUN]
 
long ipEmisFreq [LIMPUN]
 

Detailed Description

Definition at line 135 of file save.h.

Constructor & Destructor Documentation

◆ t_save()

t_save::t_save ( )
inline

Definition at line 137 of file save.h.

References FITStype, lgFITS, LIMPUN, nAverageList, and nLineList.

◆ ~t_save()

t_save::~t_save ( )
inline

Definition at line 148 of file save.h.

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

Here is the call graph for this function:

Member Function Documentation

◆ SaveAverageFree()

void t_save::SaveAverageFree ( long  i)
inline

Definition at line 164 of file save.h.

References chAverageSpeciesLabel, and chAverageType.

Referenced by parse_save_average(), and ~t_save().

◆ SaveLineListFree()

void t_save::SaveLineListFree ( long  i)
inline

Definition at line 157 of file save.h.

References chLineListLabel, and wlLineList.

Referenced by ParseSave(), and ~t_save().

Field Documentation

◆ chAverageSpeciesLabel

vector<char*> t_save::chAverageSpeciesLabel[LIMPUN]

chAverageSpeciesLabel is label for species

Definition at line 190 of file save.h.

Referenced by parse_save_average(), save_average(), and SaveAverageFree().

◆ chAverageType

vector<char*> t_save::chAverageType[LIMPUN]

chAverageType is label for type of average

Definition at line 188 of file save.h.

Referenced by parse_save_average(), save_average(), and SaveAverageFree().

◆ chConPunEnr

const char* t_save::chConPunEnr[LIMPUN]

chConPunEnr - units of continuum in save output

Definition at line 284 of file save.h.

Referenced by AnuUnit(), ChkUnits(), ParseSave(), Save1Line(), and Save1LineData().

◆ 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

Definition at line 306 of file save.h.

Referenced by cdMain(), ParseSave(), ParseSet(), and process_output().

◆ 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

Definition at line 302 of file save.h.

Referenced by cdMain(), and ParseSave().

◆ chHashString

char t_save::chHashString[INPUT_LINE_LENGTH]

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

Definition at line 295 of file save.h.

Referenced by check_grid_file(), ConvBase(), InitDefaultsPreparse(), ParseSet(), radius_first(), SaveDo(), and SaveLineStuff().

◆ chHeader

char t_save::chHeader[LIMPUN][MAX_HEADER_SIZE]

Definition at line 231 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveFilesInit().

◆ chLineListLabel

vector<char*> t_save::chLineListLabel[LIMPUN]

chLineListLabel is label for line list

Definition at line 178 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveLineListFree().

◆ chNONSENSE

const char* t_save::chNONSENSE

Definition at line 233 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveFilesInit().

◆ chOpcTyp

char t_save::chOpcTyp[LIMPUN][5]

which opacity to save out

Definition at line 229 of file save.h.

Referenced by ParseSave(), and save_opacity().

◆ chOutputFile

string t_save::chOutputFile

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

Definition at line 314 of file save.h.

Referenced by cdOutput(), cdRead(), and ParseDont().

◆ 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

Definition at line 319 of file save.h.

Referenced by ParseSave(), and SaveResults1Line().

◆ 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

Definition at line 310 of file save.h.

Referenced by cdMain(), main(), process_output(), and vary_input().

◆ chSave

char t_save::chSave[LIMPUN][5]

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

Definition at line 225 of file save.h.

Referenced by diatomics::H2_ParseSave(), ParseSave(), and SaveDo().

◆ chSaveArgs

char t_save::chSaveArgs[LIMPUN][5]

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

Definition at line 265 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveSpecies().

◆ chSaveSpecies

char t_save::chSaveSpecies[LIMPUN][CHARS_SPECIES]

Definition at line 267 of file save.h.

Referenced by ParseSave(), and SaveSpecies().

◆ chSpeciesDominantRates

char t_save::chSpeciesDominantRates[LIMPUN][CHARS_SPECIES]

Definition at line 368 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ emisfreq

Energy t_save::emisfreq[LIMPUN]

Definition at line 371 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ FITStype

int t_save::FITStype[LIMPUN]

which FITS type is in this file

Definition at line 277 of file save.h.

Referenced by ParseSave(), process_output(), and t_save().

◆ ioRecom

FILE* t_save::ioRecom

option to save recombination coefficients to external file

Definition at line 345 of file save.h.

Referenced by atmdat_3body(), CloseSaveFiles(), ion_recomb(), iso_radiative_recomb(), ParseSave(), and SaveFilesInit().

◆ ipConPun

long int t_save::ipConPun

this global variable is index of save command loop in dopunch

Definition at line 287 of file save.h.

Referenced by AnuUnit(), Save1Line(), Save1LineData(), and SaveDo().

◆ 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

Definition at line 334 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), radius_first(), radius_next(), and SaveFilesInit().

◆ ipEmisFreq

long t_save::ipEmisFreq[LIMPUN]

Definition at line 372 of file save.h.

Referenced by InitDefaultsPreparse(), and SaveDo().

◆ ipPnunit

FILE* t_save::ipPnunit[LIMPUN]

this is the file where we will direct the output

Definition at line 197 of file save.h.

Referenced by CloseSaveFiles(), parse_save_average(), ParseSave(), save_average(), SaveDo(), and SaveFilesInit().

◆ 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

Definition at line 324 of file save.h.

Referenced by CloseSaveFiles(), OpacityCreate1Element(), ParseSave(), and SaveFilesInit().

◆ ipPunConv

FILE* t_save::ipPunConv

Definition at line 329 of file save.h.

Referenced by CloseSaveFiles(), ConvIterCheck(), ParseSave(), and SaveFilesInit().

◆ ipTraceConvergeBase

FILE* t_save::ipTraceConvergeBase

Definition at line 342 of file save.h.

Referenced by CloseSaveFiles(), ConvBase(), ParseSave(), and SaveFilesInit().

◆ 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

Definition at line 242 of file save.h.

Referenced by check_grid_file(), InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ lgCumulative

bool t_save::lgCumulative[LIMPUN]

cumulative line intensities for time dependent sim

Definition at line 219 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ lgDRHash

bool t_save::lgDRHash

Definition at line 337 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and radius_first().

◆ lgDROn

bool t_save::lgDROn

Definition at line 335 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), radius_first(), radius_next(), and SaveFilesInit().

◆ lgDROn_noclobber

bool t_save::lgDROn_noclobber

Definition at line 204 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ lgDRPLst

bool t_save::lgDRPLst

Definition at line 336 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and radius_next().

◆ lgEmergent

bool t_save::lgEmergent[LIMPUN]

emergent or intrinsic line intensities

Definition at line 216 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveLineIntensity().

◆ lgFITS

bool t_save::lgFITS[LIMPUN]

flag saying that this save file is in FITS format

Definition at line 274 of file save.h.

Referenced by check_grid_file(), CloseSaveFiles(), ParseSave(), SaveDo(), and t_save().

◆ lgFLUSH

bool t_save::lgFLUSH

flush file after every iteration

Definition at line 298 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSet(), and SaveDo().

◆ 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

Definition at line 291 of file save.h.

Referenced by check_grid_file(), InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ lgioRecom

bool t_save::lgioRecom

◆ lgioRecom_noclobber

bool t_save::lgioRecom_noclobber

Definition at line 206 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ lgLineListRatio

bool t_save::lgLineListRatio[LIMPUN]

flag saying whether to take ratio (true) of pairs

Definition at line 182 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ lgLinEvery

bool t_save::lgLinEvery

Definition at line 351 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ lgNoClobber

bool t_save::lgNoClobber[LIMPUN]

option to append instead of overwrite

Definition at line 200 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ 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.

Definition at line 281 of file save.h.

◆ 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

Definition at line 251 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and PrtComment().

◆ lgPunConv

bool t_save::lgPunConv

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

Definition at line 328 of file save.h.

Referenced by CloseSaveFiles(), ConvIterCheck(), ParseSave(), and SaveFilesInit().

◆ lgPunConv_noclobber

bool t_save::lgPunConv_noclobber

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

Definition at line 203 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ lgPunHeader

bool t_save::lgPunHeader[LIMPUN]

flag saying whether we should save headers. Used in grid punches so that the header only gets punched once.

Definition at line 246 of file save.h.

Referenced by ParseSave(), PrtColumns(), SaveDo(), SaveFilesInit(), SaveSpecies(), and SaveSpeciesOne().

◆ lgPunLstIter

bool t_save::lgPunLstIter[LIMPUN]

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

Definition at line 271 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ lgPunPoint

bool t_save::lgPunPoint

Definition at line 325 of file save.h.

Referenced by CloseSaveFiles(), OpacityCreate1Element(), ParseSave(), and SaveFilesInit().

◆ lgPunPoint_noclobber

bool t_save::lgPunPoint_noclobber

Definition at line 205 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ lgQHSaveFile_noclobber

bool t_save::lgQHSaveFile_noclobber

Definition at line 207 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ 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

Definition at line 213 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveFilesInit().

◆ 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

Definition at line 261 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ lgSaveGrid_noclobber

bool t_save::lgSaveGrid_noclobber

Definition at line 209 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ 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

Definition at line 238 of file save.h.

Referenced by ParseSave(), and process_output().

◆ lgTraceConvergeBase

bool t_save::lgTraceConvergeBase

Definition at line 340 of file save.h.

Referenced by CloseSaveFiles(), ConvBase(), ParseSave(), and SaveFilesInit().

◆ lgTraceConvergeBase_noclobber

bool t_save::lgTraceConvergeBase_noclobber

Definition at line 208 of file save.h.

Referenced by CloseSaveFiles(), ParseSave(), and SaveFilesInit().

◆ lgTraceConvergeBaseHash

bool t_save::lgTraceConvergeBaseHash

Definition at line 341 of file save.h.

Referenced by ConvBase(), InitDefaultsPreparse(), and ParseSave().

◆ LinEvery

long int t_save::LinEvery

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

Definition at line 350 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ nAverage2ndPar

vector<int> t_save::nAverage2ndPar[LIMPUN]

nAverage2ndPar is set of second parameters for averages

Definition at line 194 of file save.h.

Referenced by parse_save_average(), and save_average().

◆ nAverageIonList

vector<int> t_save::nAverageIonList[LIMPUN]

nAverageIonList is set of ions for averages

Definition at line 192 of file save.h.

Referenced by parse_save_average(), and save_average().

◆ nAverageList

long t_save::nAverageList[LIMPUN]

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

Definition at line 186 of file save.h.

Referenced by parse_save_average(), save_average(), and t_save().

◆ ncSaveSkip

long int t_save::ncSaveSkip

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

Definition at line 354 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSet(), and SaveDo().

◆ nLineList

long t_save::nLineList[LIMPUN]

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

Definition at line 176 of file save.h.

Referenced by ParseSave(), SaveDo(), and t_save().

◆ nsave

long int t_save::nsave

number of save commands entered

Definition at line 222 of file save.h.

Referenced by ChkUnits(), CloseSaveFiles(), diatomics::H2_ParseSave(), InitDefaultsPreparse(), ParseSave(), ParseSet(), process_output(), and SaveDo().

◆ nSaveEveryZone

long int t_save::nSaveEveryZone[LIMPUN]

Definition at line 262 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSave(), and SaveDo().

◆ optname

string t_save::optname[LIMPUN]

punarg is set of optional arguments for the save command

Definition at line 257 of file save.h.

Referenced by ParseSave(), and SaveDo().

◆ punarg

realnum t_save::punarg[LIMPUN][3]

punarg is set of optional arguments for the save command

Definition at line 254 of file save.h.

Referenced by diatomics::H2_ParseSave(), diatomics::H2_PunchDo(), ParseSave(), save_opacity(), SaveDo(), and SaveLineIntensity().

◆ 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)

Definition at line 363 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSet(), and SaveDo().

◆ ResolutionAbs

realnum t_save::ResolutionAbs

Definition at line 366 of file save.h.

Referenced by InitDefaultsPreparse(), ParseSet(), and PrettyTransmission().

◆ 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'

Definition at line 358 of file save.h.

Referenced by CoolSave(), InitDefaultsPreparse(), ParseSet(), and SaveHeat().

◆ whichDiatomToPrint

diatomics* t_save::whichDiatomToPrint[LIMPUN]

Definition at line 226 of file save.h.

Referenced by diatomics::H2_ParseSave(), and SaveDo().

◆ wlLineList

vector<realnum> t_save::wlLineList[LIMPUN]

wlLineList is set of emission lines for LineList

Definition at line 180 of file save.h.

Referenced by ParseSave(), SaveDo(), and SaveLineListFree().


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