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:25
Mixin class for distribution type in coagulation strategies.
Provides an interface to set the distribution type for coagulation
strategies. Ensures the chosen distribution_type is valid.
Attributes¶
- distribution_type : Stores the selected distribution type (e.g., "discrete", "continuous_pdf", "particle_resolved").
Methods¶
- set_distribution_type : Set and validate the distribution type.
Examples¶
builder = SomeCoagulationBuilder()
builder.set_distribution_type("discrete")
# builder.distribution_type -> "discrete"
Signature¶
class BuilderDistributionTypeMixin:
def __init__(self): ...
BuilderDistributionTypeMixin().set_distribution_type¶
Show source in coagulation_builder_mixin.py:49
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.
Returns¶
- The instance of the class with the updated distribution_type attribute.
Raises¶
ValueError- If the distribution type is not valid.
Examples¶
builder = SomeCoagulationBuilder()
builder.set_distribution_type("discrete")
# builder.distribution_type -> "discrete"
Signature¶
def set_distribution_type(
self, distribution_type: str, distribution_type_units: str = None
): ...
BuilderFluidDensityMixin¶
Show source in coagulation_builder_mixin.py:157
Mixin class for fluid density parameters.
Adds methods and attributes for setting and validating fluid density in coagulation strategies.
Attributes¶
- fluid_density : Numeric value representing fluid density in kg/m^3 (default units).
Methods¶
- set_fluid_density : Set and validate the fluid density.
Examples¶
builder.set_fluid_density(1.225, "kg/m^3")
Signature¶
class BuilderFluidDensityMixin:
def __init__(self): ...
BuilderFluidDensityMixin().set_fluid_density¶
Show source in coagulation_builder_mixin.py:179
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
Returns¶
- The instance of the class with the updated fluid_density attribute.
Raises¶
ValueError- Must be positive value.
Examples¶
builder = SomeCoagulationBuilder()
builder.set_fluid_density(1.225, "kg/m^3")
# builder.fluid_density -> 1.225
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:97
Mixin class for turbulent shear parameters.
Adds methods and attributes for setting and validating turbulent dissipation parameters in coagulation strategies.
Attributes¶
- turbulent_dissipation : Numeric value of the energy dissipation rate in m2/s3 (default units).
Methods¶
- set_turbulent_dissipation : Set and validate the turbulent dissipation rate.
Examples¶
builder.set_turbulent_dissipation(1e-3, "m^2/s^3")
Signature¶
class BuilderTurbulentDissipationMixin:
def __init__(self): ...
BuilderTurbulentDissipationMixin().set_turbulent_dissipation¶
Show source in coagulation_builder_mixin.py:120
Set the turbulent dissipation rate.
Arguments¶
turbulent_dissipation : Turbulent dissipation rate. turbulent_dissipation_units : Units of the turbulent dissipation rate. Default is m2/s3.
Returns¶
- The instance of the class with the updated turbulent_dissipation attribute.
Raises¶
ValueError- Must be non-negative value.
Examples¶
builder = SomeCoagulationBuilder()
builder.set_turbulent_dissipation(1e-3, "m^2/s^3")
# builder.turbulent_dissipation -> 1e-3
Signature¶
@validate_inputs({"turbulent_dissipation": "nonnegative"})
def set_turbulent_dissipation(
self, turbulent_dissipation: float, turbulent_dissipation_units: str
): ...