doc/sphinx/api.rst

@@ -8,13 +8,10 @@ API Reference
    enums.rst
    stencils.rst
    kernelcreation.rst
-   methods.rst
    equilibrium.rst
    moment_transforms.rst
    maxwellian_equilibrium.rst
    continuous_distribution_measures.rst
    moments.rst
    cumulants.rst
-   boundary_conditions.rst
-   forcemodels.rst
    zbibliography.rst

doc/sphinx/lbmpy.bib

@@ -110,6 +110,24 @@ issn = {0898-1221},
 doi = {10.1016/j.camwa.2015.05.001},
 }
 
+@article{geier2017,
+author = {Geier, Martin and Pasquali, Andrea and Sch{\"{o}}nherr, Martin},
+title = {Parametrization of the Cumulant Lattice Boltzmann Method for Fourth Order Accurate Diffusion Part I},
+year = {2017},
+issue_date = {November 2017},
+publisher = {Academic Press Professional, Inc.},
+address = {USA},
+volume = {348},
+number = {C},
+issn = {0021-9991},
+url = {https://doi.org/10.1016/j.jcp.2017.05.040},
+doi = {10.1016/j.jcp.2017.05.040},
+journal = {J. Comput. Phys.},
+month = {nov},
+pages = {862–888},
+numpages = {27}
+}
+
 @Article{Coreixas2019,
   title = {Comprehensive comparison of collision models in the lattice Boltzmann framework: Theoretical investigations},
   author = {Coreixas, Christophe and Chopard, Bastien and Latt, Jonas},
@@ -248,4 +266,52 @@ journal = {Communications in Computational Physics}
   publisher = {Springer Link},
 }
 
+@article{BouzidiBC,
+    author = {Bouzidi, M’hamed and Firdaouss, Mouaouia and Lallemand, Pierre},
+    title = "{Momentum transfer of a Boltzmann-lattice fluid with boundaries}",
+    journal = {Physics of Fluids},
+    year = {2001},
+    month = {11},
+    doi = {10.1063/1.1399290},
+    url = {https://doi.org/10.1063/1.1399290},
+}
+
+@Article{rozema15,
+  doi       = {10.1063/1.4928700},
+  year      = {2015},
+  month     = {aug},
+  publisher = {AIP Publishing},
+  volume    = {27},
+  number    = {8},
+  author    = {Wybe Rozema and Hyun J. Bae and Parviz Moin and Roel Verstappen},
+  title     = {Minimum-dissipation models for large-eddy simulation},
+  journal   = {Physics of Fluids}
+}
+
+@article{Han2021,
+   doi = {10.1088/1873-7005/ac1782},
+   url = {https://dx.doi.org/10.1088/1873-7005/ac1782}                    ,
+   year = {2021},
+   month = {aug},
+   publisher = {IOP Publishing},
+   volume = {53},
+   number = {4},
+   pages = {045506},
+   author = {Mengtao Han and Ryozo Ooka and Hideki Kikumoto},
+   title = {A wall function approach in lattice Boltzmann method: algorithm and validation using turbulent channel flow},
+   journal = {Fluid Dynamics Research}
+}
+
+@article{Maronga2020,
+ author = {Maronga, Bj{\"o}rn and Knigge, Christoph and Raasch, Siegfried},
+ year = {2020},
+ title = {{An Improved Surface Boundary Condition for Large-Eddy Simulations Based on Monin--Obukhov Similarity Theory: Evaluation and Consequences for Grid Convergence in Neutral and Stable Conditions}},
+ pages = {297--325},
+ volume = {174},
+ number = {2},
+ issn = {0006-8314},
+ journal = {{Boundary-layer meteorology}},
+ doi = {10.1007/s10546-019-00485-w}
+}
+
 @Comment{jabref-meta: databaseType:bibtex;}

doc/sphinx/methods.rst

-*******************************************
-Methods and Method Creation (lbmpy.methods)
-*******************************************
+********************************
+Collision models (lbmpy.methods)
+********************************
 
 This module defines the classes defining all types of lattice Boltzmann methods available in *lbmpy*,
 together with a set of factory functions used to create their instances. The factory functions are
@@ -22,21 +22,6 @@ Abstract LB Method Base Class
 .. autoclass:: lbmpy.methods.AbstractLbMethod
     :members:
 
-
-Conserved Quantity Computation
-==============================
-
-The classes of the conserved quantity computation (CQC) submodule define an LB Method's conserved quantities and
-the equations to compute them. For hydrodynamic methods, :class:`lbmpy.methods.DensityVelocityComputation` is
-the typical choice. For custom methods, however, a custom CQC class might have to be created.
-
-.. autoclass:: lbmpy.methods.AbstractConservedQuantityComputation
-    :members:
-
-.. autoclass:: lbmpy.methods.DensityVelocityComputation
-    :members:
-
-
 .. _methods_rawmomentbased:
 
 Raw Moment-based methods
@@ -97,7 +82,7 @@ Class
 Cumulant-based methods
 ======================
 
-These methods are represented by instances of :class:`lbmpy.methods.centeredcumulant.CenteredCumulantBasedLbMethod` and will derive
+These methods are represented by instances of :class:`lbmpy.methods.cumulantbased.CumulantBasedLbMethod` and will derive
 collision equations in cumulant space.
 
 Creation Functions
@@ -105,25 +90,17 @@ Creation Functions
 
 The following factory functions create cumulant-based methods using the regular continuous hydrodynamic maxwellian equilibrium.
 
-.. autofunction:: lbmpy.methods.create_with_polynomial_cumulants
+.. autofunction:: lbmpy.methods.create_cumulant
 
 .. autofunction:: lbmpy.methods.create_with_monomial_cumulants
 
 .. autofunction:: lbmpy.methods.create_with_default_polynomial_cumulants
 
-.. autofunction:: lbmpy.methods.create_centered_cumulant_model
-
-
-Utility
--------
-
-.. autoclass:: lbmpy.methods.centeredcumulant.CenteredCumulantForceModel
-    :members:
 
 Class
 -----
 
-.. autoclass:: lbmpy.methods.centeredcumulant.CenteredCumulantBasedLbMethod
+.. autoclass:: lbmpy.methods.cumulantbased.CumulantBasedLbMethod
     :members:
 
 
@@ -171,3 +148,17 @@ Low-Level Creation Functions
 .. autofunction:: lbmpy.methods.creationfunctions.create_with_continuous_maxwellian_equilibrium
 
 .. autofunction:: lbmpy.methods.creationfunctions.create_from_equilibrium
+
+
+Conserved Quantity Computation
+==============================
+
+The classes of the conserved quantity computation (CQC) submodule define an LB Method's conserved quantities and
+the equations to compute them. For hydrodynamic methods, :class:`lbmpy.methods.DensityVelocityComputation` is
+the typical choice. For custom methods, however, a custom CQC class might have to be created.
+
+.. autoclass:: lbmpy.methods.AbstractConservedQuantityComputation
+    :members:
+
+.. autoclass:: lbmpy.methods.DensityVelocityComputation
+    :members:
\ No newline at end of file

doc/sphinx/moment_transforms.rst

@@ -241,6 +241,9 @@ Central Moment Space Transforms
 .. autoclass:: lbmpy.moment_transforms.PdfsToCentralMomentsByMatrix
     :members:
 
+.. autoclass:: lbmpy.moment_transforms.BinomialChimeraTransform
+    :members:
+
 .. autoclass:: lbmpy.moment_transforms.FastCentralMomentTransform
     :members:
 
@@ -250,6 +253,6 @@ Central Moment Space Transforms
 Cumulant Space Transforms
 -------------------------
 
-.. autoclass:: lbmpy.methods.centeredcumulant.cumulant_transform.CentralMomentsToCumulantsByGeneratingFunc
+.. autoclass:: lbmpy.moment_transforms.CentralMomentsToCumulantsByGeneratingFunc
     :members:
 

doc/sphinx/tutorials.rst

@@ -4,6 +4,10 @@ Tutorials
 All tutorials are automatically created by Jupyter Notebooks.
 You can open the notebooks directly to play around with the code examples.
 
+=================
+Basics
+=================
+
 .. toctree::
     :maxdepth: 1
 
@@ -13,16 +17,68 @@ You can open the notebooks directly to play around with the code examples.
     /notebooks/03_tutorial_lbm_formulation.ipynb
     /notebooks/04_tutorial_cumulant_LBM.ipynb
     /notebooks/05_tutorial_nondimensionalization_and_scaling.ipynb
+
+===================
+Turbulence modeling
+===================
+
+.. toctree::
+    :maxdepth: 1
+
     /notebooks/06_tutorial_modifying_method_smagorinsky.ipynb
+
+=================
+Thermal flows
+=================
+
+.. toctree::
+    :maxdepth: 1
+
     /notebooks/07_tutorial_thermal_lbm.ipynb
+    /notebooks/demo_thermalized_lbm.ipynb
+
+=================
+Multiphase flows
+=================
+
+.. toctree::
+    :maxdepth: 1
+
     /notebooks/08_tutorial_shanchen_twophase.ipynb
     /notebooks/09_tutorial_shanchen_twocomponent.ipynb
     /notebooks/10_tutorial_conservative_allen_cahn_two_phase.ipynb
+
+========================
+Thermocapillary flows
+========================
+
+.. toctree::
+    :maxdepth: 1
+
+    /notebooks/12_Thermocapillary_flows_heated_channel.ipynb
+    /notebooks/13_Thermocapillary_flows_droplet_motion.ipynb
+
+===================
+Non Newtonian flow
+===================
+
+.. toctree::
+    :maxdepth: 1
+
     /notebooks/11_tutorial_Non_Newtonian_Flow.ipynb
+
+=================
+Diverse
+=================
+
+.. toctree::
+    :maxdepth: 1
+
     /notebooks/demo_stencils.ipynb
     /notebooks/demo_streaming_patterns.ipynb
     /notebooks/demo_create_method_from_scratch.ipynb
     /notebooks/demo_moments_cumulants_and_maxwellian_equilibrium.ipynb
     /notebooks/demo_automatic_chapman_enskog_analysis.ipynb
-    /notebooks/demo_thermalized_lbm.ipynb
+    /notebooks/demo_interpolation_boundary_conditions.ipynb
+    /notebooks/demo_shallow_water_lbm.ipynb
     /notebooks/demo_theoretical_background_generic_equilibrium_construction.ipynb

lbmpy/__init__.py

-from .creationfunctions import create_lb_ast, create_lb_collision_rule, create_lb_function,\
-    create_lb_method, create_lb_update_rule, LBMConfig, LBMOptimisation
-from .enums import Stencil, Method, ForceModel, CollisionSpace
-from .lbstep import LatticeBoltzmannStep
-from .macroscopic_value_kernels import pdf_initialization_assignments, macroscopic_values_getter,\
-    compile_macroscopic_values_getter, compile_macroscopic_values_setter, create_advanced_velocity_setter_collision_rule
-from .maxwellian_equilibrium import get_weights
-from .relaxationrates import relaxation_rate_from_lattice_viscosity, lattice_viscosity_from_relaxation_rate,\
-    relaxation_rate_from_magic_number
-from .scenarios import create_lid_driven_cavity, create_fully_periodic_flow
-from .stencils import LBStencil
-
-
-__all__ = ['create_lb_ast', 'create_lb_collision_rule', 'create_lb_function', 'create_lb_method',
-           'create_lb_method_from_existing', 'create_lb_update_rule', 'LBMConfig', 'LBMOptimisation',
-           'Stencil', 'Method', 'ForceModel', 'CollisionSpace',
-           'LatticeBoltzmannStep',
-           'pdf_initialization_assignments', 'macroscopic_values_getter', 'compile_macroscopic_values_getter',
-           'compile_macroscopic_values_setter', 'create_advanced_velocity_setter_collision_rule',
-           'get_weights',
-           'relaxation_rate_from_lattice_viscosity', 'lattice_viscosity_from_relaxation_rate',
-           'relaxation_rate_from_magic_number',
-           'create_lid_driven_cavity', 'create_fully_periodic_flow',
-           'LBStencil']
-
-
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions

lbmpy/boundaries/__init__.py

-from lbmpy.boundaries.boundaryconditions import (
-    UBB, FixedDensity, DiffusionDirichlet, SimpleExtrapolationOutflow,
-    ExtrapolationOutflow, NeumannByCopy, NoSlip, StreamInConstant, FreeSlip)
-from lbmpy.boundaries.boundaryhandling import LatticeBoltzmannBoundaryHandling
-
-__all__ = ['NoSlip', 'FreeSlip', 'UBB', 'SimpleExtrapolationOutflow', 'ExtrapolationOutflow',
-           'FixedDensity', 'DiffusionDirichlet', 'NeumannByCopy',
-           'LatticeBoltzmannBoundaryHandling', 'StreamInConstant']

lbmpy/methods/centeredcumulant/__init__.py

-from .force_model import CenteredCumulantForceModel
-from .centeredcumulantmethod import CenteredCumulantBasedLbMethod
-
-__all__ = ['CenteredCumulantForceModel', 'CenteredCumulantBasedLbMethod']

lbmpy/methods/centeredcumulant/force_model.py

-from lbmpy.forcemodels import AbstractForceModel, default_velocity_shift
-
-
-#   =========================== Centered Cumulant Force Model ==========================================================
-
-
-class CenteredCumulantForceModel(AbstractForceModel):
-    """
-    A force model to be used with the centered cumulant-based LB Method.
-    It only shifts the macroscopic and equilibrium velocities and does not introduce a forcing term to the
-    collision process. Forcing is then applied through relaxation of the first central moments in the shifted frame of
-    reference (cf. https://doi.org/10.1016/j.camwa.2015.05.001).
-
-    Args:
-        force: force vector which should be applied to the fluid
-    """
-
-    def __init__(self, force):
-        self.override_momentum_relaxation_rate = 2
-
-        super(CenteredCumulantForceModel, self).__init__(force)
-
-    def __call__(self, lb_method):
-        raise Exception('This force model does not provide a forcing term.')
-
-    def equilibrium_velocity_shift(self, density):
-        return default_velocity_shift(density, self.symbolic_force_vector)

lbmpy/phasefield_allen_cahn/analytical.py

-
-def analytic_rising_speed(gravitational_acceleration, bubble_diameter, viscosity_gas):
-    r"""
-    Calculated the analytical rising speed of a bubble. This is the expected end rising speed.
-    Args:
-        gravitational_acceleration: the gravitational acceleration acting in the simulation scenario. Usually it gets
-                                    calculated based on dimensionless parameters which describe the scenario
-        bubble_diameter: the diameter of the bubble at the beginning of the simulation
-        viscosity_gas: the viscosity of the fluid inside the bubble
-    """
-    result = -(gravitational_acceleration * bubble_diameter * bubble_diameter) / (12.0 * viscosity_gas)
-    return result

lbmpy/phasefield_allen_cahn/phasefield_simplifications.py

-import sympy as sp
-
-from pystencils.simp import (
-    SimplificationStrategy, apply_to_all_assignments,
-    insert_aliases, insert_zeros, insert_constants)
-
-
-def create_phasefield_simplification_strategy(lb_method):
-    s = SimplificationStrategy()
-    expand = apply_to_all_assignments(sp.expand)
-
-    s.add(expand)
-
-    s.add(insert_zeros)
-    s.add(insert_aliases)
-    s.add(insert_constants)
-    s.add(lambda ac: ac.new_without_unused_subexpressions())
-
-    return s