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

Small changes

parent ef4bec8a
No related branches found
No related tags found
1 merge request!100Adaption to new API
......@@ -51,7 +51,7 @@ For example, to modify the AST one can run::
"""
from collections import OrderedDict
from dataclasses import dataclass, field, replace
from typing import Union, List, Tuple, Any, Type
from typing import Union, List, Tuple, Any, Type, Iterable
from warnings import warn, filterwarnings
import lbmpy.moment_transforms
......@@ -110,7 +110,7 @@ class LBMConfig:
This determines the selection and relaxation pattern of moments/cumulants, i.e. which moment/cumulant basis is
chosen, and which of the basis vectors are relaxed together
"""
relaxation_rates: Any = None
relaxation_rates: Iterable = None
"""
Sequence of relaxation rates, number depends on selected method. If you specify more rates than
method needs, the additional rates are ignored.
......@@ -119,8 +119,8 @@ class LBMConfig:
"""
For SRT, TRT and polynomial cumulant models it is possible to define
a single ``relaxation_rate`` instead of a list (Internally this is converted to a list with a single entry).
The second rate for TRT is then determined via magic number. For the
umulant model, it sets only the relaxation rate corresponding to shear viscosity, setting all others to unity.
The second rate for TRT is then determined via magic number. For the moment, central moment based and the
cumulant model, it sets only the relaxation rate corresponding to shear viscosity, setting all others to unity.
"""
compressible: bool = False
"""
......@@ -144,7 +144,7 @@ class LBMConfig:
Affects only orthogonal MRT methods. If set to True a weighted Gram-Schmidt procedure is used to orthogonalise
the moments.
"""
nested_moments: List = None
nested_moments: List[List] = None
"""
A list of lists of modes, grouped by common relaxation times. This is usually used in
conjunction with `lbmpy.methods.default_moment_sets.mrt_orthogonal_modes_literature`.
......@@ -177,11 +177,10 @@ class LBMConfig:
Special correction for D3Q27 cumulant LBMs. For Details see
:mod:`lbmpy.methods.centeredcumulant.galilean_correction`
"""
moment_transform_class: Type[lbmpy.moment_transforms.AbstractMomentTransform] = PdfsToMomentsByChimeraTransform
"""
Python class that determines how PDFs are transformed to the moment space. Usually, the chimera transform is
the best choice (see :cite:`geir2015`). However, for the SRT and TRT methods it defaults to `None`, since
the best choice (see :cite:`geier2015`). However, for the SRT and TRT methods it defaults to `None`, since
no transformation is necessary and the collision can happen in PDF space.
"""
central_moment_transform_class: Type[lbmpy.moment_transforms.AbstractMomentTransform] = \
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment