carmapy.Group

class carmapy.Group(igroup, name, rmin)

An object representing a cloud species

Parameters:

• igroup (int) – The index of the group in the Carma simulation

• name (str) – A name for the group. The typical naming convention is “Pure <Species>” (ie “Pure TiO2”) for homogeneously nucleating groups and “<Mantle> on <Core>” (ie “Mg2SiO4 on TiO2”) for heterogeneously nucleating groups

• rmin (float) – The minimum size of the condensate

Notes

1. The group.boundary describes the boundary conditions of the particulate matter in the atmosphere. Currently, CARMApy only supports non-zero boundary conditions for single element groups (ex. homogeneously nucleated groups). Noting that each of these entries is either 0 or an array of NBIN elements, the structure of the dictionary is as follows:

• [“bot_conc”] describes the concentration of the group at the base

  of the atmosphere (only used if the bottom cloud boundary condition is set to “fixed_conc”). [particles/cm^3] If not set, defaults to 0.

• [“top_conc”] describes the concentration of the group at the top

  of the atmosphere (only used if the top cloud boundary condition is set to “fixed_conc”). [particles/cm^3] If not set, defaults to 0.

• [“bot_flux”] describes the upwards flux of the group to the base

  of the atmosphere (only used if the bottom cloud boundary condition is set to “fixed_flux”) [particles/cm^2/s]. Defaults to 0 if not set.

• [“top_flux”] describes the downwards flux of the group at the top

  of the atmosphere (only used if the top cloud boundary condition is set to “fixed_flux”). [particles/cm^2/s] Defaults to 0 if not set.

Methods

coreify(…)

Create a core element from the only element of the current group.

Attributes

boundary	The boundary conditions for the group (see note 1).
core	The element which represents the original seed particle.
mantle	The element on the surface of the cloud particle.

Group.coreify(ielem, group, gas_name)

Create a core element from the only element of the current group. Used to create the core element of a heterogeneously nucleating group where this group serves as the seed particles. Adds the created element as the core of the provided group

Parameters:

• ielem (int) – The index of the new element in the Carma simulation

• group (Group) – The group to which the new element belongs

• gas_name (str) – Name of the gas resevoir corresponding to the new element

Returns:

The newly created element initialized as the core of a heterogeneous group

Return type:

Element