1 |
|
\appendix |
2 |
< |
\chapter{\label{chapt:oopse}Object-Oriented Parallel Simulation Engine (OOPSE)} |
2 |
> |
\chapter{\label{chapt:oopse}Object-Oriented Parallel Simulation Engine} |
3 |
|
|
4 |
|
Designing object-oriented software is hard, and designing reusable |
5 |
|
object-oriented scientific software is even harder. Absence of |
14 |
|
coordination to enforce design and programming guidelines. Moreover, |
15 |
|
most MD programs also suffer from missing design and implement |
16 |
|
documents which is crucial to the maintenance and extensibility. |
17 |
+ |
Along the way of studying structural and dynamic processes in |
18 |
+ |
condensed phase systems like biological membranes and nanoparticles, |
19 |
+ |
we developed and maintained an Object-Oriented Parallel Simulation |
20 |
+ |
Engine ({\sc OOPSE}). This new molecular dynamics package has some |
21 |
+ |
unique features |
22 |
+ |
\begin{enumerate} |
23 |
+ |
\item {\sc OOPSE} performs Molecular Dynamics (MD) simulations on non-standard |
24 |
+ |
atom types (transition metals, point dipoles, sticky potentials, |
25 |
+ |
Gay-Berne ellipsoids, or other "lumpy"atoms with orientational |
26 |
+ |
degrees of freedom), as well as rigid bodies. |
27 |
+ |
\item {\sc OOPSE} uses a force-based decomposition algorithm using MPI on cheap |
28 |
+ |
Beowulf clusters to obtain very efficient parallelism. |
29 |
+ |
\item {\sc OOPSE} integrates the equations of motion using advanced methods for |
30 |
+ |
orientational dynamics in NVE, NVT, NPT, NPAT, and NP$\gamma$T |
31 |
+ |
ensembles. |
32 |
+ |
\item {\sc OOPSE} can carry out simulations on metallic systems using the |
33 |
+ |
Embedded Atom Method (EAM) as well as the Sutton-Chen potential. |
34 |
+ |
\item {\sc OOPSE} can perform simulations on Gay-Berne liquid crystals. |
35 |
+ |
\item {\sc OOPSE} can simulate systems containing the extremely efficient |
36 |
+ |
extended-Soft Sticky Dipole (SSD/E) model for water. |
37 |
+ |
\end{enumerate} |
38 |
|
|
39 |
|
\section{\label{appendixSection:architecture }Architecture} |
40 |
|
|
41 |
+ |
Mainly written by \texttt{C/C++} and \texttt{Fortran90}, {\sc OOPSE} |
42 |
+ |
uses C++ Standard Template Library (STL) and fortran modules as the |
43 |
+ |
foundation. As an extensive set of the STL and Fortran90 modules, |
44 |
+ |
{\sc Base Classes} provide generic implementations of mathematical |
45 |
+ |
objects (e.g., matrices, vectors, polynomials, random number |
46 |
+ |
generators) and advanced data structures and algorithms(e.g., tuple, |
47 |
+ |
bitset, generic data, string manipulation). The molecular data |
48 |
+ |
structures for the representation of atoms, bonds, bends, torsions, |
49 |
+ |
rigid bodies and molecules \textit{etc} are contained in the {\sc |
50 |
+ |
Kernel} which is implemented with {\sc Base Classes} and are |
51 |
+ |
carefully designed to provide maximum extensibility and flexibility. |
52 |
+ |
The functionality required for applications is provide by the third |
53 |
+ |
layer which contains Input/Output, Molecular Mechanics and Structure |
54 |
+ |
modules. Input/Output module not only implements general methods for |
55 |
+ |
file handling, but also defines a generic force field interface. |
56 |
+ |
Another important component of Input/Output module is the meta-data |
57 |
+ |
file parser, which is rewritten using ANother Tool for Language |
58 |
+ |
Recognition(ANTLR)\cite{Parr1995, Schaps1999} syntax. The Molecular |
59 |
+ |
Mechanics module consists of energy minimization and a wide |
60 |
+ |
varieties of integration methods(see Chap.~\ref{chapt:methodology}). |
61 |
+ |
The structure module contains a flexible and powerful selection |
62 |
+ |
library which syntax is elaborated in |
63 |
+ |
Sec.~\ref{appendixSection:syntax}. The top layer is made of the main |
64 |
+ |
program of the package, \texttt{oopse} and it corresponding parallel |
65 |
+ |
version \texttt{oopse\_MPI}, as well as other useful utilities, such |
66 |
+ |
as \texttt{StatProps} (see Sec.~\ref{appendixSection:StaticProps}), |
67 |
+ |
\texttt{DynamicProps} (see |
68 |
+ |
Sec.~\ref{appendixSection:appendixSection:DynamicProps}), |
69 |
+ |
\texttt{Dump2XYZ} (see |
70 |
+ |
Sec.~\ref{appendixSection:appendixSection:Dump2XYZ}), \texttt{Hydro} |
71 |
+ |
(see Sec.~\ref{appendixSection:appendixSection:hydrodynamics}) |
72 |
+ |
\textit{etc}. |
73 |
+ |
|
74 |
|
\begin{figure} |
75 |
|
\centering |
76 |
|
\includegraphics[width=\linewidth]{architecture.eps} |
77 |
< |
\caption[The architecture of {\sc oopse}-3.0] {The architecture of |
78 |
< |
{\sc oopse}-3.0.} \label{appendixFig:architecture} |
77 |
> |
\caption[The architecture of {\sc OOPSE}] {Overview of the structure |
78 |
> |
of {\sc OOPSE}} \label{appendixFig:architecture} |
79 |
|
\end{figure} |
80 |
|
|
81 |
|
\section{\label{appendixSection:desginPattern}Design Pattern} |
112 |
|
|
113 |
|
As one of the latest advanced techniques emerged from |
114 |
|
object-oriented community, design patterns were applied in some of |
115 |
< |
the modern scientific software applications, such as JMol, OOPSE |
116 |
< |
\cite{Meineke05} and PROTOMOL \cite{Matthey05} \textit{etc}. |
115 |
> |
the modern scientific software applications, such as JMol, {\sc |
116 |
> |
OOPSE}\cite{Meineke05} and PROTOMOL\cite{Matthey05} \textit{etc}. |
117 |
> |
The following sections enumerates some of the patterns used in {\sc |
118 |
> |
OOPSE}. |
119 |
|
|
120 |
|
\subsection{\label{appendixSection:singleton}Singleton} |
121 |
|
The Singleton pattern ensures that only one instance of a class is |
130 |
|
subclasses can then override to specify the derived type of product |
131 |
|
that will be created. |
132 |
|
|
77 |
– |
|
133 |
|
\subsection{\label{appendixSection:visitorPattern}Visitor} |
134 |
|
The purpose of the Visitor Pattern is to encapsulate an operation |
135 |
|
that you want to perform on the elements of a data structure. In |
137 |
|
structure without the need of changing the classes of the elements |
138 |
|
that you are operating on. |
139 |
|
|
85 |
– |
|
86 |
– |
\subsection{\label{appendixSection:templateMethod}Template Method} |
87 |
– |
|
140 |
|
\section{\label{appendixSection:concepts}Concepts} |
141 |
|
|
142 |
|
OOPSE manipulates both traditional atoms as well as some objects |
162 |
|
DirectionalAtom}s which behaves as a single unit. |
163 |
|
\end{itemize} |
164 |
|
|
165 |
< |
Every Molecule, Atom and DirectionalAtom in {\sc oopse} have their |
165 |
> |
Every Molecule, Atom and DirectionalAtom in {\sc OOPSE} have their |
166 |
|
own names which are specified in the {\tt .md} file. In contrast, |
167 |
|
RigidBodies are denoted by their membership and index inside a |
168 |
|
particular molecule: [MoleculeName]\_RB\_[index] (the contents |
173 |
|
\section{\label{appendixSection:syntax}Syntax of the Select Command} |
174 |
|
|
175 |
|
The most general form of the select command is: {\tt select {\it |
176 |
< |
expression}} |
176 |
> |
expression}}. This expression represents an arbitrary set of |
177 |
> |
StuntDoubles (Atoms or RigidBodies) in {\sc OOPSE}. Expressions are |
178 |
> |
composed of either name expressions, index expressions, predefined |
179 |
> |
sets, user-defined expressions, comparison operators, within |
180 |
> |
expressions, or logical combinations of the above expression types. |
181 |
> |
Expressions can be combined using parentheses and the Boolean |
182 |
> |
operators. |
183 |
|
|
126 |
– |
This expression represents an arbitrary set of StuntDoubles (Atoms |
127 |
– |
or RigidBodies) in {\sc oopse}. Expressions are composed of either |
128 |
– |
name expressions, index expressions, predefined sets, user-defined |
129 |
– |
expressions, comparison operators, within expressions, or logical |
130 |
– |
combinations of the above expression types. Expressions can be |
131 |
– |
combined using parentheses and the Boolean operators. |
132 |
– |
|
184 |
|
\subsection{\label{appendixSection:logical}Logical expressions} |
185 |
|
|
186 |
|
The logical operators allow complex queries to be constructed out of |
262 |
|
Users can define arbitrary terms to represent groups of |
263 |
|
StuntDoubles, and then use the define terms in select commands. The |
264 |
|
general form for the define command is: {\bf define {\it term |
265 |
< |
expression}} |
265 |
> |
expression}}. Once defined, the user can specify such terms in |
266 |
> |
boolean expressions |
267 |
|
|
216 |
– |
Once defined, the user can specify such terms in boolean expressions |
217 |
– |
|
268 |
|
{\tt define SSDWATER SSD or SSD1 or SSDRF} |
269 |
|
|
270 |
|
{\tt select SSDWATER} |
309 |
|
some or all of the configurations that are contained within a dump |
310 |
|
file. The most common example of a static property that can be |
311 |
|
computed is the pair distribution function between atoms of type $A$ |
312 |
< |
and other atoms of type $B$, $g_{AB}(r)$. StaticProps can also be |
313 |
< |
used to compute the density distributions of other molecules in a |
314 |
< |
reference frame {\it fixed to the body-fixed reference frame} of a |
315 |
< |
selected atom or rigid body. |
312 |
> |
and other atoms of type $B$, $g_{AB}(r)$. {\tt StaticProps} can |
313 |
> |
also be used to compute the density distributions of other molecules |
314 |
> |
in a reference frame {\it fixed to the body-fixed reference frame} |
315 |
> |
of a selected atom or rigid body. |
316 |
|
|
317 |
|
There are five seperate radial distribution functions availiable in |
318 |
|
OOPSE. Since every radial distrbution function invlove the |
366 |
|
Any two directional objects (DirectionalAtoms and RigidBodies) have |
367 |
|
a set of two angles ($\theta$, and $\omega$) between the z-axes of |
368 |
|
their body-fixed frames.} \label{oopseFig:gofr} |
369 |
+ |
\end{figure} |
370 |
+ |
|
371 |
+ |
Due to the fact that the selected StuntDoubles from two selections |
372 |
+ |
may be overlapped, {\tt StaticProps} performs the calculation in |
373 |
+ |
three stages which are illustrated in |
374 |
+ |
Fig.~\ref{oopseFig:staticPropsProcess}. |
375 |
+ |
|
376 |
+ |
\begin{figure} |
377 |
+ |
\centering |
378 |
+ |
\includegraphics[width=\linewidth]{staticPropsProcess.eps} |
379 |
+ |
\caption[A representation of the three-stage correlations in |
380 |
+ |
\texttt{StaticProps}]{Three-stage processing in |
381 |
+ |
\texttt{StaticProps}. $S_1$ and $S_2$ are the numbers of selected |
382 |
+ |
stuntdobules from {\tt -{}-sele1} and {\tt -{}-sele2} respectively, |
383 |
+ |
while $C$ is the number of stuntdobules appearing at both sets. The |
384 |
+ |
first stage($S_1-C$ and $S_2$) and second stages ($S_1$ and $S_2-C$) |
385 |
+ |
are completely non-overlapping. On the contrary, the third stage($C$ |
386 |
+ |
and $C$) are completely overlapping} |
387 |
+ |
\label{oopseFig:staticPropsProcess} |
388 |
|
\end{figure} |
389 |
|
|
390 |
|
The options available for {\tt StaticProps} are as follows: |
448 |
|
different vectors). The ability to use two selection scripts to |
449 |
|
select different types of atoms is already present in the code. |
450 |
|
|
451 |
+ |
For large simulations, the trajectory files can sometimes reach |
452 |
+ |
sizes in excess of several gigabytes. In order to effectively |
453 |
+ |
analyze that amount of data. In order to prevent a situation where |
454 |
+ |
the program runs out of memory due to large trajectories, |
455 |
+ |
\texttt{dynamicProps} will estimate the size of free memory at |
456 |
+ |
first, and determine the number of frames in each block, which |
457 |
+ |
allows the operating system to load two blocks of data |
458 |
+ |
simultaneously without swapping. Upon reading two blocks of the |
459 |
+ |
trajectory, \texttt{dynamicProps} will calculate the time |
460 |
+ |
correlation within the first block and the cross correlations |
461 |
+ |
between the two blocks. This second block is then freed and then |
462 |
+ |
incremented and the process repeated until the end of the |
463 |
+ |
trajectory. Once the end is reached, the first block is freed then |
464 |
+ |
incremented, until all frame pairs have been correlated in time. |
465 |
+ |
|
466 |
|
The options available for DynamicProps are as follows: |
467 |
|
\begin{longtable}[c]{|EFG|} |
468 |
|
\caption{DynamicProps Command-line Options} |
490 |
|
\subsection{\label{appendixSection:Dump2XYZ}Dump2XYZ} |
491 |
|
|
492 |
|
Dump2XYZ can transform an OOPSE dump file into a xyz file which can |
493 |
< |
be opened by other molecular dynamics viewers such as Jmol and VMD. |
494 |
< |
The options available for Dump2XYZ are as follows: |
493 |
> |
be opened by other molecular dynamics viewers such as Jmol and |
494 |
> |
VMD\cite{Humphrey1996}. The options available for Dump2XYZ are as |
495 |
> |
follows: |
496 |
|
|
497 |
|
|
498 |
|
\begin{longtable}[c]{|EFG|} |
522 |
|
& {\tt -{}-refsele} & In order to rotate the system, {\tt -{}-originsele} and {\tt -{}-refsele} must be given to define the new coordinate set. A StuntDouble which contains a dipole (the direction of the dipole is always (0, 0, 1) in body frame) is specified by {\tt -{}-originsele}. The new x-z plane is defined by the direction of the dipole and the StuntDouble is specified by {\tt -{}-refsele}. |
523 |
|
\end{longtable} |
524 |
|
|
525 |
< |
\subsection{\label{appendixSection:hydrodynamics}Hydrodynamics} |
526 |
< |
|
525 |
> |
\subsection{\label{appendixSection:hydrodynamics}Hydro} |
526 |
> |
The options available for Hydro are as follows: |
527 |
|
\begin{longtable}[c]{|EFG|} |
528 |
|
\caption{Hydrodynamics Command-line Options} |
529 |
|
\\ \hline |
536 |
|
-i & {\tt -{}-input} & input dump file \\ |
537 |
|
-o & {\tt -{}-output} & output file prefix (default=`hydro') \\ |
538 |
|
-b & {\tt -{}-beads} & generate the beads only, hydrodynamics calculation will not be performed (default=off)\\ |
539 |
< |
& {\tt -{}-model} & hydrodynamics model (support ``AnalyticalModel'', ``RoughShell'' and ``BeadModel'') \\ |
539 |
> |
& {\tt -{}-model} & hydrodynamics model (supports ``AnalyticalModel'', ``RoughShell'' and ``BeadModel'') \\ |
540 |
|
\end{longtable} |