Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
RevathiJambunathan committed Mar 27, 2024
1 parent ee59b48 commit b88d309
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,12 @@ Domain Boundary Conditions
* ``Reflecting``: Particles leaving the boundary are reflected from the boundary back into the domain.
When ``boundary.reflect_all_velocities`` is false, the sign of only the normal velocity is changed, otherwise the sign of all velocities are changed.

* ``Thermal``: Particles leaving the boundary are reflected from the boundary back into the domain
and their velocities are thermalized. The tangential velocity components are sampled from ``gaussian`` distribution
and the component normal to the boundary is sampled from ``gaussian flux`` distribution.
The standard deviation for these distributions should be provided for each species using
``boundary.<species>.u_th``. The same standard deviation is used to sample all components.

* ``boundary.reflect_all_velocities`` (`bool`) optional (default `false`)
For a reflecting boundary condition, this flags whether the sign of only the normal velocity is changed or all velocities.

Expand Down

0 comments on commit b88d309

Please sign in to comment.