Coagulation Builder Mixin¶

Particula Index / Particula / Dynamics / Coagulation / Coagulation Builder / Coagulation Builder Mixin

Auto-generated documentation for particula.dynamics.coagulation.coagulation_builder.coagulation_builder_mixin module.

BuilderDistributionTypeMixin¶

Show source in coagulation_builder_mixin.py:22

Mixin class for distribution type in coagulation strategies.

This mixin class is used to set the distribution type for coagulation strategies. It provides a validation layer to ensure that the correct distribution type is passed to the coagulation strategy.

Methods¶

set_distribution_type(distribution_type) - Set the distribution type.

Signature¶

class BuilderDistributionTypeMixin:
    def __init__(self): ...

BuilderDistributionTypeMixin().set_distribution_type¶

Show source in coagulation_builder_mixin.py:36

Set the distribution type.

Arguments¶

distribution_type : The distribution type to be set. Options are "discrete", "continuous_pdf", "particle_resolved". distribution_type_units : Not used.

Raises¶

ValueError - If the distribution type is not valid.

Signature¶

def set_distribution_type(
    self, distribution_type: str, distribution_type_units: Optional[str] = None
): ...

BuilderFluidDensityMixin¶

Show source in coagulation_builder_mixin.py:106

Mixin class for fluid density parameters.

This mixin class is used to set the fluid density for turbulent shear coagulation strategies. It provides a validation layer to ensure that the correct values are passed.

Signature¶

class BuilderFluidDensityMixin:
    def __init__(self): ...

BuilderFluidDensityMixin().set_fluid_density¶

Show source in coagulation_builder_mixin.py:117

Set the density of the particle in kg/m^3.

Arguments¶

density : Density of the particle. density_units : Units of the density. Default is kg/m^3

Signature¶

@validate_inputs({"fluid_density": "positive"})
def set_fluid_density(
    self, fluid_density: Union[float, NDArray[np.float64]], fluid_density_units: str
): ...

BuilderTurbulentDissipationMixin¶

Show source in coagulation_builder_mixin.py:73

Mixin class for turbulent shear parameters.

This mixin class is used to set the turbulent dissipation and fluid density for turbulent shear coagulation strategies. It provides a validation layer to ensure that the correct values are passed.

Signature¶

class BuilderTurbulentDissipationMixin:
    def __init__(self): ...

BuilderTurbulentDissipationMixin().set_turbulent_dissipation¶

Show source in coagulation_builder_mixin.py:84

Set the turbulent dissipation rate.

Arguments¶

turbulent_dissipation : Turbulent dissipation rate. turbulent_dissipation_units : Units of the turbulent dissipation rate. Default is m^2/s3.

Signature¶

@validate_inputs({"turbulent_dissipation": "nonnegative"})
def set_turbulent_dissipation(
    self, turbulent_dissipation: float, turbulent_dissipation_units: str
): ...