docs(dimensions): added dimension doxygen comments

src/include/serif/dimensions/type_alias.hpp

@@ -1,43 +1,51 @@
 #pragma once
 
+/**
+ * @file type_alias.hpp
+ * @author Emily M. Boudreaux
+ * @brief This file contains type aliases for the dimensions and quantities used in the discretization. This is solely
+ * useful in so far as it means we do not need to type out the longer QuantityValue<Dimension> type for each of the dimensions and quantities used in the discretization.
+ * This is a convenience file that is used to make the code more readable and maintainable.
+ */
+
 #include "serif/dimensions/quantities.hpp"
 #include "serif/dimensions/dimensions.hpp"
 
 namespace serif::dimensions {
-    using DimensionlessValue                             = QuantityValue<Dimensionless>;
-    using MassValue                                      = QuantityValue<Mass>;
-    using LengthValue                                    = QuantityValue<Length>;
-    using TimeValue                                      = QuantityValue<Time>;
-    using AreaValue                                      = QuantityValue<Area>;
-    using VolumeValue                                    = QuantityValue<Volume>;
-    using DensityValue                                   = QuantityValue<MassDensity>;
-    using NumberDensityValue                             = QuantityValue<NumberDensity>;
-    using PressureValue                                  = QuantityValue<Pressure>;
-    using TemperatureValue                               = QuantityValue<Temperature>;
-    using EntropyValue                                   = QuantityValue<Entropy>;
-    using SpecificEntropyValue                           = QuantityValue<SpecificEntropy>;
-    using ChemicalPotentialValue                         = QuantityValue<ChemicalPotential>;
-    using EnergyValue                                    = QuantityValue<Energy>;
-    using InternalEnergyValue                            = QuantityValue<InternalEnergy>;
-    using SpecificEnergyValue                            = QuantityValue<SpecificEnergy>;
-    using SpecificInternalEnergyValue                    = QuantityValue<SpecificInternalEnergy>;
-    using SpecificEnthalpyValue                          = QuantityValue<SpecificEnthalpy>;
-    using EnergyDensityValue                             = QuantityValue<EnergyDensity>;
-    using GravitationalPotentialValue                    = QuantityValue<GravitationalPotential>;
-    using VelocityValue                                  = QuantityValue<Velocity>;
-    using AccelerationValue                              = QuantityValue<Acceleration>;
-    using FrequencyValue                                 = QuantityValue<Frequency>;
-    using AngularVelocityValue                           = QuantityValue<AngularVelocity>;
-    using MomentumValue                                  = QuantityValue<Momentum>;
-    using AngularMomentumValue                           = QuantityValue<AngularMomentum>;
-    using MomentOfInertiaValue                           = QuantityValue<MomentOfInertia>;
-    using ForceValue                                     = QuantityValue<Force>;
-    using TorqueValue                                    = QuantityValue<Torque>;
-    using PowerValue                                     = QuantityValue<Power>;
-    using LuminosityValue                                = QuantityValue<Luminosity>;
-    using MassFlowRateValue                              = QuantityValue<MassFlowRate>;
-    using OpacityValue                                   = QuantityValue<Opacity>;
-    using DynamicViscosityValue                          = QuantityValue<DynamicViscosity>;
-    using KinematicViscosityValue                        = QuantityValue<KinematicViscosity>;
-    using MagneticFluxDensityValue                       = QuantityValue<MagneticFluxDensity>;
+    using DimensionlessValue                             = QuantityValue<Dimensionless>;             ///< A dimensionless quantity, used for quantities that do not have a physical dimension (e.g., a pure number).
+    using MassValue                                      = QuantityValue<Mass>;                      ///< A quantity representing mass.
+    using LengthValue                                    = QuantityValue<Length>;                    ///< A quantity representing length.
+    using TimeValue                                      = QuantityValue<Time>;                      ///< A quantity representing time.
+    using AreaValue                                      = QuantityValue<Area>;                      ///< A quantity representing area.
+    using VolumeValue                                    = QuantityValue<Volume>;                    ///< A quantity representing volume.
+    using DensityValue                                   = QuantityValue<MassDensity>;               ///< A quantity representing mass density.
+    using NumberDensityValue                             = QuantityValue<NumberDensity>;             ///< A quantity representing number density.
+    using PressureValue                                  = QuantityValue<Pressure>;                  ///< A quantity representing pressure.
+    using TemperatureValue                               = QuantityValue<Temperature>;               ///< A quantity representing temperature.
+    using EntropyValue                                   = QuantityValue<Entropy>;                   ///< A quantity representing entropy.
+    using SpecificEntropyValue                           = QuantityValue<SpecificEntropy>;           ///< A quantity representing specific entropy.
+    using ChemicalPotentialValue                         = QuantityValue<ChemicalPotential>;         ///< A quantity representing chemical potential.
+    using EnergyValue                                    = QuantityValue<Energy>;                    ///< A quantity representing energy..
+    using InternalEnergyValue                            = QuantityValue<InternalEnergy>;            ///< A quantity representing internal energy.
+    using SpecificEnergyValue                            = QuantityValue<SpecificEnergy>;            ///< A quantity representing specific energy.
+    using SpecificInternalEnergyValue                    = QuantityValue<SpecificInternalEnergy>;    ///< A quantity representing specific internal energy.
+    using SpecificEnthalpyValue                          = QuantityValue<SpecificEnthalpy>;          ///< A quantity representing specific enthalpy.
+    using EnergyDensityValue                             = QuantityValue<EnergyDensity>;             ///< A quantity representing energy density.
+    using GravitationalPotentialValue                    = QuantityValue<GravitationalPotential>;    ///< A quantity representing gravitational potential.
+    using VelocityValue                                  = QuantityValue<Velocity>;                  ///< A quantity representing velocity.
+    using AccelerationValue                              = QuantityValue<Acceleration>;              ///< A quantity representing acceleration.
+    using FrequencyValue                                 = QuantityValue<Frequency>;                 ///< A quantity representing frequency.
+    using AngularVelocityValue                           = QuantityValue<AngularVelocity>;           ///< A quantity representing angular velocity.
+    using MomentumValue                                  = QuantityValue<Momentum>;                  ///< A quantity representing momentum.
+    using AngularMomentumValue                           = QuantityValue<AngularMomentum>;           ///< A quantity representing angular momentum.
+    using MomentOfInertiaValue                           = QuantityValue<MomentOfInertia>;           ///< A quantity representing moment of inertia.
+    using ForceValue                                     = QuantityValue<Force>;                     ///< A quantity representing force..
+    using TorqueValue                                    = QuantityValue<Torque>;                    ///< A quantity representing torque.
+    using PowerValue                                     = QuantityValue<Power>;                     ///< A quantity representing power.
+    using LuminosityValue                                = QuantityValue<Luminosity>;                ///< A quantity representing luminosity.
+    using MassFlowRateValue                              = QuantityValue<MassFlowRate>;              ///< A quantity representing mass flow rate.
+    using OpacityValue                                   = QuantityValue<Opacity>;                   ///< A quantity representing opacity.
+    using DynamicViscosityValue                          = QuantityValue<DynamicViscosity>;          ///< A quantity representing dynamic viscosity.
+    using KinematicViscosityValue                        = QuantityValue<KinematicViscosity>;        ///< A quantity representing kinematic viscosity.
+    using MagneticFluxDensityValue                       = QuantityValue<MagneticFluxDensity>;       ///< A quantity representing magnetic flux density.
 }

src/include/serif/discretization/blocks/rows.hpp

@@ -1 +0,0 @@
-#pragma once