update docstrings of equations

ppsci/equation/pde/biharmonic.py

@@ -16,6 +16,7 @@
 
 from typing import Optional
 from typing import Tuple
+from typing import Union
 
 from ppsci.equation.pde import base
 
@@ -29,8 +30,10 @@ class Biharmonic(base.PDE):
 
     Args:
         dim (int): Dimension of equation.
-        q (float): Load.
-        D (float): Rigidity.
+        q (Union[float, str]): Load.
+        D (Union[float, str]): Rigidity.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -40,8 +43,8 @@ class Biharmonic(base.PDE):
     def __init__(
         self,
         dim: int,
-        q: float,
-        D: float,
+        q: Union[float, str],
+        D: Union[float, str],
         detach_keys: Optional[Tuple[str, ...]] = None,
     ):
         super().__init__()

ppsci/equation/pde/laplace.py

@@ -29,6 +29,8 @@ class Laplace(base.PDE):
 
     Args:
         dim (int): Dimension of equation.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci

ppsci/equation/pde/linear_elasticity.py

@@ -16,6 +16,7 @@
 
 from typing import Optional
 from typing import Tuple
+from typing import Union
 
 import sympy as sp
 
@@ -38,13 +39,15 @@ class LinearElasticity(base.PDE):
     $$
 
     Args:
-        E (Optional[float]): The Young's modulus. Defaults to None.
-        nu (Optional[float]): The Poisson's ratio. Defaults to None.
-        lambda_ (Optional[float]): Lamé's first parameter. Defaults to None.
-        mu (Optional[float]): Lamé's second parameter (shear modulus). Defaults to None.
-        rho (float, optional): Mass density. Defaults to 1.
+        E (Optional[Union[float, str]]): The Young's modulus. Defaults to None.
+        nu (Optional[Union[float, str]]): The Poisson's ratio. Defaults to None.
+        lambda_ (Optional[Union[float, str]]): Lamé's first parameter. Defaults to None.
+        mu (Optional[Union[float, str]]): Lamé's second parameter (shear modulus). Defaults to None.
+        rho (Union[float, str], optional): Mass density. Defaults to 1.
         dim (int, optional): Dimension of the linear elasticity (2 or 3). Defaults to 3.
         time (bool, optional): Whether contains time data. Defaults to False.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -55,11 +58,11 @@ class LinearElasticity(base.PDE):
 
     def __init__(
         self,
-        E: Optional[float] = None,
-        nu: Optional[float] = None,
-        lambda_: Optional[float] = None,
-        mu: Optional[float] = None,
-        rho: float = 1,
+        E: Optional[Union[float, str]] = None,
+        nu: Optional[Union[float, str]] = None,
+        lambda_: Optional[Union[float, str]] = None,
+        mu: Optional[Union[float, str]] = None,
+        rho: Union[float, str] = 1,
         dim: int = 3,
         time: bool = False,
         detach_keys: Optional[Tuple[str, ...]] = None,

ppsci/equation/pde/navier_stokes.py

@@ -14,7 +14,6 @@
 
 from __future__ import annotations
 
-from typing import Callable
 from typing import Optional
 from typing import Tuple
 from typing import Union
@@ -55,10 +54,12 @@ class NavierStokes(base.PDE):
     $$
 
     Args:
-        nu (Union[float, Callable]): Dynamic viscosity.
-        rho (float): Density.
+        nu (Union[float, str]): Dynamic viscosity.
+        rho (Union[float, str]): Density.
         dim (int): Dimension of equation.
         time (bool): Whether the euqation is time-dependent.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -67,31 +68,32 @@ class NavierStokes(base.PDE):
 
     def __init__(
         self,
-        nu: Union[float, Callable],
-        rho: float,
+        nu: Union[float, str],
+        rho: Union[float, str],
         dim: int,
         time: bool,
         detach_keys: Optional[Tuple[str, ...]] = None,
     ):
         super().__init__()
         self.detach_keys = detach_keys
+        self.dim = dim
+        self.time = time
+
         t, x, y, z = self.create_symbols("t x y z")
         invars = (x, y)
         if time:
             invars = (t,) + invars
         if dim == 3:
             invars += (z,)
 
-        self.nu = nu
-        self.rho = rho
-        self.dim = dim
-        self.time = time
-
         if isinstance(nu, str):
             nu = self.create_function(nu, invars)
         if isinstance(rho, str):
             rho = self.create_function(rho, invars)
 
+        self.nu = nu
+        self.rho = rho
+
         u = self.create_function("u", invars)
         v = self.create_function("v", invars)
         w = self.create_function("w", invars) if dim == 3 else sp.Number(0)

ppsci/equation/pde/normal_dot_vec.py

@@ -30,6 +30,8 @@ class NormalDotVec(base.PDE):
     Args:
         vec_keys (Tuple[str, ...]): Keys for vectors, such as ("u", "v", "w") for
             velocity vector.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -49,7 +51,7 @@ def __init__(
         normals = self.create_symbols("normal_x normal_y normal_z")
 
         normal_dot_vec = 0
-        for (vec, normal) in zip(vec_vars, normals):
+        for (normal, vec) in zip(normals, vec_vars):
             normal_dot_vec += normal * vec
 
         self.add_equation("normal_dot_vec", normal_dot_vec)

ppsci/equation/pde/poisson.py

@@ -29,6 +29,8 @@ class Poisson(base.PDE):
 
     Args:
         dim (int): Dimension of equation.
+        detach_keys(Optional[Tuple[str, ...]]): Keys used for detach during computing.
+            Defaults to None.
 
     Examples:
         >>> import ppsci