[doc] Update Fluid_Simulation

tum-pbs · Oct 25, 2023 · 04f1283 · 04f1283
1 parent 67a8171
commit 04f1283
Show file tree

Hide file tree

Showing 6 changed files with 6,003 additions and 108 deletions.
diff --git a/.github/workflows/update-gh-pages.yml b/.github/workflows/update-gh-pages.yml
@@ -25,7 +25,7 @@ jobs:
         run: |
           python --version
           python -m pip install --upgrade pip
-          pip install --quiet pdoc3 tensorflow torch jax jaxlib plotly "nbformat==5.4.0" ipython notebook ipywidgets
+          pip install --quiet pdoc3 tensorflow torch jax jaxlib plotly "nbformat==5.4.0" ipython notebook ipywidgets tqdm
           pip install .
           pip list
         

diff --git a/PhiML b/PhiML
diff --git a/docs/Fluid_Simulation.ipynb b/docs/Fluid_Simulation.ipynb
diff --git a/docs/Fluid_Simulation.md b/docs/Fluid_Simulation.md
diff --git a/docs/Physics.md b/docs/Physics.md
@@ -1,6 +1,6 @@
 # Physics
 
-The module [`phi.physics`](phi/physics/) provides a library of common operations used to solve partial differential equations like [fluids](Fluid_Simulation.md).
+The module [`phi.physics`](phi/physics/) provides a library of common operations used to solve partial differential equations like [fluids](Fluid_Simulation.html).
 It builds on the [field](Fields.md), [geometry](Geometry.md) and [math](Math.html) modules and constitutes the highest-level API for physical simulations in Φ<sub>Flow</sub>.
 Similar to the field module, physics functions act on data structures represented by the [`Field`](phi/field/#phi.field.Field) class.
 

diff --git a/docs/index.md b/docs/index.md
@@ -53,12 +53,12 @@
 
 ### Module Documentation
 
-| Module API                                                                                                                                                                                                                                 | Documentation                                                                                                                                                                                                                                                                                                                                                                                     |
-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [phi.vis](phi/vis)                                                                                                                                                                                                                         | [Visualization](Visualization.md): Plotting, interactive user interfaces <br /> [Dash](Web_Interface.md): Web interface <br /> [Console](ConsoleUI.md): Command line interface                                                                                                                                                                                                                    |
-| [phi.physics](phi/physics) <br /> [phi.physics.advect](phi/physics/advect.html) <br /> [phi.physics.fluid](phi/physics/fluid.html) <br /> [phi.physics.diffuse](phi/physics/diffuse.html) | [Fluids Tutorial](Fluids_Tutorial.html): Introduction to core classes and fluid-related functions. <br /> [Higher-order schemes](Taylor_Green_Comparison.html): Compares the accuracy of various numerial schemes. <br /> [Overview](Physics.md): Domains, built-in physics functions <br /> [Functions for Fluid Simulations](Fluid_Simulation.md): Advection, projection, diffusion |
-| [phi.field](phi/field)                                                                                                                                                                                                                     | [Overview](Fields.md): Grids, particles <br /> [Staggered Grids](Staggered_Grids.html): Data layout, usage <br /> [Reading and Writing Simulation Data](Reading_and_Writing_Data.md) <br /> [Scene Format Specification](Scene_Format_Specification.md): Directory layout, file format                                                                                                            |
-| [phi.geom](phi/geom)                                                                                                                                                                                                                       | [Overview](Geometry.md): Differentiable Geometry                                                                                                                                                                                                                                                                                                                                                  |
+| Module API                                                                                                                                                                                                                                 | Documentation                                                                                                                                                                                                                                                                                                                                                                           |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [phi.vis](phi/vis)                                                                                                                                                                                                                         | [Visualization](Visualization.md): Plotting, interactive user interfaces <br /> [Dash](Web_Interface.md): Web interface <br /> [Console](ConsoleUI.md): Command line interface                                                                                                                                                                                                          |
+| [phi.physics](phi/physics) <br /> [phi.physics.advect](phi/physics/advect.html) <br /> [phi.physics.fluid](phi/physics/fluid.html) <br /> [phi.physics.diffuse](phi/physics/diffuse.html) | [Fluids Tutorial](Fluids_Tutorial.html): Introduction to core classes and fluid-related functions. <br /> [Higher-order schemes](Taylor_Green_Comparison.html): Compares the accuracy of various numerial schemes. <br /> [Overview](Physics.md): Domains, built-in physics functions <br /> [Functions for Fluid Simulations](Fluid_Simulation.html): Advection, projection, diffusion |
+| [phi.field](phi/field)                                                                                                                                                                                                                     | [Overview](Fields.md): Grids, particles <br /> [Staggered Grids](Staggered_Grids.html): Data layout, usage <br /> [Reading and Writing Simulation Data](Reading_and_Writing_Data.md) <br /> [Scene Format Specification](Scene_Format_Specification.md): Directory layout, file format                                                                                                  |
+| [phi.geom](phi/geom)                                                                                                                                                                                                                       | [Overview](Geometry.md): Differentiable Geometry                                                                                                                                                                                                                                                                                                                                        |
 
 
 ### Core Classes
+8 −1		phiml/backend/_backend.py
+9 −1		phiml/math/__init__.py
+5 −3		phiml/math/_magic_ops.py
+11 −10		phiml/math/_nd.py
+106 −25		phiml/math/_ops.py
+91 −13		phiml/math/_shape.py
+6 −0		phiml/math/_sparse.py
+20 −14		phiml/math/_tensors.py
+16 −12		phiml/math/_trace.py
+199 −56		phiml/math/extrapolation.py
+2 −2		phiml/math/magic.py
+11 −1		tests/commit/backend/test__backend.py
+8 −1		tests/commit/math/test__functional.py
+6 −0		tests/commit/math/test__ops.py
+19 −0		tests/commit/math/test__shape.py
+10 −1		tests/commit/math/test__sparse.py
+8 −1		tests/commit/math/test_extrapolation.py