methods.rst 1.58 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
***********************
Methods (lbmpy.methods)
***********************


LBM Method Interfaces
=====================

.. autoclass:: lbmpy.methods.AbstractLbMethod
    :members:

.. autoclass:: lbmpy.methods.AbstractConservedQuantityComputation
    :members:




LBM with conserved zeroth and first order
=========================================

.. autoclass:: lbmpy.methods.DensityVelocityComputation
    :members:




Moment-based methods
====================

Creation Functions
------------------

.. autofunction:: lbmpy.methods.create_srt

.. autofunction:: lbmpy.methods.create_trt

.. autofunction:: lbmpy.methods.create_trt_with_magic_number

.. autofunction:: lbmpy.methods.create_mrt_orthogonal

.. autofunction:: lbmpy.methods.create_with_continuous_maxwellian_eq_moments

.. autofunction:: lbmpy.methods.create_with_discrete_maxwellian_eq_moments


Class
-----

Frederik Hennig's avatar
Frederik Hennig committed
49
50
51
.. autoclass:: lbmpy.methods.momentbased.MomentBasedLbMethod
    :members:

Markus Holzer's avatar
Markus Holzer committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

Cumulant-based methods
======================

Creation Functions
------------------

.. autofunction:: lbmpy.methods.create_with_polynomial_cumulants

.. autofunction:: lbmpy.methods.create_with_monomial_cumulants

.. autofunction:: lbmpy.methods.create_with_default_polynomial_cumulants

.. autofunction:: lbmpy.methods.create_centered_cumulant_model


Utility
-------

.. autofunction:: lbmpy.methods.centeredcumulant.get_default_polynomial_cumulants_for_stencil

.. autoclass:: lbmpy.methods.centeredcumulant.CenteredCumulantForceModel
    :members:

Class
-----

Frederik Hennig's avatar
Frederik Hennig committed
79
.. autoclass:: lbmpy.methods.centeredcumulant.CenteredCumulantBasedLbMethod
80
81
    :members: