To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 3851c7b8 authored by Jonas Fankhauser's avatar Jonas Fankhauser
Browse files

Redundant types in docstring removed

parent 4adbefb1
......@@ -35,24 +35,14 @@ class ARF(ScatteringField, BaseARF):
computation.
:param frequency: Frequency [Hz]
:type frequency: Union[Frequency, float, int]
:param radius: Radius of the solid [m]
:type radius: Union[Sphere, float, int]
:param rho_s: Density of the fluid-like solid [kg/m^3]
:type rho_s: float
:param c_s: Speed of sound of the particle [m/s]
:type c_s: float
:param rho_f: Density of the fluid [kg/m^3]
:type rho_f: float
:param c_f: Speed of sound of the fluid [m/s]
:type c_f: float
:param p_0: Pressure amplitude of the field [Pa]
:type p_0: float
:param position: Position within the standing wave field [m]
:type position: float
:param wave_type: either standing or progressive wavefield
:type wave_type: str
:rtype: None
"""
# init of parent class
......
......@@ -36,24 +36,14 @@ class BaseYosioka(BaseSphereFrequencyComposite):
in the paper from Yoskioka and Kawasima (1955).
:param frequency: Frequency [Hz]
:type frequency: Union[Frequency, float, int]k
:param radius: Radius of the solid [m]
:type radius: Union[Sphere, float, int]
:param rho_s: Density of the fluid-like solid [kg/m^3]
:type rho_s: float
:param c_s: Speed of sound of the particle [m/s]
:type c_s: float
:param rho_f: Density of the fluid [kg/m^3]
:type rho_f: float
:param c_f: speed of sound in the fluid [m/s]
:type c_f: float
:param p_0: Pressure amplitude of the field [Pa]
:type p_0: float
:param position: Position within the standing wave field [m]
:type position: Optional[float]
:param wave_type: either standing or progressive wave
:type wave_type: str
:rtype: None
"""
# init of parent class
......
......@@ -24,7 +24,6 @@ class ScatteringField(BaseYosioka, BaseScattering):
- plane progressive / standing wave field
"""
# TODO: remove particle_type
def __init__(self, frequency: Union[Frequency, float],
radius: Union[Sphere, float],
rho_s: float, c_s: float, rho_f: float, c_f: float,
......@@ -35,24 +34,14 @@ class ScatteringField(BaseYosioka, BaseScattering):
computation.
:param frequency: Frequency [Hz]
:type frequency: Union[Frequency, float, int]
:param radius: Radius of the solid [m]
:type radius: Union[Sphere, float, int]
:param rho_s: Density of the fluid-like solid [kg/m^3]
:type rho_s: float
:param c_s: Speed of sound of the particle [m/s]
:type c_s: float
:param rho_f: Density of the fluid [kg/m^3]
:type rho_f: float
:param c_f: Speed of sound of the fluid [m/s]
:type c_f: float
:param p_0: Pressure amplitude of the field [Pa]
:type p_0: float
:param position: Position within the standing wave field [m]
:type position: float
:param wave_type: either standing or progressive wave
:type wave_type: str
:rtype: None
"""
BaseYosioka.__init__(self, frequency, radius,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment