shgpy.shg_symbols module

This module defines a number of sympy.Symbol objects which are used throughout shgpy. They are used to define free parameters in suscepitbility tensors (see tensor_definitions), and to standardize name conventions for important variables (like phi and theta, which are used throughout shgpy as the standard azimuthal and incidence angles, respectively).

These variables in this module should be treated as protected and not modified by the user unless absolutely necessary.

shgpy.shg_symbols.Fx = Fx
shgpy.shg_symbols.Fy = Fy
shgpy.shg_symbols.Fz = Fz
shgpy.shg_symbols.phi = phi

Azimuthal angle

real = True

shgpy.shg_symbols.psi = psi

Arbitrary phase shift

real = True

shgpy.shg_symbols.sxxx = sxxx
shgpy.shg_symbols.sxxy = sxxy
shgpy.shg_symbols.sxxz = sxxz
shgpy.shg_symbols.sxyx = sxyx
shgpy.shg_symbols.sxyy = sxyy
shgpy.shg_symbols.sxyz = sxyz
shgpy.shg_symbols.sxzx = sxzx
shgpy.shg_symbols.sxzy = sxzy
shgpy.shg_symbols.sxzz = sxzz
shgpy.shg_symbols.syxx = syxx
shgpy.shg_symbols.syxy = syxy
shgpy.shg_symbols.syxz = syxz
shgpy.shg_symbols.syyx = syyx
shgpy.shg_symbols.syyy = syyy
shgpy.shg_symbols.syyz = syyz
shgpy.shg_symbols.syzx = syzx
shgpy.shg_symbols.syzy = syzy
shgpy.shg_symbols.syzz = syzz
shgpy.shg_symbols.szxx = szxx
shgpy.shg_symbols.szxy = szxy
shgpy.shg_symbols.szxz = szxz
shgpy.shg_symbols.szyx = szyx
shgpy.shg_symbols.szyy = szyy
shgpy.shg_symbols.szyz = szyz
shgpy.shg_symbols.szzx = szzx
shgpy.shg_symbols.szzy = szzy
shgpy.shg_symbols.szzz = szzz
shgpy.shg_symbols.theta = theta

Angle of incidence

real = True

