.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples_gallery/custom_brownian_particles.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_custom_brownian_particles.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_custom_brownian_particles.py:


Custom Brownian motion class
============================

Demonstrates the custom implementation of Brownian motion.

.. GENERATED FROM PYTHON SOURCE LINES 8-38



.. image-sg:: /examples_gallery/images/sphx_glr_custom_brownian_particles_001.png
   :alt: custom brownian particles
   :srcset: /examples_gallery/images/sphx_glr_custom_brownian_particles_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


      0%|          | 0/10.0 [00:00<?, ?it/s]
    Initializing:   0%|          | 0/10.0 [00:00<?, ?it/s]
      0%|          | 0/10.0 [00:00<?, ?it/s]              
     10%|█         | 1.0/10.0 [00:00<00:00, 1139.45it/s]
     10%|█         | 1.0/10.0 [00:00<00:00, 943.60it/s] 
    100%|██████████| 10.0/10.0 [00:00<00:00, 8871.20it/s]
    100%|██████████| 10.0/10.0 [00:00<00:00, 8346.87it/s]






|

.. code-block:: Python


    import numpy as np

    import emulsim


    class BrownianParticlesActor(emulsim.ActorBase):
        diffusivity = 1

        def evolve(self, elements, t, dt):
            """Evolve the particles in time."""
            (particles,) = elements
            scale = np.sqrt(dt) * self.diffusivity
            size = particles.positions.shape
            particles.positions[...] += scale * np.random.normal(size=size)


    # set up state
    particle_data = np.random.uniform(0, 100, size=(10, 2))
    particles = emulsim.PointsElement(particle_data)
    state = emulsim.State({"particles": particles})

    # set up simulation
    simulation = emulsim.Simulation(state)
    simulation.add_actor("particles", BrownianParticlesActor())

    # run simulation
    result = simulation.run(t_range=10)

    result.plot()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.040 seconds)


.. _sphx_glr_download_examples_gallery_custom_brownian_particles.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: custom_brownian_particles.ipynb <custom_brownian_particles.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: custom_brownian_particles.py <custom_brownian_particles.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: custom_brownian_particles.zip <custom_brownian_particles.zip>`