Module Reference

tripodpy Package

Functions

readdump(filename)

Reads dumpfile and returns Frame object

Classes

hdf5writer(*args, **kwargs)

Class for writing HDF5 output files.

Simulation(**kwargs)

The main simulation class for running dust evolution simulations.

tripodpy.simulation Module

Classes

Boundary(r, ri, S[, condition, value])

Class for managing boundary conditions for gas and dust.

Field(owner, value[, updater, ...])

Class for storing simulation quantities.

Instruction(scheme, Y[, fstep, controller, ...])

Integration Instruction that controls the execution of an integration Scheme.

Integrator(var[, instructions, failop, ...])

Integrator class that manages the integration instructions

Simulation(**kwargs)

The main simulation class for running dust evolution simulations.

hdf5writer(*args, **kwargs)

Class for writing HDF5 output files.

partial

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

tripodpy.std Package

Package containing standard functions that can be used in simulations.

tripodpy.std.dust Module

Module containing standard functions for the dust.

Functions

D_mod(sim)

Function calculates the dust diffusivity.

F_adv(sim[, Sigma])

Function calculates the advective flux at the cell interfaces.

F_diff(sim[, Sigma])

Function calculates the diffusive flux at the cell interfaces

Fi_sig1smax(sim)

Function that calculates the total flux of the Sigma[1] and s.max used to solved the advection equation for s.max

H(sim)

Computes the dust scale height by using the dustpy function, for all Nm_long dust sizes.

S_coag(sim[, Sigma])

Function calculates the source terms from dust growth

S_compo(sim[, Sigma])

Function calculates the source terms from dust composion source terms

S_hyd_compo(sim[, group])

Function calculates the hydrodynamic source terms.

S_smax_hyd(sim)

Function calculates the hydrodynamic source terms for s.max -> assumes that I can callculate the hydrodynamic source term for the product and divide it by Sig1

S_tot(sim[, Sigma])

Function calculates the total source terms.

S_tot_compo(sim[, group])

Function returns the external source terms for each component.

S_tot_ext(sim[, Sigma])

Function calculates the total source terms.

Sigma_initial(sim)

Function calculates the initial condition of the dust surface densities

Y_jacobian(sim, x[, dx])

Function calculates the Jacobian for the statevector that includes smax.

a(sim)

Function calculates the particle sizes from the characteristic particle sizes and the distribution exponent.

dadsig(sim)

Function calculates the derivative of smax with respect to Sigma1.

dsigda(sim)

Function calculates the derivative of Sigma1 with respect to smax.

dt(sim)

Function calculates the time step from dust.

dt_Sigma(sim)

Function calculates the time step due to changes in Sigma.

dt_compo(sim)

Function calculates the time step due to changes in Sigma.

dt_smax(sim)

Function calculates the time step due to changes in smax.

enforce_f(sim)

Function enforces the minimum mass fraction in large particles.

finalize(sim)

Function finalizes implicit integration step.

jacobian(sim, x[, dx])

Function calculates the Jacobian for implicit dust integration.

m(sim)

Function calculates the particle mass from the particle sizes.

p_drift_frag(sim)

Calculate the fudge factor for the relative velocities.

p_frag(sim)

Function calculates the fragmentation probability.

p_frag_trans(sim)

Calculate the transition between the two turbulent regime.

p_stick(sim)

Function calculates the sticking probability.

prepare(sim)

Function prepares implicit dust integration step.

q_eff(sim)

Function calculates the equilibrium exponent of the distribution.

q_frag(sim)

Calculate the effective fragmentation power-law of the size distribution.

q_rec(sim)

Function computes the power law exponent of the size distribution n(a) da = a^q da

rho_midplane(sim)

Function calculates the midplane mass density.

rhos_compo(sim)

Function returns the material density of dust from the composition.

smax_deriv(sim, t, smax)

Function calculates the derivative of smax.

smax_initial(sim)

Function calculates the initial maximum particle sizes

vrad_mod(sim)

Function calculated the radial velocity of the dust.

vrel_brownian_motion(sim)

Function calculates the relative particle velocities due to Brownian motion.

Classes

Scheme(scheme[, controller, description])

Class for an integration Scheme that can be used as template for creating custom schemes.

impl_1_direct()

Modified class for implicit dust integration.

tripodpy.std.gas Module

Functions

Fi_compo(sim[, compkey, group])

Function returns the fluxes at the boundaries for each component.

S_ext_total(sim)

Function returns the total external source terms for all components.

S_hyd_compo(sim[, compkey, group])

Function returns the hydrodynamical source terms for each component.

S_tot_compo(sim[, compkey, group])

Function returns the external source terms for each component.

Sigma_tot(sim)

Function calculates the total gas surface density from the gas components.

dt_compo(sim)

Function returns the timestep depending on the source terms.

enforce_floor_value(sim)

Function enforces floor value to gas surface density.

finalize(sim)

Function finalizes gas integration step.

mu(sim)

Function calculates the mean molecular weight from the gas components.

prepare(sim)

Function prepares gas integration step.

set_implicit_boundaries(sim)

Function calculates the fluxes at the boundaries after the implicit integration step.

set_implicit_boundaries_compo(sim)

Function calculates the fluxes at the boundaries after the implicit integration step.

tripodpy.std.compo Module

Module containing standard functions for the composition

Functions

A_grains(sim)

returns total surface area of all dust grains in the simulation

L_condensation(sim, comp[, Pstick])

Function calculates the condensation source term for a given component.

L_sublimation(sim, comp[, N_bind])

Function calculates the sublimation source term for a given component.

Y_jacobian(sim, x[, dx])

Function calculates the Jacobian for implicit integration of components with both dust and gas

c_jacobian(sim, x[, dx])

Function calculates the Jacobian for implicit integration of components

finalize(sim)

Function finalizes implicit integration step.

jacobian_compo(sim, x[, dx])

Function calculates the Jacobian for implicit integration caused by sublimation.

prepare(sim)

Function prepares implicit dust integration step.

set_boundaries_component(sim, J, dx, comp)

Function sets the boundary conditions for the Jacobian of a component.

set_state_vector_components(sim)

Function sets the state vector for all components in the simulation.

tripodpy.std.sim Module

Module containing standard functions for the main simulation object.

Functions

dt(sim)

Function returns the timestep depending on the source terms.

finalize_implicit_dust(sim)

This function is the finalization function that is called after every integration step.

prepare_implicit_dust(sim)

This function is the preparation function that is called before every integration step.

dustpy.utils Package

Package containing utility classes and functions used in the simulation.

Functions

read_data(data[, filename, extension, Na])

Function returns a SimpleNamespace with the most useful data that can be used for plotting or other purposes.

print_version_warning([timeout])

Functions prints a warning to screen if a newer version of DustPy is available.

Classes

Boundary(r, ri, S[, condition, value])

Class for managing boundary conditions for gas and dust.

SimpleNamespace(*args, **kwargs)

Class for SimpleNamespace that does not allow to add new attributes.