shgpy.shg_symbols.xxx = xxx
shgpy.shg_symbols.xxxx = xxxx
shgpy.shg_symbols.xxxy = xxxy
shgpy.shg_symbols.xxxz = xxxz
shgpy.shg_symbols.xxy = xxy
shgpy.shg_symbols.xxyx = xxyx
shgpy.shg_symbols.xxyy = xxyy
shgpy.shg_symbols.xxyz = xxyz
shgpy.shg_symbols.xxz = xxz
shgpy.shg_symbols.xxzx = xxzx
shgpy.shg_symbols.xxzy = xxzy
shgpy.shg_symbols.xxzz = xxzz
shgpy.shg_symbols.xyx = xyx
shgpy.shg_symbols.xyxx = xyxx
shgpy.shg_symbols.xyxy = xyxy
shgpy.shg_symbols.xyxz = xyxz
shgpy.shg_symbols.xyy = xyy
shgpy.shg_symbols.xyyx = xyyx
shgpy.shg_symbols.xyyy = xyyy
shgpy.shg_symbols.xyyz = xyyz
shgpy.shg_symbols.xyz = xyz
shgpy.shg_symbols.xyzx = xyzx
shgpy.shg_symbols.xyzy = xyzy
shgpy.shg_symbols.xyzz = xyzz
shgpy.shg_symbols.xzx = xzx
shgpy.shg_symbols.xzxx = xzxx
shgpy.shg_symbols.xzxy = xzxy
shgpy.shg_symbols.xzxz = xzxz
shgpy.shg_symbols.xzy = xzy
shgpy.shg_symbols.xzyx = xzyx
shgpy.shg_symbols.xzyy = xzyy
shgpy.shg_symbols.xzyz = xzyz
shgpy.shg_symbols.xzz = xzz
shgpy.shg_symbols.xzzx = xzzx
shgpy.shg_symbols.xzzy = xzzy
shgpy.shg_symbols.xzzz = xzzz
shgpy.shg_symbols.yxx = yxx
shgpy.shg_symbols.yxxx = yxxx
shgpy.shg_symbols.yxxy = yxxy
shgpy.shg_symbols.yxxz = yxxz
shgpy.shg_symbols.yxy = yxy
shgpy.shg_symbols.yxyx = yxyx
shgpy.shg_symbols.yxyy = yxyy
shgpy.shg_symbols.yxyz = yxyz
shgpy.shg_symbols.yxz = yxz
shgpy.shg_symbols.yxzx = yxzx
shgpy.shg_symbols.yxzy = yxzy
shgpy.shg_symbols.yxzz = yxzz
shgpy.shg_symbols.yyx = yyx
shgpy.shg_symbols.yyxx = yyxx
shgpy.shg_symbols.yyxy = yyxy
shgpy.shg_symbols.yyxz = yyxz
shgpy.shg_symbols.yyy = yyy
shgpy.shg_symbols.yyyx = yyyx
shgpy.shg_symbols.yyyy = yyyy
shgpy.shg_symbols.yyyz = yyyz
shgpy.shg_symbols.yyz = yyz
shgpy.shg_symbols.yyzx = yyzx
shgpy.shg_symbols.yyzy = yyzy
shgpy.shg_symbols.yyzz = yyzz
shgpy.shg_symbols.yzx = yzx
shgpy.shg_symbols.yzxx = yzxx
shgpy.shg_symbols.yzxy = yzxy
shgpy.shg_symbols.yzxz = yzxz
shgpy.shg_symbols.yzy = yzy
shgpy.shg_symbols.yzyx = yzyx
shgpy.shg_symbols.yzyy = yzyy
shgpy.shg_symbols.yzyz = yzyz
shgpy.shg_symbols.yzz = yzz
shgpy.shg_symbols.yzzx = yzzx
shgpy.shg_symbols.yzzy = yzzy
shgpy.shg_symbols.yzzz = yzzz
shgpy.shg_symbols.zxx = zxx
shgpy.shg_symbols.zxxx = zxxx
shgpy.shg_symbols.zxxy = zxxy
shgpy.shg_symbols.zxxz = zxxz
shgpy.shg_symbols.zxy = zxy
shgpy.shg_symbols.zxyx = zxyx
shgpy.shg_symbols.zxyy = zxyy
shgpy.shg_symbols.zxyz = zxyz
shgpy.shg_symbols.zxz = zxz
shgpy.shg_symbols.zxzx = zxzx
shgpy.shg_symbols.zxzy = zxzy
shgpy.shg_symbols.zxzz = zxzz
shgpy.shg_symbols.zyx = zyx
shgpy.shg_symbols.zyxx = zyxx
shgpy.shg_symbols.zyxy = zyxy
shgpy.shg_symbols.zyxz = zyxz
shgpy.shg_symbols.zyy = zyy
shgpy.shg_symbols.zyyx = zyyx
shgpy.shg_symbols.zyyy = zyyy
shgpy.shg_symbols.zyyz = zyyz
shgpy.shg_symbols.zyz = zyz
shgpy.shg_symbols.zyzx = zyzx
shgpy.shg_symbols.zyzy = zyzy
shgpy.shg_symbols.zyzz = zyzz
shgpy.shg_symbols.zzx = zzx
shgpy.shg_symbols.zzxx = zzxx
shgpy.shg_symbols.zzxy = zzxy
shgpy.shg_symbols.zzxz = zzxz
shgpy.shg_symbols.zzy = zzy
shgpy.shg_symbols.zzyx = zzyx
shgpy.shg_symbols.zzyy = zzyy
shgpy.shg_symbols.zzyz = zzyz
shgpy.shg_symbols.zzz = zzz
shgpy.shg_symbols.zzzx = zzzx
shgpy.shg_symbols.zzzy = zzzy
shgpy.shg_symbols.zzzz = zzzz