consistent naming for Moments. Macroscopic is now an alias for zeroth…

… and first moments.
Autodesk · Aug 18, 2024 · 4cecd27 · 4cecd27
1 parent b15bb05
commit 4cecd27
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/xlb/operator/macroscopic/__init__.py b/xlb/operator/macroscopic/__init__.py
@@ -1,2 +1,2 @@
-from xlb.operator.macroscopic.macroscopic import Macroscopic as Macroscopic
+from xlb.operator.macroscopic.zero_first_moments import FirstAndZerothMoment as Macroscopic
 from xlb.operator.macroscopic.second_moment import SecondMoment as SecondMoment
diff --git a/xlb/operator/macroscopic/macroscopic.py → ...perator/macroscopic/zero_first_moments.py b/xlb/operator/macroscopic/macroscopic.py → ...perator/macroscopic/zero_first_moments.py
@@ -10,9 +10,9 @@
 from xlb.operator.operator import Operator
 
 
-class Macroscopic(Operator):
+class FirstAndZerothMoment(Operator):
     """
-    Base class for all macroscopic operators
+    A class to compute first and zeroth moments of distribution functions.
 
     TODO: Currently this is only used for the standard rho and u moments.
     In the future, this should be extended to include higher order moments