docs(fluid-dynamics): add fluid API map#1450
Conversation
|
Thank you for this PR, which will now be reviewed. If submitting to ./Physlib or ./QuantumInfo, please see our review guidelines if you are not familiar with the process. You should expect a back and forth with a reviewer before your PR is merged. See also that link for how to add appropriate labels to your PR. The PR will also go through a number of automated checks. You can learn more about these here, including how to run them locally. If you are submitting to ./PhyslibAlpha there will be a lighter review process, though your PR must still pass the automated checks. If you want to bring attention to this PR, please write a message on this thread of the Lean Zulip. Important: If a reviewer adds an |
|
This will likely need an update based on Physlib#1125, which I will merge now. |
Motivation
Related to #1414, the tracking map for the fluid API in #887. An API map records the implemented status and source location of each requirement for an API, so the gap between a planned API and the current library stays visible in-tree.
Changes
Adds
Physlib/FluidDynamics/API-map.yaml.The completed entries cover what exists: the mass flux density
momentumDensityand the equation of continuity in its conservative, residual and smooth forms with the implication between them. The fluid data structure is recorded as not done, sinceFluidStatecurrently provides density and velocity but the requirement also asks for pressure. The Euler equation, ideal fluid, entropy flux, Bernoulli equation, energy flux and flow out of a volume are not implemented and carry locationN/A.References cite Landau and Lifshitz, Fluid Mechanics, vol. 6, 2nd ed., Chapter 1.
Testing
Ran the API-map linter:
Every declared source file and name resolves; no completed entry is missing a location.