Lodge It

# coding=utf-8
#===============================================
#HOME INFORMATION
#===============================================
pd_source_dir = '/home/desika.narayanan/pd_git/'

#===============================================
#RESOLUTION KEYWORDS
#===============================================
oref = 0 # over refine factor - should typically be set to 0
n_ref = 128 # when n_particles > n_ref, octree refines further
zoom_box_len = 100 # kpc; so the box will be +/- zoom_box_len from the center
bbox_lim = 1.e5 # kpc - this is the initial bounding box of the grid (+/- bbox_lim)
                # This *must* encompass all of the particles in the
                # simulation. 

#===============================================
#PARALLELIZATION
#===============================================

n_processes = 16 # number of pool processes to run for stellar SED generation
n_MPI_processes = 1 # number of MPI tasks to run. for TORQUE this is
                     # best set as the same as n_processes, while for SLURM this may not be the case.

#===============================================
#RT INFORMATION
#===============================================
n_photons_initial = 1.e6
n_photons_imaging = 1.e6
n_photons_raytracing_sources = 1.e6
n_photons_raytracing_dust = 1.e6

FORCE_RANDOM_SEED = False
seed = -12345 # has to be an int, and negative.

#===============================================
#DUST INFORMATION 
#===============================================
dustdir = '/home/desika.narayanan/hyperion-dust-0.1.0/dust_files/' #location of your dust files
dustfile = 'd03_3.1_6.0_A.hdf5'
PAH = False

dust_grid_type = 'dtm' # needs to be in ['dtm','rr','manual','li_bestfit','li_ml']
dusttometals_ratio = 0.25 # skirt assumes 0.25: see http://www.skirt.ugent.be/tutorials/_tutorial_hydro_s_p_h.html ("dust system"subheading)
enforce_energy_range = False # False is the default;  ensures energy conservation

SUBLIMATION = True  # do we automatically kill dust grains above the
                    # sublimation temperature; right now is set to fast
                    # mode 
SUBLIMATION_TEMPERATURE = 1600. #K -- meaningliess if SUBLIMATION == False

#===============================================
#STELLAR SEDS INFO
#===============================================
FORCE_BINNED = True               # If True, force all star particles to be binned for calculating SED. 
                                  # If False, all star particles below max_age_direct (next parameter) are added 
                                  # directly without binning for calculating SED
max_age_direct  = 1.e-2           # Age (in Gyr) below which stars will be directly added without binning (works only if FORCE_BINNED is False)

imf_type = 2 # FSPS imf types; 0 = salpeter, 1 = chabrier; 2 = kroupa; 3 and 4 (vandokkum/dave) not currently supported
imf1 = 1.3 # Logarithmic slope of the IMF over the range 0.08 < M < 0.5. Only used if imf_type=2. (Default: 1.3)
imf2 = 2.3 # Logarithmic slope of the IMF over the range 0.5 < M < 1.0. Only used if imf_type=2. (Default: 2.3)
imf3 = 2.3 # Logarithmic slope of the IMF over the range 1.0 < M < 120. Only used if imf_type=2. (Default: 2.3)

pagb = 1 # weight given to post agb stars# 1 is the default

add_agb_dust_model = False    # add circumstellar AGB dust model (100%); Villaume, Conroy & Jonson 2015

use_cmdf = False     # If True, star particles that fit the criteria for nebular emission (see next section) are broken down 
                     # using a cluster mass distribution function (cmdf) even if nebular emission is turned off (add_nebular_emission = False). 
                     # This allows for one to one comparison of models with and without nebular emission. The cmdf is set by the following 
                     # parameters defined under nebular emission info (next section): cmdf_min_mass, cmdf_max_mass, cmdf_bins and cmdf_beta.

#===============================================
#NEBULAR EMISSION INFO
#===============================================
add_neb_emission = False    			    # add nebular line emission (under active development)

use_cloudy_tables = True    			    # If True, CLOUDY look up tables (dev. by Nell Byler) will be used to calculate 
                            			    # nebular emission. If False, CLOUDY models are generated individually 
                            			    # for each young star particle (under active development). 
                            			    # Note:  The lookup tables work only for stars particles below 10 Myr.  (Default: True)

cmdf_min_mass = 3.5                         # While calulating nebular emission from young stars and PAGB stars one star particle is broken down 
                                            # into smaller star cluster by assuming a cluster mass distribution function of the form dN/dM goes as M^(beta). 
                                            # This parameter sets the minimum mass of the star clusters in units of log(Msun). Note this value 
                                            # should not be set lower than 3.5. (Default = 3.5)

cmdf_max_mass = 5.0                         # Minimum mass of the star clusters in units of log(Msun). (Default = 5.0)

cmdf_bins = 6                               # The number of bins used for calulating the cluster mass distribution function (Default = 6.0)

cmdf_beta = -2.0                            # Beta (power law exponent) for calculating CMDF (dN/dM goes as M^(beta)) 


#**********************
# COMMON PARAMETERS
#***********************
# NOTE: These parmeters take either three or four values as an input. 
# They correspond to the value of the pararmeter for young_stars, PAGB stars, AGN and DIG respectively.

FORCE_gas_logu = [False, False, False] 	    # If set, then we force the ionization parameter (gas_logu) to be 
                            			    # gas_logu (next parameter) else, it is taken to be variable and dependent on ionizing 
                            			    # radiation from star particles. (Default: [False, False, False])

gas_logu = [-2.0, -2.0, -2.0]        		# Gas ionization parameter. This is only relevant 
                            			    # if add_neb_emission is set to True and FORCE_gas_logu is set to True (Default: [-2.0, -2.0, -2.0])

gas_logu_init = [0.0, 0.0, 0.0]        	    # Force the ionization parameter to increase/decrease by this value (Scale: log). 
                            		    	# Useful if you want to run tests (Default: [0.0, 0.0, 0.0])

FORCE_gas_logz = [False, False, False]      # If set, then we force the metallicity (gas_logz) to be gas_logz (next parameter)
                            	            # else, it is taken to be the star particles metallicity. (Default: [False, False, False])

gas_logz = [0.0, 0.0, 0.0]  			    # Metallicity of the HII region in units of log(Z/Z_sun)
                            			    # only relevant if add_neb_emission = True and FORCE_gas_logz = True (Default: [0.0, 0.0, 0.0])

FORCE_logq = [False, False, False]      	# If set, then we force the number of ionizing photons to be source_logq (next parameter)
                                            # else, it is taken to be variable and dependent on ionizing radiation of the source. (Default: [False, False, False])

source_logq = [1.e47, 1.e47,1.e47]          # The number of ionizing photons emitted by the source in units of s^-1. Only relevant if add_neb_emission = True, 
    										# use_cloudy_tables = True and  FORCE_gas_logq = True (Default: [1.e47,1.e47,1.e47])  
                                            
FORCE_inner_radius = [False, False, True]   # If set, then we force the inner radius of the cloud to be inner_radius (next parameter). 
											# IMP Note: This works only for young stars and Post-AGB stars. 
    										# For AGN we keep the inner radius fixed at whatever is set by inner_radius (next parameter) 
    										# irrespective of what this parameter is set to. (Default: [False,False,True])

inner_radius = [1.e19, 1.e19, 2.777e+20]   	# This sets the inner radius of the cloud in cm. This is used only when add_neb_emission = True,
                            		    	# use_cloudy_tables = False and FORCE_inner_radius = True (Default: [1.e19, 1.e19, 2.777e+20], Units = cm)

FORCE_N_O_Pilyugin = [False, False, False, False]  # If set to True, Nitrogen abundances are set according to the N/O vs O/H relation from Pilyugin et al. 2012
                                                   # If FORCE_N_O ratio (next parameter) is set to True then this parameter is ignored.(Default: [False,False,False])

FORCE_N_O_ratio = [False, False, False, False]     # If set, then we force the log of N/O ratio to be N_O_ratio (next parameter). 
                            			           # This can be used as a template fix adundance ratio of other elements (Default:  [False, False, False])

N_O_ratio = [-0.85, -0.85, -0.85, -0.85]           # This sets the log of N/O ratio. This is used only when add_neb_emission = True,
                            			           # use_cloudy_tables = False, FORCE_N/O ratio = True and neb_abund = "direct" (Default: = [-0.85, -0.85, -0.85])

