Commit e1f9ab43 authored by Markus Holzer's avatar Markus Holzer
Browse files

Fix flake

parent 686ec0bb
Pipeline #34329 passed with stages
in 29 minutes and 27 seconds
......@@ -16,9 +16,9 @@ General:
basis is chosen, and which of the basis vectors are relaxed together
- ``Method.SRT``: single relaxation time (:func:`lbmpy.methods.create_srt`)
- ``Method.TRT``: two relaxation time, first relaxation rate is for even moments and determines the viscosity (as in SRT),
the second relaxation rate is used for relaxing odd moments, and controls the bulk viscosity.
(:func:`lbmpy.methods.create_trt`)
- ``Method.TRT``: two relaxation time, first relaxation rate is for even moments and determines the
viscosity (as in SRT), the second relaxation rate is used for relaxing odd moments, and controls the
bulk viscosity. (:func:`lbmpy.methods.create_trt`)
- ``Method.MRT``: orthogonal multi relaxation time model, relaxation rates are used in this order for :
shear modes, bulk modes, 3rd order modes, 4th order modes, etc.
Requires also a parameter 'weighted' that should be True if the moments should be orthogonal w.r.t. weighted
......@@ -28,16 +28,16 @@ General:
the same rate. Literature values of this list can be obtained through
:func:`lbmpy.methods.creationfunctions.mrt_orthogonal_modes_literature`.
See also :func:`lbmpy.methods.create_mrt_orthogonal`
- ``Method.MRT_RAW``: non-orthogonal MRT where all relaxation rates can be specified independently i.e. there are as many
relaxation rates as stencil entries. Look at the generated method in Jupyter to see which moment<->relaxation rate
mapping (:func:`lbmpy.methods.create_mrt_raw`)
- ``Method.MRT_RAW``: non-orthogonal MRT where all relaxation rates can be specified independently i.e. there are
as many relaxation rates as stencil entries. Look at the generated method in Jupyter to see which
moment<->relaxation rate mapping (:func:`lbmpy.methods.create_mrt_raw`)
- ``Method.TRT_KBC_Nx`` where <x> is 1,2,3 or 4. Special two-relaxation rate method. This is not the entropic method
yet, only the relaxation pattern. To get the entropic method, see parameters below!
(:func:`lbmpy.methods.create_trt_kbc`)
- ``Method.CUMULANT``: cumulant-based lb method (:func:`lbmpy.methods.create_with_default_polynomial_cumulants`) which
relaxes groups of polynomial cumulants chosen to optimize rotational invariance.
- ``Method.MONOMIAL_CUMULANT``: cumulant-based lb method (:func:`lbmpy.methods.create_with_monomial_cumulants`) which
relaxes monomial cumulants.
- ``Method.CUMULANT``: cumulant-based lb method (:func:`lbmpy.methods.create_with_default_polynomial_cumulants`)
which relaxes groups of polynomial cumulants chosen to optimize rotational invariance.
- ``Method.MONOMIAL_CUMULANT``: cumulant-based lb method (:func:`lbmpy.methods.create_with_monomial_cumulants`)
which relaxes monomial cumulants.
- ``relaxation_rates``: sequence of relaxation rates, number depends on selected method. If you specify more rates than
method needs, the additional rates are ignored. For SRT, TRT and polynomial cumulant models it is possible to define
......
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