enzo Analysis Parameters

Compile Flags

The define flag ENZO_ANALYSIS should only be used for compiling the stand-alone executables. This flag lets the grid class store the file names, which makes the hierarchy even bigger.

General Parameters

Variable	Parameter File Option	Member Of	Defined In	Set In	Purpose	Default
int LoadGridDataAtStart	N/A	global	global_data.h	SetDefaultGlobalValues, sfgen.C, enzoprojector.C	Control when grid data is read in	TRUE
FLOAT dtAnalysis	dtAnalysis	struct TopGridData	TopGridData.h	SetDefaultGlobalValues, ReadParameterFile	Simulation time between analysis outputs	0 = Never
char *AnalysisName	AnalysisBaseName	struct TopGridData	TopGridData.h	SetDefaultGlobalValues, ReadParameterFile	Base name for analysis outputs	"AnalysisOutput"
SFGeneratorParameters *SFGeneratorParams	StructureFunctionAnalysis	struct TopGridData	TopGridData.h	SetDefaultGlobalValues, ReadParameterFile	Pointer to structure function parameters	NULL (off)
PDFGeneratorParameters *PDFGeneratorParams	PDFAnalysis	struct TopGridData	TopGridData.h	SetDefaultGlobalValues, ReadParameterFile	Pointer to prob. dist. function parameters	NULL (off)
ProjectionParameters *ProjectionParams	Not yet implemented	struct TopGridData	TopGridData.h	SetDefaultGlobalValues, ReadParameterFile	Pointer to projection parameters	NULL (off)

Note: The PDF (probability distribution function) generator will be turned on automatically with the structure function generator.

Structure Function Generator Parameters

These parameters are set using MetaData.SFGeneratorParams; this is a pointer to a SFGeneratorParameters structure. During a simulation, the values are using the parameter file; if the frontend sfgen is being used, there are matching flags to the executable. SFGeneratorParameters is defined in AnalysisParameters.h and the defaults are all set in DefaultSFGeneratorParameters, which is in AnalysisParameters.C.

Variable	Parameter File Option	sfgen Flag	Purpose	Default
SFGeneratorParams->OutputName	AnalysisBaseName	-o <name>	Output name prefix	Simulation: "AnalysisOutput"; sfgen: parameter file name
	StructureFunctionAnalysis	N/A	Turn on structure functions	0 (off)
SFGeneratorParams->max_level	SFGeneratorMaximumLevel	-l <int level>	Maximum level of hierarchy to use	0
SFGeneratorParams->SPRNGSeed	SFGeneratorSPRNGSeed	-S <int seed>	Random number seed	-1 (generate seed)
SFGeneratorParams->num_passes	SFGeneratorNumberOfPasses	-P <int passes>	Number of times to generate point pairs	1
SFGeneratorParams->num_pdf_bins	SFGeneratorNumberOfPDFBins	-B <int pdf bins>	Number of bins in the probability distribution	100
SFGeneratorParams->num_bins	SFGeneratorNumberOfLengthBins	-b <int bins>	Number of fixed distances between points	10
SFGeneratorParams->num_pairs	SFGeneratorNumberOfPairs	-p <int pairs>	Number of point pairs, per processor, per bin, per pass	65536
SFGeneratorParams->axis_type	SFGeneratorAxisType	-a	Length bin spacing, log = FALSE, linear = TRUE	FALSE (0, log)
SFGeneratorParams->start_len	SFGeneratorStartLength	-s <float start>	Smallest fixed distance	2 X root grid cell width
SFGeneratorParams->end_len	SFGeneratorEndLength	-e <float end>	Largest fixed distance	0.5
SFGeneratorParams->output_number	SFGeneratorCurrentOutputNumber	N/A	Next output number	0
LoadGridDataAtStart	N/A	-L	Read in all grid data before analysis	FALSE (read in grids as needed)

Structure function outputs have the names OutputName.sf.PDF.foo, where foo is the interesting thing, like the difference in density.

Probability Distribution Function Generator Parameters

These parameters are set using MetaData.PDFGeneratorParams; this is a pointer to a PDFGeneratorParameters structure. During a simulation, the values are using the parameter file; if the frontend pdfgen is being used, there are matching flags to the executable. PDFGeneratorParameters is defined in AnalysisParameters.h and the defaults are all set in DefaultPDFGeneratorParameters, which is in AnalysisParameters.C. If this looks a lot like the stuff in the structure function generator, it's because I'm guilty of a lot of cutting and pasting, both here and in the code.

Variable	Parameter File Option	pdfgen Flag	Purpose	Default
PDFGeneratorParams->OutputName	AnalysisBaseName	-o <name>	Output name prefix	Simulation: "AnalysisOutput"; pdfgen: parameter file name
	PDFAnalysis	N/A	Turn on PDFs	0 (off)
PDFGeneratorParams->max_level	PDFGeneratorMaximumLevel	-l <int level>	Maximum level of hierarchy to use	0
PDFGeneratorParams->num_pdf_bins	PDFGeneratorNumberOfPDFBins	-B <int pdf bins>	Number of bins in the probability distribution	500
PDFGeneratorParams->output_number	PDFGeneratorCurrentOutputNumber	N/A	Next output number	0
LoadGridDataAtStart	N/A	-L	Read in all grid data before analysis	FALSE (read in grids as needed)

Probability distribution function outputs have the names OutputName.PDF.foo, where foo is the interesting thing, like the density.