Skip to content
Snippets Groups Projects
Commit f728f40e authored by Frederik Hennig's avatar Frederik Hennig
Browse files

Fixed some doc comments

parent a6c37fa1
No related branches found
No related tags found
1 merge request!53Link-Wise Extrapolation Outflow
......@@ -221,7 +221,7 @@ class SimpleExtrapolationOutflow(LbBoundary):
Args:
normal_direction: direction vector normal to the outflow
stencil: stencil used for the lattice Boltzmann method
stencil: stencil used by the lattice boltzmann method
name: optional name of the boundary.
"""
......@@ -242,7 +242,7 @@ class SimpleExtrapolationOutflow(LbBoundary):
lb_method: Lattice Boltzmann method. See :func:`lbmpy.creationfunctions.create_lb_method`
Returns:
list containing LbmWeightInfo and NeighbourOffsetArrays
list containing NeighbourOffsetArrays
"""
return [NeighbourOffsetArrays(lb_method.stencil)]
......@@ -260,9 +260,10 @@ class SimpleExtrapolationOutflow(LbBoundary):
class ExtrapolationOutflow(LbBoundary):
r"""
Outflow boundary condition :cite:`geier2015`, equation F.2, with u neglected (listed below).
This boundary condition interpolates missing on the boundary in normal direction. For this interpolation, the
PDF values of the last time step are used. They are interpolated between fluid cell and boundary cell.
To get the PDF values from the last time step an index array is used which stores them.
This boundary condition interpolates populations missing on the boundary in normal direction.
For this interpolation, the PDF values of the last time step are used. They are interpolated
between fluid cell and boundary cell. To get the PDF values from the last time step an index
array is used which stores them.
.. math ::
f_{\overline{1}jkxyzt} = f_{\overline{1}jk(x - \Delta x)yz(t - \Delta t)} c \theta^{\frac{1}{2}}
......@@ -353,16 +354,13 @@ class ExtrapolationOutflow(LbBoundary):
@property
def additional_data(self):
"""Used internally only. For the ExtrapolationOutflow information of the previous PDF values is needed. This
information is added to the boundary"""
information is stored in the index vector."""
data = [('pdf', create_type("double")), ('pdf_nd', create_type("double"))]
return data
@property
def additional_data_init_callback(self):
"""The initialisation of the additional data is implemented internally for this class.
Thus no callback can be provided"""
if callable(self.init_callback):
return self.init_callback
return self.init_callback
def get_additional_code_nodes(self, lb_method):
"""Return a list of code nodes that will be added in the generated code before the index field loop.
......@@ -371,7 +369,7 @@ class ExtrapolationOutflow(LbBoundary):
lb_method: Lattice Boltzmann method. See :func:`lbmpy.creationfunctions.create_lb_method`
Returns:
list containing LbmWeightInfo and NeighbourOffsetArrays
list containing NeighbourOffsetArrays
"""
return [NeighbourOffsetArrays(lb_method.stencil)]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment