ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/io/Globals.cpp
Revision: 1729
Committed: Wed May 30 16:08:07 2012 UTC (12 years, 11 months ago) by jmarr
File size: 16403 byte(s)
Log Message:
resolved

File Contents

# User Rev Content
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     * [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39 gezelter 1665 * [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 tim 770 Globals::Globals() {
55 tim 665 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 gezelter 1126 DefineOptionalParameter(TargetPressure, "targetPressure");
70 tim 665 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 gezelter 1423 DefineOptionalParameter(MinimizerWriteFreq, "minimizerWriteFreq");
79 tim 665 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 gezelter 1078 DefineOptionalParameter(DampingAlpha, "dampingAlpha");
92 tim 665 DefineOptionalParameter(SurfaceTension, "surfaceTension");
93     DefineOptionalParameter(PrintPressureTensor, "printPressureTensor");
94 gezelter 1723 DefineOptionalParameter(PrintHeatFlux, "printHeatFlux");
95 gezelter 1291 DefineOptionalParameter(TaggedAtomPair, "taggedAtomPair");
96     DefineOptionalParameter(PrintTaggedPairDistance, "printTaggedPairDistance");
97 chrisfen 726 DefineOptionalParameter(SwitchingFunctionType, "switchingFunctionType");
98 tim 895 DefineOptionalParameter(HydroPropFile, "HydroPropFile");
99 tim 906 DefineOptionalParameter(Viscosity, "viscosity");
100     DefineOptionalParameter(BeadSize, "beadSize");
101 gezelter 945 DefineOptionalParameter(FrozenBufferRadius, "frozenBufferRadius");
102     DefineOptionalParameter(LangevinBufferRadius, "langevinBufferRadius");
103 chuckv 1095 DefineOptionalParameter(NeighborListNeighbors,"NeighborListNeighbors");
104 chuckv 1306 DefineOptionalParameter(UseMultipleTemperatureMethod, "useMultipleTemperatureMethod");
105 gezelter 1528 DefineOptionalParameter(ElectrostaticSummationMethod, "electrostaticSummationMethod");
106 chuckv 1306 DefineOptionalParameter(MTM_Ce, "MTM_Ce");
107     DefineOptionalParameter(MTM_G, "MTM_G");
108     DefineOptionalParameter(MTM_Io, "MTM_Io");
109     DefineOptionalParameter(MTM_Sigma, "MTM_Sigma");
110     DefineOptionalParameter(MTM_R, "MTM_R");
111 chuckv 1402 DefineOptionalParameter(Alpha, "alpha");
112 gezelter 1327
113 chuckv 1147
114 tim 665 DefineOptionalParameterWithDefaultValue(UsePeriodicBoundaryConditions, "usePeriodicBoundaryConditions", true);
115 gezelter 1126 DefineOptionalParameterWithDefaultValue(UseAtomicVirial, "useAtomicVirial", true);
116 tim 665 DefineOptionalParameterWithDefaultValue(UseInitalTime, "useInitialTime", false);
117     DefineOptionalParameterWithDefaultValue(UseIntialExtendedSystemState, "useInitialExtendedSystemState", false);
118     DefineOptionalParameterWithDefaultValue(OrthoBoxTolerance, "orthoBoxTolerance", 1E-6);
119 gezelter 1528 DefineOptionalParameterWithDefaultValue(CutoffMethod, "cutoffMethod", "SHIFTED_FORCE");
120 gezelter 1078 DefineOptionalParameterWithDefaultValue(ElectrostaticScreeningMethod, "electrostaticScreeningMethod", "DAMPED");
121 gezelter 1528 DefineOptionalParameterWithDefaultValue(Dielectric, "dielectric", 80.0);
122 gezelter 1711 DefineOptionalParameterWithDefaultValue(CompressDumpFile, "compressDumpFile", false);
123     DefineOptionalParameterWithDefaultValue(OutputForceVector, "outputForceVector", false);
124     DefineOptionalParameterWithDefaultValue(OutputParticlePotential, "outputParticlePotential", false);
125 gezelter 1714 DefineOptionalParameterWithDefaultValue(OutputElectricField, "outputElectricField", false);
126     DefineOptionalParameterWithDefaultValue(OutputFluctuatingCharges, "outputFluctuatingCharges", false);
127 tim 665 DefineOptionalParameterWithDefaultValue(SkinThickness, "skinThickness", 1.0);
128 tim 681 DefineOptionalParameterWithDefaultValue(StatFileFormat, "statFileFormat", "TIME|TOTAL_ENERGY|POTENTIAL_ENERGY|KINETIC_ENERGY|TEMPERATURE|PRESSURE|VOLUME|CONSERVED_QUANTITY");
129 gezelter 945 DefineOptionalParameterWithDefaultValue(UseSphericalBoundaryConditions, "useSphericalBoundaryConditions", false);
130 chrisfen 998 DefineOptionalParameterWithDefaultValue(AccumulateBoxDipole, "accumulateBoxDipole", false);
131 tim 681
132 gezelter 1327 DefineOptionalParameterWithDefaultValue(UseRNEMD, "useRNEMD", false);
133 skuang 1367 DefineOptionalParameterWithDefaultValue(RNEMD_exchangeTime, "RNEMD_exchangeTime", 100.0);
134 skuang 1341 DefineOptionalParameterWithDefaultValue(RNEMD_nBins, "RNEMD_nBins", 16);
135 skuang 1367 DefineOptionalParameterWithDefaultValue(RNEMD_logWidth, "RNEMD_logWidth", 16);
136     DefineOptionalParameterWithDefaultValue(RNEMD_exchangeType, "RNEMD_exchangeType", "KineticScale");
137     DefineOptionalParameterWithDefaultValue(RNEMD_targetFlux, "RNEMD_targetFlux", 0.0);
138 gezelter 1722 DefineOptionalParameterWithDefaultValue(RNEMD_targetJzKE, "RNEMD_targetJzKE", 0.0);
139     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpx, "RNEMD_targetJzpx", 0.0);
140     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpy, "RNEMD_targetJzpy", 0.0);
141     DefineOptionalParameterWithDefaultValue(RNEMD_targetJzpz, "RNEMD_targetJzpz", 0.0);
142 gezelter 1331 DefineOptionalParameterWithDefaultValue(RNEMD_objectSelection, "RNEMD_objectSelection", "select all");
143 gezelter 1629 DefineOptionalParameterWithDefaultValue(RNEMD_binShift, "RNEMD_binShift", false);
144 gezelter 1722 DefineOptionalParameterWithDefaultValue(RNEMD_outputTemperature, "RNEMD_outputTemperature", false);
145     DefineOptionalParameterWithDefaultValue(RNEMD_outputVx, "RNEMD_outputVx", false);
146     DefineOptionalParameterWithDefaultValue(RNEMD_outputVy, "RNEMD_outputVy", false);
147 jmarr 1729 // James put this in.
148     DefineOptionalParameterWithDefaultValue(RNEMD_outputDen, "RNEMD_outputDen", false);
149     DefineOptionalParameterWithDefaultValue(RNEMD_outputAh, "RNEMD_outputAh", false);
150     DefineOptionalParameterWithDefaultValue(RNEMD_outputVz, "RNEMD_outputVz", false);
151 gezelter 1722 DefineOptionalParameterWithDefaultValue(RNEMD_outputXyzTemperature, "RNEMD_outputXyzTemperature", false);
152     DefineOptionalParameterWithDefaultValue(RNEMD_outputRotTemperature, "RNEMD_outputRotTemperature", false);
153    
154 cli2 1360 DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false);
155 gezelter 1354 DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in");
156 cli2 1360 DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false);
157 chuckv 1402 DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex");
158 gezelter 1715 DefineOptionalParameterWithDefaultValue(FlucQPropagator, "flucQ.propagator", "NVT");
159     DefineOptionalParameterWithDefaultValue(FlucQFriction, "flucQ.friction", 1600.0);
160     DefineOptionalParameterWithDefaultValue(FlucQTolerance, "flucQ.tolerance", 1.0e-6);
161     DefineOptionalParameterWithDefaultValue(FlucQMaxIterations, "flucQ.maxIterations", 100);
162     DefineOptionalParameterWithDefaultValue(FlucQTargetTemp, "flucQ.targetTemp", 1.0e-6);
163     DefineOptionalParameterWithDefaultValue(FlucQtauThermostat, "flucQ.tauThermostat", 10.0);
164 gezelter 1327
165 gezelter 1078 deprecatedKeywords_.insert("nComponents");
166     deprecatedKeywords_.insert("nZconstraints");
167     deprecatedKeywords_.insert("initialConfig");
168 cli2 1360 deprecatedKeywords_.insert("thermIntDistSpringConst");
169     deprecatedKeywords_.insert("thermIntThetaSpringConst");
170     deprecatedKeywords_.insert("thermIntOmegaSpringConst");
171     deprecatedKeywords_.insert("useSolidThermInt");
172     deprecatedKeywords_.insert("useLiquidThermInt");
173 gezelter 2
174     }
175    
176 tim 770 Globals::~Globals() {
177 tim 816 MemoryUtils::deletePointers(components_);
178     MemoryUtils::deletePointers(zconstraints_);
179 cli2 1360 MemoryUtils::deletePointers(restraints_);
180 gezelter 2 }
181    
182 tim 770 void Globals::validate() {
183     DataHolder::validate();
184 gezelter 2
185 tim 672 CheckParameter(ForceField, isNotEmpty());
186     CheckParameter(TargetTemp, isPositive());
187 gezelter 1629 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"));
188 tim 672 CheckParameter(Dt, isPositive());
189     CheckParameter(RunTime, isPositive());
190     CheckParameter(FinalConfig, isNotEmpty());
191     CheckParameter(SampleTime, isNonNegative());
192     CheckParameter(ResetTime, isNonNegative());
193     CheckParameter(StatusTime, isNonNegative());
194     CheckParameter(CutoffRadius, isPositive());
195     CheckParameter(SwitchingRadius, isNonNegative());
196     CheckParameter(Dielectric, isPositive());
197     CheckParameter(ThermalTime, isNonNegative());
198     CheckParameter(TauThermostat, isPositive());
199     CheckParameter(TauBarostat, isPositive());
200     CheckParameter(ZconsTime, isPositive());
201     CheckParameter(ZconsTol, isPositive());
202     CheckParameter(Seed, isPositive());
203 tim 850 CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG"));
204 tim 672 CheckParameter(MinimizerMaxIter, isPositive());
205 gezelter 1423 CheckParameter(MinimizerWriteFreq, isPositive());
206 tim 672 CheckParameter(MinimizerStepSize, isPositive());
207     CheckParameter(MinimizerFTol, isPositive());
208     CheckParameter(MinimizerGTol, isPositive());
209     CheckParameter(MinimizerLSTol, isPositive());
210     CheckParameter(MinimizerLSMaxIter, isPositive());
211     CheckParameter(ZconsGap, isPositive());
212     CheckParameter(ZconsFixtime, isPositive());
213 chrisfen 979 CheckParameter(ThermodynamicIntegrationLambda, isNonNegative());
214 tim 672 CheckParameter(ThermodynamicIntegrationK, isPositive());
215     CheckParameter(ForceFieldVariant, isNotEmpty());
216     CheckParameter(ForceFieldFileName, isNotEmpty());
217 gezelter 1528 CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE"));
218 gezelter 1576 CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL"));
219 gezelter 1616 CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD"));
220 tim 850 CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED"));
221     CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL"));
222 tim 672 CheckParameter(OrthoBoxTolerance, isPositive());
223 chrisfen 716 CheckParameter(DampingAlpha,isNonNegative());
224 tim 672 CheckParameter(SkinThickness, isPositive());
225 gezelter 945 CheckParameter(Viscosity, isNonNegative());
226     CheckParameter(BeadSize, isPositive());
227     CheckParameter(FrozenBufferRadius, isPositive());
228     CheckParameter(LangevinBufferRadius, isPositive());
229 chuckv 1095 CheckParameter(NeighborListNeighbors, isPositive());
230 skuang 1367 CheckParameter(RNEMD_exchangeTime, isPositive());
231 skuang 1341 CheckParameter(RNEMD_nBins, isPositive() && isEven());
232 gezelter 1722 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"));
233 chuckv 1402 CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape"));
234     CheckParameter(Alpha, isPositive());
235 gezelter 1715 CheckParameter(FlucQPropagator, isEqualIgnoreCase("NVT") || isEqualIgnoreCase("Langevin") || isEqualIgnoreCase("Minimizer") || isEqualIgnoreCase("Exact") );
236     CheckParameter(FlucQFriction, isNonNegative());
237     CheckParameter(FlucQTolerance, isPositive());
238     CheckParameter(FlucQMaxIterations, isPositive());
239     CheckParameter(FlucQTargetTemp, isNonNegative());
240     CheckParameter(FlucQtauThermostat, isPositive());
241 chuckv 1402
242 tim 770 for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) {
243     if (!(*i)->findMoleculeStamp(moleculeStamps_)) {
244 tim 845 std::ostringstream oss;
245     oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl;
246 gezelter 1390 throw OpenMDException(oss.str());
247 tim 770 }
248     }
249     }
250 gezelter 1613
251 tim 770 bool Globals::addComponent(Component* comp) {
252     components_.push_back(comp);
253     return true;
254     }
255 gezelter 2
256 tim 770 bool Globals::addZConsStamp(ZConsStamp* zcons) {
257     zconstraints_.push_back(zcons);
258     return true;
259 gezelter 2 }
260    
261 cli2 1360 bool Globals::addRestraintStamp(RestraintStamp* rest) {
262     restraints_.push_back(rest);
263     return true;
264     }
265    
266 tim 770 bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) {
267     std::string molStampName = molStamp->getName();
268     std::map<std::string, MoleculeStamp*>::iterator i;
269     bool ret = false;
270     i = moleculeStamps_.find(molStampName);
271     if (i == moleculeStamps_.end()) {
272     moleculeStamps_.insert(std::map<std::string, MoleculeStamp*>::value_type(molStampName, molStamp));
273     ret = true;
274     } else {
275 tim 845 std::ostringstream oss;
276     oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n";
277 gezelter 1390 throw OpenMDException(oss.str());
278 tim 770 }
279     return ret;
280 gezelter 2 }
281 tim 770
282    
283     }

Properties

Name Value
svn:keywords Author Id Revision Date