Module pseudo_ellipse_torsionless

Module for the handling of Frame Order.

Functions

compile_2nd_matrix_pseudo_ellipse_torsionless(matrix, Rx2_eigen, theta_x, theta_y)
Generate the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_00(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_04(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_08(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_11(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_22(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_44(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_48(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_55(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float part_int_daeg2_pseudo_ellipse_torsionless_88(phi, x, y)
The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

float pcs_numeric_int_pseudo_ellipse_torsionless(theta_x=None, theta_y=None, c=None, r_pivot_atom=None, r_ln_pivot=None, A=None, R_eigen=None, RT_eigen=None, Ri_prime=None)
Determine the averaged PCS value via numerical integration.

pcs_numeric_int_pseudo_ellipse_torsionless_qrint(points=None, theta_x=None, theta_y=None, c=None, full_in_ref_frame=None, r_pivot_atom=None, r_pivot_atom_rev=None, r_ln_pivot=None, A=None, R_eigen=None, RT_eigen=None, Ri_prime=None, pcs_theta=None, pcs_theta_err=None, missing_pcs=None, error_flag=False)
Determine the averaged PCS value via numerical integration.

Variables

__package__ = 'lib.frame_order'

Imports: dep_check, cos, pi, sin, sqrt, dblquad, quad, pec, pcs_pivot_motion_torsionless, pcs_pivot_motion_torsionless_qrint, rotate_daeg, tmax_pseudo_ellipse

Function Details

compile_2nd_matrix_pseudo_ellipse_torsionless(matrix, Rx2_eigen, theta_x, theta_y)

Generate the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• matrix (numpy 9D, rank-2 array) - The Frame Order matrix, 2nd degree to be populated.
• Rx2_eigen (numpy 9D, rank-2 array) - The Kronecker product of the eigenframe rotation matrix with itself.
• theta_x (float) - The cone opening angle along x.
• theta_y (float) - The cone opening angle along y.

part_int_daeg2_pseudo_ellipse_torsionless_00(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_04(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_08(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_11(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_22(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_44(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_48(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_55(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

part_int_daeg2_pseudo_ellipse_torsionless_88(phi, x, y)

The theta partial integral of the 2nd degree Frame Order matrix for the torsionless pseudo-ellipse.

Parameters:

• phi (float) - The azimuthal tilt-torsion angle.
• x (float) - The cone opening angle along x.
• y (float) - The cone opening angle along y.

Returns: float

The theta partial integral.

pcs_numeric_int_pseudo_ellipse_torsionless(theta_x=None, theta_y=None, c=None, r_pivot_atom=None, r_ln_pivot=None, A=None, R_eigen=None, RT_eigen=None, Ri_prime=None)

Determine the averaged PCS value via numerical integration.

Parameters:

• theta_x (float) - The x-axis half cone angle.
• theta_y (float) - The y-axis half cone angle.
• c (float) - The PCS constant (without the interatomic distance and in Angstrom units).
• r_pivot_atom (numpy rank-1, 3D array) - The pivot point to atom vector.
• r_ln_pivot (numpy rank-1, 3D array) - The lanthanide position to pivot point vector.
• A (numpy rank-2, 3D array) - The full alignment tensor of the non-moving domain.
• R_eigen (numpy rank-2, 3D array) - The eigenframe rotation matrix.
• RT_eigen (numpy rank-2, 3D array) - The transpose of the eigenframe rotation matrix (for faster calculations).
• Ri_prime (numpy rank-2, 3D array) - The empty rotation matrix for the in-frame isotropic cone motion, used to calculate the PCS for each state i in the numerical integration.

Returns: float

The averaged PCS value.

pcs_numeric_int_pseudo_ellipse_torsionless_qrint(points=None, theta_x=None, theta_y=None, c=None, full_in_ref_frame=None, r_pivot_atom=None, r_pivot_atom_rev=None, r_ln_pivot=None, A=None, R_eigen=None, RT_eigen=None, Ri_prime=None, pcs_theta=None, pcs_theta_err=None, missing_pcs=None, error_flag=False)

Determine the averaged PCS value via numerical integration.

Parameters:

• points (numpy rank-2, 3D array) - The Sobol points in the torsion-tilt angle space.
• theta_x (float) - The x-axis half cone angle.
• theta_y (float) - The y-axis half cone angle.
• c (numpy rank-1 array) - The PCS constant (without the interatomic distance and in Angstrom units).
• full_in_ref_frame (numpy rank-1 array) - An array of flags specifying if the tensor in the reference frame is the full or reduced tensor.
• r_pivot_atom (numpy rank-2, 3D array) - The pivot point to atom vector.
• r_pivot_atom_rev (numpy rank-2, 3D array) - The reversed pivot point to atom vector.
• r_ln_pivot (numpy rank-2, 3D array) - The lanthanide position to pivot point vector.
• A (numpy rank-2, 3D array) - The full alignment tensor of the non-moving domain.
• R_eigen (numpy rank-2, 3D array) - The eigenframe rotation matrix.
• RT_eigen (numpy rank-2, 3D array) - The transpose of the eigenframe rotation matrix (for faster calculations).
• Ri_prime (numpy rank-2, 3D array) - The empty rotation matrix for the in-frame isotropic cone motion, used to calculate the PCS for each state i in the numerical integration.
• pcs_theta (numpy rank-2 array) - The storage structure for the back-calculated PCS values.
• pcs_theta_err (numpy rank-2 array) - The storage structure for the back-calculated PCS errors.
• missing_pcs (numpy rank-2 array) - A structure used to indicate which PCS values are missing.
• error_flag (bool) - A flag which if True will cause the PCS errors to be estimated and stored in pcs_theta_err.