From cb739b5b644e0ee6dfc9972306d2edc577354dba Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Mon, 3 Jun 2024 14:36:18 +0200 Subject: [PATCH] updated docstrings --- festim/temperature/temperature.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/festim/temperature/temperature.py b/festim/temperature/temperature.py index 3ddd2d25a..be695c772 100644 --- a/festim/temperature/temperature.py +++ b/festim/temperature/temperature.py @@ -4,13 +4,11 @@ class Temperature: """ - Description of Temperature + Class for Temperature in FESTIM Args: value (sp.Add, int, float, optional): The value of the temperature. - Only needed if type is not "expression". Defaults to None. - initial_value (sp.Add, int, float, optional): The initial value. - Only needed if type is not "expression". Defaults to None. + Defaults to None. Attributes: T (fenics.Function): the function attributed with temperature @@ -18,10 +16,14 @@ class Temperature: value (sp.Add, int, float): the expression of temperature expression (fenics.Expression): the expression of temperature as a fenics object + + Usage: + >>> import festim as F + >>> my_model = F.Simulation(...) + >>> my_model.T = F.Temperature(300 + 10 * F.x + F.t) """ def __init__(self, value=None) -> None: - # self.type = type self.T = None self.T_n = None self.value = value