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 507091cc authored by Cyrill Mast's avatar Cyrill Mast
Browse files

added units

parent 2b634c5e
Pipeline #90952 passed with stages
in 6 minutes and 19 seconds
......@@ -297,9 +297,9 @@ class ARF(ScatteringField, BaseARF):
Computes the coefficients D, where num takes values 1 or 2
based on eq. (54) & (55)
:param num: number of the coefficient
:param num: number of the coefficient []
:type num: int
:param n: degree
:param n: degree []
:type n: int
:rtype: float
"""
......@@ -318,6 +318,11 @@ class ARF(ScatteringField, BaseARF):
@property
def density_compressibility_factor(self) -> float:
"""
Density-compressibility factor F []
dimensionless parameter used for special solutions
dependent on the wavetype and the assumption
"""
return self._F.value
def _compute_F(self) -> float:
......@@ -354,7 +359,7 @@ class ARF(ScatteringField, BaseARF):
"""
returns the coefficients from eq. (43)
:param n: degree
:param n: degree []
:type n: int
:rtype: complex
"""
......@@ -369,7 +374,7 @@ class ARF(ScatteringField, BaseARF):
"""
returns the coefficients from eq. (42)
:param n: degree
:param n: degree []
:type n: int
:rtype: complex
"""
......
......@@ -139,14 +139,14 @@ class BaseYosioka(BaseSphereFrequencyComposite):
@property
def sigma(self) -> float:
"""c - ratio or k-ratio.
"""c - ratio or k-ratio [].
:rtype: float
"""
return self._sigma.value
@property
def xlambda(self) -> float:
"""rho - ratio
"""rho - ratio []
:rtype: float
"""
return self._xlambda.value
......
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