pingu_98/cara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improving docstrings in expiration classes

Browse source
This commit is contained in:
Nicolas Mounet 2021-05-28 06:56:13 +02:00 committed by Phil Elson
parent b8422aaf1b
commit f050214237
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
cara/models.py
View file

@ -520,7 +520,7 @@ class _ExpirationBase:
types: typing.ClassVar[typing.Dict[str, "_ExpirationBase"]]
def aerosols(self, mask: _MaskBase):
# total volume of aerosols expired (cm^3).
# total volume of aerosols expired per volume of air (mL/cm^3).
raise NotImplementedError("Subclass must implement")
@ -528,7 +528,10 @@ class _ExpirationBase:
class Expiration(_ExpirationBase):
"""
Simple model based on four different sizes of particles emitted,
with different ejection factors.
with different ejection factors. See Fig. 4 in L. Morawska et al,
Size distribution and sites of origin of droplets expelled from the
human respiratory tract during expiratory activities,
Aerosol Science 40 (2009) pp. 256 - 269.
"""
ejection_factor: typing.Tuple[float, ...]
particle_sizes: typing.Tuple[float, ...] = (0.8e-4, 1.8e-4, 3.5e-4, 5.5e-4) # In cm.