ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/src/io/Globals.cpp
Revision: 1731
Committed: Thu May 31 12:25:30 2012 UTC (12 years, 11 months ago) by gezelter
File size: 13415 byte(s)
Log Message:
Reorganized source directories, added RNEMD and flucQ blocks for
options parsing.

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 cli2 1360 DefineOptionalParameterWithDefaultValue(UseRestraints, "useRestraints", false);
133 gezelter 1354 DefineOptionalParameterWithDefaultValue(Restraint_file, "Restraint_file", "idealCrystal.in");
134 cli2 1360 DefineOptionalParameterWithDefaultValue(UseThermodynamicIntegration, "useThermodynamicIntegration", false);
135 chuckv 1402 DefineOptionalParameterWithDefaultValue(HULL_Method,"HULL_Method","Convex");
136 gezelter 1327
137 gezelter 1078 deprecatedKeywords_.insert("nComponents");
138     deprecatedKeywords_.insert("nZconstraints");
139     deprecatedKeywords_.insert("initialConfig");
140 cli2 1360 deprecatedKeywords_.insert("thermIntDistSpringConst");
141     deprecatedKeywords_.insert("thermIntThetaSpringConst");
142     deprecatedKeywords_.insert("thermIntOmegaSpringConst");
143     deprecatedKeywords_.insert("useSolidThermInt");
144     deprecatedKeywords_.insert("useLiquidThermInt");
145 gezelter 2
146     }
147    
148 tim 770 Globals::~Globals() {
149 tim 816 MemoryUtils::deletePointers(components_);
150     MemoryUtils::deletePointers(zconstraints_);
151 cli2 1360 MemoryUtils::deletePointers(restraints_);
152 gezelter 2 }
153    
154 tim 770 void Globals::validate() {
155     DataHolder::validate();
156 gezelter 2
157 tim 672 CheckParameter(ForceField, isNotEmpty());
158     CheckParameter(TargetTemp, isPositive());
159 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"));
160 tim 672 CheckParameter(Dt, isPositive());
161     CheckParameter(RunTime, isPositive());
162     CheckParameter(FinalConfig, isNotEmpty());
163     CheckParameter(SampleTime, isNonNegative());
164     CheckParameter(ResetTime, isNonNegative());
165     CheckParameter(StatusTime, isNonNegative());
166     CheckParameter(CutoffRadius, isPositive());
167     CheckParameter(SwitchingRadius, isNonNegative());
168     CheckParameter(Dielectric, isPositive());
169     CheckParameter(ThermalTime, isNonNegative());
170     CheckParameter(TauThermostat, isPositive());
171     CheckParameter(TauBarostat, isPositive());
172     CheckParameter(ZconsTime, isPositive());
173     CheckParameter(ZconsTol, isPositive());
174     CheckParameter(Seed, isPositive());
175 tim 850 CheckParameter(Minimizer, isEqualIgnoreCase("SD") || isEqualIgnoreCase("CG"));
176 tim 672 CheckParameter(MinimizerMaxIter, isPositive());
177 gezelter 1423 CheckParameter(MinimizerWriteFreq, isPositive());
178 tim 672 CheckParameter(MinimizerStepSize, isPositive());
179     CheckParameter(MinimizerFTol, isPositive());
180     CheckParameter(MinimizerGTol, isPositive());
181     CheckParameter(MinimizerLSTol, isPositive());
182     CheckParameter(MinimizerLSMaxIter, isPositive());
183     CheckParameter(ZconsGap, isPositive());
184     CheckParameter(ZconsFixtime, isPositive());
185 chrisfen 979 CheckParameter(ThermodynamicIntegrationLambda, isNonNegative());
186 tim 672 CheckParameter(ThermodynamicIntegrationK, isPositive());
187     CheckParameter(ForceFieldVariant, isNotEmpty());
188     CheckParameter(ForceFieldFileName, isNotEmpty());
189 gezelter 1528 CheckParameter(CutoffMethod, isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE"));
190 gezelter 1576 CheckParameter(CutoffPolicy, isEqualIgnoreCase("MIX") || isEqualIgnoreCase("MAX") || isEqualIgnoreCase("TRADITIONAL"));
191 gezelter 1616 CheckParameter(ElectrostaticSummationMethod, isEqualIgnoreCase("NONE") || isEqualIgnoreCase("HARD") || isEqualIgnoreCase("SWITCHED") || isEqualIgnoreCase("SHIFTED_POTENTIAL") || isEqualIgnoreCase("SHIFTED_FORCE") || isEqualIgnoreCase("REACTION_FIELD"));
192 tim 850 CheckParameter(ElectrostaticScreeningMethod, isEqualIgnoreCase("UNDAMPED") || isEqualIgnoreCase("DAMPED"));
193     CheckParameter(SwitchingFunctionType, isEqualIgnoreCase("CUBIC") || isEqualIgnoreCase("FIFTH_ORDER_POLYNOMIAL"));
194 tim 672 CheckParameter(OrthoBoxTolerance, isPositive());
195 chrisfen 716 CheckParameter(DampingAlpha,isNonNegative());
196 tim 672 CheckParameter(SkinThickness, isPositive());
197 gezelter 945 CheckParameter(Viscosity, isNonNegative());
198     CheckParameter(BeadSize, isPositive());
199     CheckParameter(FrozenBufferRadius, isPositive());
200     CheckParameter(LangevinBufferRadius, isPositive());
201 chuckv 1095 CheckParameter(NeighborListNeighbors, isPositive());
202 chuckv 1402 CheckParameter(HULL_Method, isEqualIgnoreCase("Convex") || isEqualIgnoreCase("AlphaShape"));
203     CheckParameter(Alpha, isPositive());
204    
205 tim 770 for(std::vector<Component*>::iterator i = components_.begin(); i != components_.end(); ++i) {
206     if (!(*i)->findMoleculeStamp(moleculeStamps_)) {
207 tim 845 std::ostringstream oss;
208     oss << "Globals Error: can not find molecule stamp for component " << (*i)->getType() << std::endl;
209 gezelter 1390 throw OpenMDException(oss.str());
210 tim 770 }
211     }
212     }
213 gezelter 1613
214 tim 770 bool Globals::addComponent(Component* comp) {
215     components_.push_back(comp);
216     return true;
217     }
218 gezelter 2
219 tim 770 bool Globals::addZConsStamp(ZConsStamp* zcons) {
220     zconstraints_.push_back(zcons);
221     return true;
222 gezelter 2 }
223    
224 cli2 1360 bool Globals::addRestraintStamp(RestraintStamp* rest) {
225     restraints_.push_back(rest);
226     return true;
227     }
228    
229 gezelter 1731 bool Globals::addFluctuatingChargeParameters(FluctuatingChargeParameters* fqp) {
230     if (flucQpars_ != NULL)
231     delete flucQpars_;
232    
233     flucQpars_ = fqp;
234     return true;
235     }
236    
237     bool Globals::addRNEMDParameters(RNEMDParameters* rnemdPars) {
238     if (rnemdPars_ != NULL)
239     delete rnemdPars_;
240    
241     rnemdPars_ = rnemdPars;
242     return true;
243     }
244    
245 tim 770 bool Globals::addMoleculeStamp(MoleculeStamp* molStamp) {
246     std::string molStampName = molStamp->getName();
247     std::map<std::string, MoleculeStamp*>::iterator i;
248     bool ret = false;
249     i = moleculeStamps_.find(molStampName);
250     if (i == moleculeStamps_.end()) {
251     moleculeStamps_.insert(std::map<std::string, MoleculeStamp*>::value_type(molStampName, molStamp));
252     ret = true;
253     } else {
254 tim 845 std::ostringstream oss;
255     oss << "Globals Error: Molecule Stamp " << molStamp->getName() << "appears multiple times\n";
256 gezelter 1390 throw OpenMDException(oss.str());
257 tim 770 }
258     return ret;
259 gezelter 2 }
260 tim 770
261    
262     }

Properties

Name Value
svn:keywords Author Id Revision Date