Commit 41f3e83a authored by Martin Bauer's avatar Martin Bauer
Browse files

Separated modules into subfolders with own setup.py

This restructuring allows for easier separation of modules into
separate repositories later. Also, now pip install with repo url can be
used.

The setup.py files have also been updated to correctly reference each
other. Module versions are not extracted from git state
parent b789f010
******************************************************
Continuous Distribution Measures (Moments & Cumulants)
******************************************************
This module provides functions to compute moments and cumulants from continuous probability distribution functions.
.. automodule:: lbmpy.continuous_distribution_measures
:members:
*********
Cumulants
*********
.. automodule:: lbmpy.cumulants
:members:
************
Force models
************
.. automodule:: lbmpy.forcemodels
:members:
.. automodule:: lbmpy.creationfunctions
:members:
@article{karlin2015entropic,
title={Entropic multirelaxation lattice Boltzmann models for turbulent flows},
author={B{\"o}sch, Fabian and Chikatamarla, Shyam S and Karlin, Ilya V},
journal={Physical Review E},
volume={92},
number={4},
pages={043309},
year={2015},
publisher={APS}
}
@PHDTHESIS{luo1993lattice,
author = {{Luo}, L.-S.},
title = "{Lattice-Gas Automata and Lattice Boltzmann Equations for Two-Dimensional Hydrodynamics}",
keywords = {HYDRODYNAMICS},
school = {GEORGIA INSTITUTE OF TECHNOLOGY.},
year = 1993,
adsurl = {http://adsabs.harvard.edu/abs/1993PhDT.......233L},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@Article{guo2002discrete,
author = {Guo, Zhaoli and Zheng, Chuguang and Shi, Baochang},
title = {Discrete lattice effects on the forcing term in the lattice Boltzmann method},
journal = {Physical Review E},
year = {2002},
volume = {65},
number = {4},
pages = {046308},
publisher = {APS},
}
@article{buick2000gravity,
title={Gravity in a lattice Boltzmann model},
author={Buick, JM and Greated, CA},
journal={Physical Review E},
volume={61},
number={5},
pages={5307},
year={2000},
publisher={APS}
}
@article{Wohrwag2018,
archivePrefix = {arXiv},
arxivId = {1710.07486},
author = {W{\"{o}}hrwag, M. and Semprebon, C. and {Mazloomi Moqaddam}, A. and Karlin, I. and Kusumaatmaja, H.},
doi = {10.1103/PhysRevLett.120.234501},
eprint = {1710.07486},
isbn = {9783642121425},
issn = {10797114},
journal = {Physical Review Letters},
number = {23},
pmid = {23347591},
title = {{Ternary Free-Energy Entropic Lattice Boltzmann Model with a High Density Ratio}},
volume = {120},
year = {2018}
}
@article{Semprebon2016,
author = {Semprebon, Ciro and Kusumaatmaja, Halim},
doi = {10.1103/PhysRevE.93.033305},
keywords = {lbm,multiphase,phasefield},
mendeley-tags = {lbm,multiphase,phasefield},
pages = {1--11},
title = {{Ternary free-energy lattice Boltzmann model with tunable surface tensions and contact angles}},
volume = {033305},
year = {2016}
}
\ No newline at end of file
**********************
Maxwellian Equilibrium
**********************
.. automodule:: lbmpy.maxwellian_equilibrium
:members:
.. autofunction:: lbmpy.maxwellian_equilibrium.discrete_maxwellian_equilibrium
.. autofunction:: lbmpy.maxwellian_equilibrium.generate_equilibrium_by_matching_moments
.. autofunction:: lbmpy.maxwellian_equilibrium.continuous_maxwellian_equilibrium
.. autofunction:: lbmpy.maxwellian_equilibrium.get_moments_of_continuous_maxwellian_equilibrium
.. autofunction:: lbmpy.maxwellian_equilibrium.get_moments_of_discrete_maxwellian_equilibrium
This diff is collapsed.
This diff is collapsed.
*******
Moments
*******
.. automodule:: lbmpy.moments
:members:
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment