Skip to content
Snippets Groups Projects
Commit e1f9ab43 authored by Markus Holzer's avatar Markus Holzer
Browse files

Fix flake

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