.TH "serif::dimensions" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::dimensions
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBAcceleration\fP"
.br
.RI "Dimension of \fBAcceleration\fP\&. "
.ti -1c
.RI "struct \fBAngularAcceleration\fP"
.br
.RI "Angular acceleration, distinct from angular velocity despite sharing its chosen axis\&. "
.ti -1c
.RI "struct \fBAngularMomentum\fP"
.br
.RI "Dimension of Angular \fBMomentum\fP\&. "
.ti -1c
.RI "struct \fBAngularVelocity\fP"
.br
.RI "Dimension of Angular \fBVelocity\fP\&. "
.ti -1c
.RI "struct \fBArea\fP"
.br
.RI "Dimension of \fBArea\fP\&. "
.ti -1c
.RI "struct \fBBarotropicPressurePotential\fP"
.br
.RI "The barotropic pressure primitive A with dA/density = (dP/density)/density\&. "
.ti -1c
.RI "struct \fBChemicalPotential\fP"
.br
.RI "Dimension of Chemical Potential\&. "
.ti -1c
.RI "struct \fBDimensionless\fP"
.br
.RI "Non dimensional type\&. "
.ti -1c
.RI "struct \fBDynamicViscosity\fP"
.br
.RI "Dimension of Dynamic Viscosity\&. "
.ti -1c
.RI "struct \fBEnergy\fP"
.br
.RI "Dimension of \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBEnergyDensity\fP"
.br
.RI "Dimension of \fBEnergy\fP Density\&. "
.ti -1c
.RI "struct \fBEntropy\fP"
.br
.RI "Dimension of \fBEntropy\fP\&. "
.ti -1c
.RI "struct \fBForce\fP"
.br
.RI "Dimension of \fBForce\fP\&. "
.ti -1c
.RI "struct \fBForceDensity\fP"
.br
.RI "\fBForce\fP per unit volume\&. "
.ti -1c
.RI "struct \fBFrequency\fP"
.br
.RI "Dimension of \fBFrequency\fP\&. "
.ti -1c
.RI "struct \fBGravitationalConstant\fP"
.br
.RI "Newton's gravitational constant, expressed in the selected system of units\&. "
.ti -1c
.RI "struct \fBGravitationalPotential\fP"
.br
.RI "Dimension of Gravitational Potential\&. "
.ti -1c
.RI "struct \fBInternalEnergy\fP"
.br
.RI "Dimension of Internal \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBInverseTimeSquared\fP"
.br
.RI "Inverse time squared, the physical dimension of a Poisson residual\&. "
.ti -1c
.RI "struct \fBIsQuantityValue\fP"
.br
.ti -1c
.RI "struct \fBIsQuantityValue< QuantityValue< Quantity > >\fP"
.br
.ti -1c
.RI "struct \fBKinematicViscosity\fP"
.br
.RI "Dimension of Kinematic Viscosity\&. "
.ti -1c
.RI "struct \fBLength\fP"
.br
.RI "Dimension of \fBLength\fP\&. "
.ti -1c
.RI "struct \fBLuminosity\fP"
.br
.RI "Dimension of \fBLuminosity\fP\&. "
.ti -1c
.RI "struct \fBMagneticFluxDensity\fP"
.br
.RI "Dimension of Magnetic Flux Density\&. "
.ti -1c
.RI "struct \fBMass\fP"
.br
.RI "Dimension of mass\&. "
.ti -1c
.RI "struct \fBMassDensity\fP"
.br
.RI "Dimension of \fBMass\fP Density\&. "
.ti -1c
.RI "struct \fBMassDensityRate\fP"
.br
.RI "\fBMass\fP density divided by time,\&. "
.ti -1c
.RI "struct \fBMassFlowRate\fP"
.br
.RI "Dimension of \fBMass\fP Flow Rate\&. "
.ti -1c
.RI "struct \fBMomentOfInertia\fP"
.br
.RI "Dimension of Moment Of Inertia\&. "
.ti -1c
.RI "struct \fBMomentum\fP"
.br
.RI "Dimension of \fBMomentum\fP\&. "
.ti -1c
.RI "struct \fBNumberDensity\fP"
.br
.RI "Dimension of Number Density\&. "
.ti -1c
.RI "struct \fBOpacity\fP"
.br
.RI "Dimension of \fBOpacity\fP\&. "
.ti -1c
.RI "class \fBPartialDerivative\fP"
.br
.RI "Class to represent a compile time derivative relation between two quantities\&. Note that this class does not, in fact cannot, compute any derivatives itself\&. Rather, this is a way for the compiler to understand higher level mathematical relations\&. Unless you are really in the weeds of the development team you will likely not need to interact with this directly\&. Further note that this class does include (unlike the more basic dimension system) some basic dimensional analysis\&. Specifically, there are some overloaded operators that allow for certain specializations of \fBPartialDerivative\fP to operate on one and other conditioned on what their input and output types are\&. This does not do any thing like convert area to length^2\&. However, it will do more basic things like ensure that you can only add two partials which agree on their dimensions exactly\&. Or that while you can multiple a partial by any scalar, you cannot multiply arbitrary partials\&. "
.ti -1c
.RI "struct \fBPhysicalQuantity\fP"
.br
.ti -1c
.RI "struct \fBPower\fP"
.br
.RI "Dimension of \fBPower\fP\&. "
.ti -1c
.RI "struct \fBPressure\fP"
.br
.RI "Dimension of \fBPressure\fP\&. "
.ti -1c
.RI "struct \fBPressureLaplacian\fP"
.br
.RI "\fBPressure\fP divided by length squared\&. "
.ti -1c
.RI "struct \fBQuantityAt\fP"
.br
.ti -1c
.RI "struct \fBQuantityAt< Index, QuantityList< Quantities\&.\&.\&. > >\fP"
.br
.ti -1c
.RI "struct \fBQuantityList\fP"
.br
.ti -1c
.RI "struct \fBQuantityOf\fP"
.br
.ti -1c
.RI "struct \fBQuantityOf< QuantityValue< Quantity > >\fP"
.br
.ti -1c
.RI "class \fBQuantityValue\fP"
.br
.RI "This is the non derivative equivalent to \fBPartialDerivative\fP\&. This associates a dimension with a value and, if that value can be determined at compile time, can be decomposed to a transparent double through \&.\fBvalue()\fP "
.ti -1c
.RI "class \fBSecondPartialDerivative\fP"
.br
.RI "A second EOS partial retains both differentiation quantities in its type\&. "
.ti -1c
.RI "struct \fBSpecificEnergy\fP"
.br
.RI "Dimension of Specific \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBSpecificEnthalpy\fP"
.br
.RI "Dimension of Specific Enthalpy\&. "
.ti -1c
.RI "struct \fBSpecificEntropy\fP"
.br
.RI "Dimension of Specific \fBEntropy\fP\&. "
.ti -1c
.RI "struct \fBSpecificInternalEnergy\fP"
.br
.RI "Dimension of Specific Internal \fBEnergy\fP\&. "
.ti -1c
.RI "struct \fBTemperature\fP"
.br
.RI "Dimension of \fBTemperature\fP\&. "
.ti -1c
.RI "struct \fBThermodynamicQuantity\fP"
.br
.ti -1c
.RI "struct \fBTime\fP"
.br
.RI "Dimension of \fBTime\fP\&. "
.ti -1c
.RI "struct \fBTorque\fP"
.br
.RI "Dimension of \fBTorque\fP\&. "
.ti -1c
.RI "struct \fBVelocity\fP"
.br
.RI "Dimension of \fBVelocity\fP\&. "
.ti -1c
.RI "struct \fBVolume\fP"
.br
.RI "Dimension of \fBVolume\fP\&. "
.ti -1c
.RI "struct \fBWithRespectTo\fP"
.br
.RI "A type that is empty at runtime but allows for the developer to specify to the compiler what quantity the partial is with respect to\&. "
.in -1c
.SS "Concepts"

