| 1 |
/* |
| 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. Redistributions of source code must retain the above copyright |
| 10 |
* notice, this list of conditions and the following disclaimer. |
| 11 |
* |
| 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. |
| 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 |
* |
| 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> |
| 44 |
#include <stdio.h> |
| 45 |
#include <string.h> |
| 46 |
#include <string> |
| 47 |
|
| 48 |
#include "io/Globals.hpp" |
| 49 |
#include "io/ParamConstraint.hpp" |
| 50 |
#include "utils/MemoryUtils.hpp" |
| 51 |
#include "utils/simError.h" |
| 52 |
|
| 53 |
namespace OpenMD { |
| 54 |
Globals::Globals() { |
| 55 |
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 |
DefineOptionalParameter(TargetPressure, "targetPressure"); |
| 70 |
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 |
DefineOptionalParameter(MinimizerWriteFreq, "minimizerWriteFreq"); |
| 79 |
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 |
DefineOptionalParameter(DampingAlpha, "dampingAlpha"); |
| 92 |
DefineOptionalParameter(SurfaceTension, "surfaceTension"); |
| 93 |
DefineOptionalParameter(PrintPressureTensor, "printPressureTensor"); |
| 94 |
DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair"); |
| 95 |
DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance"); |
| 96 |
DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType"); |
| 97 |
DefineOptionalParameter(HydroPropFile, "HydroPropFile"); |
| 98 |
DefineOptionalParameter(Viscosity, "viscosity"); |
| 99 |
DefineOptionalParameter(BeadSize, "beadSize"); |
| 100 |
DefineOptionalParameter(FrozenBufferRadius, "frozenBufferRadius"); |
| 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 |
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(CutoffMethod, "cutoffMethod", "SHIFTED_FORCE"); |
| 119 |
DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, "electrostaticScreeningMethod", "DAMPED"); |
| 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_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 |
DefineOptionalParameterWithDefaultValue(RNEMD_objectSelection, "RNEMD_objectSelection", "select all"); |
| 142 |
DefineOptionalParameterWithDefaultValue(RNEMD_binShift, "RNEMD_binShift", false); |
| 143 |
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 |
DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false); |
| 150 |
DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in"); |
| 151 |
DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false); |
| 152 |
DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex"); |
| 153 |
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 |
|
| 160 |
deprecatedKeywords_.insert("nComponents"); |
| 161 |
deprecatedKeywords_.insert("nZconstraints"); |
| 162 |
deprecatedKeywords_.insert("initialConfig"); |
| 163 |
deprecatedKeywords_.insert("thermIntDistSpringConst"); |
| 164 |
deprecatedKeywords_.insert("thermIntThetaSpringConst"); |
| 165 |
deprecatedKeywords_.insert("thermIntOmegaSpringConst"); |
| 166 |
deprecatedKeywords_.insert("useSolidThermInt"); |
| 167 |
deprecatedKeywords_.insert("useLiquidThermInt"); |
| 168 |
|
| 169 |
} |
| 170 |
|
| 171 |
Globals::~Globals() { |
| 172 |
MemoryUtils::deletePointers(components_); |
| 173 |
MemoryUtils::deletePointers(zconstraints_); |
| 174 |
MemoryUtils::deletePointers(restraints_); |
| 175 |
} |
| 176 |
|
| 177 |
void Globals::validate() { |
| 178 |
DataHolder::validate(); |
| 179 |
|
| 180 |
CheckParameter(ForceField, isNotEmpty()); |
| 181 |
CheckParameter(TargetTemp, isPositive()); |
| 182 |
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 |
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 |
CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG")); |
| 199 |
CheckParameter(MinimizerMaxIter, isPositive()); |
| 200 |
CheckParameter(MinimizerWriteFreq, isPositive()); |
| 201 |
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 |
CheckParameter(ThermodynamicIntegrationLambda, isNonNegative()); |
| 209 |
CheckParameter(ThermodynamicIntegrationK, isPositive()); |
| 210 |
CheckParameter(ForceFieldVariant, isNotEmpty()); |
| 211 |
CheckParameter(ForceFieldFileName, isNotEmpty()); |
| 212 |
CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE")); |
| 213 |
CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL")); |
| 214 |
CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD")); |
| 215 |
CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED")); |
| 216 |
CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL")); |
| 217 |
CheckParameter(OrthoBoxTolerance, isPositive()); |
| 218 |
CheckParameter(DampingAlpha,isNonNegative()); |
| 219 |
CheckParameter(SkinThickness, isPositive()); |
| 220 |
CheckParameter(Viscosity, isNonNegative()); |
| 221 |
CheckParameter(BeadSize, isPositive()); |
| 222 |
CheckParameter(FrozenBufferRadius, isPositive()); |
| 223 |
CheckParameter(LangevinBufferRadius, isPositive()); |
| 224 |
CheckParameter(NeighborListNeighbors, isPositive()); |
| 225 |
CheckParameter(RNEMD_exchangeTime, isPositive()); |
| 226 |
CheckParameter(RNEMD_nBins, isPositive() && isEven()); |
| 227 |
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 |
CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape")); |
| 229 |
CheckParameter(Alpha, isPositive()); |
| 230 |
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 |
|
| 237 |
for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) { |
| 238 |
if (!(*i)->findMoleculeStamp(moleculeStamps_)) { |
| 239 |
std::ostringstream oss; |
| 240 |
oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl; |
| 241 |
throw OpenMDException(oss.str()); |
| 242 |
} |
| 243 |
} |
| 244 |
} |
| 245 |
|
| 246 |
bool Globals::addComponent(Component* comp) { |
| 247 |
components_.push_back(comp); |
| 248 |
return true; |
| 249 |
} |
| 250 |
|
| 251 |
bool Globals::addZConsStamp(ZConsStamp* zcons) { |
| 252 |
zconstraints_.push_back(zcons); |
| 253 |
return true; |
| 254 |
} |
| 255 |
|
| 256 |
bool Globals::addRestraintStamp(RestraintStamp* rest) { |
| 257 |
restraints_.push_back(rest); |
| 258 |
return true; |
| 259 |
} |
| 260 |
|
| 261 |
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 |
std::ostringstream oss; |
| 271 |
oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n"; |
| 272 |
throw OpenMDException(oss.str()); |
| 273 |
} |
| 274 |
return ret; |
| 275 |
} |
| 276 |
|
| 277 |
|
| 278 |
} |
