:3260 update the fusion reactions section of the plasma docs to full account for all models and details #3345
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…the-plasma-docs-to-full-account-for-all-models-and-details
…update-the-fusion-reactions-section-of-the-plasma-docs-to-full-account-for-all-models-and-details
…e difference in D-D reactions
…the-plasma-docs-to-full-account-for-all-models-and-details
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3345 +/- ##
==========================================
+ Coverage 27.20% 27.30% +0.10%
==========================================
Files 76 77 +1
Lines 17779 17955 +176
==========================================
+ Hits 4837 4903 +66
- Misses 12942 13052 +110 ☔ View full report in Codecov by Sentry. |
The commit updates the electron mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Explicitly written float values has now also been set to this variable
The commit updates the proton mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Variable name has been changed from pmass to PROTON_MASS
…nd helion mass. Fix broken links for the electron and proton mass
…the-plasma-docs-to-full-account-for-all-models-and-details
… variable for electron_volt The commit updates the electron mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Variable name has been changed from emass to electron_mass
…reaction energy and both D-D reactions
…function signature
This commit adds new constants for the energy fractions carried by neutrons and protons in various fusion reactions. These constants are used to calculate the energy released in fusion reactions involving deuterium, tritium, helium-3, and protons. The energy fractions are calculated assuming a non-relativistic center of mass frame. The following constants have been added: - dt_neutron_energy_fraction: Energy fraction carried by neutron in deuterium-tritium reaction - dd_neutron_energy_fraction: Energy fraction carried by neutron in deuterium-deuterium (helium-3 producing) reaction - dd_proton_energy_fraction: Energy fraction carried by proton in deuterium-deuterium (triton producing) reaction - dhelium_proton_energy_fraction: Energy fraction carried by proton in deuterium-helion (helium-3) reaction These constants will be used in further calculations related to fusion reactions.
…d make function more explicit
- Renamed `alpharate` variable to `alpha_rate_density` for clarity and consistency.
a30b5d1 to
61f1056
Compare
…as distinct total and plasma only variants
…the-plasma-docs-to-full-account-for-all-models-and-details
kj5248
reviewed
Nov 5, 2024
documentation/proc-pages/physics-models/fusion_reactions/beam_reactions.md
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/beam_reactions.md
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/beam_reactions.md
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_bosch_hale.md
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_bosch_hale.md
Outdated
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md
Outdated
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md
Outdated
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md
Outdated
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md
Show resolved
Hide resolved
documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md
Show resolved
Hide resolved
d6774d1 to
a7b7587
Compare
3234d63 to
15c42a1
Compare
|
Can I request a review from @ajpearcey or @stuartmuldrew to confirm they are happy with variable name changes |
|
@je-cook FYI variable name changes that might cause problems in bluemira before you switch to our new release |
timothy-nunn
approved these changes
Nov 6, 2024
There was a problem hiding this comment.
Code looks fine. Alex or Jonny need to review the branching for physical validity.
Changes in the regression tests appear minor but, again, Alex or Jonny need agree.
Variable name changes need to be approved by Alex
Only one point about moving atomic masses of tritium and deuterium into the constants file?
Comment on lines
+12
to
+16
| # https://physics.nist.gov/cgi-bin/cuu/Value?mdu|search_for=deuteron | ||
| ATOMIC_MASS_DEUTERIUM = 2.013553212544 | ||
|
|
||
| # https://physics.nist.gov/cgi-bin/cuu/Value?mtu|search_for=triton | ||
| ATOMIC_MASS_TRITIUM = 3.01550071597 |
There was a problem hiding this comment.
Worth moving to constants.f90?
There was a problem hiding this comment.
Can leave out for now, will get swept out when another bit of the code needs to use the values
kj5248
approved these changes
Nov 6, 2024
ajpearcey
approved these changes
Nov 7, 2024
There was a problem hiding this comment.
There are no issues with the variable name changes and branching ratio.
We could maybe have a discussion to write down a style guide for variable name to add to the docs.
Also ref: @je-cook these name changes may cause issues with Bluemira/process interactions.
|
see Fusion-Power-Plant-Framework/bluemira#3636 for changes because of this |
chris-ashe
added a commit
that referenced
this pull request
Nov 8, 2024
…account for all models and details (#3345) * refactor: Update Fusion Reactions navigation structure * Fix some variable names for clairty * Convert physics functions to Python * Add new duterium_branching() function from Bosch-Hale to calculate the difference in D-D reactions * Update electron mass constant to use the more accurate value The commit updates the electron mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Explicitly written float values has now also been set to this variable * Update proton mass constant to use the more accurate value The commit updates the proton mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Variable name has been changed from pmass to PROTON_MASS * Add new constants for the deuteron, triton, neutron, alpha particle and helion mass. Fix broken links for the electron and proton mass * Revert variable names back to lowercase due to parsing issue with f2py * Update electron mass constant to use the more accurate value. Add new variable for electron_volt The commit updates the electron mass constant in multiple files to use the more accurate value provided by the NIST. This ensures that calculations involving the electron mass are more precise. Variable name has been changed from emass to electron_mass * Add new constants for the speed of light, D-T reaction energy, D-3He reaction energy and both D-D reactions * Refactor bosch_hale function to use more descriptive name and update function signature * Add new constants for fusion reaction energy fractions This commit adds new constants for the energy fractions carried by neutrons and protons in various fusion reactions. These constants are used to calculate the energy released in fusion reactions involving deuterium, tritium, helium-3, and protons. The energy fractions are calculated assuming a non-relativistic center of mass frame. The following constants have been added: - dt_neutron_energy_fraction: Energy fraction carried by neutron in deuterium-tritium reaction - dd_neutron_energy_fraction: Energy fraction carried by neutron in deuterium-deuterium (helium-3 producing) reaction - dd_proton_energy_fraction: Energy fraction carried by proton in deuterium-deuterium (triton producing) reaction - dhelium_proton_energy_fraction: Energy fraction carried by proton in deuterium-helion (helium-3) reaction These constants will be used in further calculations related to fusion reactions. * Refactor fint() into fusion_rate_integral() to be more descriptive and make function more explicit * Refactor variable name palppv to alpha_power_density for clarity and consistency * Refactor variable name palppv to alpha_power_density for clarity and consistency * Refactor variable name pneutpv to neutron_power_density for clarity and consistency * Refactor variable names for fusion reactions in physics calculations * Refactor variable names fusionrate to fusion_rate_density * Refactor variable names for alpha particle production rate - Renamed `alpharate` variable to `alpha_rate_density` for clarity and consistency. * Refactor variable names for proton rate density in physics calculations * Refactor variable name pdd to dd_power_density for clarity and consistency * Refactor variable name pdtpv to dt_power_density for clarity and consistency * Refactor variable names for helium-3 power density in physics calculations * Refactor variable name sigvdt to sigmav_dt_average for clarity and consistency * Refactor sum_fusion_rates() to be more explicit and pythonic * Refactor set_physics_variables() to update global and module variables with fusion power densities and reaction rates * Refactor the fusion reaction function. Docstring and type hints added with internal variables renamed for clarity * Refactor the fusion reaction function. Docstring and type hints added with internal variables renamed for clarity * Implement the new reaction energies and product particle fractions from constants.f90 * Rename pdt to dt_power to be more explicit * Rename pdhe3 to dhe3_power to be more descriptive * Rename pdd to dd_power for more clarity * Rename "vol" to "plasma_volume" in multiple files to improve code readability and maintain consistency with other variable names. * Add type hints and expand docstring to palph2() * Add new variable alpha_power_plasma that represents the alpha power produced just by reactions in the plasma. Has been added to output to show the breakdown of the total alpha power from the plasma and NBI contribution. * Rename palpnb to alpha_power_beams for more clarity and consistency * Rename "palpmw" to "alpha_power_total" for clarity and consistency * Add new variable neutron_power_plasma that represents the neutron power produced just by reactions in the plasma. Has been added to output to show the breakdown of the total alpha power from the plasma and NBI contribution. * Rename pneutmw to neutron_power_total for more clarity and consistency * Add new variable to output called neutron_power_beams to show the breakdown of total fusion power * Rename pchargemw to non_alpha_charged_power for clarity * Add charged_particle_power as a new physics variable and add it to the output * Rename powfmw to fusion_power for clarity * Rename palpipv to alpha_power_ion_density for clarity * Rename palpepv to alpha_power_electron_density for clarity * Add alpha_power_electron_density and alpha_power_electron_density to output * Add main bulk of FusionReaction class documentation descriptions * Update BoschHale docs section * Update variable name for charged particle power in stellarator.py and physics_variables.f90 * Remove ealphadt variable for the alpha particle energy in D-T reactions. New constant dt_alpha_energy is now called from the constants file in functions * Update the variable name falpha to f_alpha_plasma for clarity and consistency * Add new atomic mass unit and kilo electron volt constant. Rename palphabm() to alpha_power_beam(). Replace use of the proton mass instead of the amu unit * Update atomic mass units for deuterium and tritium and change multiplied constant form proton mass to amu mass * Add NBI beam fusion sections to new beam_reactions.md file. Rename xbrak() to beam_energy_to_ions(). Update beam energy to ions docs * Update beam_reactions.md with NBI beam fusion sections and function name changes * Rename sgvhot() to beam_reaction_rate() * Rename _sigbmfus() to _beam_fusion_cross_section() and add to docs * Refactor the _hot_beam_fusion_reaction_rate_integrand() function to improve readability and clarity. Update the function to use more descriptive variable names and add comments for better understanding. * Refactor output.f90 format strings for improved spacing and readability * Refactor palph2() to set_fusion_powers() and update naming of variables and test names * Rename beamfus() to beam_fusion() and re-arrange beam fusion docs page * Rename cnbeam to beam_current * Rename enbeam to beam_energy * Rename ftritbm to f_tritium_beam * Rename beam_energy_to_ions() to _fast_ion_pressure_integral(). Add about derivations for beamcalc() * Updated references to `dnbeam2` to `beam_density_out` in relevant files * Rename betanb to beta_beam for consistency * Beam reactions doc page structure refactor * Rename falpe to f_alpha_electron and falpi to f_alpha_ion * Refactor variable names for fuel ion fractions * Remove the fast alpha beta contribution from set_fusion_powers() and put it into fast_alpha_beta(). neutron and alpha power densities are now split into separate plasma only and total variables. * Add image showing the deuterium branching ratio and add discussion about plasma fuelling and add warning about reactions not covered * Refactor bosch hale reactivity and replace electron with ion density * Update the dt_power, alpha_rate_density, fusion_rate_density to now has distinct total and plasma only variants * Add variables to obsolete variables dictionary and fix unit tests * Add constraint equations to docs and tidy * Revoke new outfile spacing and append fusion_power to pass integration tests * pre-commit file fix * Update Bosch-Hale documentation for clarity and consistency * Revert deni to dene to prevent profile normalisation errors * Add f_dd_branching_trit attribute and update fusion reaction calculations --------- Co-authored-by: Timothy Nunn <timothy.nunn@ukaea.uk>
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes multiple changes across various documentation files and source code to improve the clarity and accuracy of the fusion reaction models and related constants. The most important changes include renaming variables for consistency, adding detailed documentation for fusion reaction methods, and updating references to reflect these changes.
Documentation Enhancements:
documentation/proc-pages/physics-models/fusion_reactions/beam_reactions.md: Added detailed sections on NBI Fusion, including derivations and equations for beam fusion cross-section, reaction rates, and power.documentation/proc-pages/physics-models/fusion_reactions/plasma_reactions.md: Added detailed documentation for fusion reactions, including initialization, calculation methods, and attributes.documentation/proc-pages/physics-models/fusion_reactions/plasma_bosch_hale.md: Added new documentation for Bosch-Hale methods and constants used in fusion reaction calculations.Navigation and Organization:
mkdocs.yml: Updated the navigation structure to include a more detailed breakdown of fusion reactions, separating the overview and Bosch-Hale methods.Bugs 🐛
The value for the mass of deuterium (
ATOMIC_MASS_DEUTERIUM) and tritium (ATOMIC_MASS_TRITIUM) in atomic mass units was in correctly given and then multiplied by the mass of the proton instead of the atomic mass unit value inphysics_functions.py.One of the term values in
beam_energy_to_ions()used an approximate value which is now calculated directlyThe
_hot_beam_fusion_reaction_rate_integrand()was using proton mass instead of atomic mass unitThe normalised density for the fusion rate integral in
fusion_rate_integral()was normalising to the volume averaged electron density instead of the ion density.New features
calculated implicitly.
Old
New
Code cleanup and test updates ♻️ :
OUT.DATand variable name widths have been widened to allow for more variable name space and labelsset_fusion_powers()has now had the fast alpha beta component calculation removed and placed into a new function offast_alpha_beta()Namespace changes
Constants
Several constants in
constants.f90have been made more verbose. Sadly they have not been able to be put into all uppercase form to be more Pythonic (PEP8).This is due to a parsing problem with f2py. The values have also been made more precise by taking values from NIST (https://physics.nist.gov/cuu/Constants/index.html). Comments are now also above the constants with link references to their values.Some changes below are:
emass->electron_mass; Value:9.10938370D-31->9.1093837139D-31. This new value has been applied to explicitly written floats incfnbi()andeccdef(). This has been updated in the docs alsopmass->proton_mass; Value:1.6726231D-27->1.67262192595D-27.echarge->electron_charge; Value1.60217733D-19->1.602176634D-19.New additions:
deuteron_mass,triton_mass,neutro 8000 n_mass,alpha_mass,helion_mass.speed_lightelectron_volt: This new value has been applied to explicitly written floats ineccdef(),acc2272(). This has been updated in the docs also. This has been added to be more syntactically correct when working with energy units instead of just callingkiloelectron_volt: This has been added as a lot of conversions would previously multiply by1000.0across the code. This should increase readability.atomic_mass_unit: Lots of functions are calling different fundamental mass values that are close but not technically correct, this is added to correct these errors.electron_charged_t_energy,d_helium_energy,dd_helium_energy,dd_triton_energy. These are the reaction energy constants and are calculated implicitly from the mass differences of products and reactantsdt_alpha_energy. This is created to compliment the removal ofealphadtfrom the variables listdt_neutron_energy_fraction,dd_neutron_energy_fraction,dd_proton_energy_fraction,dhelium_proton_energy_fraction. These are the calculated fractions my mass difference of the shared reaction energy between the fusion products.alpha_power_plasma: This is a new output file variable to differentiate between the alpha power from the plasma and that from beams.neutron_power_plasma: This is a new output file variable to differentiate between the neutron power from the plasma and that from beams.neutron_power_beams: This is a new output file variable to differentiate between the neutron power from the plasma and that from beams.fusion_rate_density_plasmafusion_rate_density_totalalpha_rate_density_totalalpha_rate_desnty_plasmadt_power_totaldt_power_plasmaf_dd_branching_tritFunctions
Re-named to be more descriptive about what the function does
bosch_hale()->bosch_hale_reactivity()fint()->fusion_rate_integral()dt()->dt_reaction()dhe3()->dhe3_reaction()dd1()->dd_helion_reaction()dd2()->dd_triton_reaction()palphabm()->alpha_power_plasma()xbrak()->_fast_ion_pressure_integral()sgvhot()->beam_reaction_rate()_sigbmfus()->_beam_fusion_cross_section()palph2()->set_fusion_powers()beamfus()->beam_fusion()Variables
A handful of variables are not quite descriptive/explicit enough in their naming and tend to lead to misinterpretation if it presents a per unit volume or a total value. Thus the following internal variables have been changed:
palppv->alpha_power_densitypchargepv->charged_power_densitypneutpv->neutron_power_densityfusionrate->fusion_rate_densityalpharate->alpha_rate_densityprotonrate->proton_rate_densitypddpv->dd_power_densitypdtpv->dt_power_densitypdhepv->dhe3_power_densitysigvdt->sigmav_dt_averagepdt->dt_powerpdhe3->dhe3_powerpdd->dd_powerpalpnb->alpha_power_beamspalpmw->alpha_power_totalpneutmw->neutron_power_totalpchargemw->non_alpha_charged_power. This was a misleading name as it doesn't account for alphas so was re-namedpfuscmw->charged_particle_power: This is a new output file variable which is now added tophysics_variables.f90It was output bypalph2()but was never written to output. It now is.palpipv-> alpha_power_ion_density`. This variable has now also been added to the outputpalpepv-> alpha_power_electron_density`. This variable has now also been added to the outputcnbeam->beam_currentenbeam->beam_energyftritbm->f_tritium_beambetanb->beta_beamdnbeam2->beam_density_out- To better clarify that this is the beam density produced by code output and is not from the input. Also to remove a variable name with a number at the end.falpe->f_alpha_electronfalpi->f_alpha_ionfdeut->f_deuteriumf_trit->f_tritiumfhe3->f_helium3vol->plasma_volume. This was changed due to conflicting understanding depending on the context of the module and to make it easier to search and find.powfmw->fusion_powerfalpha->f_alpha_plasma. Docs section created showing origin of default value.Removals
ealphadt. Removed as it was a constants value, though down as an input variable. Replaced bydt_alpha_energyconstant.Checklist
I confirm that I have completed the following checks: