ifdef MACROs

[alwinm]

A collection of ifdefs (originally compiled by @bcaddy!) and a rough estimate of their counts counted using
git grep MACRO_NAME | grep "ifdef\|ifndef\|define" | wc -l

Items near the top of the list may be easy targets for removal (low counts)

A check mark means "someone has looked at this" with some degree of certainty. Check marks do not signify whether a task has been started or completed.

Please feel free to reply/discuss in comments, and maintainers please feel free to add short blurbs to items in the list accordingly.

• GIT_HASH 0 (not an ifdef - Alwin)
• MACRO_FLAGS 0 (not an ifdef - Alwin)
• INITIAL_FRACTION_HII 1
• INITIAL_FRACTION_HEIII 1
• INITIAL_FRACTION_ELECTRON 1
• INITIAL_FRACTION_METAL 1
• NO_GHOST 1 (Read_Grid_Binary - Alwin)
• N_OUTPUT_COMPLETE 1
• N_STEPS_LIMIT 1
• N_Y 1 (this looks sus - Alwin)
• N_Z 1 (this looks sus - Alwin)
• OUTPUT_METALS 1
• OUTPUT_ELECTRONS 1
• OUTPUT_FULL_IONIZATION 1
• OUTPUT_CHEMISTRY 1
• OUTPUT_ALWAYS 1
• PRINT_DOMAIN 1
• PRINT_OMP_DOMAIN 1
• SLICES 1 (this is good- Alwin)
• WITH_GHOST 1 (Read_Grid_Binary - Alwin)
• COOLING_CPU 2 (this is good- Alwin)
• CUDA_ERROR_CHECK 2
• DISK_ICS 2 (this is good - Alwin)
• HLLD 2
• HYDRO 2 (not an ifdef - Alwin)
• INITIAL_FRACTION_HI 2
• INITIAL_FRACTION_HEII 2
• NSCALARS 2 (no ifdefs- Alwin)
• OUTPUT_ENERGY 2
• OUTPUT_MOMENTUM 2
• OUTPUT_PARTICLES_DATA 2
• PRINT_DEVICE_IDS 2
• STEEPENING 2
• TYPEDEF_DEFINED_REAL 2 (this looks sus - Alwin)
• FFTW 3
• INITIAL_FRACTION_HEI 3
• PARTICLES_KDK 3
• SET_MPI_GRID 3 (Could be set at runtime since it is only used 1 time - Alwin)
• TEXTURES_UVB_INTERPOLATION 3
• TIME_SOR 3 (merge into CPU_TIME? - Alwin)
• FLATTENING 4
• OUTPUT_POTENTIAL 4
• OUTPUT_SKEWERS_TRANSMITTED_FLUX 4
• PARTICLES_LONG_INTS 4
• PRINT_MAX_MEMORY_USAGE 4
• PARIS_3PT 5
• PARIS_5PT 5
• PARIS_GALACTIC_3PT 5
• PARIS_GALACTIC_5PT 5
• PARIS_TEST 5
• ROTATED_PROJECTION 5
• COOLING_GPU 6 (Obvious - Alwin)
• BINARY 6
• DENSITY_FLOOR 6
• H_CORRECTION 6
• OUTPUT_TEMPERATURE 6
• PRINT_ANALYSIS_LOG 6
• PROJECTION 6
• TILED_INITIAL_CONDITIONS 7
• PARIS_GALACTIC_TEST 7
• PRINT_GPU_MEMORY 8
• TEMPERATURE_FLOOR 8 (Obvious - Alwin)
• PLMP 9
• PHASE_DIAGRAM 9
• STATIC_GRAV 9 (Obvious - Alwin)
• AVERAGE_SLOW_CELLS 10 (Obvious - Alwin)
• CLOUDY_COOL 10 (Obvious - Alwin)
• GRACKLE_METALS 10
• PRINT_INITIAL_STATS 10
• PPMP 10
• ROE 10
• EXACT 11
• PLMC 11
• PPMC 11
• SIMPLE 11
• HLLC 12
• LYA_STATISTICS 12
• ONLY_PARTICLES 12
• O_HIP 12 (Obvious - Alwin)
• GRAVITY_ANALYTIC_COMP 13
• GRAVITY_5_POINTS_GRADIENT 13
• GRAV_ISOLATED_BOUNDARY_Y 14
• HALF_SIZE_BOUNDARIES 14
• PCM 14
• GRAV_ISOLATED_BOUNDARY_X 15
• GRAV_ISOLATED_BOUNDARY_Z 16
• HLL 19
• ANALYSIS 26
• PARIS_GALACTIC 26
• SOR 27
• VL 28
• COOLING_GRACKLE 30
• OUTPUT_SKEWERS 31
• PARTICLE_AGE 32 (Obvious - Alwin)
• PARALLEL_OMP 35
• CPU_TIME 37 (Obvious - Alwin)
• HDF5 38 (Obvious - Alwin)
• CHEMISTRY_GPU 39
• SINGLE_PARTICLE_MASS 41
• PARIS 42
• PARTICLE_IDS 49 (Obvious - Alwin)
• GRAVITY_GPU 54
• OUTPUT 55
• MHD 68 (Obvious - Alwin)
• PARTICLES_CPU 71
• MPI_GPU 74 (Obvious - Alwin)
• COSMOLOGY 79
• PARTICLES_GPU 98
• CUDA 113
• GRAVITY 128 (Obvious - Alwin)
• MPI_CHOLLA 142 (Obvious - Alwin)
• SCALAR 199 (Obvious - Alwin)
• PARTICLES 267 (Obvious - Alwin)
• DE 327 (Obvious - Alwin)

[alwinm]

Output related thoughts:

Perhaps Cholla should always have output enabled, hence deprecating OUTPUT (similar to how we are deprecating #ifdef CUDA)

Many of the OUTPUT_X can be replaced with runtime options (similar to what I did with out_float_x). It appears that usually we want full outputs anyway so src/io/io.cpp can be simplified a bit if we remove that flexibility.

The BINARY flag could be deprecated since it is for the ifndef HDF5 case where HDF5 is missing. Selecting an output type could be done at runtime to switch between TEXT/BINARY/HDF5 (if that's a valuable switch).

[alwinm]

Print related thoughts:

Many of the PRINT_X ifdefs may warrant scrutiny to decide whether to remove them.