Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions Physlib/FluidDynamics/API-map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
version: v0.1

Title: "Fluid"

Overview: |
A fluid is described by the spatial distribution of its velocity, density, and
pressure fields. This is a core data structure of fluid dynamics from which the
continuity equation, the equations of motion, and thermodynamic balance laws are
built (Landau and Lifshitz, Fluid Mechanics, vol. 6, 2nd ed., Chapter 1).

At present the fluid state carries density and velocity but not pressure, so the
data structure covers only part of the requirement. The mass flux density and
the equation of continuity are fully formalized, the latter in conservative,
residual, and smooth forms with the implication between them. The Euler
equation, the ideal fluid, entropy flux, the Bernoulli equation, energy flux,
and flow out of a volume are open; they are recorded below with location N/A.

ParentAPIs:
- Space (Physlib/SpaceAndTime/Space)
- Time (Physlib/SpaceAndTime/Time)

References:
- "Landau, L. D. and Lifshitz, E. M., Fluid Mechanics (Course of Theoretical Physics, vol. 6), 2nd ed., Chapter 1 (continuity, Euler equation, Bernoulli equation, energy and momentum flux)"

Requirements:

- description: >
The key data structure for a fluid, given by the spatial distribution of its
velocity, density, and pressure, is defined. (FluidState currently provides
the density and velocity fields; pressure is not yet part of the structure.)
done: false
location: "Physlib/FluidDynamics/FluidState.lean (FluidState, FluidInMomentumBalance, ScalarField, VectorField, MassDensity, VelocityField, StressTensor)"

- description: >
Flow out of a volume: the flux of fluid through the boundary of a spatial
region.
done: false
location: "N/A"

- description: >
Mass flux density rho u, the vector whose divergence enters the continuity
equation. (Defined as momentumDensity, which equals rho u.)
done: true
location: "Physlib/FluidDynamics/NavierStokes/Momentum.lean (momentumDensity)"

- description: >
Equation of continuity, expressing local conservation of mass as
partial_t rho + div (rho u) = 0.
done: true
location: "Physlib/FluidDynamics/NavierStokes/Continuity.lean (ClassicalContinuityEquation, continuityResidual, SmoothContinuityEquation, SmoothContinuityEquation.toClassical)"

- description: >
Euler's equation, the equation of motion of an ideal (inviscid) fluid.
done: false
location: "N/A"

- description: >
Definition of an ideal fluid.
done: false
location: "N/A"

- description: >
Definition of the entropy flux density.
done: false
location: "N/A"

- description: >
Bernoulli's equation.
done: false
location: "N/A"

- description: >
Energy flux of a fluid.
done: false
location: "N/A"
Loading