diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..18bb84d1 --- /dev/null +++ b/.readthedocs.yaml @@ -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 diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml deleted file mode 100644 index 69f98b1f..00000000 --- a/docs/.readthedocs.yaml +++ /dev/null @@ -1,16 +0,0 @@ - -version: 2 - -formats: all - -build: - os: "ubuntu-20.04" - tools: - python: "3.10" - -sphinx: - configuration: conf.py - -python: - install: - - requirements: requirements.txt diff --git a/docs/Integrator/BrownianHydrodynamics.rst b/docs/Integrator/BrownianHydrodynamics.rst index 41d2c18b..37f6d6e6 100644 --- a/docs/Integrator/BrownianHydrodynamics.rst +++ b/docs/Integrator/BrownianHydrodynamics.rst @@ -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 std::vector 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