Removed obsolete function `transformed_boundary_rule` and updated creationfunctions doc comment.

lbmpy/boundaries/boundaries_in_kernel.py

@@ -7,7 +7,6 @@ from pystencils.boundaries.boundaryhandling import BoundaryOffsetInfo
 from pystencils.assignment import Assignment
 from pystencils.astnodes import Block, Conditional, LoopOverCoordinate, SympyAssignment
 from pystencils.data_types import type_all_numbers
-from pystencils.field import Field
 from pystencils.simp.assignment_collection import AssignmentCollection
 from pystencils.simp.simplifications import sympy_cse_on_assignment_list
 from pystencils.stencil import inverse_direction
@@ -58,33 +57,6 @@ def border_conditions(direction, field, ghost_layers=1):
         result = sp.And(border_condition, *other_min, *other_max)
         return type_all_numbers(result, loop_ctr.dtype)
 
-#   TODO: Function is called nowhere... remove it?
-
-
-def transformed_boundary_rule(boundary, accessor_func, field, direction_symbol, lb_method, **kwargs):
-    tmp_field = field.new_field_with_different_name("t")
-    rule = boundary(tmp_field, direction_symbol, lb_method, **kwargs)
-    bsubs = boundary_substitutions(lb_method)
-    rule = [a.subs(bsubs) for a in rule]
-    accessor_writes = accessor_func(tmp_field, lb_method.stencil)
-    to_replace = set()
-    for assignment in rule:
-        to_replace.update({fa for fa in assignment.rhs.atoms(Field.Access) if fa.field == tmp_field})
-
-    def compute_replacement(fa):
-        f = fa.index[0]
-        shift = accessor_writes[f].offsets
-        new_index = tuple(a + b for a, b in zip(fa.offsets, shift))
-        return field[new_index](accessor_writes[f].index[0])
-
-    substitutions = {fa: compute_replacement(fa) for fa in to_replace}
-    all_assignments = [assignment.subs(substitutions) for assignment in rule]
-    main_assignments = [a for a in all_assignments if isinstance(a.lhs, Field.Access)]
-    sub_expressions = [a for a in all_assignments if not isinstance(a.lhs, Field.Access)]
-    assert len(main_assignments) == 1
-    ac = AssignmentCollection(main_assignments, sub_expressions).new_without_subexpressions()
-    return ac.main_assignments[0].rhs
-
 
 def boundary_conditional(boundary, direction, streaming_pattern, prev_timestep, lb_method, output_field, cse=False):
     stencil = lb_method.stencil

lbmpy/creationfunctions.py

@@ -57,8 +57,15 @@ General:
 - ``velocity_input``: symbolic field where the velocities are read from (for advection diffusion LBM)
 - ``density_input``: symbolic field or field access where to read density from. When passing this parameter,
   ``velocity_input`` has to be passed as well
-- ``kernel_type``: supported values: 'stream_pull_collide' (default), 'collide_only', stream_pull_only,
-  collide_stream_push, esotwist_even, esotwist_odd, aa_even, aa_odd
+- ``kernel_type``: supported values: 'default_stream_collide' (default), 'collide_only', 'stream_pull_only'. 
+  With 'default_stream_collide', streaming pattern and even/odd time-step (for in-place patterns) can be specified
+  by the ``streaming_pattern`` and ``timestep`` arguments. For backwards compatibility, ``kernel_type`` also accepts
+  'stream_pull_collide', 'collide_stream_push', 'esotwist_even', 'esotwist_odd', 'aa_even' and 'aa_odd' for selection 
+  of the streaming pattern. 
+- ``streaming_pattern``: The streaming pattern to be used with a 'default_stream_collide' kernel. Accepted values are
+  'pull', 'push', 'aa' and 'esotwist'.
+- ``timestep``: Timestep modulus for the streaming pattern. For two-fields patterns, this argument is irrelevant and
+  by default set to ``Timestep.BOTH``. For in-place patterns, ``Timestep.EVEN`` or ``Timestep.ODD`` must be speficied.
 
 Entropic methods: