STARSS Star Formation and Feedback

doc/source/param/method.incl

@@ -706,6 +706,16 @@ most up-to-date description of Grackle parameters, see the `Grackle parameters <
 :Todo: :o:`write`
 :Status:  **Not accessed**
 
+star_maker
+----------
+
+..include:: method_star_maker.incl
+
+feedback
+--------
+
+..include:: method_feedback.incl
+
 heat
 ----
 

doc/source/param/method_feedback.incl

@@ -0,0 +1,63 @@
+:p: `Method:feedback` parameters.
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`single_sn`
+:Summary: :s:`Whether to turn on supernova feedback in EnzoMethodFeedbackSTARSS`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Whether to turn on supernova feedback in EnzoMethodFeedbackSTARSS`
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`unrestricted_sn`
+:Summary: :s:`Whether to turn on supernova feedback in EnzoMethodFeedbackSTARSS`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Allow for > 1 supernova event per star particle in a timestep.`
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`stellar_winds`
+:Summary: :s:`Whether to turn on stellar winds in EnzoMethodFeedbackSTARSS`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Whether to turn on stellar wind feedback in EnzoMethodFeedbackSTARSS`
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`analytic_SNR_shell_mass`
+:Summary: :s:`Calculates supernova remnant shell mass via analytic formulae`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Calculates supernova remnant shell mass via analytic formulae`
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`fade_SNR`
+:Summary: :s:`Allow coupling to fading phase of SNe in EnzoMethodFeedbackSTARSS`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Allow coupling to fading phase of SNe in EnzoMethodFeedbackSTARSS if cell width is greater than fading radius.`
+
+----
+
+Parameter:  :p:`Method` : :p:`feedback` : :p:`NEvents`
+:Summary: :s:`Manually set off supernovae in test problems`
+:Type:   :t:`integer`
+:Default: :d:`-1`
+:Scope:     :z:`Enzo`
+
+:e:`If -1, will probabilistically model supernova. If "NEvents" > 1, will set off N-supernovae per particle, (1 per timestep). Mostly for testing purposes`
+
+----

doc/source/param/method_star_maker.incl

@@ -0,0 +1,191 @@
+:p: `Method:star_maker` parameters.
+
+----
+
+:Parameter:  :p:`Method` : :p:`star_maker` : :p:`flavor`
+:Summary: :s:`Which star_maker method to use`
+:Type:   :t:`string`
+:Default: :d:`STARSS`
+:Scope:     :z:`Enzo`
+
+:e:`Options: "STARSS", "stochastic"`
+
+----
+
+:Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_density_threshold`
+:Summary: :s:`Use number density threshold for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Flag to enable number density threshold for star formation.`
+
+----
+
+:Parameter:  :p:`Method` : :p:`star_maker` : :p:`number_density_threshold`
+:Summary: :s:`Use number density threshold for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Set number density threshold for star formation. Requires "use_density_threshold"=true.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_overdensity_threshold`
+:Summary: :s:`Use overdensity threshold`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Flag to enable overdensity threshold for star formation.`
+
+----
+
+:Parameter:  :p:`Method` : :p:`star_maker` : :p:`overdensity_threshold`
+:Summary: :s:`Use overdensity threshold for star formation`
+:Type:   :t:`float`
+:Default: :d:`0.0`
+:Scope:     :z:`Enzo`
+
+:e:`Set overdensity threshold for star formation. Requires "use_overdensity_threshold"=true.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_velocity_divergence`
+:Summary: :s:`Use converging flow criterion for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Flag to check whether div(V) < 0`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_cooling_time`
+:Summary: :s:`Check if cooling_time < dynamical_time for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Flag to check if cooling_time < dynamical_time`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_temperature_threshold`
+:Summary: :s:`Use temperature threshold for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Flag to enable temperature threshold check for star formation`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`temperature_threshold`
+:Summary: :s:`Temperature threshold for star formation`
+:Type:   :t:`float`
+:Default: :d:`1e4`
+:Scope:     :z:`Enzo`
+
+:e:`Set temperature threshold required for star formation. Requires "use_temperature_threshold"=true.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_self_gravitating`
+:Summary: :s:`Use FIRE2 virial parameter criterion for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Checks that alpha < 1, where alpha is the virial parameter calculated using the FIRE2 prescription.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_altAlpha`
+:Summary: :s:`Use alternate virial parameter criterion for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Checks that alpha < 1, where alpha is the virial parameter calculated as "potential/total_energy". Currently only accessed by EnzoMethodStarMakerSTARSS. Requires DEBUG_COPY_POTENTIAL flag to be set in EnzoMethodGravity.cpp`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_h2_self_shielding`
+:Summary: :s:`Use H2 self-shielding criterion for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Checks that f_shield < 0, f_shield is calculated using fits from Krumholz & Gnedin (2011).'
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`use_jeans_mass`
+:Summary: :s:`Use Jeans mass criterion for star formation`
+:Type:   :t:`logical`
+:Default: :d:`false`
+:Scope:     :z:`Enzo`
+
+:e:`Checks that cell_mass > jeans_mass in a cell'
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`critical_metallicity`
+:Summary: :s:`Metallicity threshold for star formation`
+:Type:   :t:`float`
+:Default: :d:`0.0`
+:Scope:     :z:`Enzo`
+
+:e:`Set metallicity threshold required for star formation`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`maximum_mass_fraction`
+:Summary: :s:`Max fraction of gas in a cell that can be converted into a star particle per formation event.`
+:Type:   :t:`float`
+:Default: :d:`0.5`
+:Scope:     :z:`Enzo`
+
+:e:`Max fraction of gas in a cell that can be converted into a star particle per formation event.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`min_level`
+:Summary: :s:`Minimum AMR level required for star formation.`
+:Type:   :t:`integer`
+:Default: :d:`0`
+:Scope:     :z:`Enzo`
+
+:e:`Set minimum AMR level required for star formation.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`minimum_star_mass`
+:Summary: :s:`Minimum star particle mass`
+:Type:   :t:`float`
+:Default: :d:`0.0`
+:Scope:     :z:`Enzo`
+
+:e:`Set minimum star particle mass.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`maximum_star_mass`
+:Summary: :s:`Maximum star particle mass`
+:Type:   :t:`float`
+:Default: :d:`1e4`
+:Scope:     :z:`Enzo`
+
+:e:`Set maximum star particle mass. For no limit, set "maximum_star_mass" < 0.`
+
+----
+
+Parameter:  :p:`Method` : :p:`star_maker` : :p:`turn_off_probability`
+:Summary: :s:`Turn off probablistic elements of EnzoMethodStarMakerSTARSS.`
+:Type:   :t:`logical`
+:Default: :d:`fapse`
+:Scope:     :z:`Enzo`
+
+:e:`Turn off probablistic elements of EnzoMethodStarMakerSTARSS. Mostly meant for debugging.`