Skip to content

Commit a87fa0f

Browse files
author
apearce
committed
🎨 add doc strings
1 parent c4ad18c commit a87fa0f

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

process/sctfcoil.py

+23-4
Original file line numberDiff line numberDiff line change
@@ -7187,9 +7187,17 @@ def _inductance_factor(H, Ri, Ro, Rm, theta1):
71877187
)
71887188

71897189

7190+
@staticmethod
71907191
def lambda_term(tau, omega):
7191-
"""
7192-
words
7192+
"""Lambda Term
7193+
7194+
Author: Alexander Pearce, UKAEA
7195+
7196+
:param tau: tau_{s,k} = (R_{s,k} - R_{c,k}) / R_k
7197+
:param omega: omega_k = R_{c,k}/R_k
7198+
7199+
The lammbda fucntion used inegral in inductance calcuation found
7200+
in Y. Itoh et al. The full form of the functions are given in appendix A.
71937201
"""
71947202
p = 1.0 - omega**2.0
71957203

@@ -7205,9 +7213,20 @@ def lambda_term(tau, omega):
72057213
return integral
72067214

72077215

7216+
@staticmethod
72087217
def _theta_factor_integral(Ro_vv, Ri_vv, Rm_vv, H_vv, theta1_vv):
7209-
"""
7210-
words
7218+
"""Theta Factor Integral
7219+
Author: Alexander Pearce, UKAEA
7220+
7221+
:param Ro_vv: the radius of the outboard edge of the VV CCL
7222+
:param Ri_vv: the radius of the inboard edge of the VV CCL
7223+
:param Rm_vv: the radius where the maximum height of the VV CCL occurs
7224+
:param H_vv: the maximum height of the VV CCL
7225+
:param theta1_vv: the polar angle of the point at which one circular arc is
7226+
joined to another circular arc in the approximation to the VV CCL
7227+
7228+
The calcuation of the theta factor found in Eq 4 of Y. Itoh et al. The
7229+
full form of the integral is given in appendix A.
72117230
"""
72127231
theta2 = np.pi / 2.0 + theta1_vv
72137232
a = (Ro_vv - Ri_vv) / 2.0

0 commit comments

Comments
 (0)