sasktran2.constituent.NumberDensityScatterer2D

sasktran2.constituent.NumberDensityScatterer2D#

class sasktran2.constituent.NumberDensityScatterer2D(optical_property: OpticalProperty, number_density: ndarray, **kwargs)[source]#

Bases: Constituent

A scatterer specified by number density on a Geometry2D grid.

The number density and all spatially varying optical-property arguments are stored in (horizontal, altitude) order. They are used directly on the native Geometry2D grid without interpolation or an expanded identity mapping.

Parameters:

  • optical_property (OpticalProperty) – Property supplying extinction, scattering, and phase-function data.

  • number_density (numpy.ndarray) – Particle number density in m^-3 with shape (horizontal, altitude).

  • **kwargs – Additional spatial inputs for optical_property. Each input must be either a scalar or an array with the same shape as number_density. Scalars are applied uniformly to all locations.

__init__(optical_property: OpticalProperty, number_density: ndarray, **kwargs) → None[source]#

Methods

__init__(optical_property, number_density, ...)

add_to_atmosphere(atmo)

register_derivative(atmo, name)

Attributes

number_density

Particle number density in (horizontal, altitude) order.

volume_spatial_mode

Spatial input mode used when adding the constituent to an atmosphere.
property number_density: ndarray#

Particle number density in (horizontal, altitude) order.

property volume_spatial_mode: str#

Spatial input mode used when adding the constituent to an atmosphere.

Existing constituents are altitude profiles and are broadcast across the horizontal dimension of a 2D atmosphere. New constituents that consume native 2D fields can override this with "native_2d".