.in +1c
.ti -1c
.RI "concept \fBPhysicalQuantityType\fP"
.br
.RI "Is compile-time true of the QuantityCandidate can have any const / volatile stripped and if its derived from PhysicalQuantity\&. Note all ThermodynamicQuantities will also satisfy this concept\&. "
.ti -1c
.RI "concept \fBThermodynamicQuantityType\fP"
.br
.RI "Is compile-time true of the QuantityCandidate can have any const / volatile stripped and if its derived from PhysicalQuantity (both enforced through checking \fBPhysicalQuantityType\fP) and then that is is also derived from ThermodynamicQuantity\&. Note not all physical quanties will satisfy this\&. "
.ti -1c
.RI "concept \fBQuantityValueType\fP"
.br
.RI "Turn those compile time structs into a concept that can be used to constrain a template parameter\&. "
.ti -1c
.RI "concept \fBThermodynamicQuantityValueType\fP"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "template<QuantityValueType Value> using \fBQuantityOfT\fP = typename \fBQuantityOf\fP<\fBNeitherConstNorVolatileReference\fP<Value>>::Type"
.br
.ti -1c
.RI "using \fBDimensionlessValue\fP = \fBQuantityValue\fP<\fBDimensionless\fP>"
.br
.RI "A dimensionless quantity, used for quantities that do not have a physical dimension (e\&.g\&., a pure number)\&. "
.ti -1c
.RI "using \fBMassValue\fP = \fBQuantityValue\fP<\fBMass\fP>"
.br
.RI "A quantity representing mass\&. "
.ti -1c
.RI "using \fBLengthValue\fP = \fBQuantityValue\fP<\fBLength\fP>"
.br
.RI "A quantity representing length\&. "
.ti -1c
.RI "using \fBTimeValue\fP = \fBQuantityValue\fP<\fBTime\fP>"
.br
.RI "A quantity representing time\&. "
.ti -1c
.RI "using \fBAreaValue\fP = \fBQuantityValue\fP<\fBArea\fP>"
.br
.RI "A quantity representing area\&. "
.ti -1c
.RI "using \fBVolumeValue\fP = \fBQuantityValue\fP<\fBVolume\fP>"
.br
.RI "A quantity representing volume\&. "
.ti -1c
.RI "using \fBDensityValue\fP = \fBQuantityValue\fP<\fBMassDensity\fP>"
.br
.RI "A quantity representing mass density\&. "
.ti -1c
.RI "using \fBNumberDensityValue\fP = \fBQuantityValue\fP<\fBNumberDensity\fP>"
.br
.RI "A quantity representing number density\&. "
.ti -1c
.RI "using \fBPressureValue\fP = \fBQuantityValue\fP<\fBPressure\fP>"
.br
.RI "A quantity representing pressure\&. "
.ti -1c
.RI "using \fBTemperatureValue\fP = \fBQuantityValue\fP<\fBTemperature\fP>"
.br
.RI "A quantity representing temperature\&. "
.ti -1c
.RI "using \fBEntropyValue\fP = \fBQuantityValue\fP<\fBEntropy\fP>"
.br
.RI "A quantity representing entropy\&. "
.ti -1c
.RI "using \fBSpecificEntropyValue\fP = \fBQuantityValue\fP<\fBSpecificEntropy\fP>"
.br
.RI "A quantity representing specific entropy\&. "
.ti -1c
.RI "using \fBChemicalPotentialValue\fP = \fBQuantityValue\fP<\fBChemicalPotential\fP>"
.br
.RI "A quantity representing chemical potential\&. "
.ti -1c
.RI "using \fBEnergyValue\fP = \fBQuantityValue\fP<\fBEnergy\fP>"
.br
.RI "A quantity representing energy\&.\&. "
.ti -1c
.RI "using \fBInternalEnergyValue\fP = \fBQuantityValue\fP<\fBInternalEnergy\fP>"
.br
.RI "A quantity representing internal energy\&. "
.ti -1c
.RI "using \fBSpecificEnergyValue\fP = \fBQuantityValue\fP<\fBSpecificEnergy\fP>"
.br
.RI "A quantity representing specific energy\&. "
.ti -1c
.RI "using \fBSpecificInternalEnergyValue\fP = \fBQuantityValue\fP<\fBSpecificInternalEnergy\fP>"
.br
.RI "A quantity representing specific internal energy\&. "
.ti -1c
.RI "using \fBSpecificEnthalpyValue\fP = \fBQuantityValue\fP<\fBSpecificEnthalpy\fP>"
.br
.RI "A quantity representing specific enthalpy\&. "
.ti -1c
.RI "using \fBBarotropicPressurePotentialValue\fP = \fBQuantityValue\fP<\fBBarotropicPressurePotential\fP>"
.br
.RI "A barotropic pressure primitive with specific energy units\&. "
.ti -1c
.RI "using \fBEnergyDensityValue\fP = \fBQuantityValue\fP<\fBEnergyDensity\fP>"
.br
.RI "A quantity representing energy density\&. "
.ti -1c
.RI "using \fBGravitationalPotentialValue\fP = \fBQuantityValue\fP<\fBGravitationalPotential\fP>"
.br
.RI "A quantity representing gravitational potential\&. "
.ti -1c
.RI "using \fBVelocityValue\fP = \fBQuantityValue\fP<\fBVelocity\fP>"
.br
.RI "A quantity representing velocity\&. "
.ti -1c
.RI "using \fBAccelerationValue\fP = \fBQuantityValue\fP<\fBAcceleration\fP>"
.br
.RI "A quantity representing acceleration\&. "
.ti -1c
.RI "using \fBFrequencyValue\fP = \fBQuantityValue\fP<\fBFrequency\fP>"
.br
.RI "A quantity representing frequency\&. "
.ti -1c
.RI "using \fBAngularVelocityValue\fP = \fBQuantityValue\fP<\fBAngularVelocity\fP>"
.br
.RI "A quantity representing angular velocity\&. "
.ti -1c
.RI "using \fBMomentumValue\fP = \fBQuantityValue\fP<\fBMomentum\fP>"
.br
.RI "A quantity representing momentum\&. "
.ti -1c
.RI "using \fBAngularMomentumValue\fP = \fBQuantityValue\fP<\fBAngularMomentum\fP>"
.br
.RI "A quantity representing angular momentum\&. "
.ti -1c
.RI "using \fBMomentOfInertiaValue\fP = \fBQuantityValue\fP<\fBMomentOfInertia\fP>"
.br
.RI "A quantity representing moment of inertia\&. "
.ti -1c
.RI "using \fBForceValue\fP = \fBQuantityValue\fP<\fBForce\fP>"
.br
.RI "A quantity representing force\&.\&. "
.ti -1c
.RI "using \fBTorqueValue\fP = \fBQuantityValue\fP<\fBTorque\fP>"
.br
.RI "A quantity representing torque\&. "
.ti -1c
.RI "using \fBPowerValue\fP = \fBQuantityValue\fP<\fBPower\fP>"
.br
.RI "A quantity representing power\&. "
.ti -1c
.RI "using \fBLuminosityValue\fP = \fBQuantityValue\fP<\fBLuminosity\fP>"
.br
.RI "A quantity representing luminosity\&. "
.ti -1c
.RI "using \fBMassFlowRateValue\fP = \fBQuantityValue\fP<\fBMassFlowRate\fP>"
.br
.RI "A quantity representing mass flow rate\&. "
.ti -1c
.RI "using \fBOpacityValue\fP = \fBQuantityValue\fP<\fBOpacity\fP>"
.br
.RI "A quantity representing opacity\&. "
.ti -1c
.RI "using \fBDynamicViscosityValue\fP = \fBQuantityValue\fP<\fBDynamicViscosity\fP>"
.br
.RI "A quantity representing dynamic viscosity\&. "
.ti -1c
.RI "using \fBKinematicViscosityValue\fP = \fBQuantityValue\fP<\fBKinematicViscosity\fP>"
.br
.RI "A quantity representing kinematic viscosity\&. "
.ti -1c
.RI "using \fBMagneticFluxDensityValue\fP = \fBQuantityValue\fP<\fBMagneticFluxDensity\fP>"
.br
.RI "A quantity representing magnetic flux density\&. "
.ti -1c
.RI "template<class T> using \fBNeitherConstNorVolatile\fP"
.br
.ti -1c
.RI "template<class T> using \fBNeitherConstNorVolatileReference\fP"
.br
.in -1c
.SH "Typedef Documentation"
.PP 
.SS "using \fBserif::dimensions::AccelerationValue\fP = \fBQuantityValue\fP<\fBAcceleration\fP>"

