4.3 BlasterSim source code conventions

  • Some code comments contain bibliographic keys referring to the BlasterSim documentation’s BibTeX database. The BibTeX database is located at docs/blastersim.bib, and the associated keys can be found there.

  • Some code comments may refer to handwritten notes. I intend to slowly clean up and add these notes to this documentation.

  • Constants (parameters in Fortran terminology) are denoted by capitalizing the variable name. Note that this is different from convention used for intensive and extensive quantities in the typeset math in this documentation as discussed in § 2.1.1. Because each variable in BlasterSim’s source code is given a unit (see § 3.1.3), whether a quantity is extensive or intensive can be determined from the units for that quantity, if unclear.

  • The control volume index for the barrel is I_BARREL, which is set to 1. This convention allows BlasterSim to easily know which control volume is the barrel.