Module Reference

dustpy Package

DustPy is a package for simulating dust coagulation and disk evolution in protoplanetary disks.

The class for performing simulations is dustpy.Simulation.

Furthermore DustPy contains a simple package for plotting data dustpy.plot and a package that contains pre-defined standard functions dustpy.std that can be used in the simulation.

dustpy.utils contains some helper classes/functions that are used within the simulation.

DustPy is mainly written in Python. Computation intensive calculations are written in Fortran.

DustPy is using the simframe package for setting up scientific simulations.

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 coagulation simulations.

dustpy.constants Package

Package containing constants that are used in the simulations. All constants are in cgs units.

The constants are defined in dustpy/constants/constants.f90 so they can be used in the Fortran scripts.

Constants

au : Astronomical unit

G : Gravitational constant

k_B : Boltzmann constant

m_p : Proton mass

M_earth : Mass of the Earth

M_jup : Mass of Jupiter

M_sun : Mass of the Sun

pi : Ratio of circle’s circumference to diameter

R_sun : Radius of the sun

sigma_H2 : Geometrical cross-section of H2 molecule

sigma_sb : Stephan-Boltzmann constant

year : Year in seconds

dustpy.plot Package

Package containing simple scripts for plotting objects dustpy.Simulation or data files.

Functions

ipanel(data[, filename, extension, im, ir, ...])	Simple interactive plotting script for data files or simulation objects.
panel(data[, filename, extension, im, ir, ...])	Simple plotting script for data files or simulation objects.

dustpy.std Package

Package containing standard functions that can be used in simulations.

dustpy.std.dust Module

Module containing standard functions for the dust.

Functions

D(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
F_tot(sim[, Sigma])	Function calculates the total mass fluxes through grid cell interfaces.
H(sim)	Function calculates the dust scale height according Dubrulle et al. (1995).
MRN_distribution(sim)	Function calculates the initial particle mass distribution.
S_coag(sim[, Sigma])	Function calculates the coagulation source terms.
S_hyd(sim[, Sigma])	Function calculates the hydrodynamic source terms.
S_tot(sim[, Sigma])	Function calculates the total source terms.
SigmaFloor(sim)	Function calculates the floor value for the dust distribution.
Sigma_deriv(sim, t, Sigma)	Function calculates the derivative of the dust surface density.
St_Epstein_StokesI(sim)	Function calculates the Stokes number using the Epstein and the Stokes I drag regimes.
a(sim)	Function calculates the particle size from the solid density and the filling factor.
boundary(sim)	Function sets the boundary condition of dust surface density.
coagulation_parameters(sim)	Function calculates the coagulation parameters needed for a simple sticking-erosion-fragmentation collision model.
dt(sim)	Function calculates the time step from the dust sources.
dt_adaptive(sim)	Function returns the adaptive time step.
enforce_floor_value(sim)	Function enforces floor value onto dust surface density.
eps(sim)	Function returns the vertically integrated dust-to-gas ratio.
finalize_explicit(sim)	Function finalizes integration step.
finalize_implicit(sim)	Function finalizes implicit integration step.
jacobian(sim, x[, dx])	Function calculates the Jacobian for implicit dust integration.
kernel(sim)	Function calculates the vertically integrated collision kernel.
p_frag(sim)	Function calculates the fragmentation probability.
p_stick(sim)	Function calculates the sticking probability.
prepare(sim)	Function prepares implicit dust integration step.
rho_midplane(sim)	Function calculates the midplane mass density.
set_implicit_boundaries(sim)	Function calculates the fluxes at the boundaries after the implicit integration step.
vdriftmax(sim)	Function calculates the maximum drift velocity of the dust including back reaction of the gas onto the dust, if the back reaction coefficients are set.
vrad(sim)	Function calculated the radial velocity of the dust.
vrel_azimuthal_drift(sim)	Function calculates the relative particle velocities due to azimuthal drift.
vrel_brownian_motion(sim)	Function calculates the relative particle velocities due to Brownian motion.
vrel_radial_drift(sim)	Function calculates the relative particle velocities due to radial drift.
vrel_tot(sim)	Function calculates the total relative vparticle velocities by taking the root mean square of all individual sources.
vrel_turbulent_motion(sim)	Function calculates the relative particle velocities due to turbulent motion.
vrel_vertical_settling(sim)	Function calculates the relative particle velocities due to vertical settling.

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.

dustpy.std.gas Module

Module containing standard functions for the gas.

Functions

Fi(sim)	Function calculates the mass flux through the cell interfaces.
Hp(sim)	Function calculates the pressure scale height.
P_midplane(sim)	Function calculates the midplane gas pressure.
S_hyd(sim)	Function calculates the hydrodynamic source terms.
S_tot(sim)	Function calculates the total source terms.
T_passive(sim)	Function calculates the temperature profile of a passively irridiated disk with a constant irradiation angle of 0.05.
boundary(sim)	Function set the boundary conditions of the gas.
cs_isothermal(sim)	Function calculates the isothermal sound speed of the gas.
dt(sim)	Function calculates the time step from the gas sources.
enforce_floor_value(sim)	Function enforces floor value to gas surface density.
eta_midplane(sim)	Function calculates the midplane pressure gradient parameter.
finalize(sim)	Function finalizes gas integration step.
jacobian(sim, x, *args, **kwargs)	Functions calculates the Jacobian for the gas.
lyndenbellpringle1974(r, rc, p, Mdisk)	Function calculates the surface density according the self similar solution of Lynden-Bell & Pringle (1974).
mfp_midplane(sim)	Function calculates the midplane mean free path.
n_midplane(sim)	Function calculates the midplane number density of the gas.
nu(sim)	Function calculates the kinematic viscocity of the gas.
prepare(sim)	Function prepares gas integration step.
rho_midplane(sim)	Function calculates the midplane mass density of the gas.
set_implicit_boundaries(sim)	Function calculates the fluxes at the boundaries after the implicit integration step.
vrad(sim)	Function calculates the radial radial gas velocity.
vtorque(sim)	Function calculates the velocity contribution from a torque profile
vvisc(sim)	Function calculates the viscous radial gas velocity.

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 gas integration.

dustpy.std.grid Module

Module containing standard functions for the grids.

Functions

OmegaK(sim)

Function calculates the Keplerian frequency.

dustpy.std.sim Module

Module containing standard functions for the main simulation object.

Functions

dt(sim)	Function returns the timestep depending on the source terms.
dt_adaptive(sim)	Function that returns the suggested adaptive timestep.
finalize_explicit_dust(sim)	This function is the finalization function that is called after every integration step.
finalize_implicit_dust(sim)	This function is the finalization function that is called after every integration step.
prepare_explicit_dust(sim)	This function is the preparation function that is called before every integration step.
prepare_implicit_dust(sim)	This function is the preparation function that is called before every integration step.

dustpy.std.star Module

Module containing standard functions for the central star.

Functions

luminosity(sim)

Function calculates the luminosity of the star.

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([mapping_or_iterable])	Class for SimpleNamespace that does not allow to add new attributes.