Skip to content

Commit

Permalink
updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
RemDelaporteMathurin committed Jun 3, 2024
1 parent 315aebd commit cb739b5
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions festim/temperature/temperature.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,26 @@

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
T_n (fenics.Function): the previous function
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
Expand Down

0 comments on commit cb739b5

Please sign in to comment.