Image dipole_pair


Calculate the unit vectors for all interatomic interactions.



Keyword arguments

ave: A flag which if True will cause the bond vectors from all models to be averaged. If vectors from only one model is extracted, this will have no effect.


For an orientational dependent analysis, such as model-free analysis with the spheroidal and ellipsoidal global diffusion tensors or any analysis using RDCs, the unit vectors between the two dipoles must be calculated prior to starting the analysis. For the unit vector extraction, the two interacting spins should already possess positional information and the dipole-dipole interaction should already be defined via the interatom.define user function. This information will be used to calculate unit vectors between the two spins. Without positional information from a 3D structure, no vectors can be calculated and an orientational dependent analysis will not be possible.

The number of unit vectors per interaction will be defined by the number of positions each spin possesses together with the averaging flag. If both spins have N and M positions loaded, the number of positions for both must match (N=M). In this case, as well as when one spin has N positions and the other a single position, then N unit vectors will be calculated. This is unless the averaging flag is set in which case an averaged vector of unit length will be calculated.

Prompt examples

To calculate the unit vectors prior to a model-free analysis, type one of the following:

relax> interatom.unit_vectors(True)

relax> interatom.unit_vectors(ave=True)

The relax user manual (PDF), created 2024-06-08.