1 |
|
/* |
2 |
< |
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
2 |
> |
* Copyright (c) 2005, 2010 The University of Notre Dame. All Rights Reserved. |
3 |
|
* |
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 |
< |
* 1. Acknowledgement of the program authors must be made in any |
10 |
< |
* publication of scientific results based in part on use of the |
11 |
< |
* program. An acceptable form of acknowledgement is citation of |
12 |
< |
* the article in which the program was described (Matthew |
13 |
< |
* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher |
14 |
< |
* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented |
15 |
< |
* Parallel Simulation Engine for Molecular Dynamics," |
16 |
< |
* J. Comput. Chem. 26, pp. 252-271 (2005)) |
17 |
< |
* |
18 |
< |
* 2. Redistributions of source code must retain the above copyright |
9 |
> |
* 1. Redistributions of source code must retain the above copyright |
10 |
|
* notice, this list of conditions and the following disclaimer. |
11 |
|
* |
12 |
< |
* 3. Redistributions in binary form must reproduce the above copyright |
12 |
> |
* 2. Redistributions in binary form must reproduce the above copyright |
13 |
|
* notice, this list of conditions and the following disclaimer in the |
14 |
|
* documentation and/or other materials provided with the |
15 |
|
* distribution. |
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 |
+ |
* |
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 |
+ |
* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010). |
40 |
+ |
* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011). |
41 |
|
*/ |
42 |
|
|
43 |
|
#include <stdlib.h> |
50 |
|
#include "utils/MemoryUtils.hpp" |
51 |
|
#include "utils/simError.h" |
52 |
|
|
53 |
< |
namespace oopse { |
53 |
> |
namespace OpenMD { |
54 |
|
Globals::Globals() { |
55 |
+ |
|
56 |
+ |
flucQpars_ = new FluctuatingChargeParameters(); |
57 |
+ |
rnemdPars_ = new RNEMDParameters(); |
58 |
+ |
minimizerPars_ = new MinimizerParameters(); |
59 |
+ |
|
60 |
|
DefineParameter(ForceField, "forceField") |
61 |
|
|
62 |
|
DefineOptionalParameter(TargetTemp, "targetTemp"); |
78 |
|
DefineOptionalParameter(ZconsTol, "zconsTol"); |
79 |
|
DefineOptionalParameter(ZconsForcePolicy, "zconsForcePolicy"); |
80 |
|
DefineOptionalParameter(Seed, "seed"); |
75 |
– |
DefineOptionalParameter(Minimizer, "minimizer"); |
76 |
– |
DefineOptionalParameter(MinimizerMaxIter,"minimizerMaxIter"); |
77 |
– |
DefineOptionalParameter(MinimizerWriteFrq, "minimizerWriteFrq"); |
78 |
– |
DefineOptionalParameter(MinimizerStepSize, "minimizerStepSize"); |
79 |
– |
DefineOptionalParameter(MinimizerFTol, "minimizerFTol"); |
80 |
– |
DefineOptionalParameter(MinimizerGTol, "minimizerGTol"); |
81 |
– |
DefineOptionalParameter(MinimizerLSTol, "minimizerLSTol"); |
82 |
– |
DefineOptionalParameter(MinimizerLSMaxIter, "minimizerLSMaxIter"); |
81 |
|
DefineOptionalParameter(ZconsGap, "zconsGap"); |
82 |
|
DefineOptionalParameter(ZconsFixtime, "zconsFixtime"); |
83 |
|
DefineOptionalParameter(ZconsUsingSMD, "zconsUsingSMD"); |
86 |
|
DefineOptionalParameter(ForceFieldVariant, "forceFieldVariant"); |
87 |
|
DefineOptionalParameter(ForceFieldFileName, "forceFieldFileName"); |
88 |
|
DefineOptionalParameter(DampingAlpha, "dampingAlpha"); |
91 |
– |
DefineOptionalParameter(ThermIntDistSpringConst, "thermIntDistSpringConst"); |
92 |
– |
DefineOptionalParameter(ThermIntThetaSpringConst, "thermIntThetaSpringConst"); |
93 |
– |
DefineOptionalParameter(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst"); |
89 |
|
DefineOptionalParameter(SurfaceTension, "surfaceTension"); |
90 |
|
DefineOptionalParameter(PrintPressureTensor, "printPressureTensor"); |
91 |
+ |
DefineOptionalParameter(PrintHeatFlux, "printHeatFlux"); |
92 |
|
DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair"); |
93 |
|
DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance"); |
98 |
– |
DefineOptionalParameter(CutoffPolicy, "cutoffPolicy"); |
94 |
|
DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType"); |
95 |
|
DefineOptionalParameter(HydroPropFile, "HydroPropFile"); |
96 |
|
DefineOptionalParameter(Viscosity, "viscosity"); |
99 |
|
DefineOptionalParameter(LangevinBufferRadius, "langevinBufferRadius"); |
100 |
|
DefineOptionalParameter(NeighborListNeighbors,"NeighborListNeighbors"); |
101 |
|
DefineOptionalParameter(UseMultipleTemperatureMethod, "useMultipleTemperatureMethod"); |
102 |
+ |
DefineOptionalParameter(ElectrostaticSummationMethod, "electrostaticSummationMethod"); |
103 |
|
DefineOptionalParameter(MTM_Ce, "MTM_Ce"); |
104 |
|
DefineOptionalParameter(MTM_G, "MTM_G"); |
105 |
|
DefineOptionalParameter(MTM_Io, "MTM_Io"); |
106 |
|
DefineOptionalParameter(MTM_Sigma, "MTM_Sigma"); |
107 |
|
DefineOptionalParameter(MTM_R, "MTM_R"); |
108 |
< |
|
108 |
> |
DefineOptionalParameter(Alpha, "alpha"); |
109 |
|
|
110 |
|
|
111 |
|
DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, "usePeriodicBoundaryConditions", true); |
113 |
|
DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", false); |
114 |
|
DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, "useInitialExtendedSystemState", false); |
115 |
|
DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, "orthoBoxTolerance", 1E-6); |
116 |
< |
DefineOptionalParameterWithDefaultValue(UseSolidThermInt, "useSolidThermInt", false); |
121 |
< |
DefineOptionalParameterWithDefaultValue(UseLiquidThermInt, "useLiquidThermInt", false); |
122 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntDistSpringConst, "thermIntDistSpringConst", 6.0); |
123 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntThetaSpringConst, "thermIntThetaSpringConst", 7.5); |
124 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst", 13.5); |
125 |
< |
DefineOptionalParameterWithDefaultValue(ElectrostaticSummationMethod, "electrostaticSummationMethod", "SHIFTED_FORCE"); |
116 |
> |
DefineOptionalParameterWithDefaultValue(CutoffMethod, "cutoffMethod", "SHIFTED_FORCE"); |
117 |
|
DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, "electrostaticScreeningMethod", "DAMPED"); |
118 |
< |
DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 78.5); |
119 |
< |
DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", 0); |
120 |
< |
DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", 0); |
118 |
> |
DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 80.0); |
119 |
> |
DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", false); |
120 |
> |
DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", false); |
121 |
> |
DefineOptionalParameterWithDefaultValue(OutputParticlePotential, "outputParticlePotential", false); |
122 |
> |
DefineOptionalParameterWithDefaultValue(OutputElectricField, "outputElectricField", false); |
123 |
> |
DefineOptionalParameterWithDefaultValue(OutputFluctuatingCharges, "outputFluctuatingCharges", false); |
124 |
|
DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", 1.0); |
125 |
|
DefineOptionalParameterWithDefaultValue(StatFileFormat, "statFileFormat", "TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY"); |
126 |
|
DefineOptionalParameterWithDefaultValue(UseSphericalBoundaryConditions, "useSphericalBoundaryConditions", false); |
127 |
|
DefineOptionalParameterWithDefaultValue(AccumulateBoxDipole, "accumulateBoxDipole", false); |
128 |
|
|
129 |
< |
DefineOptionalParameterWithDefaultValue(UseRNEMD, "useRNEMD", false); |
130 |
< |
DefineOptionalParameterWithDefaultValue(RNEMD_swapTime, "RNEMD_swapTime", 100.0); |
131 |
< |
DefineOptionalParameterWithDefaultValue(RNEMD_nBins, "RNEMD_nBins", 15); |
132 |
< |
DefineOptionalParameterWithDefaultValue(RNEMD_swapType, "RNEMD_swapType", "Kinetic"); |
139 |
< |
DefineOptionalParameterWithDefaultValue(RNEMD_objectSelection, "RNEMD_objectSelection", "select all"); |
140 |
< |
|
129 |
> |
DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false); |
130 |
> |
DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in"); |
131 |
> |
DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false); |
132 |
> |
DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex"); |
133 |
|
|
134 |
|
deprecatedKeywords_.insert("nComponents"); |
135 |
|
deprecatedKeywords_.insert("nZconstraints"); |
136 |
|
deprecatedKeywords_.insert("initialConfig"); |
137 |
+ |
deprecatedKeywords_.insert("thermIntDistSpringConst"); |
138 |
+ |
deprecatedKeywords_.insert("thermIntThetaSpringConst"); |
139 |
+ |
deprecatedKeywords_.insert("thermIntOmegaSpringConst"); |
140 |
+ |
deprecatedKeywords_.insert("useSolidThermInt"); |
141 |
+ |
deprecatedKeywords_.insert("useLiquidThermInt"); |
142 |
+ |
deprecatedKeywords_.insert("minimizerMaxIter"); |
143 |
+ |
deprecatedKeywords_.insert("minimizerWriteFreq"); |
144 |
+ |
deprecatedKeywords_.insert("minimizerStepSize"); |
145 |
+ |
deprecatedKeywords_.insert("minimizerFTol"); |
146 |
+ |
deprecatedKeywords_.insert("minimizerGTol"); |
147 |
+ |
deprecatedKeywords_.insert("minimizerLSTol"); |
148 |
+ |
deprecatedKeywords_.insert("minimizerLSMaxIter"); |
149 |
+ |
|
150 |
|
|
151 |
|
} |
152 |
|
|
153 |
|
Globals::~Globals() { |
154 |
|
MemoryUtils::deletePointers(components_); |
155 |
|
MemoryUtils::deletePointers(zconstraints_); |
156 |
+ |
MemoryUtils::deletePointers(restraints_); |
157 |
|
} |
158 |
|
|
159 |
|
void Globals::validate() { |
161 |
|
|
162 |
|
CheckParameter(ForceField, isNotEmpty()); |
163 |
|
CheckParameter(TargetTemp, isPositive()); |
164 |
< |
CheckParameter(Ensemble, isEqualIgnoreCase("NVE") || isEqualIgnoreCase("NVT") || isEqualIgnoreCase("NPTi") || isEqualIgnoreCase("NPTf") || isEqualIgnoreCase("NPTxyz") || isEqualIgnoreCase("NPAT") || isEqualIgnoreCase("LANGEVINDYNAMICS") || isEqualIgnoreCase("LD") || isEqualIgnoreCase("NPRT") || isEqualIgnoreCase("NPGT") || isEqualIgnoreCase("NGammaT") || isEqualIgnoreCase("NGT") || isEqualIgnoreCase("SMIPD")); |
164 |
> |
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")); |
165 |
|
CheckParameter(Dt, isPositive()); |
166 |
|
CheckParameter(RunTime, isPositive()); |
167 |
|
CheckParameter(FinalConfig, isNotEmpty()); |
177 |
|
CheckParameter(ZconsTime, isPositive()); |
178 |
|
CheckParameter(ZconsTol, isPositive()); |
179 |
|
CheckParameter(Seed, isPositive()); |
174 |
– |
CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG")); |
175 |
– |
CheckParameter(MinimizerMaxIter, isPositive()); |
176 |
– |
CheckParameter(MinimizerWriteFrq, isPositive()); |
177 |
– |
CheckParameter(MinimizerStepSize, isPositive()); |
178 |
– |
CheckParameter(MinimizerFTol, isPositive()); |
179 |
– |
CheckParameter(MinimizerGTol, isPositive()); |
180 |
– |
CheckParameter(MinimizerLSTol, isPositive()); |
181 |
– |
CheckParameter(MinimizerLSMaxIter, isPositive()); |
180 |
|
CheckParameter(ZconsGap, isPositive()); |
181 |
|
CheckParameter(ZconsFixtime, isPositive()); |
182 |
|
CheckParameter(ThermodynamicIntegrationLambda, isNonNegative()); |
183 |
|
CheckParameter(ThermodynamicIntegrationK, isPositive()); |
184 |
|
CheckParameter(ForceFieldVariant, isNotEmpty()); |
185 |
|
CheckParameter(ForceFieldFileName, isNotEmpty()); |
186 |
< |
CheckParameter(ThermIntDistSpringConst, isPositive()); |
189 |
< |
CheckParameter(ThermIntThetaSpringConst, isPositive()); |
190 |
< |
CheckParameter(ThermIntOmegaSpringConst, isPositive()); |
191 |
< |
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD")); |
192 |
< |
CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
186 |
> |
CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE")); |
187 |
|
CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL")); |
188 |
+ |
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD")); |
189 |
+ |
CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
190 |
|
CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL")); |
195 |
– |
//CheckParameter(StatFileFormat,); |
191 |
|
CheckParameter(OrthoBoxTolerance, isPositive()); |
197 |
– |
CheckParameter(ThermIntDistSpringConst, isPositive()); |
198 |
– |
CheckParameter(ThermIntThetaSpringConst, isPositive()); |
199 |
– |
CheckParameter(ThermIntOmegaSpringConst, isPositive()); |
192 |
|
CheckParameter(DampingAlpha,isNonNegative()); |
193 |
|
CheckParameter(SkinThickness, isPositive()); |
194 |
|
CheckParameter(Viscosity, isNonNegative()); |
196 |
|
CheckParameter(FrozenBufferRadius, isPositive()); |
197 |
|
CheckParameter(LangevinBufferRadius, isPositive()); |
198 |
|
CheckParameter(NeighborListNeighbors, isPositive()); |
199 |
< |
CheckParameter(RNEMD_swapTime, isPositive()); |
200 |
< |
CheckParameter(RNEMD_nBins, isPositive()); |
201 |
< |
CheckParameter(RNEMD_swapType, isEqualIgnoreCase("Kinetic") || isEqualIgnoreCase("Px") || isEqualIgnoreCase("Py") || isEqualIgnoreCase("Pz")); |
210 |
< |
|
199 |
> |
CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape")); |
200 |
> |
CheckParameter(Alpha, isPositive()); |
201 |
> |
|
202 |
|
for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) { |
203 |
|
if (!(*i)->findMoleculeStamp(moleculeStamps_)) { |
204 |
|
std::ostringstream oss; |
205 |
|
oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl; |
206 |
< |
throw OOPSEException(oss.str()); |
206 |
> |
throw OpenMDException(oss.str()); |
207 |
|
} |
208 |
|
} |
209 |
|
} |
210 |
< |
|
210 |
> |
|
211 |
|
bool Globals::addComponent(Component* comp) { |
212 |
|
components_.push_back(comp); |
213 |
|
return true; |
218 |
|
return true; |
219 |
|
} |
220 |
|
|
221 |
+ |
bool Globals::addRestraintStamp(RestraintStamp* rest) { |
222 |
+ |
restraints_.push_back(rest); |
223 |
+ |
return true; |
224 |
+ |
} |
225 |
+ |
|
226 |
+ |
bool Globals::addFluctuatingChargeParameters(FluctuatingChargeParameters* fqp) { |
227 |
+ |
if (flucQpars_ != NULL) |
228 |
+ |
delete flucQpars_; |
229 |
+ |
|
230 |
+ |
flucQpars_ = fqp; |
231 |
+ |
return true; |
232 |
+ |
} |
233 |
+ |
|
234 |
+ |
bool Globals::addRNEMDParameters(RNEMDParameters* rnemdPars) { |
235 |
+ |
if (rnemdPars_ != NULL) |
236 |
+ |
delete rnemdPars_; |
237 |
+ |
|
238 |
+ |
rnemdPars_ = rnemdPars; |
239 |
+ |
return true; |
240 |
+ |
} |
241 |
+ |
|
242 |
+ |
bool Globals::addMinimizerParameters(MinimizerParameters* miniPars) { |
243 |
+ |
if (minimizerPars_ != NULL) |
244 |
+ |
delete minimizerPars_; |
245 |
+ |
|
246 |
+ |
minimizerPars_ = miniPars; |
247 |
+ |
return true; |
248 |
+ |
} |
249 |
+ |
|
250 |
|
bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) { |
251 |
|
std::string molStampName = molStamp->getName(); |
252 |
|
std::map<std::string, MoleculeStamp*>::iterator i; |
258 |
|
} else { |
259 |
|
std::ostringstream oss; |
260 |
|
oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n"; |
261 |
< |
throw OOPSEException(oss.str()); |
261 |
> |
throw OpenMDException(oss.str()); |
262 |
|
} |
263 |
|
return ret; |
264 |
|
} |