emc2.simulator.subcolumn.set_stratiform_sub_col_frac

emc2.simulator.subcolumn.set_stratiform_sub_col_frac(model, N_columns=None, use_rad_logic=True, parallel=True, chunk=None)[source]

Sets the hydrometeor fraction due to stratiform cloud particles in each subcolumn.

Parameters:
model: :py:func: `emc2.core.Model`

The model we are generating the subcolumns of stratiform fraction for.

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).

N_columns: int or None

The number of subcolumns to generate. Specifying this will set the number of subcolumns in the model parameter when the first subcolumns are generated. Therefore, after those are generated this must either be equal to None or the number of subcolumns in the model. Setting this to None will use the number of subcolumns in the model parameter.

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.

Returns:
model: :py:func: emc2.core.Model

The Model object with the stratiform hydrometeor fraction in each subcolumn added.