Skip to content

Commit

Permalink
Fix documentation build (#23)
Browse files Browse the repository at this point in the history
* Update docs

* Move readthedocs

* Revert "Move readthedocs"

This reverts commit 1b4cab0.

* Update readthedocs.yaml

* Move .readthedocs.yaml to root

* Update readthedocs.yaml
  • Loading branch information
RaulPPelaez authored Dec 20, 2023
1 parent b1da83f commit 13ca5dd
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 16 deletions.
17 changes: 17 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.11"

sphinx:
configuration: docs/conf.py

python:
install:
- requirements: docs/requirements.txt

formats:
- pdf
16 changes: 0 additions & 16 deletions docs/.readthedocs.yaml

This file was deleted.

18 changes: 18 additions & 0 deletions docs/Integrator/BrownianHydrodynamics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -989,8 +989,26 @@ In addition to the previous ones, the integrator also requires:
Both the solver and Integrator will fail if some particle lies beyond the domain limits in the z direction.


Computing average velocity in the plane directions
**************************************************

The class :code:`DPStokesSlab_ns::DPStokes` can also be used to compute the average velocity of a group of particles in the plane directions.


.. cpp:function:: template<class PosIterator, class ForceIterator> std::vector<double> DPStokes::computeAverageVelocity(PosIterator pos, ForceIterator forces, int numberParticles, int direction = 0, cudaStream_t st = 0)


Computes the average velocity :math:`\langle v(z) \rangle_{x/y}` a group of particles in the plane directions.

:param PosIterator pos: Iterator to the positions of the particles.
:param ForceIterator forces: Iterator to the forces acting on the particles.
:param int numberParticles: Number of particles.
:param int direction: Direction of the average velocity. 0 for x, 1 for y.
:param cudaStream_t st: CUDA stream where the computation will be performed.
:returns: A vector with the average velocity (size n.z).



.. rubric:: References:

.. [1] An Introduction to Dynamics of Colloids. Dhont, J.K.G. 1996. https://www.elsevier.com/books/an-introduction-to-dynamics-of-colloids/dhont/978-0-444-82009-9
Expand Down

0 comments on commit 13ca5dd

Please sign in to comment.