Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 2.44 KB

index.rst

File metadata and controls

84 lines (56 loc) · 2.44 KB

PlasmaPy logo

blobmodel Documentation

:py:mod:`blobmodel` is a python package for creating numerical realizations of advecting and dissipating blobs in up to two spatial dimensions. This open source project is developed by the Complex Systems Modelling group at UiT The Arctic University of Norway.

:py:mod:`blobmodel` is developed openly on GitHub, where you can request a new feature, report a bug or contribute to the package by creating a pull request.

Mathematically, the model of K superposed blobs, \Phi_K, can be expressed as

\Phi_K(x, y, t) = \sum_{k=1}^{K} \phi_k(x, y, t).

The blobs \phi_k consists of an amplitude a_k and a blob shape \varphi with a blob width in x and y, given by l_x and l_y:

\phi(x, y, t) = a_k \varphi\left(\frac{x}{l_x}, \frac{y}{l_y}, t \right).

Each blob has an individual velocity in x and y, v_x and v_y, and decreases in amplitude with the drainage time \tau:

\frac{\partial \phi_k}{\partial t} + v_x \frac{\partial \phi_k}{\partial x} + v_y \frac{\partial \phi_k}{\partial y} + \frac{\phi_k}{\tau} = 0.

A 2D example of the model is shown below:

StreamPlayer

The model can also be reduced to one spatial dimension as shown in the following example:

StreamPlayer

The following sections provide detailed information about the package components. Alternatively, you can take a look at the examples gallery at :py:mod:`blobmodel/examples/` for a quick overview of the package's functionalities.

.. toctree::
   :caption: Contents
   :maxdepth: 1

   Installing <install>
   getting_started
   visualize_model
   model_geometry
   blob_shapes
   parameter_distributions
   blob_labels
   drainage_time
   blob_alignment
   contributor_guide


.. toctree::
   :maxdepth: 2
   :caption: API reference

   modules

Indices and tables