Update documentation (#233)

acodcha · Jul 30, 2024 · ad55101 · ad55101
1 parent 560460e
commit ad55101
Show file tree

Hide file tree

Showing 2 changed files with 143 additions and 143 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Contents:
 - [Configuration](#configuration): [CMake](#configuration-cmake), [Bazel](#configuration-bazel)
 - [Background](#background): [Theory](#background-theory), [Design](#background-design)
 - [User Guide](#user-guide): [Basics](#user-guide-basics), [Vectors and Tensors](#user-guide-vectors-and-tensors), [Operations](#user-guide-operations), [Units](#user-guide-units), [Unit Systems](#user-guide-unit-systems), [Models](#user-guide-models), [Dimensions](#user-guide-dimensions)
-- [Features](#features): [Physical Quantities](#features-physical-quantities), [Physical Models](#features-physical-models), [Units](#features-units), [Unit Systems](#features-unit-systems)
+- [Features](#features): [Physical Quantities](#features-physical-quantities), [Models](#features-models), [Units](#features-units), [Unit Systems](#features-unit-systems)
 - [Developer Guide](#developer-guide): [Documentation](#developer-guide-documentation), [Installation](#developer-guide-installation), [Testing](#developer-guide-testing), [Coverage](#developer-guide-coverage)
 - [License](#license)
 
@@ -565,7 +565,7 @@ The above example obtains the physical dimension set of mass density, which is L
 This section provides an overview of the features of the Physical Quantities library:
 
 - [Physical Quantities](#features-physical-quantities)
-- [Physical Models](#features-physical-models)
+- [Models](#features-models)
 - [Units](#features-units)
 - [Unit Systems](#features-unit-systems)
 
@@ -575,164 +575,164 @@ This section provides an overview of the features of the Physical Quantities lib
 
 The Physical Quantities library features the following physical quantities:
 
-- PhQ::Acceleration
-- PhQ::Angle
-- PhQ::AngularSpeed
-- PhQ::Area
-- PhQ::BulkDynamicViscosity
-- PhQ::Direction
-- PhQ::Displacement
-- PhQ::DisplacementGradient
-- PhQ::DynamicKinematicPressure
-- PhQ::DynamicPressure
-- PhQ::DynamicViscosity
-- PhQ::ElectricCharge
-- PhQ::ElectricCurrent
-- PhQ::Energy
-- PhQ::Force
-- PhQ::Frequency
-- PhQ::GasConstant
-- PhQ::HeatCapacityRatio
-- PhQ::HeatFlux
-- PhQ::IsentropicBulkModulus
-- PhQ::IsobaricHeatCapacity
-- PhQ::IsochoricHeatCapacity
-- PhQ::IsothermalBulkModulus
-- PhQ::KinematicViscosity
-- PhQ::LameFirstModulus
-- PhQ::Length
-- PhQ::LinearThermalExpansionCoefficient
-- PhQ::MachNumber
-- PhQ::Mass
-- PhQ::MassDensity
-- PhQ::MassRate
-- PhQ::Memory
-- PhQ::MemoryRate
-- PhQ::PWaveModulus
-- PhQ::PlanarAcceleration
-- PhQ::PlanarDirection
-- PhQ::PlanarDisplacement
-- PhQ::PlanarForce
-- PhQ::PlanarHeatFlux
-- PhQ::PlanarPosition
-- PhQ::PlanarTemperatureGradient
-- PhQ::PlanarTraction
-- PhQ::PlanarVelocity
-- PhQ::PoissonRatio
-- PhQ::Position
-- PhQ::Power
-- PhQ::PrandtlNumber
-- PhQ::ReynoldsNumber
-- PhQ::ScalarAcceleration
-- PhQ::ScalarAngularAcceleration
-- PhQ::ScalarDisplacementGradient
-- PhQ::ScalarForce
-- PhQ::ScalarHeatFlux
-- PhQ::ScalarStrain
-- PhQ::ScalarStrainRate
-- PhQ::ScalarStress
-- PhQ::ScalarTemperatureGradient
-- PhQ::ScalarThermalConductivity
-- PhQ::ScalarTraction
-- PhQ::ScalarVelocityGradient
-- PhQ::ShearModulus
-- PhQ::SolidAngle
-- PhQ::SoundSpeed
-- PhQ::SpecificEnergy
-- PhQ::SpecificGasConstant
-- PhQ::SpecificIsobaricHeatCapacity
-- PhQ::SpecificIsochoricHeatCapacity
-- PhQ::SpecificPower
-- PhQ::Speed
-- PhQ::StaticKinematicPressure
-- PhQ::StaticPressure
-- PhQ::Strain
-- PhQ::StrainRate
-- PhQ::Stress
-- PhQ::SubstanceAmount
-- PhQ::Temperature
-- PhQ::TemperatureDifference
-- PhQ::TemperatureGradient
-- PhQ::ThermalConductivity
-- PhQ::ThermalDiffusivity
-- PhQ::Time
-- PhQ::TotalKinematicPressure
-- PhQ::TotalPressure
-- PhQ::Traction
-- PhQ::TransportEnergyConsumption
-- PhQ::VectorArea
-- PhQ::Velocity
-- PhQ::VelocityGradient
-- PhQ::Volume
-- PhQ::VolumeRate
-- PhQ::VolumetricThermalExpansionCoefficient
-- PhQ::YoungModulus
+- [PhQ::Acceleration](include/PhQ/Acceleration.hpp)
+- [PhQ::Angle](include/PhQ/Angle.hpp)
+- [PhQ::AngularSpeed](include/PhQ/AngularSpeed.hpp)
+- [PhQ::Area](include/PhQ/Area.hpp)
+- [PhQ::BulkDynamicViscosity](include/PhQ/BulkDynamicViscosity.hpp)
+- [PhQ::Direction](include/PhQ/Direction.hpp)
+- [PhQ::Displacement](include/PhQ/Displacement.hpp)
+- [PhQ::DisplacementGradient](include/PhQ/DisplacementGradient.hpp)
+- [PhQ::DynamicKinematicPressure](include/PhQ/DynamicKinematicPressure.hpp)
+- [PhQ::DynamicPressure](include/PhQ/DynamicPressure.hpp)
+- [PhQ::DynamicViscosity](include/PhQ/DynamicViscosity.hpp)
+- [PhQ::ElectricCharge](include/PhQ/ElectricCharge.hpp)
+- [PhQ::ElectricCurrent](include/PhQ/ElectricCurrent.hpp)
+- [PhQ::Energy](include/PhQ/Energy.hpp)
+- [PhQ::Force](include/PhQ/Force.hpp)
+- [PhQ::Frequency](include/PhQ/Frequency.hpp)
+- [PhQ::GasConstant](include/PhQ/GasConstant.hpp)
+- [PhQ::HeatCapacityRatio](include/PhQ/HeatCapacityRatio.hpp)
+- [PhQ::HeatFlux](include/PhQ/HeatFlux.hpp)
+- [PhQ::IsentropicBulkModulus](include/PhQ/IsentropicBulkModulus.hpp)
+- [PhQ::IsobaricHeatCapacity](include/PhQ/IsobaricHeatCapacity.hpp)
+- [PhQ::IsochoricHeatCapacity](include/PhQ/IsochoricHeatCapacity.hpp)
+- [PhQ::IsothermalBulkModulus](include/PhQ/IsothermalBulkModulus.hpp)
+- [PhQ::KinematicViscosity](include/PhQ/KinematicViscosity.hpp)
+- [PhQ::LameFirstModulus](include/PhQ/LameFirstModulus.hpp)
+- [PhQ::Length](include/PhQ/Length.hpp)
+- [PhQ::LinearThermalExpansionCoefficient](include/PhQ/LinearThermalExpansionCoefficient.hpp)
+- [PhQ::MachNumber](include/PhQ/MachNumber.hpp)
+- [PhQ::Mass](include/PhQ/Mass.hpp)
+- [PhQ::MassDensity](include/PhQ/MassDensity.hpp)
+- [PhQ::MassRate](include/PhQ/MassRate.hpp)
+- [PhQ::Memory](include/PhQ/Memory.hpp)
+- [PhQ::MemoryRate](include/PhQ/MemoryRate.hpp)
+- [PhQ::PWaveModulus](include/PhQ/PWaveModulus.hpp)
+- [PhQ::PlanarAcceleration](include/PhQ/PlanarAcceleration.hpp)
+- [PhQ::PlanarDirection](include/PhQ/PlanarDirection.hpp)
+- [PhQ::PlanarDisplacement](include/PhQ/PlanarDisplacement.hpp)
+- [PhQ::PlanarForce](include/PhQ/PlanarForce.hpp)
+- [PhQ::PlanarHeatFlux](include/PhQ/PlanarHeatFlux.hpp)
+- [PhQ::PlanarPosition](include/PhQ/PlanarPosition.hpp)
+- [PhQ::PlanarTemperatureGradient](include/PhQ/PlanarTemperatureGradient.hpp)
+- [PhQ::PlanarTraction](include/PhQ/PlanarTraction.hpp)
+- [PhQ::PlanarVelocity](include/PhQ/PlanarVelocity.hpp)
+- [PhQ::PoissonRatio](include/PhQ/PoissonRatio.hpp)
+- [PhQ::Position](include/PhQ/Position.hpp)
+- [PhQ::Power](include/PhQ/Power.hpp)
+- [PhQ::PrandtlNumber](include/PhQ/PrandtlNumber.hpp)
+- [PhQ::ReynoldsNumber](include/PhQ/ReynoldsNumber.hpp)
+- [PhQ::ScalarAcceleration](include/PhQ/ScalarAcceleration.hpp)
+- [PhQ::ScalarAngularAcceleration](include/PhQ/ScalarAngularAcceleration.hpp)
+- [PhQ::ScalarDisplacementGradient](include/PhQ/ScalarDisplacementGradient.hpp)
+- [PhQ::ScalarForce](include/PhQ/ScalarForce.hpp)
+- [PhQ::ScalarHeatFlux](include/PhQ/ScalarHeatFlux.hpp)
+- [PhQ::ScalarStrain](include/PhQ/ScalarStrain.hpp)
+- [PhQ::ScalarStrainRate](include/PhQ/ScalarStrainRate.hpp)
+- [PhQ::ScalarStress](include/PhQ/ScalarStress.hpp)
+- [PhQ::ScalarTemperatureGradient](include/PhQ/ScalarTemperatureGradient.hpp)
+- [PhQ::ScalarThermalConductivity](include/PhQ/ScalarThermalConductivity.hpp)
+- [PhQ::ScalarTraction](include/PhQ/ScalarTraction.hpp)
+- [PhQ::ScalarVelocityGradient](include/PhQ/ScalarVelocityGradient.hpp)
+- [PhQ::ShearModulus](include/PhQ/ShearModulus.hpp)
+- [PhQ::SolidAngle](include/PhQ/SolidAngle.hpp)
+- [PhQ::SoundSpeed](include/PhQ/SoundSpeed.hpp)
+- [PhQ::SpecificEnergy](include/PhQ/SpecificEnergy.hpp)
+- [PhQ::SpecificGasConstant](include/PhQ/SpecificGasConstant.hpp)
+- [PhQ::SpecificIsobaricHeatCapacity](include/PhQ/SpecificIsobaricHeatCapacity.hpp)
+- [PhQ::SpecificIsochoricHeatCapacity](include/PhQ/SpecificIsochoricHeatCapacity.hpp)
+- [PhQ::SpecificPower](include/PhQ/SpecificPower.hpp)
+- [PhQ::Speed](include/PhQ/Speed.hpp)
+- [PhQ::StaticKinematicPressure](include/PhQ/StaticKinematicPressure.hpp)
+- [PhQ::StaticPressure](include/PhQ/StaticPressure.hpp)
+- [PhQ::Strain](include/PhQ/Strain.hpp)
+- [PhQ::StrainRate](include/PhQ/StrainRate.hpp)
+- [PhQ::Stress](include/PhQ/Stress.hpp)
+- [PhQ::SubstanceAmount](include/PhQ/SubstanceAmount.hpp)
+- [PhQ::Temperature](include/PhQ/Temperature.hpp)
+- [PhQ::TemperatureDifference](include/PhQ/TemperatureDifference.hpp)
+- [PhQ::TemperatureGradient](include/PhQ/TemperatureGradient.hpp)
+- [PhQ::ThermalConductivity](include/PhQ/ThermalConductivity.hpp)
+- [PhQ::ThermalDiffusivity](include/PhQ/ThermalDiffusivity.hpp)
+- [PhQ::Time](include/PhQ/Time.hpp)
+- [PhQ::TotalKinematicPressure](include/PhQ/TotalKinematicPressure.hpp)
+- [PhQ::TotalPressure](include/PhQ/TotalPressure.hpp)
+- [PhQ::Traction](include/PhQ/Traction.hpp)
+- [PhQ::TransportEnergyConsumption](include/PhQ/TransportEnergyConsumption.hpp)
+- [PhQ::VectorArea](include/PhQ/VectorArea.hpp)
+- [PhQ::Velocity](include/PhQ/Velocity.hpp)
+- [PhQ::VelocityGradient](include/PhQ/VelocityGradient.hpp)
+- [PhQ::Volume](include/PhQ/Volume.hpp)
+- [PhQ::VolumeRate](include/PhQ/VolumeRate.hpp)
+- [PhQ::VolumetricThermalExpansionCoefficient](include/PhQ/VolumetricThermalExpansionCoefficient.hpp)
+- [PhQ::YoungModulus](include/PhQ/YoungModulus.hpp)
 
 [(Back to Features)](#features)
 
-### Features: Physical Models
+### Features: Models
 
 The Physical Quantities library features the following physical models:
 
-- PhQ::ConstitutiveModel
-  - PhQ::ConstitutiveModel::CompressibleNewtonianFluid
-  - PhQ::ConstitutiveModel::ElasticIsotropicSolid
-  - PhQ::ConstitutiveModel::IncompressibleNewtonianFluid
+- [PhQ::ConstitutiveModel](include/PhQ/ConstitutiveModel.hpp)
+  - [PhQ::ConstitutiveModel::CompressibleNewtonianFluid](include/PhQ/ConstitutiveModel/CompressibleNewtonianFluid.hpp)
+  - [PhQ::ConstitutiveModel::ElasticIsotropicSolid](include/PhQ/ConstitutiveModel/ElasticIsotropicSolid.hpp)
+  - [PhQ::ConstitutiveModel::IncompressibleNewtonianFluid](include/PhQ/ConstitutiveModel/IncompressibleNewtonianFluid.hpp)
 
 [(Back to Features)](#features)
 
 ### Features: Units
 
 The Physical Quantities library features the following units of measure:
 
-- PhQ::Unit::Acceleration
-- PhQ::Unit::Angle
-- PhQ::Unit::AngularAcceleration
-- PhQ::Unit::AngularSpeed
-- PhQ::Unit::Area
-- PhQ::Unit::Diffusivity
-- PhQ::Unit::DynamicViscosity
-- PhQ::Unit::ElectricCharge
-- PhQ::Unit::ElectricCurrent
-- PhQ::Unit::Energy
-- PhQ::Unit::EnergyFlux
-- PhQ::Unit::Force
-- PhQ::Unit::Frequency
-- PhQ::Unit::HeatCapacity
-- PhQ::Unit::Length
-- PhQ::Unit::Mass
-- PhQ::Unit::MassDensity
-- PhQ::Unit::MassRate
-- PhQ::Unit::Memory
-- PhQ::Unit::MemoryRate
-- PhQ::Unit::Power
-- PhQ::Unit::Pressure
-- PhQ::Unit::SolidAngle
-- PhQ::Unit::SpecificEnergy
-- PhQ::Unit::SpecificHeatCapacity
-- PhQ::Unit::SpecificPower
-- PhQ::Unit::Speed
-- PhQ::Unit::SubstanceAmount
-- PhQ::Unit::Temperature
-- PhQ::Unit::TemperatureDifference
-- PhQ::Unit::TemperatureGradient
-- PhQ::Unit::ThermalConductivity
-- PhQ::Unit::ThermalExpansion
-- PhQ::Unit::Time
-- PhQ::Unit::TransportEnergyConsumption
-- PhQ::Unit::Volume
-- PhQ::Unit::VolumeRate
+- [PhQ::Unit::Acceleration](include/PhQ/Unit/Acceleration.hpp)
+- [PhQ::Unit::Angle](include/PhQ/Unit/Angle.hpp)
+- [PhQ::Unit::AngularAcceleration](include/PhQ/Unit/AngularAcceleration.hpp)
+- [PhQ::Unit::AngularSpeed](include/PhQ/Unit/AngularSpeed.hpp)
+- [PhQ::Unit::Area](include/PhQ/Unit/Area.hpp)
+- [PhQ::Unit::Diffusivity](include/PhQ/Unit/Diffusivity.hpp)
+- [PhQ::Unit::DynamicViscosity](include/PhQ/Unit/DynamicViscosity.hpp)
+- [PhQ::Unit::ElectricCharge](include/PhQ/Unit/ElectricCharge.hpp)
+- [PhQ::Unit::ElectricCurrent](include/PhQ/Unit/ElectricCurrent.hpp)
+- [PhQ::Unit::Energy](include/PhQ/Unit/Energy.hpp)
+- [PhQ::Unit::EnergyFlux](include/PhQ/Unit/EnergyFlux.hpp)
+- [PhQ::Unit::Force](include/PhQ/Unit/Force.hpp)
+- [PhQ::Unit::Frequency](include/PhQ/Unit/Frequency.hpp)
+- [PhQ::Unit::HeatCapacity](include/PhQ/Unit/HeatCapacity.hpp)
+- [PhQ::Unit::Length](include/PhQ/Unit/Length.hpp)
+- [PhQ::Unit::Mass](include/PhQ/Unit/Mass.hpp)
+- [PhQ::Unit::MassDensity](include/PhQ/Unit/MassDensity.hpp)
+- [PhQ::Unit::MassRate](include/PhQ/Unit/MassRate.hpp)
+- [PhQ::Unit::Memory](include/PhQ/Unit/Memory.hpp)
+- [PhQ::Unit::MemoryRate](include/PhQ/Unit/MemoryRate.hpp)
+- [PhQ::Unit::Power](include/PhQ/Unit/Power.hpp)
+- [PhQ::Unit::Pressure](include/PhQ/Unit/Pressure.hpp)
+- [PhQ::Unit::SolidAngle](include/PhQ/Unit/SolidAngle.hpp)
+- [PhQ::Unit::SpecificEnergy](include/PhQ/Unit/SpecificEnergy.hpp)
+- [PhQ::Unit::SpecificHeatCapacity](include/PhQ/Unit/SpecificHeatCapacity.hpp)
+- [PhQ::Unit::SpecificPower](include/PhQ/Unit/SpecificPower.hpp)
+- [PhQ::Unit::Speed](include/PhQ/Unit/Speed.hpp)
+- [PhQ::Unit::SubstanceAmount](include/PhQ/Unit/SubstanceAmount.hpp)
+- [PhQ::Unit::Temperature](include/PhQ/Unit/Temperature.hpp)
+- [PhQ::Unit::TemperatureDifference](include/PhQ/Unit/TemperatureDifference.hpp)
+- [PhQ::Unit::TemperatureGradient](include/PhQ/Unit/TemperatureGradient.hpp)
+- [PhQ::Unit::ThermalConductivity](include/PhQ/Unit/ThermalConductivity.hpp)
+- [PhQ::Unit::ThermalExpansion](include/PhQ/Unit/ThermalExpansion.hpp)
+- [PhQ::Unit::Time](include/PhQ/Unit/Time.hpp)
+- [PhQ::Unit::TransportEnergyConsumption](include/PhQ/Unit/TransportEnergyConsumption.hpp)
+- [PhQ::Unit::Volume](include/PhQ/Unit/Volume.hpp)
+- [PhQ::Unit::VolumeRate](include/PhQ/Unit/VolumeRate.hpp)
 
 [(Back to Features)](#features)
 
 ### Features: Unit Systems
 
 The Physical Quantities library features the following consistent systems of units of measure:
 
-- PhQ::UnitSystem::MetreKilogramSecondKelvin
-- PhQ::UnitSystem::MillimetreGramSecondKelvin
-- PhQ::UnitSystem::FootPoundSecondRankine
-- PhQ::UnitSystem::InchPoundSecondRankine
+- [PhQ::UnitSystem::MetreKilogramSecondKelvin](include/PhQ/UnitSystem.hpp)
+- [PhQ::UnitSystem::MillimetreGramSecondKelvin](include/PhQ/UnitSystem.hpp)
+- [PhQ::UnitSystem::FootPoundSecondRankine](include/PhQ/UnitSystem.hpp)
+- [PhQ::UnitSystem::InchPoundSecondRankine](include/PhQ/UnitSystem.hpp)
 
 [(Back to Features)](#features)
 

diff --git a/docs/main.txt b/docs/main.txt
@@ -8,7 +8,7 @@
 /// - \ref configuration "Configuration": \ref configuration_cmake "CMake", \ref configuration_bazel "Bazel"
 /// - \ref background "Background": \ref background_theory "Theory", \ref background_design "Design"
 /// - \ref user_guide "User Guide": \ref user_guide_basics "Basics", \ref user_guide_vectors_and_tensors "Vectors and Tensors", \ref user_guide_operations "Operations", \ref user_guide_units "Units", \ref user_guide_unit_systems "Unit Systems", \ref user_guide_models "Models", \ref user_guide_dimensions "Dimensions"
-/// - \ref features "Features": \ref features_physical_quantities "Physical Quantities", \ref features_physical_models "Physical Models", \ref features_units "Units", \ref features_unit_systems "Unit Systems"
+/// - \ref features "Features": \ref features_physical_quantities "Physical Quantities", \ref features_models "Models", \ref features_units "Units", \ref features_unit_systems "Unit Systems"
 /// - \ref developer_guide "Developer Guide": \ref developer_guide_documentation "Documentation", \ref developer_guide_installation "Installation", \ref developer_guide_testing "Testing", \ref developer_guide_coverage "Coverage"
 /// - \ref license "License"
 ///
@@ -567,7 +567,7 @@
 /// This section provides an overview of the features of the Physical Quantities library:
 ///
 /// - \ref features_physical_quantities "Physical Quantities"
-/// - \ref features_physical_models "Physical Models"
+/// - \ref features_models "Models"
 /// - \ref features_units "Units"
 /// - \ref features_unit_systems "Unit Systems"
 ///
@@ -672,7 +672,7 @@
 ///
 /// \ref features "(Back to Features)"
 ///
-/// \subsection features_physical_models Features: Physical Models
+/// \subsection features_models Features: Models
 ///
 /// The Physical Quantities library features the following physical models:
 ///