ashdisperse.containers package

Submodules

ashdisperse.containers.cheb module

cheb.py

This module defines a container for Chebyshev polynomials, stored as a numba jitclass.

class ashdisperse.containers.cheb.ChebContainer(*args, **kwargs)

Bases: ChebContainer

A container for chebyshev matrices.

ChebContainer contains chebyshev matrices for different degrees of approximation.

Attributes:

N (int[:]): Array of the degrees of the chebyshev approximations. x (float[:,:]): Array such that x[:N[k], k] contains the collocation

points for the chebyshev approximation at iterate k.

Tn (float[:,:,:]): Array such that Tn[:N[k], :N[k], k] contains the

chebyshev polynomials evaluated at the collocation points for iterate k.

dTn (float[:,:,:]): Array such that dTn[:N[k], :N[k], k] contains the

derivative of the chebyshev polynomials evaluated at the collocation points for iterate k.

d2Tn (float[:,:,:]): Array such that d2Tn[:N[k], :N[k], k] contains the

second derivative of the chebyshev polynomials evaluated at the collocation points for iterate k.

class_type = jitclass.ChebContainer#70c169330710<N:array(int64, 1d, C),x:array(float64, 2d, C),Tn:array(float64, 3d, C),dTn:array(float64, 3d, C),d2Tn:array(float64, 3d, C)>

ashdisperse.containers.velocities module

velocities.py

This module defines a container for velocities used in AshDisperse, stored as a numba jitclass.

class ashdisperse.containers.velocities.VelocityContainer(*args, **kwargs)

Bases: VelocityContainer

A container for velocities at chebyshev collocation points.

VelocityContainer contains wind and settling velocities evaluated at chebyshev collocation points for different degrees of approximation.

Attributes:

N (int[:]): Array of the degrees of the chebyshev approximations. z (float[:,:,:]): Altitudes of the wind data (in physical space).

The altitudes are split into those from ground to the top of the plume (contained in z[:N[k],0,k] for approximation index k) and those above (contained in z[:N[k],1,k] for approximation index k).

U (float[:,:,:]): The easting component of the wind velocity.

The wind velocity is split into those from ground to the top of the plume (contained in U[:N[k],0,k] for approximation index k) and those above (contained in U[:N[k],1,k] for approximation index k).

V (float[:,:,:]): The northin component of the wind velocity.

Structured as U.

Ws (float[:,:,:,:]): The settling speed.

Each grain class has it’s own settling speed, which also varies with altitude. The settling is split into those from ground to the top of the plume (contained in Ws[:N[k],0,k,j] for approximation index k and grain class index j) and those above (contained in Ws[:N[k],1,k,j] for approximation index k and grain class index j).

dWs (float[:,:,:,:]): The first derivative of the settling speed with
  1. Structured as Ws.

class_type = jitclass.VelocityContainer#70c1693b83b0<N:array(int64, 1d, C),z:array(float64, 3d, C),U:array(float64, 3d, C),V:array(float64, 3d, C),Ws:array(float64, 4d, C),dWs:array(float64, 4d, C)>

Module contents