neb_abund = ["dopita", "dopita", "dopita", "dopita"]  # This sets the HII region elemental abundances for generating CLOUDY models. 
                            			              # Available abundaces are.
                            			              #    dopita:    Abundabces from Dopita (2001) with old solar abundances = 0.019 and ISM grains.
                            			              #    newdopita: Abundances from Dopita (2013). Solar Abundances from Grevasse 2010 - z= 0.013
                            			              #               includes smooth polynomial for N/O, C/O relationship functional form for He(z),
                            			              #               new depletion and factors in ISM grains.
                            			              #    gutkin:    Abundabces from Gutkin (2016) and PARSEC metallicity (Bressan+2012) based on Grevesse+Sauvel (1998) 
                            			              #               and Caffau+2011 
                            			              #    direct:    Abundances are taken directly from the simulation if possible. Defaults to using "dopita" if there is 
                            			              #               an error. (Note: Works only for AGNs and star particles that are added directly without binning.
                            			              #               Make sure to set FORCE_BINNED to False)
                            			              # This is used only when add_neb_emission = True and use_cloudy_tables = False. (Default: ["dopita", "dopita", "dopita"])

#***************************
# YOUNG STARS (HII regions)
#***************************

add_young_stars = True      			    # If set, the young stars are included when calculating nebular emission (Default: False)


HII_Rinner_per_Rs = 0.01        		    # Rinner for cloudy calculations is set to this value times the Stromgen Radius. 
                            			    # For example, if set to 0.01 Rinner is taken to be 1 % of Stromgren Radius. 
                            		    	# If FORCE_inner_radius (next parameter) is set to True then this is overridden
                            			    # and the value set by the inner_radius is used. This parameter is used 
                            			    # only when add_neb_emission = True and use_cloudy_tables = False (Default: 0.01)
   
HII_nh = 1.e2               			    # Gas hydrogen density for calcualting nebular emission in units if cm^-3. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 1.e2)

HII_min_age = 1.e-3                         # Sets the minimum age limit for calculating nebular emission in units of Gyr. 
                                            # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 1.e-3)

HII_max_age = 1.e-2         			    # Sets the maximum age limit for calculating nebular emission in units of Gyr. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 1.e-2)

HII_escape_fraction = 0.0   			    # Fraction of H-ionizaing photons that escape the HII region. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 0.0)

HII_alpha_enhacement = False                # If set to True then the metallicity of star particles to Fe/H rather than the total metals. 
                                            # Since FSPS does not support non solar abundance ratios, this parameter can be used to mimic the 
                                            # hardening of the radiaiton field due to alpha-enhancement. (Default: False)

#****************
# Post-AGB STARS
#****************

add_pagb_stars = False      			    # If set, the Post-AGB stars are included when calculating nebular emission (Default: False)

PAGB_N_enhancement = 0.4    			    # Enhances the Nitrogen abundance Post-AGB stars by increasing the log(N/O) by this value. 
                            			    # This used only when add_neb_emission = True, use_cloudy_tables = False and add_pagb_stars = True (Default = 0.4)  

PAGB_C_enhancement = 0.4    			    # Enhances the Carbon abundance Post-AGB stars by increasing the log(C/O) by this value.
                            			    # This used only when add_neb_emission = True, use_cloudy_tables = False and add_pagb_stars = True (Default = 0.4)

PAGB_Rinner_per_Rs = 0.01        		    # Rinner for cloudy calculations is set to this value times the Stromgen Radius. 
                            			    # For example, if set to 0.01 Rinner is taken to be 1 % of Stromgren Radius. 
                            			    # If FORCE_inner_radius (next parameter) is set to True then this is overridden
                            			    # and the value set by the inner_radius is used. This parameter is used 
                            			    # only when add_neb_emission = True and use_cloudy_tables = False (Default: 0.01)

PAGB_nh = 1.e2               			    # Gas hydrogen density for calcualting nebular emission in units if cm^-3. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 1.e2)

PAGB_min_age = 0.1          		    	# Sets the minimum age limit for calculating nebular emission from post-AGB stars, in units of Gyr.
                            			    # This is used only when add_neb_emission = True, use_cloudy_tables = False and add_pagb_stars = True (Default = 0.1)

PAGB_max_age = 10           			    # Sets the maximum age limit for calculating nebular emission from post-AGB stars, in units of Gyr.
                            			    # This is used only when add_neb_emission = True, use_cloudy_tables = False and add_pagb_stars = True (Default = 10)

PAGB_escape_fraction = 0.0   			    # Fraction of H-ionizaing photons that escape the HII region. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 0.0)

#**************
# AGN
#**************

add_AGN_neb = False				            # If set, AGNs are included when calculating nebular emission (Default: False)

AGN_nh = 1.e3					            # Gas hydrogen density for calcualting nebular emission in units if cm^-3. 
                            			    # This is used only when add_neb_emission = True and use_cloudy_tables = False (Default = 1.e2)

AGN_num_gas = 32							# For CLOUDY calculations we use the distance weighted average metallicity of gas particles around the AGN. 
											# The number of gas particles used for doing so is set by this parameter. (Default: 32)
											
#**********************
# DIffused Ionized Gas (DIG)
#**********************

add_DIG_neb = False                         # If set, Contribution from DIG is included when calculating nebular emission (Default: False)

DIG_nh = 1.e1                               # Gas hydrogen density for calcualting nebular emission in units of cm^-3. (Default: 10)

DIG_min_factor = 1                          # For DIG CLOUDY calculations we use Black (1987) SED as a template. The normalization of the SED is 
                                            # set by a parameter called  "Factor". It is the ratio of total energy dumped in a cell to the total 
                                            # energy of the Black (1987) SED, which we use as the template for setting the SED shape for calculating 
                                            # DIG emission. This parameter sets the minimum factor that the code uses for calculation. For example, 
                                            # setting this parameter to 1 causes the code to ignore all the cells that have a factor < 1 or in other 
                                            # words ignore all the cells where the total energy dumped is less than the integrated energy of the 
                                            # Black (1987) SED (Default: 1).
                                            
#*************************
# DEBUGGING AND CLEAN UP
#*************************

dump_emlines = False                        # If True, The emission lines are saved in a file before going through the dust radiative transfer. 
                                            # This can be used as a fast way getting emission lines for the purpose of debugging the code.
                                            # Naming convention: emlines.galaxy*.txt where * is the galaxy number 
                                            # This works only when add_neb_emission = True (Default: False) 

cloudy_cleanup = True                       # If set to True, all the CLOUDY files will be deleted after the source addition is complete. 
                                            # Only relevant if add_neb_emission = True and use_cloudy_tables = False (Default: True)

#===============================================
#BIRTH CLOUD INFORMATION
#===============================================

CF_on = False               # if set to true, then we enable the Charlot & Fall birthcloud models 

birth_cloud_clearing_age = 0.01 # Gyr - stars with age <
                                # birth_cloud_clearing_age have
                                # charlot&fall birthclouds meaningless
                                # of CF_on  == False


#===============================================
# Idealized Galaxy SED Parameters
#===============================================
Z_init = 0 # force a metallicity increase in the newstar particles.
           # This is useful for idealized galaxies.  The units for this
           # are absolute (so enter 0.02 for solar).  Setting to 0
           # means you use the stellar metallicities as they come in
           # the simulation (more likely appropriate for cosmological
           # runs)

           #NOTE - this is not exclusively used for idealized
           #simulations (i.e. one could use this for a cosmological
           #simulation), but the typical use case is for idealized simulations.

disk_stars_age = 8      # Gyr ;meaningless if this is a cosmological simulation
bulge_stars_age = 8     # Gyr ; meaningless if this is a cosmological simulation
disk_stars_metals = 19  # in fsps metallicity units
bulge_stars_metals = 19 # in fsps metallicity units



#===============================================
# Stellar Ages and Metallicities
#===============================================

# bins for binning the stellar ages and metallicities for SED
# assignments in cases of many (where many ==
# >N_METALLICITY_BINS*N_STELLAR_AGE_BINS) stars; this is necessary for
# reduction of memory load; see manual for details.

N_STELLAR_AGE_BINS = 100


metallicity_legend= "/home/desika.narayanan/pd_git/fsps_files/zlegend.mist.dat"

#===============================================
#BLACK HOLES
#===============================================

BH_SED = False
BH_eta = 0.1 #bhluminosity = BH_eta * mdot * c**2.
BH_model = "Nenkova"
BH_modelfile = "/home/desika.narayanan/pd_git/agn_models/clumpy_models_201410_tvavg.hdf5"
# The Nenkova BH_modelfile can be downloaded here:
# https://www.clumpy.org/downloads/clumpy_models_201410_tvavg.hdf5
BH_var = True # Include time variations on BH luminosity (default Hickox+ 2014)

nenkova_params = [5,30,0,1.5,30,40] #Nenkova+ (2008) model parameters

#===============================================
#IMAGES AND SED PARAMETERS
#===============================================

NTHETA = 1
NPHI = 1
SED = True

SED_MONOCHROMATIC = False
FIX_SED_MONOCHROMATIC_WAVELENGTHS = False # if set, then we only use
                                          # the wavelengths in the
                                          # range between min_lam and
                                          # max_lam
SED_MONOCHROMATIC_min_lam = 0.3 # micron
SED_MONOCHROMATIC_max_lam = 0.4 # micron





IMAGING = False
filterdir = '/home/desika.narayanan/pd_git/filters/'
filterfiles = [
    'arbitrary.filter',
#    'ACS_F475W.filter',
#    'ACS_F606W.filter',
#    'ACS_F814W.filter',
#    'B_subaru.filter',
]

# Insert additional filter files as above. In bash, the following command 
# formats the filenames for easy copying/pasting.
# $ shopt -s globstar; printf "#    '%s'\n" *.filter


npix_x = 128
npix_y = 128

#experimental and under development - not advised for use
IMAGING_TRANSMISSION_FILTER = False
filter_list = ['filters/irac_ch1.filter']
TRANSMISSION_FILTER_REDSHIFT = 0.001

#===============================================
#GRID INFORMATION  
#===============================================

MANUAL_ORIENTATION = False
THETA = 0
PHI = 0

#===============================================
#OTHER INFORMATION
#===============================================

solar = 0.013
PAH_frac = {'usg': 0.0586, 'vsg': 0.1351, 'big': 0.8063} # values will be normalized to 1

#===============================================
#DEBUGGING -THE PERFORMANCE OF THE CODE USING THESE PARAMETERS IS NOT GUARANTEED
#===============================================
SOURCES_RANDOM_POSITIONS = False
SOURCES_IN_CENTER = False
STELLAR_SED_WRITE = True
SKIP_RT = False # skip radiative transfer (i.e. just read in the grids and maybe write some diagnostics)
SUPER_SIMPLE_SED = False # just generate 1 oct of 100 pc on a side,
                         # centered on [0,0,0].  sources are added at
                         # random positions.
SKIP_GRID_READIN = False

CONSTANT_DUST_GRID = False # if set, then we don't create a dust grid by
                          # smoothing, but rather just make it the same
                          # size as the octree with a constant value of
                          # 4e-20
                          
N_MASS_BINS = 0 # this is really just a place holder that exists in
                # some loops to be able to insert some code downstream
                # for spatially varying IMFs.  right now for speed best
                # to set to 1 as it doesn't actually do anything.

FORCE_STELLAR_AGES = False
FORCE_STELLAR_AGES_VALUE = 0.05# Gyr

FORCE_STELLAR_METALLICITIES = False
FORCE_STELLAR_METALLICITIES_VALUE = 0.012 # absolute values (so 0.013 ~ solar) 
NEB_DEBUG = False # Dumps parameters related to nebular line emission in a file for debugging.
                  # The file includes the ionization parameter, number of ionizing photons, 
                  # metallicity, inner radius, stellar mass and age for each particle.
                  # Naming convention: nebular_properties_galaxy*.txt where * is the galaxy number
DIFF_DIG_SED = False # If set, SEDs with DIG nebular emission are saved separately with "_DIG" appended to the rtout files