- class maicos.modules.dipoleangle.DipoleAngle(atomgroup, dim=2, output='dipangle.dat', concfreq=0)[source]#
Calculate angle timeseries of dipole moments with respect to an axis.
The analysis can be applied to study the orientational dynamics of water molecules during an excitation pulse. For more details read Elgabarty et al..
atomgroup (AtomGroup) – A
AtomGroupfor which the calculations are performed.
refgroup (AtomGroup) –
AtomGroupused for the calculation.
If refgroup is provided, the calculation is performed relative to the center of mass of the AtomGroup.
If refgroup is
Nonethe calculations are performed to the center of the (changing) box.
unwrap (bool) –
unwrap = True, molecules that are broken due to the periodic boundary conditions are made whole.
If the input contains molecules that are already whole, speed up the calculation by disabling unwrap. To do so, use the flag
-no-unwrapwhen using MAICoS from the command line, or use
unwrap = Falsewhen using MAICoS from the Python interpreter.
Note: Molecules containing virtual sites (e.g. TIP4P water models) are not currently supported in MDAnalysis. In this case, you need to provide unwrapped trajectory files directly, and disable unwrap. Trajectories can be unwrapped, for example, using the
trjconvcommand of GROMACS.
concfreq (int) – When concfreq (for conclude frequency) is larger than 0, the conclude function is called and the output files are written every concfreq frames
dim (int) – Reference vector for angle (
output (str) – Prefix for output filenames.
concfreq – Default number of frames after which results are calculated and files refreshed. If
0results are only calculated at the end of the analysis and not saved by default.
Average \(\cos\) between dipole and axis.
Average \(\cos²\) of the dipoles and axis.
Product \(\cos\) of dipole i and cos of dipole j (
i != j).