diff --git a/README.md b/README.md index 1c598c8..2347403 100644 --- a/README.md +++ b/README.md @@ -10,6 +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) - [Developer Guide](#developer-guide): [Documentation](#developer-guide-documentation), [Installation](#developer-guide-installation), [Testing](#developer-guide-testing), [Coverage](#developer-guide-coverage) - [License](#license) @@ -559,6 +560,182 @@ The above example obtains the physical dimension set of mass density, which is L [(Back to User Guide)](#user-guide) +## Features + +This section provides an overview of the features of the Physical Quantities library: + +- [Physical Quantities](#features-physical-quantities) +- [Physical Models](#features-physical-models) +- [Units](#features-units) +- [Unit Systems](#features-unit-systems) + +[(Back to Top)](#physical-quantities) + +### Features: Physical Quantities + +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 + +[(Back to Features)](#features) + +### Features: Physical Models + +The Physical Quantities library features the following physical models: + +- PhQ::ConstitutiveModel + - PhQ::ConstitutiveModel::CompressibleNewtonianFluid + - PhQ::ConstitutiveModel::ElasticIsotropicSolid + - PhQ::ConstitutiveModel::IncompressibleNewtonianFluid + +[(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 + +[(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 + +[(Back to Features)](#features) + ## Developer Guide This section presents information pertinent to software developers of the Physical Quantities library: diff --git a/docs/main.txt b/docs/main.txt index 2c1649d..b85c636 100644 --- a/docs/main.txt +++ b/docs/main.txt @@ -8,6 +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 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" /// @@ -561,6 +562,182 @@ /// /// \ref user_guide "(Back to User Guide)" /// +/// \section features Features Guide +/// +/// 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_units "Units" +/// - \ref features_unit_systems "Unit Systems" +/// +/// \ref index "(Back to Top)" +/// +/// \subsection features_physical_quantities Features: Physical Quantities +/// +/// 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 +/// +/// \ref features "(Back to Features)" +/// +/// \subsection features_physical_models Features: Physical Models +/// +/// The Physical Quantities library features the following physical models: +/// +/// - PhQ::ConstitutiveModel +/// - PhQ::ConstitutiveModel::CompressibleNewtonianFluid +/// - PhQ::ConstitutiveModel::ElasticIsotropicSolid +/// - PhQ::ConstitutiveModel::IncompressibleNewtonianFluid +/// +/// \ref features "(Back to Features)" +/// +/// \subsection features_units 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 +/// +/// \ref features "(Back to Features)" +/// +/// \subsection features_unit_systems 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 +/// +/// \ref features "(Back to Features)" +/// /// \section developer_guide Developer Guide /// /// This section presents information pertinent to software developers of the Physical Quantities library: