| 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 |
|
DefineParameter(ForceField, "forceField") |
| 56 |
|
|
| 75 |
|
DefineOptionalParameter(Seed, "seed"); |
| 76 |
|
DefineOptionalParameter(Minimizer, "minimizer"); |
| 77 |
|
DefineOptionalParameter(MinimizerMaxIter,"minimizerMaxIter"); |
| 78 |
< |
DefineOptionalParameter(MinimizerWriteFrq, "minimizerWriteFrq"); |
| 78 |
> |
DefineOptionalParameter(MinimizerWriteFreq, "minimizerWriteFreq"); |
| 79 |
|
DefineOptionalParameter(MinimizerStepSize, "minimizerStepSize"); |
| 80 |
|
DefineOptionalParameter(MinimizerFTol, "minimizerFTol"); |
| 81 |
|
DefineOptionalParameter(MinimizerGTol, "minimizerGTol"); |
| 89 |
|
DefineOptionalParameter(ForceFieldVariant, "forceFieldVariant"); |
| 90 |
|
DefineOptionalParameter(ForceFieldFileName, "forceFieldFileName"); |
| 91 |
|
DefineOptionalParameter(DampingAlpha, "dampingAlpha"); |
| 91 |
– |
DefineOptionalParameter(ThermIntDistSpringConst, "thermIntDistSpringConst"); |
| 92 |
– |
DefineOptionalParameter(ThermIntThetaSpringConst, "thermIntThetaSpringConst"); |
| 93 |
– |
DefineOptionalParameter(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst"); |
| 92 |
|
DefineOptionalParameter(SurfaceTension, "surfaceTension"); |
| 93 |
|
DefineOptionalParameter(PrintPressureTensor, "printPressureTensor"); |
| 94 |
|
DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair"); |
| 95 |
|
DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance"); |
| 98 |
– |
DefineOptionalParameter(CutoffPolicy, "cutoffPolicy"); |
| 96 |
|
DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType"); |
| 97 |
|
DefineOptionalParameter(HydroPropFile, "HydroPropFile"); |
| 98 |
|
DefineOptionalParameter(Viscosity, "viscosity"); |
| 101 |
|
DefineOptionalParameter(LangevinBufferRadius, "langevinBufferRadius"); |
| 102 |
|
DefineOptionalParameter(NeighborListNeighbors,"NeighborListNeighbors"); |
| 103 |
|
DefineOptionalParameter(UseMultipleTemperatureMethod, "useMultipleTemperatureMethod"); |
| 104 |
+ |
DefineOptionalParameter(ElectrostaticSummationMethod, "electrostaticSummationMethod"); |
| 105 |
|
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 |
+ |
DefineOptionalParameter(Alpha, "alpha"); |
| 111 |
+ |
|
| 112 |
|
|
| 113 |
– |
|
| 113 |
|
DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, "usePeriodicBoundaryConditions", true); |
| 114 |
|
DefineOptionalParameterWithDefaultValue(UseAtomicVirial, "useAtomicVirial", true); |
| 115 |
|
DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", false); |
| 116 |
|
DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, "useInitialExtendedSystemState", false); |
| 117 |
|
DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, "orthoBoxTolerance", 1E-6); |
| 118 |
< |
DefineOptionalParameterWithDefaultValue(UseSolidThermInt, "useSolidThermInt", false); |
| 120 |
< |
DefineOptionalParameterWithDefaultValue(UseLiquidThermInt, "useLiquidThermInt", false); |
| 121 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntDistSpringConst, "thermIntDistSpringConst", 6.0); |
| 122 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntThetaSpringConst, "thermIntThetaSpringConst", 7.5); |
| 123 |
< |
DefineOptionalParameterWithDefaultValue(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst", 13.5); |
| 124 |
< |
DefineOptionalParameterWithDefaultValue(ElectrostaticSummationMethod, "electrostaticSummationMethod", "SHIFTED_FORCE"); |
| 118 |
> |
DefineOptionalParameterWithDefaultValue(CutoffMethod, "cutoffMethod", "SHIFTED_FORCE"); |
| 119 |
|
DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, "electrostaticScreeningMethod", "DAMPED"); |
| 120 |
< |
DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 78.5); |
| 121 |
< |
DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", 0); |
| 122 |
< |
DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", 0); |
| 120 |
> |
DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 80.0); |
| 121 |
> |
DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", false); |
| 122 |
> |
DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", false); |
| 123 |
> |
DefineOptionalParameterWithDefaultValue(OutputParticlePotential, "outputParticlePotential", false); |
| 124 |
> |
DefineOptionalParameterWithDefaultValue(OutputElectricField, "outputElectricField", false); |
| 125 |
> |
DefineOptionalParameterWithDefaultValue(OutputFluctuatingCharges, "outputFluctuatingCharges", false); |
| 126 |
|
DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", 1.0); |
| 127 |
|
DefineOptionalParameterWithDefaultValue(StatFileFormat, "statFileFormat", "TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY"); |
| 128 |
|
DefineOptionalParameterWithDefaultValue(UseSphericalBoundaryConditions, "useSphericalBoundaryConditions", false); |
| 129 |
|
DefineOptionalParameterWithDefaultValue(AccumulateBoxDipole, "accumulateBoxDipole", false); |
| 130 |
|
|
| 131 |
+ |
DefineOptionalParameterWithDefaultValue(UseRNEMD, "useRNEMD", false); |
| 132 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_exchangeTime, "RNEMD_exchangeTime", 100.0); |
| 133 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_nBins, "RNEMD_nBins", 16); |
| 134 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_logWidth, "RNEMD_logWidth", 16); |
| 135 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_exchangeType, "RNEMD_exchangeType", "KineticScale"); |
| 136 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_targetFlux, "RNEMD_targetFlux", 0.0); |
| 137 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_objectSelection, "RNEMD_objectSelection", "select all"); |
| 138 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_binShift, "RNEMD_binShift", false); |
| 139 |
+ |
DefineOptionalParameterWithDefaultValue(RNEMD_outputDimensionalTemperature, "RNEMD_outputDimensionalTemperature", false); |
| 140 |
+ |
DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false); |
| 141 |
+ |
DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in"); |
| 142 |
+ |
DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false); |
| 143 |
+ |
DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex"); |
| 144 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQPropagator, "flucQ.propagator", "NVT"); |
| 145 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQFriction, "flucQ.friction", 1600.0); |
| 146 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQTolerance, "flucQ.tolerance", 1.0e-6); |
| 147 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQMaxIterations, "flucQ.maxIterations", 100); |
| 148 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQTargetTemp, "flucQ.targetTemp", 1.0e-6); |
| 149 |
+ |
DefineOptionalParameterWithDefaultValue(FlucQtauThermostat, "flucQ.tauThermostat", 10.0); |
| 150 |
+ |
|
| 151 |
|
deprecatedKeywords_.insert("nComponents"); |
| 152 |
|
deprecatedKeywords_.insert("nZconstraints"); |
| 153 |
|
deprecatedKeywords_.insert("initialConfig"); |
| 154 |
+ |
deprecatedKeywords_.insert("thermIntDistSpringConst"); |
| 155 |
+ |
deprecatedKeywords_.insert("thermIntThetaSpringConst"); |
| 156 |
+ |
deprecatedKeywords_.insert("thermIntOmegaSpringConst"); |
| 157 |
+ |
deprecatedKeywords_.insert("useSolidThermInt"); |
| 158 |
+ |
deprecatedKeywords_.insert("useLiquidThermInt"); |
| 159 |
|
|
| 160 |
|
} |
| 161 |
|
|
| 162 |
|
Globals::~Globals() { |
| 163 |
|
MemoryUtils::deletePointers(components_); |
| 164 |
|
MemoryUtils::deletePointers(zconstraints_); |
| 165 |
+ |
MemoryUtils::deletePointers(restraints_); |
| 166 |
|
} |
| 167 |
|
|
| 168 |
|
void Globals::validate() { |
| 170 |
|
|
| 171 |
|
CheckParameter(ForceField, isNotEmpty()); |
| 172 |
|
CheckParameter(TargetTemp, isPositive()); |
| 173 |
< |
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")); |
| 173 |
> |
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")); |
| 174 |
|
CheckParameter(Dt, isPositive()); |
| 175 |
|
CheckParameter(RunTime, isPositive()); |
| 176 |
|
CheckParameter(FinalConfig, isNotEmpty()); |
| 188 |
|
CheckParameter(Seed, isPositive()); |
| 189 |
|
CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG")); |
| 190 |
|
CheckParameter(MinimizerMaxIter, isPositive()); |
| 191 |
< |
CheckParameter(MinimizerWriteFrq, isPositive()); |
| 191 |
> |
CheckParameter(MinimizerWriteFreq, isPositive()); |
| 192 |
|
CheckParameter(MinimizerStepSize, isPositive()); |
| 193 |
|
CheckParameter(MinimizerFTol, isPositive()); |
| 194 |
|
CheckParameter(MinimizerGTol, isPositive()); |
| 200 |
|
CheckParameter(ThermodynamicIntegrationK, isPositive()); |
| 201 |
|
CheckParameter(ForceFieldVariant, isNotEmpty()); |
| 202 |
|
CheckParameter(ForceFieldFileName, isNotEmpty()); |
| 203 |
< |
CheckParameter(ThermIntDistSpringConst, isPositive()); |
| 181 |
< |
CheckParameter(ThermIntThetaSpringConst, isPositive()); |
| 182 |
< |
CheckParameter(ThermIntOmegaSpringConst, isPositive()); |
| 183 |
< |
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD")); |
| 184 |
< |
CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
| 203 |
> |
CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE")); |
| 204 |
|
CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL")); |
| 205 |
+ |
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD")); |
| 206 |
+ |
CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
| 207 |
|
CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL")); |
| 187 |
– |
//CheckParameter(StatFileFormat,); |
| 208 |
|
CheckParameter(OrthoBoxTolerance, isPositive()); |
| 189 |
– |
CheckParameter(ThermIntDistSpringConst, isPositive()); |
| 190 |
– |
CheckParameter(ThermIntThetaSpringConst, isPositive()); |
| 191 |
– |
CheckParameter(ThermIntOmegaSpringConst, isPositive()); |
| 209 |
|
CheckParameter(DampingAlpha,isNonNegative()); |
| 210 |
|
CheckParameter(SkinThickness, isPositive()); |
| 211 |
|
CheckParameter(Viscosity, isNonNegative()); |
| 213 |
|
CheckParameter(FrozenBufferRadius, isPositive()); |
| 214 |
|
CheckParameter(LangevinBufferRadius, isPositive()); |
| 215 |
|
CheckParameter(NeighborListNeighbors, isPositive()); |
| 216 |
< |
|
| 216 |
> |
CheckParameter(RNEMD_exchangeTime, isPositive()); |
| 217 |
> |
CheckParameter(RNEMD_nBins, isPositive() && isEven()); |
| 218 |
> |
CheckParameter(RNEMD_exchangeType, isEqualIgnoreCase("KineticSwap") || isEqualIgnoreCase("KineticScale") || isEqualIgnoreCase("Px") || isEqualIgnoreCase("Py") || isEqualIgnoreCase("Pz") || isEqualIgnoreCase("PxScale") || isEqualIgnoreCase("PyScale") || isEqualIgnoreCase("PzScale")); |
| 219 |
> |
CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape")); |
| 220 |
> |
CheckParameter(Alpha, isPositive()); |
| 221 |
> |
CheckParameter(FlucQPropagator, isEqualIgnoreCase("NVT") || isEqualIgnoreCase("Langevin") || isEqualIgnoreCase("Minimizer") || isEqualIgnoreCase("Exact") ); |
| 222 |
> |
CheckParameter(FlucQFriction, isNonNegative()); |
| 223 |
> |
CheckParameter(FlucQTolerance, isPositive()); |
| 224 |
> |
CheckParameter(FlucQMaxIterations, isPositive()); |
| 225 |
> |
CheckParameter(FlucQTargetTemp, isNonNegative()); |
| 226 |
> |
CheckParameter(FlucQtauThermostat, isPositive()); |
| 227 |
> |
|
| 228 |
|
for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) { |
| 229 |
|
if (!(*i)->findMoleculeStamp(moleculeStamps_)) { |
| 230 |
|
std::ostringstream oss; |
| 231 |
|
oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl; |
| 232 |
< |
throw OOPSEException(oss.str()); |
| 232 |
> |
throw OpenMDException(oss.str()); |
| 233 |
|
} |
| 234 |
|
} |
| 235 |
|
} |
| 236 |
< |
|
| 236 |
> |
|
| 237 |
|
bool Globals::addComponent(Component* comp) { |
| 238 |
|
components_.push_back(comp); |
| 239 |
|
return true; |
| 244 |
|
return true; |
| 245 |
|
} |
| 246 |
|
|
| 247 |
+ |
bool Globals::addRestraintStamp(RestraintStamp* rest) { |
| 248 |
+ |
restraints_.push_back(rest); |
| 249 |
+ |
return true; |
| 250 |
+ |
} |
| 251 |
+ |
|
| 252 |
|
bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) { |
| 253 |
|
std::string molStampName = molStamp->getName(); |
| 254 |
|
std::map<std::string, MoleculeStamp*>::iterator i; |
| 260 |
|
} else { |
| 261 |
|
std::ostringstream oss; |
| 262 |
|
oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n"; |
| 263 |
< |
throw OOPSEException(oss.str()); |
| 263 |
> |
throw OpenMDException(oss.str()); |
| 264 |
|
} |
| 265 |
|
return ret; |
| 266 |
|
} |
