diff --git a/src/include/serif/dimensions/type_alias.hpp b/src/include/serif/dimensions/type_alias.hpp index 473f294b..6e588b41 100644 --- a/src/include/serif/dimensions/type_alias.hpp +++ b/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 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; - using MassValue = QuantityValue; - using LengthValue = QuantityValue; - using TimeValue = QuantityValue