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 |
gezelter |
1879 |
* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008). |
39 |
gezelter |
1782 |
* [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 |
gezelter |
1879 |
Globals::Globals() { |
55 |
gezelter |
1782 |
|
56 |
gezelter |
1879 |
flucQpars_ = new FluctuatingChargeParameters(); |
57 |
|
|
rnemdPars_ = new RNEMDParameters(); |
58 |
|
|
minimizerPars_ = new MinimizerParameters(); |
59 |
gezelter |
1782 |
|
60 |
gezelter |
1879 |
DefineParameter(ForceField, "forceField"); |
61 |
|
|
|
62 |
|
|
DefineOptionalParameter(TargetTemp, "targetTemp"); |
63 |
|
|
DefineOptionalParameter(Ensemble, "ensemble"); |
64 |
|
|
DefineOptionalParameter(Dt, "dt"); |
65 |
|
|
DefineOptionalParameter(RunTime, "runTime"); |
66 |
|
|
DefineOptionalParameter(FinalConfig, "finalConfig"); |
67 |
|
|
DefineOptionalParameter(SampleTime, "sampleTime"); |
68 |
|
|
DefineOptionalParameter(ResetTime, "resetTime"); |
69 |
|
|
DefineOptionalParameter(StatusTime, "statusTime"); |
70 |
|
|
DefineOptionalParameter(CutoffRadius, "cutoffRadius"); |
71 |
|
|
DefineOptionalParameter(SwitchingRadius, "switchingRadius"); |
72 |
|
|
DefineOptionalParameter(TempSet, "tempSet"); |
73 |
|
|
DefineOptionalParameter(ThermalTime, "thermalTime"); |
74 |
|
|
DefineOptionalParameter(TargetPressure, "targetPressure"); |
75 |
|
|
DefineOptionalParameter(TauThermostat, "tauThermostat"); |
76 |
|
|
DefineOptionalParameter(TauBarostat, "tauBarostat"); |
77 |
|
|
DefineOptionalParameter(ZconsTime, "zconsTime"); |
78 |
|
|
DefineOptionalParameter(ZconsTol, "zconsTol"); |
79 |
|
|
DefineOptionalParameter(ZconsForcePolicy, "zconsForcePolicy"); |
80 |
|
|
DefineOptionalParameter(Seed, "seed"); |
81 |
|
|
DefineOptionalParameter(ZconsGap, "zconsGap"); |
82 |
|
|
DefineOptionalParameter(ZconsFixtime, "zconsFixtime"); |
83 |
|
|
DefineOptionalParameter(ZconsUsingSMD, "zconsUsingSMD"); |
84 |
|
|
DefineOptionalParameter(ThermodynamicIntegrationLambda, |
85 |
|
|
"thermodynamicIntegrationLambda"); |
86 |
|
|
DefineOptionalParameter(ThermodynamicIntegrationK, |
87 |
|
|
"thermodynamicIntegrationK"); |
88 |
|
|
DefineOptionalParameter(ForceFieldVariant, "forceFieldVariant"); |
89 |
|
|
DefineOptionalParameter(ForceFieldFileName, "forceFieldFileName"); |
90 |
|
|
DefineOptionalParameter(DampingAlpha, "dampingAlpha"); |
91 |
|
|
DefineOptionalParameter(SurfaceTension, "surfaceTension"); |
92 |
|
|
DefineOptionalParameter(PrintPressureTensor, "printPressureTensor"); |
93 |
|
|
DefineOptionalParameter(ElectricField, "electricField"); |
94 |
gezelter |
1782 |
|
95 |
gezelter |
1879 |
DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair"); |
96 |
|
|
DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance"); |
97 |
|
|
DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType"); |
98 |
|
|
DefineOptionalParameter(HydroPropFile, "HydroPropFile"); |
99 |
|
|
DefineOptionalParameter(Viscosity, "viscosity"); |
100 |
|
|
DefineOptionalParameter(BeadSize, "beadSize"); |
101 |
|
|
DefineOptionalParameter(FrozenBufferRadius, "frozenBufferRadius"); |
102 |
|
|
DefineOptionalParameter(LangevinBufferRadius, "langevinBufferRadius"); |
103 |
|
|
DefineOptionalParameter(NeighborListNeighbors,"NeighborListNeighbors"); |
104 |
|
|
DefineOptionalParameter(UseMultipleTemperatureMethod, |
105 |
|
|
"useMultipleTemperatureMethod"); |
106 |
|
|
DefineOptionalParameter(ElectrostaticSummationMethod, |
107 |
|
|
"electrostaticSummationMethod"); |
108 |
|
|
DefineOptionalParameter(MTM_Ce, "MTM_Ce"); |
109 |
|
|
DefineOptionalParameter(MTM_G, "MTM_G"); |
110 |
|
|
DefineOptionalParameter(MTM_Io, "MTM_Io"); |
111 |
|
|
DefineOptionalParameter(MTM_Sigma, "MTM_Sigma"); |
112 |
|
|
DefineOptionalParameter(MTM_R, "MTM_R"); |
113 |
|
|
DefineOptionalParameter(Alpha, "alpha"); |
114 |
gezelter |
1327 |
|
115 |
chuckv |
1147 |
|
116 |
gezelter |
1879 |
DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, |
117 |
|
|
"usePeriodicBoundaryConditions", |
118 |
|
|
true); |
119 |
|
|
DefineOptionalParameterWithDefaultValue(UseAtomicVirial, "useAtomicVirial", |
120 |
|
|
true); |
121 |
|
|
DefineOptionalParameterWithDefaultValue(UseLongRangeCorrections, |
122 |
|
|
"useLongRangeCorrections", true); |
123 |
|
|
DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", |
124 |
|
|
false); |
125 |
|
|
DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, |
126 |
|
|
"useInitialExtendedSystemState", |
127 |
|
|
false); |
128 |
|
|
DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, |
129 |
|
|
"orthoBoxTolerance", 1E-6); |
130 |
|
|
DefineOptionalParameterWithDefaultValue(CutoffMethod, "cutoffMethod", |
131 |
|
|
"SHIFTED_FORCE"); |
132 |
|
|
DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, |
133 |
|
|
"electrostaticScreeningMethod", |
134 |
|
|
"DAMPED"); |
135 |
|
|
DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 80.0); |
136 |
|
|
DefineOptionalParameterWithDefaultValue(CompressDumpFile, |
137 |
|
|
"compressDumpFile", false); |
138 |
|
|
DefineOptionalParameterWithDefaultValue(PrintHeatFlux, "printHeatFlux", |
139 |
|
|
false); |
140 |
|
|
DefineOptionalParameterWithDefaultValue(OutputForceVector, |
141 |
|
|
"outputForceVector", false); |
142 |
|
|
DefineOptionalParameterWithDefaultValue(OutputParticlePotential, |
143 |
|
|
"outputParticlePotential", false); |
144 |
|
|
DefineOptionalParameterWithDefaultValue(OutputElectricField, |
145 |
|
|
"outputElectricField", false); |
146 |
|
|
DefineOptionalParameterWithDefaultValue(OutputFluctuatingCharges, |
147 |
|
|
"outputFluctuatingCharges", false); |
148 |
|
|
DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", |
149 |
|
|
1.0); |
150 |
|
|
DefineOptionalParameterWithDefaultValue(StatFileFormat, |
151 |
|
|
"statFileFormat", |
152 |
|
|
"TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY"); |
153 |
|
|
DefineOptionalParameterWithDefaultValue(UseSphericalBoundaryConditions, |
154 |
|
|
"useSphericalBoundaryConditions", |
155 |
|
|
false); |
156 |
|
|
DefineOptionalParameterWithDefaultValue(AccumulateBoxDipole, |
157 |
|
|
"accumulateBoxDipole", false); |
158 |
|
|
DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", |
159 |
|
|
false); |
160 |
|
|
DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", |
161 |
|
|
"idealCrystal.in"); |
162 |
|
|
DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, |
163 |
|
|
"useThermodynamicIntegration", |
164 |
|
|
false); |
165 |
|
|
DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex"); |
166 |
tim |
681 |
|
167 |
gezelter |
1879 |
deprecatedKeywords_.insert("nComponents"); |
168 |
|
|
deprecatedKeywords_.insert("nZconstraints"); |
169 |
|
|
deprecatedKeywords_.insert("initialConfig"); |
170 |
|
|
deprecatedKeywords_.insert("thermIntDistSpringConst"); |
171 |
|
|
deprecatedKeywords_.insert("thermIntThetaSpringConst"); |
172 |
|
|
deprecatedKeywords_.insert("thermIntOmegaSpringConst"); |
173 |
|
|
deprecatedKeywords_.insert("useSolidThermInt"); |
174 |
|
|
deprecatedKeywords_.insert("useLiquidThermInt"); |
175 |
|
|
deprecatedKeywords_.insert("minimizerMaxIter"); |
176 |
|
|
deprecatedKeywords_.insert("minimizerWriteFreq"); |
177 |
|
|
deprecatedKeywords_.insert("minimizerStepSize"); |
178 |
|
|
deprecatedKeywords_.insert("minimizerFTol"); |
179 |
|
|
deprecatedKeywords_.insert("minimizerGTol"); |
180 |
|
|
deprecatedKeywords_.insert("minimizerLSTol"); |
181 |
|
|
deprecatedKeywords_.insert("minimizerLSMaxIter"); |
182 |
gezelter |
1327 |
|
183 |
gezelter |
2 |
|
184 |
gezelter |
1879 |
} |
185 |
gezelter |
2 |
|
186 |
gezelter |
1879 |
Globals::~Globals() { |
187 |
tim |
816 |
MemoryUtils::deletePointers(components_); |
188 |
|
|
MemoryUtils::deletePointers(zconstraints_); |
189 |
cli2 |
1360 |
MemoryUtils::deletePointers(restraints_); |
190 |
gezelter |
1879 |
} |
191 |
gezelter |
2 |
|
192 |
gezelter |
1879 |
void Globals::validate() { |
193 |
|
|
DataHolder::validate(); |
194 |
gezelter |
2 |
|
195 |
gezelter |
1879 |
CheckParameter(ForceField, isNotEmpty()); |
196 |
|
|
CheckParameter(TargetTemp, isPositive()); |
197 |
|
|
CheckParameter(Ensemble, isEqualIgnoreCase("NVE") || |
198 |
|
|
isEqualIgnoreCase("NVT") || isEqualIgnoreCase("NPTi") || |
199 |
|
|
isEqualIgnoreCase("NPTf") || isEqualIgnoreCase("NPTxyz") || |
200 |
|
|
isEqualIgnoreCase("NPTsz") || isEqualIgnoreCase("NPAT") || |
201 |
|
|
isEqualIgnoreCase("LANGEVINDYNAMICS") || |
202 |
|
|
isEqualIgnoreCase("LD") || isEqualIgnoreCase("NPRT") || |
203 |
|
|
isEqualIgnoreCase("NPGT") || isEqualIgnoreCase("NGammaT") || |
204 |
|
|
isEqualIgnoreCase("NGT") || |
205 |
|
|
isEqualIgnoreCase("LANGEVINHULL") || |
206 |
|
|
isEqualIgnoreCase("LHULL") || isEqualIgnoreCase("SMIPD")); |
207 |
|
|
CheckParameter(Dt, isPositive()); |
208 |
|
|
CheckParameter(RunTime, isPositive()); |
209 |
|
|
CheckParameter(FinalConfig, isNotEmpty()); |
210 |
|
|
CheckParameter(SampleTime, isNonNegative()); |
211 |
|
|
CheckParameter(ResetTime, isNonNegative()); |
212 |
|
|
CheckParameter(StatusTime, isNonNegative()); |
213 |
|
|
CheckParameter(CutoffRadius, isPositive()); |
214 |
|
|
CheckParameter(SwitchingRadius, isNonNegative()); |
215 |
|
|
CheckParameter(Dielectric, isPositive()); |
216 |
|
|
CheckParameter(ThermalTime, isNonNegative()); |
217 |
|
|
CheckParameter(TauThermostat, isPositive()); |
218 |
|
|
CheckParameter(TauBarostat, isPositive()); |
219 |
|
|
CheckParameter(ZconsTime, isPositive()); |
220 |
|
|
CheckParameter(ZconsTol, isPositive()); |
221 |
|
|
CheckParameter(Seed, isPositive()); |
222 |
|
|
CheckParameter(ZconsGap, isPositive()); |
223 |
|
|
CheckParameter(ZconsFixtime, isPositive()); |
224 |
|
|
CheckParameter(ThermodynamicIntegrationLambda, isNonNegative()); |
225 |
|
|
CheckParameter(ThermodynamicIntegrationK, isPositive()); |
226 |
|
|
CheckParameter(ForceFieldVariant, isNotEmpty()); |
227 |
|
|
CheckParameter(ForceFieldFileName, isNotEmpty()); |
228 |
|
|
CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || |
229 |
|
|
isEqualIgnoreCase("SWITCHED") || |
230 |
|
|
isEqualIgnoreCase("SHIFTED_POTENTIAL") || |
231 |
|
|
isEqualIgnoreCase("SHIFTED_FORCE") || |
232 |
gezelter |
1915 |
isEqualIgnoreCase("TAYLOR_SHIFTED") || |
233 |
|
|
isEqualIgnoreCase("EWALD_FULL")); |
234 |
gezelter |
1879 |
CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || |
235 |
|
|
isEqualIgnoreCase("MAX") || |
236 |
|
|
isEqualIgnoreCase("TRADITIONAL")); |
237 |
|
|
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || |
238 |
|
|
isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || |
239 |
|
|
isEqualIgnoreCase("SHIFTED_POTENTIAL") || |
240 |
|
|
isEqualIgnoreCase("SHIFTED_FORCE") || |
241 |
|
|
isEqualIgnoreCase("REACTION_FIELD") || |
242 |
|
|
isEqualIgnoreCase("TAYLOR_SHIFTED")); |
243 |
|
|
CheckParameter(ElectrostaticScreeningMethod, |
244 |
|
|
isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
245 |
|
|
CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || |
246 |
|
|
isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL")); |
247 |
|
|
CheckParameter(OrthoBoxTolerance, isPositive()); |
248 |
|
|
CheckParameter(DampingAlpha,isNonNegative()); |
249 |
|
|
CheckParameter(SkinThickness, isPositive()); |
250 |
|
|
CheckParameter(Viscosity, isNonNegative()); |
251 |
|
|
CheckParameter(BeadSize, isPositive()); |
252 |
|
|
CheckParameter(FrozenBufferRadius, isPositive()); |
253 |
|
|
CheckParameter(LangevinBufferRadius, isPositive()); |
254 |
|
|
CheckParameter(NeighborListNeighbors, isPositive()); |
255 |
|
|
CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || |
256 |
|
|
isEqualIgnoreCase("AlphaShape")); |
257 |
|
|
CheckParameter(Alpha, isPositive()); |
258 |
chuckv |
1402 |
|
259 |
gezelter |
1879 |
for(std::vector<Component*>::iterator i = components_.begin(); |
260 |
|
|
i != components_.end(); ++i) { |
261 |
|
|
if (!(*i)->findMoleculeStamp(moleculeStamps_)) { |
262 |
tim |
845 |
std::ostringstream oss; |
263 |
gezelter |
1879 |
oss << "Globals Error: can not find molecule stamp for component " |
264 |
|
|
<< (*i)->getType() << std::endl; |
265 |
gezelter |
1390 |
throw OpenMDException(oss.str()); |
266 |
gezelter |
1879 |
} |
267 |
tim |
770 |
} |
268 |
|
|
} |
269 |
gezelter |
1879 |
|
270 |
|
|
bool Globals::addComponent(Component* comp) { |
271 |
tim |
770 |
components_.push_back(comp); |
272 |
|
|
return true; |
273 |
gezelter |
1879 |
} |
274 |
gezelter |
2 |
|
275 |
gezelter |
1879 |
bool Globals::addZConsStamp(ZConsStamp* zcons) { |
276 |
tim |
770 |
zconstraints_.push_back(zcons); |
277 |
|
|
return true; |
278 |
gezelter |
1879 |
} |
279 |
gezelter |
2 |
|
280 |
gezelter |
1879 |
bool Globals::addRestraintStamp(RestraintStamp* rest) { |
281 |
cli2 |
1360 |
restraints_.push_back(rest); |
282 |
|
|
return true; |
283 |
gezelter |
1879 |
} |
284 |
cli2 |
1360 |
|
285 |
gezelter |
1879 |
bool Globals::addFluctuatingChargeParameters(FluctuatingChargeParameters* fqp) { |
286 |
|
|
if (flucQpars_ != NULL) |
287 |
|
|
delete flucQpars_; |
288 |
gezelter |
1782 |
|
289 |
gezelter |
1879 |
flucQpars_ = fqp; |
290 |
|
|
return true; |
291 |
|
|
} |
292 |
gezelter |
1782 |
|
293 |
gezelter |
1879 |
bool Globals::addRNEMDParameters(RNEMDParameters* rnemdPars) { |
294 |
|
|
if (rnemdPars_ != NULL) |
295 |
|
|
delete rnemdPars_; |
296 |
gezelter |
1782 |
|
297 |
gezelter |
1879 |
rnemdPars_ = rnemdPars; |
298 |
|
|
return true; |
299 |
|
|
} |
300 |
gezelter |
1782 |
|
301 |
gezelter |
1879 |
bool Globals::addMinimizerParameters(MinimizerParameters* miniPars) { |
302 |
|
|
if (minimizerPars_ != NULL) |
303 |
|
|
delete minimizerPars_; |
304 |
gezelter |
1782 |
|
305 |
gezelter |
1879 |
minimizerPars_ = miniPars; |
306 |
|
|
return true; |
307 |
|
|
} |
308 |
gezelter |
1782 |
|
309 |
gezelter |
1879 |
bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) { |
310 |
tim |
770 |
std::string molStampName = molStamp->getName(); |
311 |
|
|
std::map<std::string, MoleculeStamp*>::iterator i; |
312 |
|
|
bool ret = false; |
313 |
|
|
i = moleculeStamps_.find(molStampName); |
314 |
|
|
if (i == moleculeStamps_.end()) { |
315 |
gezelter |
1879 |
moleculeStamps_.insert(std::map<std::string, MoleculeStamp*>::value_type(molStampName, molStamp)); |
316 |
|
|
ret = true; |
317 |
tim |
770 |
} else { |
318 |
gezelter |
1879 |
std::ostringstream oss; |
319 |
|
|
oss << "Globals Error: Molecule Stamp " << molStamp->getName() |
320 |
|
|
<< "appears multiple times\n"; |
321 |
|
|
throw OpenMDException(oss.str()); |
322 |
tim |
770 |
} |
323 |
|
|
return ret; |
324 |
gezelter |
1879 |
} |
325 |
gezelter |
2 |
} |