| 1 | gezelter | 404 | /* | 
| 2 | gezelter | 246 | * Copyright (c) 2005 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 | 
| 19 |  |  | *    notice, this list of conditions and the following disclaimer. | 
| 20 |  |  | * | 
| 21 |  |  | * 3. Redistributions in binary form must reproduce the above copyright | 
| 22 |  |  | *    notice, this list of conditions and the following disclaimer in the | 
| 23 |  |  | *    documentation and/or other materials provided with the | 
| 24 |  |  | *    distribution. | 
| 25 |  |  | * | 
| 26 |  |  | * This software is provided "AS IS," without a warranty of any | 
| 27 |  |  | * kind. All express or implied conditions, representations and | 
| 28 |  |  | * warranties, including any implied warranty of merchantability, | 
| 29 |  |  | * fitness for a particular purpose or non-infringement, are hereby | 
| 30 |  |  | * excluded.  The University of Notre Dame and its licensors shall not | 
| 31 |  |  | * be liable for any damages suffered by licensee as a result of | 
| 32 |  |  | * using, modifying or distributing the software or its | 
| 33 |  |  | * derivatives. In no event will the University of Notre Dame or its | 
| 34 |  |  | * licensors be liable for any lost revenue, profit or data, or for | 
| 35 |  |  | * direct, indirect, special, consequential, incidental or punitive | 
| 36 |  |  | * damages, however caused and regardless of the theory of liability, | 
| 37 |  |  | * arising out of the use of or inability to use software, even if the | 
| 38 |  |  | * University of Notre Dame has been advised of the possibility of | 
| 39 |  |  | * such damages. | 
| 40 |  |  | */ | 
| 41 |  |  |  | 
| 42 | gezelter | 2 | #include <stdlib.h> | 
| 43 |  |  | #include <stdio.h> | 
| 44 |  |  | #include <string.h> | 
| 45 | tim | 665 | #include <string> | 
| 46 | gezelter | 2 |  | 
| 47 | tim | 3 | #include "io/Globals.hpp" | 
| 48 | tim | 816 | #include "io/ParamConstraint.hpp" | 
| 49 |  |  | #include "utils/MemoryUtils.hpp" | 
| 50 | tim | 3 | #include "utils/simError.h" | 
| 51 | gezelter | 2 |  | 
| 52 | tim | 770 | namespace oopse { | 
| 53 |  |  | Globals::Globals() { | 
| 54 | tim | 665 | DefineParameter(ForceField, "forceField") | 
| 55 |  |  |  | 
| 56 |  |  | DefineOptionalParameter(TargetTemp, "targetTemp"); | 
| 57 |  |  | DefineOptionalParameter(Ensemble, "ensemble"); | 
| 58 |  |  | DefineOptionalParameter(Dt, "dt"); | 
| 59 |  |  | DefineOptionalParameter(RunTime, "runTime"); | 
| 60 |  |  | DefineOptionalParameter(InitialConfig, "initialConfig"); | 
| 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(Dielectric, "dielectric"); | 
| 68 |  |  | DefineOptionalParameter(TempSet, "tempSet"); | 
| 69 |  |  | DefineOptionalParameter(ThermalTime, "thermalTime"); | 
| 70 |  |  | DefineOptionalParameter(TargetPressure, "targetPressure"); | 
| 71 |  |  | DefineOptionalParameter(TauThermostat, "tauThermostat"); | 
| 72 |  |  | DefineOptionalParameter(TauBarostat, "tauBarostat"); | 
| 73 |  |  | DefineOptionalParameter(ZconsTime, "zconsTime"); | 
| 74 |  |  | DefineOptionalParameter(ZconsTol, "zconsTol"); | 
| 75 |  |  | DefineOptionalParameter(ZconsForcePolicy, "zconsForcePolicy"); | 
| 76 |  |  | DefineOptionalParameter(Seed, "seed"); | 
| 77 |  |  | DefineOptionalParameter(Minimizer, "minimizer"); | 
| 78 |  |  | DefineOptionalParameter(MinimizerMaxIter,"minimizerMaxIter"); | 
| 79 |  |  | DefineOptionalParameter(MinimizerWriteFrq, "minimizerWriteFrq"); | 
| 80 |  |  | DefineOptionalParameter(MinimizerStepSize, "minimizerStepSize"); | 
| 81 |  |  | DefineOptionalParameter(MinimizerFTol, "minimizerFTol"); | 
| 82 |  |  | DefineOptionalParameter(MinimizerGTol, "minimizerGTol"); | 
| 83 |  |  | DefineOptionalParameter(MinimizerLSTol, "minimizerLSTol"); | 
| 84 |  |  | DefineOptionalParameter(MinimizerLSMaxIter, "minimizerLSMaxIter"); | 
| 85 |  |  | DefineOptionalParameter(ZconsGap, "zconsGap"); | 
| 86 |  |  | DefineOptionalParameter(ZconsFixtime, "zconsFixtime"); | 
| 87 |  |  | DefineOptionalParameter(ZconsUsingSMD, "zconsUsingSMD"); | 
| 88 |  |  | DefineOptionalParameter(ThermodynamicIntegrationLambda, "thermodynamicIntegrationLambda"); | 
| 89 |  |  | DefineOptionalParameter(ThermodynamicIntegrationK, "thermodynamicIntegrationK"); | 
| 90 |  |  | DefineOptionalParameter(ForceFieldVariant, "forceFieldVariant"); | 
| 91 |  |  | DefineOptionalParameter(ForceFieldFileName, "forceFieldFileName"); | 
| 92 |  |  | DefineOptionalParameter(ThermIntDistSpringConst, "thermIntDistSpringConst"); | 
| 93 |  |  | DefineOptionalParameter(ThermIntThetaSpringConst, "thermIntThetaSpringConst"); | 
| 94 |  |  | DefineOptionalParameter(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst"); | 
| 95 |  |  | DefineOptionalParameter(SurfaceTension, "surfaceTension"); | 
| 96 |  |  | DefineOptionalParameter(PrintPressureTensor, "printPressureTensor"); | 
| 97 |  |  | DefineOptionalParameter(ElectrostaticSummationMethod, "electrostaticSummationMethod"); | 
| 98 | chrisfen | 716 | DefineOptionalParameter(ElectrostaticScreeningMethod, "electrostaticScreeningMethod"); | 
| 99 | tim | 665 | DefineOptionalParameter(CutoffPolicy, "cutoffPolicy"); | 
| 100 | chrisfen | 726 | DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType"); | 
| 101 | tim | 665 | DefineOptionalParameterWithDefaultValue(MixingRule, "mixingRule", "standard"); | 
| 102 |  |  | DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, "usePeriodicBoundaryConditions", true); | 
| 103 |  |  | DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", false); | 
| 104 |  |  | DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, "useInitialExtendedSystemState", false); | 
| 105 |  |  | DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, "orthoBoxTolerance", 1E-6); | 
| 106 |  |  | DefineOptionalParameterWithDefaultValue(UseSolidThermInt, "useSolidThermInt", false); | 
| 107 |  |  | DefineOptionalParameterWithDefaultValue(UseLiquidThermInt, "useLiquidThermInt", false); | 
| 108 | chrisfen | 666 | DefineOptionalParameterWithDefaultValue(ThermIntDistSpringConst, "thermIntDistSpringConst", 6.0); | 
| 109 |  |  | DefineOptionalParameterWithDefaultValue(ThermIntThetaSpringConst, "thermIntThetaSpringConst", 7.5); | 
| 110 |  |  | DefineOptionalParameterWithDefaultValue(ThermIntOmegaSpringConst, "thermIntOmegaSpringConst", 13.5); | 
| 111 | chrisfen | 716 | DefineOptionalParameterWithDefaultValue(DampingAlpha, "dampingAlpha", 0.2); | 
| 112 | tim | 665 | DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", 0); | 
| 113 | chrisfen | 726 | DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", 0); | 
| 114 | tim | 665 | DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", 1.0); | 
| 115 | tim | 681 | DefineOptionalParameterWithDefaultValue(StatFileFormat, "statFileFormat", "TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY"); | 
| 116 |  |  |  | 
| 117 | gezelter | 2 |  | 
| 118 | tim | 770 | deprecatedKeywords_.insert("nComponents"); | 
| 119 |  |  | deprecatedKeywords_.insert("nZconstraints"); | 
| 120 | gezelter | 2 |  | 
| 121 |  |  | } | 
| 122 |  |  |  | 
| 123 | tim | 770 | Globals::~Globals() { | 
| 124 | tim | 816 | MemoryUtils::deletePointers(components_); | 
| 125 |  |  | MemoryUtils::deletePointers(zconstraints_); | 
| 126 | gezelter | 2 | } | 
| 127 |  |  |  | 
| 128 | tim | 770 | void Globals::validate() { | 
| 129 |  |  | DataHolder::validate(); | 
| 130 | gezelter | 2 |  | 
| 131 | tim | 672 | CheckParameter(ForceField, isNotEmpty()); | 
| 132 |  |  | CheckParameter(TargetTemp, isPositive()); | 
| 133 | gezelter | 765 | CheckParameter(Ensemble, isEqualIgnoreCase(std::string("NVE")) || isEqualIgnoreCase(std::string("NVT")) || isEqualIgnoreCase(std::string("NPTi")) || isEqualIgnoreCase(std::string("NPTf")) || isEqualIgnoreCase(std::string("NPTxyz")) ); | 
| 134 | tim | 672 | CheckParameter(Dt, isPositive()); | 
| 135 |  |  | CheckParameter(RunTime, isPositive()); | 
| 136 |  |  | CheckParameter(InitialConfig, isNotEmpty()); | 
| 137 |  |  | CheckParameter(FinalConfig, isNotEmpty()); | 
| 138 |  |  | CheckParameter(SampleTime, isNonNegative()); | 
| 139 |  |  | CheckParameter(ResetTime, isNonNegative()); | 
| 140 |  |  | CheckParameter(StatusTime, isNonNegative()); | 
| 141 |  |  | CheckParameter(CutoffRadius, isPositive()); | 
| 142 |  |  | CheckParameter(SwitchingRadius, isNonNegative()); | 
| 143 |  |  | CheckParameter(Dielectric, isPositive()); | 
| 144 |  |  | CheckParameter(ThermalTime,  isNonNegative()); | 
| 145 |  |  | CheckParameter(TargetPressure,  isPositive()); | 
| 146 |  |  | CheckParameter(TauThermostat, isPositive()); | 
| 147 |  |  | CheckParameter(TauBarostat, isPositive()); | 
| 148 |  |  | CheckParameter(ZconsTime, isPositive()); | 
| 149 |  |  | CheckParameter(ZconsTol, isPositive()); | 
| 150 |  |  | CheckParameter(Seed, isPositive()); | 
| 151 | gezelter | 765 | CheckParameter(Minimizer, isEqualIgnoreCase(std::string("SD")) || isEqualIgnoreCase(std::string("CG"))); | 
| 152 | tim | 672 | CheckParameter(MinimizerMaxIter, isPositive()); | 
| 153 |  |  | CheckParameter(MinimizerWriteFrq, isPositive()); | 
| 154 |  |  | CheckParameter(MinimizerStepSize, isPositive()); | 
| 155 |  |  | CheckParameter(MinimizerFTol, isPositive()); | 
| 156 |  |  | CheckParameter(MinimizerGTol, isPositive()); | 
| 157 |  |  | CheckParameter(MinimizerLSTol, isPositive()); | 
| 158 |  |  | CheckParameter(MinimizerLSMaxIter, isPositive()); | 
| 159 |  |  | CheckParameter(ZconsGap, isPositive()); | 
| 160 |  |  | CheckParameter(ZconsFixtime, isPositive()); | 
| 161 |  |  | CheckParameter(ThermodynamicIntegrationLambda, isPositive()); | 
| 162 |  |  | CheckParameter(ThermodynamicIntegrationK, isPositive()); | 
| 163 |  |  | CheckParameter(ForceFieldVariant, isNotEmpty()); | 
| 164 |  |  | CheckParameter(ForceFieldFileName, isNotEmpty()); | 
| 165 |  |  | CheckParameter(ThermIntDistSpringConst, isPositive()); | 
| 166 |  |  | CheckParameter(ThermIntThetaSpringConst, isPositive()); | 
| 167 |  |  | CheckParameter(ThermIntOmegaSpringConst, isPositive()); | 
| 168 |  |  | CheckParameter(SurfaceTension, isPositive()); | 
| 169 | gezelter | 765 | CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase(std::string("NONE")) || isEqualIgnoreCase(std::string("SHIFTED_POTENTIAL")) || isEqualIgnoreCase(std::string("SHIFTED_FORCE")) || isEqualIgnoreCase(std::string("REACTION_FIELD"))); | 
| 170 |  |  | CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase(std::string("UNDAMPED")) || isEqualIgnoreCase(std::string("DAMPED"))); | 
| 171 |  |  | CheckParameter(CutoffPolicy, isEqualIgnoreCase(std::string("MIX")) || isEqualIgnoreCase(std::string("MAX")) || isEqualIgnoreCase(std::string("TRADITIONAL"))); | 
| 172 |  |  | CheckParameter(SwitchingFunctionType, isEqualIgnoreCase(std::string("CUBIC")) || isEqualIgnoreCase(std::string("FIFTH_ORDER_POLYNOMIAL"))); | 
| 173 | tim | 672 | //CheckParameter(StatFileFormat,); | 
| 174 |  |  | //CheckParameter(MixingRule,); | 
| 175 |  |  | CheckParameter(OrthoBoxTolerance, isPositive()); | 
| 176 |  |  | CheckParameter(ThermIntDistSpringConst, isPositive()); | 
| 177 |  |  | CheckParameter(ThermIntThetaSpringConst, isPositive()); | 
| 178 |  |  | CheckParameter(ThermIntOmegaSpringConst, isPositive()); | 
| 179 | chrisfen | 716 | CheckParameter(DampingAlpha,isNonNegative()); | 
| 180 | tim | 672 | CheckParameter(SkinThickness, isPositive()); | 
| 181 | gezelter | 2 |  | 
| 182 | tim | 770 | for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) { | 
| 183 |  |  | if (!(*i)->findMoleculeStamp(moleculeStamps_)) { | 
| 184 |  |  | std::cout << "Globals Error: can not find molecule stamp for component" << std::endl; | 
| 185 |  |  | } | 
| 186 |  |  | } | 
| 187 |  |  | } | 
| 188 |  |  |  | 
| 189 |  |  | bool Globals::addComponent(Component* comp) { | 
| 190 |  |  | components_.push_back(comp); | 
| 191 |  |  | return true; | 
| 192 |  |  | } | 
| 193 | gezelter | 2 |  | 
| 194 | tim | 770 | bool Globals::addZConsStamp(ZConsStamp* zcons) { | 
| 195 |  |  | zconstraints_.push_back(zcons); | 
| 196 |  |  | return true; | 
| 197 | gezelter | 2 | } | 
| 198 |  |  |  | 
| 199 | tim | 770 | bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) { | 
| 200 |  |  | std::string molStampName = molStamp->getName(); | 
| 201 |  |  | std::map<std::string, MoleculeStamp*>::iterator i; | 
| 202 |  |  | bool ret = false; | 
| 203 |  |  | i = moleculeStamps_.find(molStampName); | 
| 204 |  |  | if (i == moleculeStamps_.end()) { | 
| 205 |  |  | moleculeStamps_.insert(std::map<std::string, MoleculeStamp*>::value_type(molStampName, molStamp)); | 
| 206 |  |  | ret = true; | 
| 207 |  |  | } else { | 
| 208 | tim | 789 | std::cout << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n"; | 
| 209 | tim | 770 | } | 
| 210 |  |  | return ret; | 
| 211 | gezelter | 2 | } | 
| 212 | tim | 770 |  | 
| 213 |  |  |  | 
| 214 |  |  | } |