.TH "src/include/serif/dimensions/dimensions.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/dimensions/dimensions.hpp \- File containing prue dimensions\&. Note that this is not intended to be (nor does it have the capability to be) a general dimensional analysis library\&. There is no understanding here that, for example, a dimension of length^2 is an area\&. Rather, the purpose of this is to force developers to be explicit about what values they are passing to what functions\&. Further, most of this system is built to be compile time constant\&. This means that the compiler can still apply many optimizations\&. Note that the dimensions here do not contain a value, rather these are \fIjust\fP the concept of a dimension\&. To store a value you must use a \fBQuantity\fP and \fBQuantityValue\fP\&.  

.SH SYNOPSIS
.br
.PP
\fR#include <string_view>\fP
.br
\fR#include 'serif/dimensions/quantities\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBserif::dimensions::Dimensionless\fP"
.br
.RI "Non dimensional type\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Mass\fP"
.br
.RI "Dimension of mass\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Length\fP"
.br
.RI "Dimension of \fBLength\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Time\fP"
.br
.RI "Dimension of \fBTime\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::InverseTimeSquared\fP"
.br
.RI "Inverse time squared, the physical dimension of a Poisson residual\&. "
.ti -1c
.RI "struct \fBserif::dimensions::MassDensityRate\fP"
.br
.RI "\fBMass\fP density divided by time,\&. "
.ti -1c
.RI "struct \fBserif::dimensions::ForceDensity\fP"
.br
.RI "\fBForce\fP per unit volume\&. "
.ti -1c
.RI "struct \fBserif::dimensions::PressureLaplacian\fP"
.br
.RI "\fBPressure\fP divided by length squared\&. "
.ti -1c
.RI "struct \fBserif::dimensions::GravitationalConstant\fP"
.br
.RI "Newton's gravitational constant, expressed in the selected system of units\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Area\fP"
.br
.RI "Dimension of \fBArea\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Volume\fP"
.br
.RI "Dimension of \fBVolume\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::MassDensity\fP"
.br
.RI "Dimension of \fBMass\fP Density\&. "
.ti -1c
.RI "struct \fBserif::dimensions::NumberDensity\fP"
.br
.RI "Dimension of Number Density\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Pressure\fP"
.br
.RI "Dimension of \fBPressure\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Temperature\fP"
.br
.RI "Dimension of \fBTemperature\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Entropy\fP"
.br
.RI "Dimension of \fBEntropy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::SpecificEntropy\fP"
.br
.RI "Dimension of Specific \fBEntropy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::ChemicalPotential\fP"
.br
.RI "Dimension of Chemical Potential\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Energy\fP"
.br
.RI "Dimension of \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::InternalEnergy\fP"
.br
.RI "Dimension of Internal \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::SpecificEnergy\fP"
.br
.RI "Dimension of Specific \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::SpecificInternalEnergy\fP"
.br
.RI "Dimension of Specific Internal \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::SpecificEnthalpy\fP"
.br
.RI "Dimension of Specific Enthalpy\&. "
.ti -1c
.RI "struct \fBserif::dimensions::BarotropicPressurePotential\fP"
.br
.RI "The barotropic pressure primitive A with dA/density = (dP/density)/density\&. "
.ti -1c
.RI "struct \fBserif::dimensions::EnergyDensity\fP"
.br
.RI "Dimension of \fBEnergy\fP Density\&. "
.ti -1c
.RI "struct \fBserif::dimensions::GravitationalPotential\fP"
.br
.RI "Dimension of Gravitational Potential\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Velocity\fP"
.br
.RI "Dimension of \fBVelocity\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Acceleration\fP"
.br
.RI "Dimension of \fBAcceleration\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Frequency\fP"
.br
.RI "Dimension of \fBFrequency\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::AngularVelocity\fP"
.br
.RI "Dimension of Angular \fBVelocity\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::AngularAcceleration\fP"
.br
.RI "Angular acceleration, distinct from angular velocity despite sharing its chosen axis\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Momentum\fP"
.br
.RI "Dimension of \fBMomentum\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::AngularMomentum\fP"
.br
.RI "Dimension of Angular \fBMomentum\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::MomentOfInertia\fP"
.br
.RI "Dimension of Moment Of Inertia\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Force\fP"
.br
.RI "Dimension of \fBForce\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Torque\fP"
.br
.RI "Dimension of \fBTorque\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Power\fP"
.br
.RI "Dimension of \fBPower\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Luminosity\fP"
.br
.RI "Dimension of \fBLuminosity\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::MassFlowRate\fP"
.br
.RI "Dimension of \fBMass\fP Flow Rate\&. "
.ti -1c
.RI "struct \fBserif::dimensions::Opacity\fP"
.br
.RI "Dimension of \fBOpacity\fP\&. "
.ti -1c
.RI "struct \fBserif::dimensions::DynamicViscosity\fP"
.br
.RI "Dimension of Dynamic Viscosity\&. "
.ti -1c
.RI "struct \fBserif::dimensions::KinematicViscosity\fP"
.br
.RI "Dimension of Kinematic Viscosity\&. "
.ti -1c
.RI "struct \fBserif::dimensions::MagneticFluxDensity\fP"
.br
.RI "Dimension of Magnetic Flux Density\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::dimensions\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
File containing prue dimensions\&. Note that this is not intended to be (nor does it have the capability to be) a general dimensional analysis library\&. There is no understanding here that, for example, a dimension of length^2 is an area\&. Rather, the purpose of this is to force developers to be explicit about what values they are passing to what functions\&. Further, most of this system is built to be compile time constant\&. This means that the compiler can still apply many optimizations\&. Note that the dimensions here do not contain a value, rather these are \fIjust\fP the concept of a dimension\&. To store a value you must use a \fBQuantity\fP and \fBQuantityValue\fP\&. 


.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.