.PP
A quantity representing acceleration\&. 
.SS "using \fBserif::dimensions::AngularMomentumValue\fP = \fBQuantityValue\fP<\fBAngularMomentum\fP>"

.PP
A quantity representing angular momentum\&. 
.SS "using \fBserif::dimensions::AngularVelocityValue\fP = \fBQuantityValue\fP<\fBAngularVelocity\fP>"

.PP
A quantity representing angular velocity\&. 
.SS "using \fBserif::dimensions::AreaValue\fP = \fBQuantityValue\fP<\fBArea\fP>"

.PP
A quantity representing area\&. 
.SS "using \fBserif::dimensions::BarotropicPressurePotentialValue\fP = \fBQuantityValue\fP<\fBBarotropicPressurePotential\fP>"

.PP
A barotropic pressure primitive with specific energy units\&. 
.SS "using \fBserif::dimensions::ChemicalPotentialValue\fP = \fBQuantityValue\fP<\fBChemicalPotential\fP>"

.PP
A quantity representing chemical potential\&. 
.SS "using \fBserif::dimensions::DensityValue\fP = \fBQuantityValue\fP<\fBMassDensity\fP>"

.PP
A quantity representing mass density\&. 
.SS "using \fBserif::dimensions::DimensionlessValue\fP = \fBQuantityValue\fP<\fBDimensionless\fP>"

.PP
A dimensionless quantity, used for quantities that do not have a physical dimension (e\&.g\&., a pure number)\&. 
.SS "using \fBserif::dimensions::DynamicViscosityValue\fP = \fBQuantityValue\fP<\fBDynamicViscosity\fP>"

.PP
A quantity representing dynamic viscosity\&. 
.SS "using \fBserif::dimensions::EnergyDensityValue\fP = \fBQuantityValue\fP<\fBEnergyDensity\fP>"

.PP
A quantity representing energy density\&. 
.SS "using \fBserif::dimensions::EnergyValue\fP = \fBQuantityValue\fP<\fBEnergy\fP>"

.PP
A quantity representing energy\&.\&. 
.SS "using \fBserif::dimensions::EntropyValue\fP = \fBQuantityValue\fP<\fBEntropy\fP>"

.PP
A quantity representing entropy\&. 
.SS "using \fBserif::dimensions::ForceValue\fP = \fBQuantityValue\fP<\fBForce\fP>"

.PP
A quantity representing force\&.\&. 
.SS "using \fBserif::dimensions::FrequencyValue\fP = \fBQuantityValue\fP<\fBFrequency\fP>"

.PP
A quantity representing frequency\&. 
.SS "using \fBserif::dimensions::GravitationalPotentialValue\fP = \fBQuantityValue\fP<\fBGravitationalPotential\fP>"

.PP
A quantity representing gravitational potential\&. 
.SS "using \fBserif::dimensions::InternalEnergyValue\fP = \fBQuantityValue\fP<\fBInternalEnergy\fP>"

.PP
A quantity representing internal energy\&. 
.SS "using \fBserif::dimensions::KinematicViscosityValue\fP = \fBQuantityValue\fP<\fBKinematicViscosity\fP>"

.PP
A quantity representing kinematic viscosity\&. 
.SS "using \fBserif::dimensions::LengthValue\fP = \fBQuantityValue\fP<\fBLength\fP>"

.PP
A quantity representing length\&. 
.SS "using \fBserif::dimensions::LuminosityValue\fP = \fBQuantityValue\fP<\fBLuminosity\fP>"

.PP
A quantity representing luminosity\&. 
.SS "using \fBserif::dimensions::MagneticFluxDensityValue\fP = \fBQuantityValue\fP<\fBMagneticFluxDensity\fP>"

.PP
A quantity representing magnetic flux density\&. 
.SS "using \fBserif::dimensions::MassFlowRateValue\fP = \fBQuantityValue\fP<\fBMassFlowRate\fP>"

.PP
A quantity representing mass flow rate\&. 
.SS "using \fBserif::dimensions::MassValue\fP = \fBQuantityValue\fP<\fBMass\fP>"

.PP
A quantity representing mass\&. 
.SS "using \fBserif::dimensions::MomentOfInertiaValue\fP = \fBQuantityValue\fP<\fBMomentOfInertia\fP>"

.PP
A quantity representing moment of inertia\&. 
.SS "using \fBserif::dimensions::MomentumValue\fP = \fBQuantityValue\fP<\fBMomentum\fP>"

.PP
A quantity representing momentum\&. 
.SS "template<class T> using \fBserif::utils::misc::std_helper::NeitherConstNorVolatile\fP"

.SS "template<class T> using \fBserif::utils::misc::std_helper::NeitherConstNorVolatileReference\fP"

.SS "using \fBserif::dimensions::NumberDensityValue\fP = \fBQuantityValue\fP<\fBNumberDensity\fP>"

.PP
A quantity representing number density\&. 
.SS "using \fBserif::dimensions::OpacityValue\fP = \fBQuantityValue\fP<\fBOpacity\fP>"

.PP
A quantity representing opacity\&. 
.SS "using \fBserif::dimensions::PowerValue\fP = \fBQuantityValue\fP<\fBPower\fP>"

.PP
A quantity representing power\&. 
.SS "using \fBserif::dimensions::PressureValue\fP = \fBQuantityValue\fP<\fBPressure\fP>"

.PP
A quantity representing pressure\&. 
.SS "template<QuantityValueType Value> using \fBserif::dimensions::QuantityOfT\fP = typename \fBQuantityOf\fP<\fBNeitherConstNorVolatileReference\fP<Value>>::Type"

.SS "using \fBserif::dimensions::SpecificEnergyValue\fP = \fBQuantityValue\fP<\fBSpecificEnergy\fP>"

.PP
A quantity representing specific energy\&. 
.SS "using \fBserif::dimensions::SpecificEnthalpyValue\fP = \fBQuantityValue\fP<\fBSpecificEnthalpy\fP>"

.PP
A quantity representing specific enthalpy\&. 
.SS "using \fBserif::dimensions::SpecificEntropyValue\fP = \fBQuantityValue\fP<\fBSpecificEntropy\fP>"

.PP
A quantity representing specific entropy\&. 
.SS "using \fBserif::dimensions::SpecificInternalEnergyValue\fP = \fBQuantityValue\fP<\fBSpecificInternalEnergy\fP>"

.PP
A quantity representing specific internal energy\&. 
.SS "using \fBserif::dimensions::TemperatureValue\fP = \fBQuantityValue\fP<\fBTemperature\fP>"

.PP
A quantity representing temperature\&. 
.SS "using \fBserif::dimensions::TimeValue\fP = \fBQuantityValue\fP<\fBTime\fP>"

.PP
A quantity representing time\&. 
.SS "using \fBserif::dimensions::TorqueValue\fP = \fBQuantityValue\fP<\fBTorque\fP>"

.PP
A quantity representing torque\&. 
.SS "using \fBserif::dimensions::VelocityValue\fP = \fBQuantityValue\fP<\fBVelocity\fP>"

.PP
A quantity representing velocity\&. 
.SS "using \fBserif::dimensions::VolumeValue\fP = \fBQuantityValue\fP<\fBVolume\fP>"

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