emc2.simulator.subcolumn.set_precip_sub_col_frac¶

emc2.simulator.subcolumn.set_precip_sub_col_frac(model, is_conv, N_columns=None, use_rad_logic=True, parallel=True, chunk=None, precip_types=['pl', 'pi'])[source]¶

Sets the hydrometeor fraction due to precipitation in each subcolumn. This module works for both stratiform and convective precipitation.

Parameters:

model: :py:func: `emc2.core.Model`: The model we are generating the subcolumns of stratiform fraction for.
is_conv: bool: Set to True to generate subcolumns for convective precipitation. Set to False to generate subcolumns for stratiform precipitation.
N_columns: int or None: Use this to set the number of subcolumns in the model. This can only be set once. After the number of subcolumns is set, use None to make EMC2 automatically detect the number of subcolumns.
use_rad_logic: bool: When True using the cloud fraction utilized in a model radiative scheme. Otherwise, using the microphysics scheme (note that these schemes do not necessarily use exactly the same cloud fraction logic).
parallel: bool: If True, use parallelism in calculating lidar parameters.
chunk: int or None: The number of entries to process in one parallel loop. None will send all of the entries to the Dask worker queue at once. Sometimes, Dask will freeze if too many tasks are sent at once due to memory issues, so adjusting this number might be needed if that happens.
ice_hyd_type: str: The ice hydrometeor type to include in the subcolumn distribution for precipitation

Returns:

model: :py:func: emc2.core.Model: The Model object with the stratiform hydrometeor fraction in each subcolumn added.