Skip to content

Commit

Permalink
Document vector geom and debye
Browse files Browse the repository at this point in the history
  • Loading branch information
drroe committed Aug 29, 2024
1 parent b590c99 commit db51c3e
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions doc/cpptraj.lyx
Original file line number Diff line number Diff line change
Expand Up @@ -43104,7 +43104,7 @@ vector [<name>] <Type> [out <filename> [ptrajoutput]] [<mask1>] [<mask2>]
\end_layout

\begin_layout LyX-Code
[magnitude] [ired] [gridset <grid>]
[magnitude] [geom] [ired] [gridset <grid>] [debye]
\end_layout

\begin_layout LyX-Code
Expand Down Expand Up @@ -43184,6 +43184,11 @@ ptraj
[magnitude] Store the magnitude of the vector with aspect [Mag].
\end_layout

\begin_layout Description
[geom] If specified,
use geometric centers instead of centers of mass.
\end_layout

\begin_layout Description
[ired] Mark this vector for subsequent IRED analysis with commands 'matrix ired' and 'ired'.
\end_layout
Expand All @@ -43210,6 +43215,14 @@ ucell[x|y|z]
.
\end_layout

\begin_layout Description
[debye] (
\series bold
'dipole'
\series default
vector only) Report dipole vector in units of Debye instead of e-*Ang.
\end_layout

\begin_layout Standard
Data Sets Created:
\end_layout
Expand Down Expand Up @@ -43267,8 +43280,13 @@ dipole Store the dipole and center of mass of the atoms specified in
<mask1>
\series default
.
The vector is not converted to appropriate units,
nor is the value well-defined if the atoms in the mask are not overall charge neutral.
The dipole vector has units of e-*Ang unless
\series bold
'debye'
\series default
is specified for units of Debye.
The center is always stored as simply Ang (since it is just coordinates).
Note that the value may not be well-defined if the atoms in the mask are not overall charge neutral.
\end_layout

\begin_layout Description
Expand Down

0 comments on commit db51c3e

Please sign in to comment.