BareHyperfine

class nexus.BareHyperfine(weight=0.0, isomer=0.0, magnetic_field=0.0, magnetic_theta=0.0, magnetic_phi=0.0, quadrupole=0.0, quadrupole_alpha=0.0, quadrupole_beta=0.0, quadrupole_gamma=0.0, quadrupole_asymmetry=0.0, texture=1.0, lamb_moessbauer=0.0, broadening=1.0, gaussian_broadening=0.0, isotropic=False)

Constructor for BareHyperfine class. This class is only used for calculations of the nuclear Hamiltonian. Defines a set of hyperfine parameters acting on a Moessbauer isotope. Angles are input in degree but internally stored in radian.

Parameters:
  • weight (float) – Relative weight of the site, > 0.

  • isomer (float) – Isomer shift (mm/s).

  • magnetic_field (float) – Magnetic hyperfine field amplitude (Tesla).

  • magnetic_theta (float) – Polar angle of the magnetic field with respect to the beam propagation direction - photon \(k\) vector (degree).

  • magnetic_phi (float) – Azimuthal angle of the magnetic field with respect to the \(sigma\) direction of the beam (degree).

  • quadrupole (float) – Quadrupole splitting amplitude (mm/s).

  • quadrupole_alpha (float) – Euler angle of the electric field gradient \(\alpha\) in extrinsic ZYZ convention (degree).

  • quadrupole_beta (float) – Euler angle of the electric field gradient \(\beta\) in extrinsic ZYZ convention (degree).

  • quadrupole_gamma (float) – Euler angle of the electric field gradient \(\gamma\) in extrinsic ZYZ convention (degree).

  • quadrupole_asymmetry (float) – Asymmetry parameter of the electric field gradient, 0 to 1.

  • isotropic (bool) – If True the hyperfine site is set to 3D random distribution in both magnetic field and quadrupole splitting.

  • texture (float) –

    Texture coefficient between 0 and 1.

    Added in version 1.2.0.

  • lamb_moessbauer (float) –

    Lamb-Moessbauer factor of the hyperfine site.

    Added in version 1.2.0.

  • broadening (float or Var) –

    Optional inhomogeneous broadening parameter. It introduces an additional Lorentzian broadening to the natural Lorentzian linewidth. The value multiplies with the natural linewidth.

    Added in version 1.2.0.

  • gaussian_broadening (float or Var) –

    Optional inhomogeneous Gaussian broadening parameter. It introduces an additional Gaussian broadening to the natural Lorentzian linewidth. The value is the FWHM of the Gaussian in units of the natural linewidth.

    Added in version 2.0.0.

weight

Relative weight of the site, > 0.

Type:

float

isomer

Isomer shift (mm/s).

Type:

float

magnetic_field

Magnetic hyperfine field amplitude (Tesla).

Type:

float

magnetic_theta

Polar angle of the magnetic field with respect to the beam propagation direction - photon \(k\) vector (rad).

Type:

float

magnetic_phi

Azimuthal angle of the magnetic field with respect to the \(sigma\) direction of the beam (rad).

Type:

float

quadrupole

Quadrupole splitting amplitude (mm/s).

Type:

float

quadrupole_alpha

Euler angle of the electric field gradient \(\alpha\) in extrinsic ZYZ convention (rad).

Type:

float

quadrupole_beta

Euler angle of the electric field gradient \(\beta\) in extrinsic ZYZ convention (rad).

Type:

float

quadrupole_gamma

Euler angle of the electric field gradient \(\gamma\) in extrinsic ZYZ convention (rad).

Type:

float

quadrupole_asymmetry

Asymmetry parameter of the electric field gradient, 0 to 1.

Type:

float

isotropic

If True the hyperfine site is set to 3D random distribution in both magnetic field and quadrupole splitting.

Type:

bool

texture

Texture coefficient between 0 and 1. If isotropic is True it is not taken into account.

Added in version 1.2.0.

Type:

float

lamb_moessbauer

Lamb-Moessbauer factor of the hyperfine site. Not used if the lamb_moessbauer of the material is None.

Added in version 1.2.0.

Type:

float

broadening

Optional inhomogeneous broadening parameter. It introduces an additional Lorentzian broadening to the natural Lorentzian linewidth. The value multiplies with the natural linewidth.

Added in version 1.2.0.

Type:

float or Var

gaussian_broadening

Optional inhomogeneous Gaussian broadening parameter. It introduces an additional Gaussian broadening to the natural Lorentzian linewidth. The value is the FWHM of the Gaussian in units of the natural linewidth.

Added in version 2.0.0.

Type:

float or Var

class nexus.VectorBareHyperfine(*args)

List of BareHyperfine objects.

Examples

Define a BareHyperfine object.

site = nx.BareHyperfine(
  weight = 1,
  isomer = -0.11,
  magnetic_field = 0,
  magnetic_theta = 0,
  magnetic_phi = 45,
  quadrupole = 0.8,
  quadrupole_alpha = 90,
  quadrupole_beta = 45,
  quadrupole_gamma = 0,
  quadrupole_asymmetry = 0.05,
  isotropic = False
  )