4.3.4 pde.pdes.diffusion module

A simple diffusion equation.

class DiffusionPDE(diffusivity=1, *, bc=None, noise=0, rng=None)[source]

Bases: PDEBase

A simple diffusion equation.

The mathematical definition is

\[\partial_t c = D \nabla^2 c\]

where \(c\) is a scalar field and \(D\) denotes the diffusivity.

Parameters:

  • diffusivity (float) – The diffusivity of the described species

  • bc (BoundariesData | None) – The boundary conditions applied to the field. Boundary conditions are generally given as a dictionary with one condition for each axis side. For periodic axes, only periodic boundary conditions are allowed (indicated by ‘periodic’ and ‘anti-periodic’). For non-periodic axes, different boundary conditions can be specified for the lower and upper end (using specific identifiers, like x- and y+). For instance, Dirichlet conditions enforcing a value NUM (specified by {‘value’: NUM}) and Neumann conditions enforcing the value DERIV for the derivative in the normal direction (specified by {‘derivative’: DERIV}) are supported. Note that the special value ‘auto_periodic_neumann’ imposes periodic boundary conditions for periodic axis and a vanishing derivative otherwise. More information can be found in the boundaries documentation.

  • noise (float) – Variance of the (additive) noise term

  • rng (Generator) – Random number generator (default: default_rng()) used for stochastic simulations. Note that this random number generator is only used for numpy function, while compiled numba code uses the random number generator of numba. Moreover, in simulations using multiprocessing, setting the same generator in all processes might yield unintended correlations in the simulation results.

default_bc = 'auto_periodic_neumann'

Default boundary condition used when no specific conditions are chosen.

evolution_rate(state, t=0)[source]

Evaluate the right hand side of the PDE.

Parameters:

  • state (ScalarField) – The scalar field describing the concentration distribution

  • t (float) – The current time point

Returns:

Scalar field describing the evolution rate of the PDE

Return type:

ScalarField

explicit_time_dependence: bool | None = False

Flag indicating whether the right hand side of the PDE has an explicit time dependence.

Type:

bool

property expression: str

the expression of the right hand side of this PDE

Type:

str