diff --git a/lbmpy/methods/creationfunctions.py b/lbmpy/methods/creationfunctions.py index 9c1bc6251160c0bef00124f19e524cd304030f9c..cf11abd94243e90d32607361b371f2c52acd8053 100644 --- a/lbmpy/methods/creationfunctions.py +++ b/lbmpy/methods/creationfunctions.py @@ -187,6 +187,7 @@ def create_from_equilibrium(stencil, equilibrium, moment_to_relaxation_rate_dict the same rate compressible: see create_with_discrete_maxwellian_eq_moments force_model: see create_with_discrete_maxwellian_eq_moments + moment_transform_class: class to define the transformation to the moment space """ if any(isinstance(moment_to_relaxation_rate_dict, t) for t in (sp.Symbol, float, int)): moment_to_relaxation_rate_dict = {m: moment_to_relaxation_rate_dict @@ -459,7 +460,7 @@ def create_centered_cumulant_model(stencil, cumulant_to_rr_dict, force_model=Non stencil: instance of :class:`lbmpy.stencils.LBStenil` cumulant_to_rr_dict: dict that has as many entries as the stencil. Each cumulant, which can be represented by an exponent tuple or in polynomial form is mapped to a relaxation rate. - See `lbmpy.methods.default_moment_sets.cascaded_moment_sets_literature` + See :func:`lbmpy.methods.default_moment_sets.cascaded_moment_sets_literature` force_model: force model used for the collision. For cumulant LB method a good choice is `lbmpy.methods.centeredcumulant.CenteredCumulantForceModel` equilibrium_order: approximation order of macroscopic velocity :math:`\mathbf{u}` in the equilibrium