ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/io/Globals.cpp
Revision: 1722
Committed: Thu May 24 14:23:40 2012 UTC (12 years, 11 months ago) by gezelter
File size: 16064 byte(s)
Log Message:
Merging Shenyu's RNEMD changes from openmd-1 into the development branch.

File Contents

# User Rev Content
1 gezelter 404 /*
2 chuckv 1402 * Copyright (c) 2005, 2010 The University of Notre Dame. All Rights Reserved.
3 gezelter 246 *
4     * The University of Notre Dame grants you ("Licensee") a
5     * non-exclusive, royalty free, license to use, modify and
6     * redistribute this software in source and binary code form, provided
7     * that the following conditions are met:
8     *
9 gezelter 1390 * 1. Redistributions of source code must retain the above copyright
10 gezelter 246 * notice, this list of conditions and the following disclaimer.
11     *
12 gezelter 1390 * 2. Redistributions in binary form must reproduce the above copyright
13 gezelter 246 * notice, this list of conditions and the following disclaimer in the
14     * documentation and/or other materials provided with the
15     * distribution.
16     *
17     * This software is provided "AS IS," without a warranty of any
18     * kind. All express or implied conditions, representations and
19     * warranties, including any implied warranty of merchantability,
20     * fitness for a particular purpose or non-infringement, are hereby
21     * excluded. The University of Notre Dame and its licensors shall not
22     * be liable for any damages suffered by licensee as a result of
23     * using, modifying or distributing the software or its
24     * derivatives. In no event will the University of Notre Dame or its
25     * licensors be liable for any lost revenue, profit or data, or for
26     * direct, indirect, special, consequential, incidental or punitive
27     * damages, however caused and regardless of the theory of liability,
28     * arising out of the use of or inability to use software, even if the
29     * University of Notre Dame has been advised of the possibility of
30     * such damages.
31 gezelter 1390 *
32     * SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33     * research, please cite the appropriate papers when you publish your
34     * work. Good starting points are:
35     *
36     * [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37     * [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38     * [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39 gezelter 1665 * [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40     * [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41 gezelter 246 */
42    
43 gezelter 2 #include <stdlib.h>
44     #include <stdio.h>
45     #include <string.h>
46 tim 665 #include <string>
47 gezelter 2
48 tim 3 #include "io/Globals.hpp"
49 tim 816 #include "io/ParamConstraint.hpp"
50     #include "utils/MemoryUtils.hpp"
51 tim 3 #include "utils/simError.h"
52 gezelter 2
53 gezelter 1390 namespace OpenMD {
54 tim 770 Globals::Globals() {
55 tim 665 DefineParameter(ForceField, "forceField")
56    
57     DefineOptionalParameter(TargetTemp, "targetTemp");
58     DefineOptionalParameter(Ensemble, "ensemble");
59     DefineOptionalParameter(Dt, "dt");
60     DefineOptionalParameter(RunTime, "runTime");
61     DefineOptionalParameter(FinalConfig, "finalConfig");
62     DefineOptionalParameter(SampleTime, "sampleTime");
63     DefineOptionalParameter(ResetTime, "resetTime");
64     DefineOptionalParameter(StatusTime, "statusTime");
65     DefineOptionalParameter(CutoffRadius, "cutoffRadius");
66     DefineOptionalParameter(SwitchingRadius, "switchingRadius");
67     DefineOptionalParameter(TempSet, "tempSet");
68     DefineOptionalParameter(ThermalTime, "thermalTime");
69 gezelter 1126 DefineOptionalParameter(TargetPressure, "targetPressure");
70 tim 665 DefineOptionalParameter(TauThermostat, "tauThermostat");
71     DefineOptionalParameter(TauBarostat, "tauBarostat");
72     DefineOptionalParameter(ZconsTime, "zconsTime");
73     DefineOptionalParameter(ZconsTol, "zconsTol");
74     DefineOptionalParameter(ZconsForcePolicy, "zconsForcePolicy");
75     DefineOptionalParameter(Seed, "seed");
76     DefineOptionalParameter(Minimizer, "minimizer");
77     DefineOptionalParameter(MinimizerMaxIter,"minimizerMaxIter");
78 gezelter 1423 DefineOptionalParameter(MinimizerWriteFreq, "minimizerWriteFreq");
79 tim 665 DefineOptionalParameter(MinimizerStepSize, "minimizerStepSize");
80     DefineOptionalParameter(MinimizerFTol, "minimizerFTol");
81     DefineOptionalParameter(MinimizerGTol, "minimizerGTol");
82     DefineOptionalParameter(MinimizerLSTol, "minimizerLSTol");
83     DefineOptionalParameter(MinimizerLSMaxIter, "minimizerLSMaxIter");
84     DefineOptionalParameter(ZconsGap, "zconsGap");
85     DefineOptionalParameter(ZconsFixtime, "zconsFixtime");
86     DefineOptionalParameter(ZconsUsingSMD, "zconsUsingSMD");
87     DefineOptionalParameter(ThermodynamicIntegrationLambda, "thermodynamicIntegrationLambda");
88     DefineOptionalParameter(ThermodynamicIntegrationK, "thermodynamicIntegrationK");
89     DefineOptionalParameter(ForceFieldVariant, "forceFieldVariant");
90     DefineOptionalParameter(ForceFieldFileName, "forceFieldFileName");
91 gezelter 1078 DefineOptionalParameter(DampingAlpha, "dampingAlpha");
92 tim 665 DefineOptionalParameter(SurfaceTension, "surfaceTension");
93     DefineOptionalParameter(PrintPressureTensor, "printPressureTensor");
94 gezelter 1291 DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair");
95     DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance");
96 chrisfen 726 DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType");
97 tim 895 DefineOptionalParameter(HydroPropFile, "HydroPropFile");
98 tim 906 DefineOptionalParameter(Viscosity, "viscosity");
99     DefineOptionalParameter(BeadSize, "beadSize");
100 gezelter 945 DefineOptionalParameter(FrozenBufferRadius, "frozenBufferRadius");
101     DefineOptionalParameter(LangevinBufferRadius, "langevinBufferRadius");
102 chuckv 1095 DefineOptionalParameter(NeighborListNeighbors,"NeighborListNeighbors");
103 chuckv 1306 DefineOptionalParameter(UseMultipleTemperatureMethod, "useMultipleTemperatureMethod");
104 gezelter 1528 DefineOptionalParameter(ElectrostaticSummationMethod, "electrostaticSummationMethod");
105 chuckv 1306 DefineOptionalParameter(MTM_Ce, "MTM_Ce");
106     DefineOptionalParameter(MTM_G, "MTM_G");
107     DefineOptionalParameter(MTM_Io, "MTM_Io");
108     DefineOptionalParameter(MTM_Sigma, "MTM_Sigma");
109     DefineOptionalParameter(MTM_R, "MTM_R");
110 chuckv 1402 DefineOptionalParameter(Alpha, "alpha");
111 gezelter 1327
112 chuckv 1147
113 tim 665 DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, "usePeriodicBoundaryConditions", true);
114 gezelter 1126 DefineOptionalParameterWithDefaultValue(UseAtomicVirial, "useAtomicVirial", true);
115 tim 665 DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", false);
116     DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, "useInitialExtendedSystemState", false);
117     DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, "orthoBoxTolerance", 1E-6);
118 gezelter 1528 DefineOptionalParameterWithDefaultValue(CutoffMethod, "cutoffMethod", "SHIFTED_FORCE");
119 gezelter 1078 DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, "electrostaticScreeningMethod", "DAMPED");
120 gezelter 1528 DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 80.0);
121 gezelter 1711 DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", false);
122     DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", false);
123     DefineOptionalParameterWithDefaultValue(OutputParticlePotential, "outputParticlePotential", false);
124 gezelter 1714 DefineOptionalParameterWithDefaultValue(OutputElectricField, "outputElectricField", false);
125     DefineOptionalParameterWithDefaultValue(OutputFluctuatingCharges, "outputFluctuatingCharges", false);
126 tim 665 DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", 1.0);
127 tim 681 DefineOptionalParameterWithDefaultValue(StatFileFormat, "statFileFormat", "TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY");
128 gezelter 945 DefineOptionalParameterWithDefaultValue(UseSphericalBoundaryConditions, "useSphericalBoundaryConditions", false);
129 chrisfen 998 DefineOptionalParameterWithDefaultValue(AccumulateBoxDipole, "accumulateBoxDipole", false);
130 tim 681
131 gezelter 1327 DefineOptionalParameterWithDefaultValue(UseRNEMD, "useRNEMD", false);
132 skuang 1367 DefineOptionalParameterWithDefaultValue(RNEMD_exchangeTime, "RNEMD_exchangeTime", 100.0);
133 skuang 1341 DefineOptionalParameterWithDefaultValue(RNEMD_nBins, "RNEMD_nBins", 16);
134 skuang 1367 DefineOptionalParameterWithDefaultValue(RNEMD_logWidth, "RNEMD_logWidth", 16);
135     DefineOptionalParameterWithDefaultValue(RNEMD_exchangeType, "RNEMD_exchangeType", "KineticScale");
136     DefineOptionalParameterWithDefaultValue(RNEMD_targetFlux, "RNEMD_targetFlux", 0.0);
137 gezelter 1722 DefineOptionalParameterWithDefaultValue(RNEMD_targetJzKE, "RNEMD_targetJzKE", 0.0);
138     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpx, "RNEMD_targetJzpx", 0.0);
139     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpy, "RNEMD_targetJzpy", 0.0);
140     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpz, "RNEMD_targetJzpz", 0.0);
141 gezelter 1331 DefineOptionalParameterWithDefaultValue(RNEMD_objectSelection, "RNEMD_objectSelection", "select all");
142 gezelter 1629 DefineOptionalParameterWithDefaultValue(RNEMD_binShift, "RNEMD_binShift", false);
143 gezelter 1722 DefineOptionalParameterWithDefaultValue(RNEMD_outputTemperature, "RNEMD_outputTemperature", false);
144     DefineOptionalParameterWithDefaultValue(RNEMD_outputVx, "RNEMD_outputVx", false);
145     DefineOptionalParameterWithDefaultValue(RNEMD_outputVy, "RNEMD_outputVy", false);
146     DefineOptionalParameterWithDefaultValue(RNEMD_outputXyzTemperature, "RNEMD_outputXyzTemperature", false);
147     DefineOptionalParameterWithDefaultValue(RNEMD_outputRotTemperature, "RNEMD_outputRotTemperature", false);
148    
149 cli2 1360 DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false);
150 gezelter 1354 DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in");
151 cli2 1360 DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false);
152 chuckv 1402 DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex");
153 gezelter 1715 DefineOptionalParameterWithDefaultValue(FlucQPropagator, "flucQ.propagator", "NVT");
154     DefineOptionalParameterWithDefaultValue(FlucQFriction, "flucQ.friction", 1600.0);
155     DefineOptionalParameterWithDefaultValue(FlucQTolerance, "flucQ.tolerance", 1.0e-6);
156     DefineOptionalParameterWithDefaultValue(FlucQMaxIterations, "flucQ.maxIterations", 100);
157     DefineOptionalParameterWithDefaultValue(FlucQTargetTemp, "flucQ.targetTemp", 1.0e-6);
158     DefineOptionalParameterWithDefaultValue(FlucQtauThermostat, "flucQ.tauThermostat", 10.0);
159 gezelter 1327
160 gezelter 1078 deprecatedKeywords_.insert("nComponents");
161     deprecatedKeywords_.insert("nZconstraints");
162     deprecatedKeywords_.insert("initialConfig");
163 cli2 1360 deprecatedKeywords_.insert("thermIntDistSpringConst");
164     deprecatedKeywords_.insert("thermIntThetaSpringConst");
165     deprecatedKeywords_.insert("thermIntOmegaSpringConst");
166     deprecatedKeywords_.insert("useSolidThermInt");
167     deprecatedKeywords_.insert("useLiquidThermInt");
168 gezelter 2
169     }
170    
171 tim 770 Globals::~Globals() {
172 tim 816 MemoryUtils::deletePointers(components_);
173     MemoryUtils::deletePointers(zconstraints_);
174 cli2 1360 MemoryUtils::deletePointers(restraints_);
175 gezelter 2 }
176    
177 tim 770 void Globals::validate() {
178     DataHolder::validate();
179 gezelter 2
180 tim 672 CheckParameter(ForceField, isNotEmpty());
181     CheckParameter(TargetTemp, isPositive());
182 gezelter 1629 CheckParameter(Ensemble, isEqualIgnoreCase("NVE") || isEqualIgnoreCase("NVT") || isEqualIgnoreCase("NPTi") || isEqualIgnoreCase("NPTf") || isEqualIgnoreCase("NPTxyz") || isEqualIgnoreCase("NPTsz") || isEqualIgnoreCase("NPAT") || isEqualIgnoreCase("LANGEVINDYNAMICS") || isEqualIgnoreCase("LD") || isEqualIgnoreCase("NPRT") || isEqualIgnoreCase("NPGT") || isEqualIgnoreCase("NGammaT") || isEqualIgnoreCase("NGT") || isEqualIgnoreCase("LANGEVINHULL") || isEqualIgnoreCase("LHULL") || isEqualIgnoreCase("SMIPD"));
183 tim 672 CheckParameter(Dt, isPositive());
184     CheckParameter(RunTime, isPositive());
185     CheckParameter(FinalConfig, isNotEmpty());
186     CheckParameter(SampleTime, isNonNegative());
187     CheckParameter(ResetTime, isNonNegative());
188     CheckParameter(StatusTime, isNonNegative());
189     CheckParameter(CutoffRadius, isPositive());
190     CheckParameter(SwitchingRadius, isNonNegative());
191     CheckParameter(Dielectric, isPositive());
192     CheckParameter(ThermalTime, isNonNegative());
193     CheckParameter(TauThermostat, isPositive());
194     CheckParameter(TauBarostat, isPositive());
195     CheckParameter(ZconsTime, isPositive());
196     CheckParameter(ZconsTol, isPositive());
197     CheckParameter(Seed, isPositive());
198 tim 850 CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG"));
199 tim 672 CheckParameter(MinimizerMaxIter, isPositive());
200 gezelter 1423 CheckParameter(MinimizerWriteFreq, isPositive());
201 tim 672 CheckParameter(MinimizerStepSize, isPositive());
202     CheckParameter(MinimizerFTol, isPositive());
203     CheckParameter(MinimizerGTol, isPositive());
204     CheckParameter(MinimizerLSTol, isPositive());
205     CheckParameter(MinimizerLSMaxIter, isPositive());
206     CheckParameter(ZconsGap, isPositive());
207     CheckParameter(ZconsFixtime, isPositive());
208 chrisfen 979 CheckParameter(ThermodynamicIntegrationLambda, isNonNegative());
209 tim 672 CheckParameter(ThermodynamicIntegrationK, isPositive());
210     CheckParameter(ForceFieldVariant, isNotEmpty());
211     CheckParameter(ForceFieldFileName, isNotEmpty());
212 gezelter 1528 CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE"));
213 gezelter 1576 CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL"));
214 gezelter 1616 CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD"));
215 tim 850 CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED"));
216     CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL"));
217 tim 672 CheckParameter(OrthoBoxTolerance, isPositive());
218 chrisfen 716 CheckParameter(DampingAlpha,isNonNegative());
219 tim 672 CheckParameter(SkinThickness, isPositive());
220 gezelter 945 CheckParameter(Viscosity, isNonNegative());
221     CheckParameter(BeadSize, isPositive());
222     CheckParameter(FrozenBufferRadius, isPositive());
223     CheckParameter(LangevinBufferRadius, isPositive());
224 chuckv 1095 CheckParameter(NeighborListNeighbors, isPositive());
225 skuang 1367 CheckParameter(RNEMD_exchangeTime, isPositive());
226 skuang 1341 CheckParameter(RNEMD_nBins, isPositive() && isEven());
227 gezelter 1722 CheckParameter(RNEMD_exchangeType, isEqualIgnoreCase("KineticSwap") || isEqualIgnoreCase("KineticScale") || isEqualIgnoreCase("KineticScaleVAM") || isEqualIgnoreCase("KineticScaleAM") || isEqualIgnoreCase("Px") || isEqualIgnoreCase("Py") || isEqualIgnoreCase("Pz") || isEqualIgnoreCase("PxScale") || isEqualIgnoreCase("PyScale") || isEqualIgnoreCase("PzScale") || isEqualIgnoreCase("ShiftScaleV") || isEqualIgnoreCase("ShiftScaleVAM"));
228 chuckv 1402 CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape"));
229     CheckParameter(Alpha, isPositive());
230 gezelter 1715 CheckParameter(FlucQPropagator, isEqualIgnoreCase("NVT") || isEqualIgnoreCase("Langevin") || isEqualIgnoreCase("Minimizer") || isEqualIgnoreCase("Exact") );
231     CheckParameter(FlucQFriction, isNonNegative());
232     CheckParameter(FlucQTolerance, isPositive());
233     CheckParameter(FlucQMaxIterations, isPositive());
234     CheckParameter(FlucQTargetTemp, isNonNegative());
235     CheckParameter(FlucQtauThermostat, isPositive());
236 chuckv 1402
237 tim 770 for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) {
238     if (!(*i)->findMoleculeStamp(moleculeStamps_)) {
239 tim 845 std::ostringstream oss;
240     oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl;
241 gezelter 1390 throw OpenMDException(oss.str());
242 tim 770 }
243     }
244     }
245 gezelter 1613
246 tim 770 bool Globals::addComponent(Component* comp) {
247     components_.push_back(comp);
248     return true;
249     }
250 gezelter 2
251 tim 770 bool Globals::addZConsStamp(ZConsStamp* zcons) {
252     zconstraints_.push_back(zcons);
253     return true;
254 gezelter 2 }
255    
256 cli2 1360 bool Globals::addRestraintStamp(RestraintStamp* rest) {
257     restraints_.push_back(rest);
258     return true;
259     }
260    
261 tim 770 bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) {
262     std::string molStampName = molStamp->getName();
263     std::map<std::string, MoleculeStamp*>::iterator i;
264     bool ret = false;
265     i = moleculeStamps_.find(molStampName);
266     if (i == moleculeStamps_.end()) {
267     moleculeStamps_.insert(std::map<std::string, MoleculeStamp*>::value_type(molStampName, molStamp));
268     ret = true;
269     } else {
270 tim 845 std::ostringstream oss;
271     oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n";
272 gezelter 1390 throw OpenMDException(oss.str());
273 tim 770 }
274     return ret;
275 gezelter 2 }
276 tim 770
277    
278     }

Properties

Name Value
svn:keywords Author Id Revision Date