From eb39f628d8c484e73f4c1bc0238dfdfc466137d4 Mon Sep 17 00:00:00 2001 From: "CERN\\Andrejh" Date: Fri, 10 Jun 2022 09:49:26 +0200 Subject: [PATCH] update docstring --- cara/models.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/cara/models.py b/cara/models.py index 1dc6cb5f..49f94efc 100644 --- a/cara/models.py +++ b/cara/models.py @@ -800,9 +800,9 @@ class _PopulationWithVirus(Population): def emission_rate_per_aerosol_when_present(self) -> _VectorisedFloat: """ - The emission rate of virions in the expired air per aerosol volume, + The emission rate of virions in the expired air per mL of respiratory fluid, if the infected population is present, in (virion.cm^3)/(mL.h). - This method includes the diameter-independent variables of the emission rate. + This method includes only the diameter-independent variables within the emission rate. It should not be a function of time. """ raise NotImplementedError("Subclass must implement") @@ -857,9 +857,9 @@ class EmittingPopulation(_PopulationWithVirus): @method_cache def emission_rate_per_aerosol_when_present(self) -> _VectorisedFloat: """ - The emission rate of virions in the expired air per aerosol volume, + The emission rate of virions in the expired air per mL of respiratory fluid, if the infected population is present, in (virion.cm^3)/(mL.h). - This method includes the diameter-independent variables of the emission rate. + This method includes only the diameter-independent variables within the emission rate. It should not be a function of time. """ return self.known_individual_emission_rate * self.number @@ -886,13 +886,13 @@ class InfectedPopulation(_PopulationWithVirus): @method_cache def emission_rate_per_aerosol_when_present(self) -> _VectorisedFloat: """ - The emission rate of virions in the expired air per aerosol volume, + The emission rate of virions in the expired air per mL of respiratory fluid, if the infected population is present, in (virion.cm^3)/(mL.h). - This method includes the diameter-independent variables of the emission rate. + This method includes only the diameter-independent variables within the emission rate. It should not be a function of time. """ # Note on units: exhalation rate is in m^3/h -> 1e6 conversion factor - # returns the results of ER times the 'numeber' of infected hosts in the room + # Returns the emission rate times the number of infected hosts in the room ER = (self.virus.viral_load_in_sputum * self.activity.exhalation_rate *