ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/oopsePaper/keywordTable.tex
(Generate patch)

Comparing trunk/oopsePaper/keywordTable.tex (file contents):
Revision 1146 by mmeineke, Tue May 4 19:41:47 2004 UTC vs.
Revision 1147 by mmeineke, Wed May 5 17:42:55 2004 UTC

# Line 23 | Line 23 | These are the bass keywords.
23  
24  
25   \begin{table}
26 < \caption{The Global Keywords}
26 > \caption{The Global Keywords: Required Parameters}
27   \begin{center}
28   % Note when adding or removing columns, the \hsize numbers must add up to the total number
29   % of columns.
# Line 34 | Line 34 | These are the bass keywords.
34    >{\setlength{\hsize}{1.4\hsize}}X}
35  
36   {\bf keyword} & {\bf units} & {\bf use} & {\bf remarks} \\ \hline
37 < {\tt forceField} & string & Sets the force field. & Simulation will fail if not present. \\
38 < {\tt ensemble} & string & Sets the ensemble. & Simulation will fail if not present. \\
39 < {\tt dt} & fs & Sets the time step. & Simulation will fail if not present. \\
40 < {\tt nComponents} & integer & Sets the number of components. & Simulation will fail if not present. \\
41 < {\tt initialConfig} & string & Sets the file containing the initial configuration. & Simulation will fail if not present.\\
37 >
38 > {\tt forceField} & string & Sets the force field. & Possible force fields are "DUFF", "LJ", and "EAM". \\
39 > {\tt ensemble} & string & Sets the ensemble. & Possible ensembles are "NVE", "NVT", "NPTi", "NPTf", and "NPTxyz".\\
40 > {\tt dt} & fs & Sets the time step. & Selection of {\tt dt} should be small enough to sample the fastest motion of the simulation. \\
41 > {\tt nComponents} & integer & Sets the number of components. & Needs to appear before the first {\tt Component} block. \\
42 > {\tt initialConfig} & string & Sets the file containing the initial configuration. & Can point to any file containing the configuration in the correct order.
43 >
44 > \end{tabularx}
45 > \end{center}
46 > \end{table}
47 >
48 >
49 > \begin{table}
50 > \caption{The Global Keywords: General Parameters}
51 > \begin{center}
52 > % Note when adding or removing columns, the \hsize numbers must add up to the total number
53 > % of columns.
54 > \begin{tabularx}{\linewidth}%
55 >  {>{\setlength{\hsize}{1.00\hsize}}X%
56 >  >{\setlength{\hsize}{0.4\hsize}}X%
57 >  >{\setlength{\hsize}{1.2\hsize}}X%
58 >  >{\setlength{\hsize}{1.4\hsize}}X}
59 >
60 > {\bf keyword} & {\bf units} & {\bf use} & {\bf remarks} \\ \hline
61 >
62 > {\tt finalConfig} & string & Option to set the name of the final output file. & Useful when stringing simulations together. Defaults to the {\tt .bass} file with an {\tt .eor} extension. \\
63 > {\tt runTime} & fs & Sets the time at which the simulation should end. & The time is an absolute time, and will end the simulation when the current time meets or exceeds the {\tt runTime}. \\
64 > {\tt useInitialTime} & logical & Sets whether the initial time is taken from the {\tt .init} file. & Useful when recovering a simulation from a crashed processor. Default is false. \\
65 > {\tt sampleTime} & fs & Sets the frequency at which the {\tt .dump} file is written. & Default sets the frequency to the {\tt runTime}. \\
66 > {\tt statusTime} & fs & Sets the frequency at which the {\tt .stat} file is written. & Defaults sets the frequency to the {\tt sampleTime}. \\
67 > {\tt LJrcut} & $\mbox{\AA}$ & Manually sets the Lennard-Jones cutoff. & Defaults to $2.5\sigma_L$, where $\sigma_L$ is the largest LJ $\sigma$ in the simulation. \\
68 > {\tt electrostaticCutoffRadius}& & & \\
69 >      & $\mbox{\AA}$ & Manually sets the cutoff used by the electrostatic potentials. & Defaults to $15\mbox{\AA}$ \\
70 > {\tt electrostaticSkinThickness} & & & \\
71 >     & $\mbox{\AA}$  & Manually sets the skin thickness for the electrostatic switching function. & Defaults to 5~\% of the {\tt electrostaticSkinThickness}. \\
72 > {\tt useReactionField} & logical & Turns the reaction field correction on/off. & Default is "false". \\
73 > {\tt dielectric} & unitless & Sets the dielectric constant for reaction field. & If {\tt useReactionField} is true, then {\tt dielectric} must be set. \\
74 > {\tt usePeriodicBoundaryConditions} & & & \\
75 >        & logical & Turns periodic boundary conditions on/off. & Default is "true". \\
76 > {\tt seed } & integer & Sets the seed value for the random number generator. & The seed needs to be at least 9 digits long. The default is to take the seed from the CPU clock.
77 >
78 > \end{tabularx}
79 > \end{center}
80 > \end{table}
81 >
82 >
83 >
84 > \begin{table}
85 > \caption{The Global Keywords: Ensemble Parameters}
86 > \begin{center}
87 > % Note when adding or removing columns, the \hsize numbers must add up to the total number
88 > % of columns.
89 > \begin{tabularx}{\linewidth}%
90 >  {>{\setlength{\hsize}{1.00\hsize}}X%
91 >  >{\setlength{\hsize}{0.4\hsize}}X%
92 >  >{\setlength{\hsize}{1.2\hsize}}X%
93 >  >{\setlength{\hsize}{1.4\hsize}}X}
94 >
95 > {\bf keyword} & {\bf units} & {\bf use} & {\bf remarks} \\ \hline
96 >
97 > {\tt tempSet} & logical & Turns Boltzmann sampling of velocities on/off. & Should only be used in the NVE ensemble. Default is "false". \\
98 > {\tt thermalTime} & fs & Sets the frequency of the velocity resampling when {\tt tempSet} is true. & Default  frequency is set to the {\tt runTime} (\emph{i.e.}~once at the beginning only). \\
99   {\tt targetTemp } & K & Sets the target temperature. & Used when re-scaling the velocities and by the constant temperature ensembles. \\
100 + {\tt targetPressure} & atm & Sets the target pressure. & Used in the constant pressure ensembles. \\
101 + {\tt tauThermostat} & fs & Sets the $\tau_{\text{thermostat}}$. & Used by the constant temperature integration schemes. \\
102 + {\tt tauBarostat} & fs & Sets the $\tau_{\text{barostat}}$. & Used by the constant pressure integration schemes. \\
103 + {\tt resetTime} & fs & Sets the frequency at which the constant pressure and temperature schemes have their drag coefficients set to 0. & If {\tt resetTime} is not present, then the integrators are only zeroed at the beginning of the run.\\
104 + {\tt useInitialExtendedSystemState} & & & \\
105 +        & logical & Sets whether the initial state of the constant pressure and temperature integrators is pulled from the {\tt .init} file. & Useful when recovering a simulation from a crashed process. Default is "false". \\
106 + {\tt orthoBoxTolerance} & unitless & Sets the tolerance for orthorhombic/non-orthorhombic box wrapping. & Used mainly in the "NPTf" ensemble. Default is $1\times 10^{-6}$. \\
107  
108 +
109 +
110   \end{tabularx}
111   \end{center}
112   \end{table}

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines