swigInputConfig.py 40.1 KB
Newer Older
1
2
3
4
5
6
# This file contains all API version specific info.  Should only need editing
# for major changes in the OpenMM API.

# Add base classes missing from the XML input file
MISSING_BASE_CLASSES = {'OpenMMException':'std::exception'}

7
# Doc strings to replace some of the confusing ones generated by swig
8
9
10
11
12
13
14
15
# Indexed by (className, methodName)
DOC_STRINGS = {("Context", "setPositions") :
                "setPositions(self, positions)",
               ("Context", "setVelocities") :
                "setVelocities(self, velocities)"}

# Do not generate wrappers for the following methods.
# Indexed by (className, [methodName [, numParams]])
16
17
18
19
SKIP_METHODS = [('State', 'getPositions'),
                ('State', 'getVelocities'),
                ('State', 'getForces'),
                ('StateBuilder',),
20
                ('Vec3',),
21
                ('OpenMMException',),
22
23
24
25
26
27
28
29
30
31
32
33
                ('AngleInfo',),
                ('ApplyAndersenThermostatKernel',),
                ('ApplyConstraintsKernel',),
                ('ApplyMonteCarloBarostatKernel',),
                ('BondInfo',),
                ('BondParameterInfo',),
                ('CalcAmoebaGeneralizedKirkwoodForceKernel',),
                ('CalcAmoebaMultipoleForceKernel',),
                ('CalcAmoebaTorsionTorsionForceKernel',),
                ('CalcAmoebaVdwForceKernel',),
                ('CalcAmoebaWcaDispersionForceKernel',),
                ('CalcCMAPTorsionForceKernel',),
34
                ('CalcConstantPotentialForceKernel',),
35
                ('CalcCustomBondForceKernel',),
36
                ('CalcCustomCompoundBondForceKernel',),
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
                ('CalcCustomExternalForceKernel',),
                ('CalcCustomAngleForceKernel',),
                ('CalcCustomGBForceKernel',),
                ('CalcCustomHbondForceKernel',),
                ('CalcCustomNonbondedForceKernel',),
                ('CalcCustomTorsionForceKernel',),
                ('CalcForcesAndEnergyKernel',),
                ('CalcGBSAOBCForceKernel',),
                ('CalcHarmonicAngleForceKernel',),
                ('CalcHarmonicBondForceKernel',),
                ('CalcNonbondedForceKernel',),
                ('CalcPeriodicTorsionForceKernel',),
                ('CalcRBTorsionForceKernel',),
                ('ComputationInfo',),
                ('ConstraintInfo',),
                ('CudaKernelFactory',),
53
                ('HipKernelFactory',),
54
                ('ElectrodeInfo',),
55
56
57
58
59
                ('ExceptionInfo',),
                ('ExclusionInfo',),
                ('FunctionInfo',),
                ('GlobalParameterInfo',),
                ('IntegrateBrownianStepKernel',),
60
                ('IntegrateNoseHooverStepKernel',),
61
62
63
                ('IntegrateVariableLangevinStepKernel',),
                ('IntegrateVariableVerletStepKernel',),
                ('IntegrateVerletStepKernel',),
64
                ('IntegrateCustomStepKernel',),
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
                ('Kernel',),
                ('KernelFactory',),
                ('KernelImpl',),
                ('MultipoleInfo',),
                ('ParameterInfo',),
                ('ParticleInfo',),
                ('PeriodicTorsionInfo',),
                ('PerParticleParameterInfo',),
                ('PlatformData',),
                ('RBTorsionInfo',),
                ('RemoveCMMotionKernel',),
                ('SplineFitter',),
                ('TorsionInfo',),
                ('TorsionTorsionGridInfo',),
                ('TorsionTorsionInfo',),
                ('UpdateStateDataKernel',),
                ('VdwInfo',),
                ('WcaDispersionInfo',),
83
                ('Context',  'getIntegrator'),
84
85
                ('Context',  'createCheckpoint'),
                ('Context',  'loadCheckpoint'),
86
                ('CudaPlatform',),
87
                ('HipPlatform',),
88
89
90
91
92
93
                ('Force',    'Force'),
                ('ParticleParameterInfo',),
                ('Platform', 'contextCreated'),
                ('Platform', 'contextDestroyed'),
                ('Platform', 'createKernel'),
                ('Platform', 'registerKernelFactory'),
94
                ('IntegrateRPMDStepKernel',),
95
96
                ('CalcDrudeForceKernel',),
                ('IntegrateDrudeLangevinStepKernel',),
97
                ('IntegrateDrudeSCFStepKernel',),
98
99
                ('XmlSerializer',  'serialize'),
                ('XmlSerializer',  'deserialize'),
100
101
                ("NoseHooverIntegrator", "getAllThermostatedIndividualParticles"),
                ("NoseHooverIntegrator", "getAllThermostatedPairs"),
Peter Eastman's avatar
Peter Eastman committed
102
                ("PythonForce", "PythonForce"),
103
104
]

105
106
107



108
# The build script assumes method args that are non-const references are
109
# used to output values. This list gives exceptions to this rule.
110
111
112
113
114
115
116
NO_OUTPUT_ARGS = [('LocalEnergyMinimizer', 'minimize', 'context'),
                  ('Platform', 'setPropertyValue', 'context'),
                  ('AmoebaTorsionTorsionForce', 'setTorsionTorsionGrid', 'grid'),
                  ('AmoebaVdwForce', 'setParticleExclusions', 'exclusions'),
                  ('AmoebaMultipoleForce', 'addParticle', 'molecularDipole'),
                  ('AmoebaMultipoleForce', 'addParticle', 'molecularQuadrupole'),
                  ('AmoebaMultipoleForce', 'setCovalentMap', 'covalentAtoms'),
117
118
                  ('AmoebaMultipoleForce', 'getElectrostaticPotential', 'context'),
                  ('AmoebaMultipoleForce', 'getInducedDipoles', 'context'),
119
                  ('AmoebaMultipoleForce', 'getLabFramePermanentDipoles', 'context'),
120
                  ('AmoebaMultipoleForce', 'getTotalDipoles', 'context'),
121
                  ('ConstantPotentialForce', 'getCharges', 'context'),
peastman's avatar
peastman committed
122
123
124
125
                  ('HippoNonbondedForce', 'addParticle', 'dipole'),
                  ('HippoNonbondedForce', 'addParticle', 'quadrupole'),
                  ('HippoNonbondedForce', 'getInducedDipoles', 'context'),
                  ('HippoNonbondedForce', 'getLabFramePermanentDipoles', 'context'),
126
127
128
129
130
131
132
133
134
135
]

# SWIG assumes the target language shadow class owns the C++ class
# so by default, when the  shadow class is deleted, the C++ class is also.
# However, if a class is passed to another class, it may be appropriate to
# change this.  The following dict lists the (Class,Methods) for which the
# shadow class should *lose* ownership of the C++ class.
# The list is the argument position(s).
STEAL_OWNERSHIP = {("Platform", "registerPlatform") : [0],
                   ("System", "addForce") : [0],
136
                   ("System", "setVirtualSite") : [1],
137
                   ("ATMForce", "addForce") : [0],
138
                   ("ATMForce", "setParticleTransformation") : [1],
139
140
141
                   ("CustomNonbondedForce", "addTabulatedFunction") : [1],
                   ("CustomGBForce", "addTabulatedFunction") : [1],
                   ("CustomHbondForce", "addTabulatedFunction") : [1],
142
                   ("CustomCentroidBondForce", "addTabulatedFunction") : [1],
143
                   ("CustomCompoundBondForce", "addTabulatedFunction") : [1],
144
                   ("CustomManyParticleForce", "addTabulatedFunction") : [1],
145
146
                   ("CustomCVForce", "addTabulatedFunction") : [1],
                   ("CustomCVForce", "addCollectiveVariable") : [1],
147
                   ("CustomIntegrator", "addTabulatedFunction") : [1],
peastman's avatar
peastman committed
148
                   ("CompoundIntegrator", "addIntegrator") : [0],
149
150
}

151
152
153
154
155
156

REQUIRE_ORDERED_SET = {("CustomNonbondedForce", "addInteractionGroup") : [0, 1],
                       ("CustomNonbondedForce", "setInteractionGroupParameters") : [1, 2],
}


157
158
159
# This is a list of units to attach to return values and method args.
# Indexed by (ClassName, MethodsName)
UNITS = {
160
("*", "getConstraintTolerance") : (None, ()),
161
("*", "getCutoffDistance") : ("unit.nanometers", ()),
162
("*", "setCutoffDistance") : (None, ("unit.nanometers",)),
163
("*", "getSwitchingDistance") : ("unit.nanometers", ()),
164
165
166
167
168
("*", "setSwitchingDistance") : (None, ("unit.nanometers",)),
("*", "getDefaultCollisionFrequency") : ("unit.picosecond**-1", ()),
("*", "setDefaultCollisionFrequency") : (None, ("unit.picosecond**-1",)),
("*", "getDefaultPeriodicBoxVectors") : (None, ("unit.nanometer", "unit.nanometer", "unit.nanometer")),
("*", "setDefaultPeriodicBoxVectors") : (None, ("unit.nanometer", "unit.nanometer", "unit.nanometer")),
169
("*", "getDefaultPressure") : ("unit.bar", ()),
Lee-Ping's avatar
Lee-Ping committed
170
171
172
("*", "getDefaultPressureX") : ("unit.bar", ()),
("*", "getDefaultPressureY") : ("unit.bar", ()),
("*", "getDefaultPressureZ") : ("unit.bar", ()),
173
174
175
176
("*", "setDefaultPressure") : (None, ("unit.bar",)),
("*", "setDefaultPressureX") : (None, ("unit.bar",)),
("*", "setDefaultPressureY") : (None, ("unit.bar",)),
("*", "setDefaultPressureZ") : (None, ("unit.bar",)),
177
("*", "getDefaultSurfaceTension") : ("unit.bar*unit.nanometer", ()),
178
("*", "setDefaultSurfaceTension") : (None, ("unit.bar*unit.nanometer",)),
Peter Eastman's avatar
Peter Eastman committed
179
("*", "computeCurrentPressure") : ("unit.bar", ()),
180
("*", "getDefaultTemperature") : ("unit.kelvin", ()),
181
("*", "setDefaultTemperature") : (None, ("unit.kelvin",)),
182
("*", "getRelativeTemperature") : ("unit.kelvin", ()),
183
184
("*", "getErrorTolerance") : (None, ()),
("*", "getEwaldErrorTolerance") : (None, ()),
185
186
("*", "getFriction") : ("unit.picosecond**-1", ()),
("*", "setFriction") : (None, ("unit.picosecond**-1",)),
187
("*", "getGlobalVariable") : (None, ()),
Robert McGibbon's avatar
Robert McGibbon committed
188
("*", "getGlobalVariableByName") : (None, ()),
189
190
191
192
193
194
195
196
197
198
199
200
201
202
("*", "getIntegrator") : (None, ()),
("*", "getMapParameters") : (None, ()),
("*", "getName") : (None, ()),
("*", "getNumAngles") : (None, ()),
("*", "getNumBonds") : (None, ()),
("*", "getNumConstraints") : (None, ()),
("*", "getNumExceptions") : (None, ()),
("*", "getNumForces") : (None, ()),
("*", "getNumMaps") : (None, ()),
("*", "getNumParticles") : (None, ()),
("*", "getNumPlatforms") : (None, ()),
("*", "getNumTorsions") : (None, ()),
("*", "getOpenMMVersion") : (None, ()),
("*", "getParticleMass") : ("unit.amu", ()),
203
("*", "setParticleMass") : (None, (None, "unit.amu")),
204
205
("*", "getPlatform") : (None, ()),
("*", "getPlatformByName") : (None, ()),
Robert McGibbon's avatar
Robert McGibbon committed
206
("*", "getPluginLoadFailures"): (None, ()),
207
("*", "getRandomNumberSeed") : (None, ()),
208
209
210
("*", "getReactionFieldDielectric") : (None, ()),
("*", "getSoluteDielectric") : (None, ()),
("*", "getSolventDielectric") : (None, ()),
211
("*", "getStepSize") : ("unit.picosecond", ()),
212
("*", "setStepSize") : (None, ("unit.picosecond",)),
213
("*", "getMaximumStepSize") : ("unit.picosecond", ()),
214
("*", "setMaximumStepSize") : (None, ("unit.picosecond",)),
215
("*", "getSystem") : (None, ()),
216
("*", "getTabulatedFunction") : (None, ()),
217
218
("*", "getUseDispersionCorrection") : (None, ()),
("*", "getTemperature") : ("unit.kelvin", ()),
219
220
("*", "getCollisionFrequency") : ( "unit.picosecond**-1", ()),
("*", "getRelativeCollisionFrequency") : ( "unit.picosecond**-1", ()),
221
("*", "getUseDispersionCorrection") : (None, ()),
222
223
224
225
("*", "getWeight") : (None, ()),
("*", "getWeight12") : (None, ()),
("*", "getWeight13") : (None, ()),
("*", "getWeightCross") : (None, ()),
226
227
("*", "getNonbondedMethod") : (None, ()),
("*", "getGlobalParameterDefaultValue") : (None, ()),
228
("*", "getPermutationMode") : (None, ()),
229
("*", "computeSystemTemperature") : ("unit.kelvin", ()),
230
("*", "computeDrudeTemperature") : ("unit.kelvin", ()),
231
232
233
234
("LocalCoordinatesSite", "getOriginWeights") : (None, ()),
("LocalCoordinatesSite", "getXWeights") : (None, ()),
("LocalCoordinatesSite", "getYWeights") : (None, ()),
("LocalCoordinatesSite", "getLocalPosition") : ("unit.nanometer", ()),
235
("SymmetrySite", "getOffsetVector") : (None, ()),
236
237
238
239
240
("SerializationNode", "getChildren") : (None, ()),
("SerializationNode", "getChildNode") : (None, ()),
("SerializationNode", "getProperties") : (None, ()),
("SerializationNode", "getStringProperty") : (None, ()),
("SerializationNode", "getIntProperty") : (None, ()),
241
("SerializationNode", "getLongProperty") : (None, ()),
242
243
244
245
246
("SerializationNode", "getDoubleProperty") : (None, ()),
("SerializationProxy", "getProxy") : (None, ()),
("SerializationProxy", "getTypeName") : (None, ()),

# check getSurfaceAreaFactor
247
("AmoebaGeneralizedKirkwoodForce",       "getParticleParameters")                         :  (None, ('unit.elementary_charge', 'unit.nanometer', None, 'unit.nanometer', None)),
248
("AmoebaGeneralizedKirkwoodForce",       "getDielectricOffset")                           :  ( 'unit.nanometer', ()),
249
250
("AmoebaGeneralizedKirkwoodForce",       "getSolventDielectric")                          :  (None, ()),
("AmoebaGeneralizedKirkwoodForce",       "getSoluteDielectric")                           :  (None, ()),
251
("AmoebaGeneralizedKirkwoodForce",       "getIncludeCavityTerm")                          :  ( None,()),
252
253
254
("AmoebaGeneralizedKirkwoodForce",       "getTanhRescaling")                              :  ( None,()),
("AmoebaGeneralizedKirkwoodForce",       "getTanhParameters")                             : ( None,(None, None, None)),
("AmoebaGeneralizedKirkwoodForce",       "getDescreenOffset")                             :  ( 'unit.nanometer', ()),
255
("AmoebaGeneralizedKirkwoodForce",       "getProbeRadius")                                :  ( 'unit.nanometer', ()),
256
("AmoebaGeneralizedKirkwoodForce",       "getSurfaceAreaFactor")                          :  ( 'unit.kilojoule_per_mole/(unit.nanometer*unit.nanometer)',()),
257

258

259
("AmoebaMultipoleForce",                 "getNumMultipoles")                              :  ( None,()),
260
("AmoebaMultipoleForce",                 "getPolarizationType")                           :  ( None,()),
261
262
263
264
265
("AmoebaMultipoleForce",                 "getCutoffDistance")                             :  (  'unit.nanometer',()),
("AmoebaMultipoleForce",                 "getAEwald")                                     :  (  '1/unit.nanometer',()),
("AmoebaMultipoleForce",                 "getPmeBSplineOrder")                            :  ( None,()),
("AmoebaMultipoleForce",                 "getMutualInducedMaxIterations")                 :  ( None, ()),
("AmoebaMultipoleForce",                 "getMutualInducedTargetEpsilon")                 :  ( None, ()),
266
("AmoebaMultipoleForce",                 "getExtrapolationCoefficients")                            :  ( None, ()),
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
("AmoebaMultipoleForce",                 "getEwaldErrorTolerance")                        :  ( None, ()),
("AmoebaMultipoleForce",                 "getPmeGridDimensions")                          :  ( None,()),

# AmoebaMultipoleForce methods starting w/ getMultipoleParameters need work

# dipoleConversion        = AngstromToNm;
# quadrupoleConversion    = AngstromToNm*AngstromToNm;
# polarityConversion      = AngstromToNm*AngstromToNm*AngstromToNm;
# dampingFactorConversion = sqrt( AngstromToNm );

#    void getMultipoleParameters(int index, double& charge, std::vector<double>& molecularDipole, std::vector<double>& molecularQuadrupole,
#                                int& axisType, int& multipoleAtomZ, int& multipoleAtomX, int& multipoleAtomY, double& thole, double& dampingFactor, double& polarity ) const;
#    void getCovalentMap(int index, CovalentType typeId, std::vector<int>& covalentAtoms )
#    void getCovalentMaps(int index, std::vector < std::vector<int> >& covalentLists )

282
283
("AmoebaMultipoleForce",                 "getMultipoleParameters")                        :  ( None, ('unit.elementary_charge', 'unit.elementary_charge*unit.nanometer',
                                                                                                      'unit.elementary_charge*unit.nanometer**2', None, None, None, None, None, None,
284
                                                                                                      'unit.nanometer**3')),
285
286
287
288
("AmoebaMultipoleForce",                 "getCovalentMap")                                :  ( None, ()),
("AmoebaMultipoleForce",                 "getCovalentMaps")                               :  ( None, ()),
("AmoebaMultipoleForce",                 "getScalingDistanceCutoff")                      :  ( 'unit.nanometer', ()),
("AmoebaMultipoleForce",                 "getElectricConstant")                           :  ( None, ()),
289
290
291
#("AmoebaMultipoleForce",                 "getElectrostaticPotential")                     :  ( None, ('unit.kilojoule_per_mole')),
#("AmoebaMultipoleForce",                 "getElectrostaticPotential")                     :  ( ('unit.kilojoule_per_mole'), ()),
("AmoebaMultipoleForce",                 "getElectrostaticPotential")                     :  ( None, ()),
292
("AmoebaMultipoleForce",                 "getInducedDipoles")                             :  ( None, ()),
293
("AmoebaMultipoleForce",                 "getLabFramePermanentDipoles")                   :  ( None, ()),
294
("AmoebaMultipoleForce",                 "getTotalDipoles")                               :  ( None, ()),
295
("AmoebaMultipoleForce",                 "getSystemMultipoleMoments")                     :  ( None, ()),
296
297
298
299
300
301
302
303
304

("AmoebaTorsionTorsionForce",             "getNumTorsionTorsions")                         :  ( None, ()),
("AmoebaTorsionTorsionForce",             "getNumTorsionTorsionGrids")                     :  ( None, ()),
("AmoebaTorsionTorsionForce",             "getTorsionTorsionParameters")                   :  ( None, ()),
("AmoebaTorsionTorsionForce",             "getTorsionTorsionGrid")                         :  ( None, ()),

("AmoebaVdwForce",                        "getSigmaCombiningRule")                         :  ( None, ()),
("AmoebaVdwForce",                        "getEpsilonCombiningRule")                       :  ( None, ()),
("AmoebaVdwForce",                        "getParticleExclusions")                         :  ( None, ()),
305
("AmoebaVdwForce",                        "getAlchemicalMethod")                           :  ( None, ()),
306
("AmoebaVdwForce",                        "getPotentialFunction")                          :  ( None, ()),
307
308
("AmoebaVdwForce",                        "getSoftcorePower")                              :  ( None, ()),
("AmoebaVdwForce",                        "getSoftcoreAlpha")                              :  ( None, ()),
309
("AmoebaVdwForce",                        "getCutoff")                                     :  ( 'unit.nanometer', ()),
310
("AmoebaVdwForce",                        "getParticleParameters")                         :  ( None, (None, 'unit.nanometer', 'unit.kilojoule_per_mole', None, None, None, None)),
311
312
("AmoebaVdwForce",                        "getParticleTypeParameters")                     :  ( None, ('unit.nanometer', 'unit.kilojoule_per_mole')),
("AmoebaVdwForce",                        "getTypePairParameters")                         :  ( None, (None, None, 'unit.nanometer', 'unit.kilojoule_per_mole')),
313
314
315
316
317
318
319
320
321
322
323

("AmoebaWcaDispersionForce",              "getParticleParameters")                         :  ( None, ('unit.nanometer', 'unit.kilojoule_per_mole')),
("AmoebaWcaDispersionForce",              "getAwater")                                     :  ( '1/(unit.nanometer*unit.nanometer*unit.nanometer)',()),
("AmoebaWcaDispersionForce",              "getDispoff")                                    :  ( 'unit.nanometer',()),
("AmoebaWcaDispersionForce",              "getRmino")                                      :  ( 'unit.nanometer',()),
("AmoebaWcaDispersionForce",              "getRminh")                                      :  ( 'unit.nanometer',()),
("AmoebaWcaDispersionForce",              "getEpso")                                       :  ( 'unit.kilojoule_per_mole',()),
("AmoebaWcaDispersionForce",              "getEpsh")                                       :  ( 'unit.kilojoule_per_mole',()),
("AmoebaWcaDispersionForce",              "getSlevy")                                      :  ( None, ()),
("AmoebaWcaDispersionForce",              "getShctd")                                      :  ( None, ()),

peastman's avatar
peastman committed
324
325
326
327
328
329
("HippoNonbondedForce",                 "getExtrapolationCoefficients")                  :  ( None, ()),
("HippoNonbondedForce",                 "getParticleParameters")                         :  ( None, ('unit.elementary_charge', 'unit.elementary_charge*unit.nanometer',
                                                                                                      'unit.elementary_charge*unit.nanometer**2', 'unit.elementary_charge',
                                                                                                       None, None, None, None, None, None, None, None, None, None, None, None)),
("HippoNonbondedForce",                 "getInducedDipoles")                             :  ( None, ()),
("HippoNonbondedForce",                 "getLabFramePermanentDipoles")                   :  ( None, ()),
330
    
331
("Context", "getParameter") : (None, ()),
332
("Context", "getParameters") : (None, ()),
333
("Context", "getMolecules") : (None, ()),
334
("Context", "getState") : (None, (None, None, None)),
335
336
("Context", "setPeriodicBoxVectors") : (None, ("unit.nanometer", "unit.nanometer", "unit.nanometer")),
("Context", "setPositions") : (None, ("unit.nanometer",)),
337
("Context", "getTime") : ("unit.picosecond", ()),
338
("Context", "setTime") : (None, ("unit.picosecond",)),
339
340
("Context", "getStepCount") : (None, ()),
("Context", "setStepCount") : (None, (None,)),
341
342
343
("Context", "setVelocities") : (None, ("unit.nanometer/unit.picosecond",)),
("CMAPTorsionForce", "getMapParameters") : (None, (None, "unit.kilojoule_per_mole")),
("CMAPTorsionForce", "setMapParameters") : (None, (None, None, "unit.kilojoule_per_mole")),
344
345
("CMAPTorsionForce", "getTorsionParameters") : (None, ()),
("CMMotionRemover", "getFrequency") : (None, ()),
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
("ConstantPotentialForce", "getPMEParameters") : (None, ("unit.nanometer**-1", None, None, None)),
("ConstantPotentialForce", "setPMEParameters") : (None, ("unit.nanometer**-1", None, None, None)),
("ConstantPotentialForce", "addException") : (None, (None, None, "unit.elementary_charge*unit.elementary_charge")),
("ConstantPotentialForce", "getExceptionParameters") : (None, (None, None, "unit.elementary_charge*unit.elementary_charge")),
("ConstantPotentialForce", "setExceptionParameters") : (None, (None, None, None, "unit.elementary_charge*unit.elementary_charge")),
("ConstantPotentialForce", "addParticle") : (None, ("unit.elementary_charge",)),
("ConstantPotentialForce", "getParticleParameters") : ("unit.elementary_charge", ()),
("ConstantPotentialForce", "setParticleParameters") : (None, (None, "unit.elementary_charge",)),
("ConstantPotentialForce", "getConstantPotentialMethod") : (None, ()),
("ConstantPotentialForce", "setConstantPotentialMethod") : (None, (None,)),
("ConstantPotentialForce", "getUsePreconditioner") : (None, ()),
("ConstantPotentialForce", "setUsePreconditioner") : (None, (None,)),
("ConstantPotentialForce", "getCGErrorTolerance") : ("unit.kilojoule_per_mole/unit.elementary_charge", ()),
("ConstantPotentialForce", "setCGErrorTolerance") : (None, ("unit.kilojoule_per_mole/unit.elementary_charge",)),
("ConstantPotentialForce", "addElectrode") : (None, (None, "unit.kilojoule_per_mole/unit.elementary_charge", "unit.nanometer", "unit.nanometer**-1")),
("ConstantPotentialForce", "getElectrodeParameters") : (None, (None, "unit.kilojoule_per_mole/unit.elementary_charge", "unit.nanometer", "unit.nanometer**-1")),
("ConstantPotentialForce", "setElectrodeParameters") : (None, (None, None, "unit.kilojoule_per_mole/unit.elementary_charge", "unit.nanometer", "unit.nanometer**-1")),
("ConstantPotentialForce", "getUseChargeConstraint") : (None, ()),
("ConstantPotentialForce", "setUseChargeConstraint") : (None, (None,)),
("ConstantPotentialForce", "getChargeConstraintTarget") : ("unit.elementary_charge", ()),
("ConstantPotentialForce", "setChargeConstraintTarget") : (None, ("unit.elementary_charge",)),
("ConstantPotentialForce", "getExternalField") : ("unit.kilojoule_per_mole/(unit.nanometer*unit.elementary_charge)", ()),
("ConstantPotentialForce", "setExternalField") : (None, ("unit.kilojoule_per_mole/(unit.nanometer*unit.elementary_charge)",)),
("ConstantPotentialForce", "getCharges") : ("unit.elementary_charge", ()),
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
("CustomAngleForce", "getNumPerAngleParameters") : (None, ()),
("CustomAngleForce", "getNumGlobalParameters") : (None, ()),
("CustomAngleForce", "getEnergyFunction") : (None, ()),
("CustomAngleForce", "getPerAngleParameterName") : (None, ()),
("CustomAngleForce", "getGlobalParameterName") : (None, ()),
("CustomAngleForce", "getAngleParameters") : (None, ()),
("CustomBondForce", "getNumPerBondParameters") : (None, ()),
("CustomBondForce", "getNumGlobalParameters") : (None, ()),
("CustomBondForce", "getEnergyFunction") : (None, ()),
("CustomBondForce", "getPerBondParameterName") : (None, ()),
("CustomBondForce", "getGlobalParameterName") : (None, ()),
("CustomBondForce", "getBondParameters") : (None, ()),
("CustomExternalForce", "getNumPerParticleParameters") : (None, ()),
("CustomExternalForce", "getNumGlobalParameters") : (None, ()),
("CustomExternalForce", "getEnergyFunction") : (None, ()),
("CustomExternalForce", "getPerParticleParameterName") : (None, ()),
("CustomExternalForce", "getGlobalParameterName") : (None, ()),
("CustomExternalForce", "getParticleParameters") : (None, ()),
("CustomGBForce", "getNumExclusions") : (None, ()),
("CustomGBForce", "getNumPerParticleParameters") : (None, ()),
("CustomGBForce", "getNumGlobalParameters") : (None, ()),
("CustomGBForce", "getNumFunctions") : (None, ()),
("CustomGBForce", "getNumComputedValues") : (None, ()),
("CustomGBForce", "getNumEnergyTerms") : (None, ()),
("CustomGBForce", "getPerParticleParameterName") : (None, ()),
("CustomGBForce", "getGlobalParameterName") : (None, ()),
("CustomGBForce", "getParticleParameters") : (None, ()),
("CustomGBForce", "getComputedValueParameters") : (None, ()),
("CustomGBForce", "getEnergyTermParameters") : (None, ()),
("CustomGBForce", "getExclusionParticles") : (None, ()),
("CustomGBForce", "getFunctionParameters") : (None, ()),
("CustomHbondForce", "getAcceptorParameters") : (None, ()),
("CustomHbondForce", "getDonorParameters") : (None, ()),
("CustomHbondForce", "getEnergyFunction") : (None, ()),
("CustomHbondForce", "getExclusionParticles") : (None, ()),
("CustomHbondForce", "getFunctionParameters") : (None, ()),
("CustomHbondForce", "getNumAcceptors") : (None, ()),
("CustomHbondForce", "getNumDonors") : (None, ()),
("CustomHbondForce", "getNumExclusions") : (None, ()),
("CustomHbondForce", "getNumFunctions") : (None, ()),
("CustomHbondForce", "getNumGlobalParameters") : (None, ()),
("CustomHbondForce", "getNumPerAcceptorParameters") : (None, ()),
("CustomHbondForce", "getNumPerDonorParameters") : (None, ()),
("CustomHbondForce", "getGlobalParameterName") : (None, ()),
("CustomHbondForce", "getPerAcceptorParameterName") : (None, ()),
("CustomHbondForce", "getPerDonorParameterName") : (None, ()),
("CustomNonbondedForce", "getEnergyFunction") : (None, ()),
("CustomNonbondedForce", "getExceptionParameters") : (None, ()),
("CustomNonbondedForce", "getExclusionParticles") : (None, ()),
("CustomNonbondedForce", "getFunctionParameters") : (None, ()),
("CustomNonbondedForce", "getGlobalParameterName") : (None, ()),
("CustomNonbondedForce", "getNumExclusions") : (None, ()),
("CustomNonbondedForce", "getNumFunctions") : (None, ()),
("CustomNonbondedForce", "getNumPerParticleParameters") : (None, ()),
("CustomNonbondedForce", "getNumParameters") : (None, ()),
("CustomNonbondedForce", "getNumGlobalParameters") : (None, ()),
("CustomNonbondedForce", "getParameterCombiningRule") : (None, ()),
("CustomNonbondedForce", "getParameterName") : (None, ()),
("CustomNonbondedForce", "getParticleParameters") : (None, ()),
("CustomNonbondedForce", "getPerParticleParameterName") : (None, ()),
("CustomTorsionForce", "getNumPerTorsionParameters") : (None, ()),
("CustomTorsionForce", "getNumGlobalParameters") : (None, ()),
("CustomTorsionForce", "getEnergyFunction") : (None, ()),
("CustomTorsionForce", "getPerTorsionParameterName") : (None, ()),
("CustomTorsionForce", "getGlobalParameterName") : (None, ()),
("CustomTorsionForce", "getTorsionParameters") : (None, ()),
436
437
("CustomCVForce", "getCollectiveVariable") : (None, ()),
("CustomCVForce", "getInnerContext") : (None, ()),
438
439
440
("DrudeForce", "addParticle") : (None, (None, None, None, None, None, "unit.elementary_charge", "unit.nanometer**3", None, None)),
("DrudeForce", "getParticleParameters") : (None, (None, None, None, None, None, "unit.elementary_charge", "unit.nanometer**3", None, None)),
("DrudeForce", "setParticleParameters") : (None, (None, None, None, None, None, None, "unit.elementary_charge", "unit.nanometer**3", None, None)),
441
442
("DrudeForce", "getNumScreenedPairs") : (None, ()),
("DrudeForce", "getScreenedPairParameters") : (None, ()),
443
444
445
446
447
448
449
450
451
452
453
("GBSAOBCForce", "addParticle") : (None, ("unit.elementary_charge", "unit.nanometer", None)),
("GBSAOBCForce", "getParticleParameters") : (None, ("unit.elementary_charge", "unit.nanometer", None)),
("GBSAOBCForce", "setParticleParameters") : (None, (None, "unit.elementary_charge", "unit.nanometer", None)),
("GBSAOBCForce", "getSurfaceAreaEnergy") : ("unit.kilojoule_per_mole/unit.nanometer/unit.nanometer", ()),
("GBSAOBCForce", "setSurfaceAreaEnergy") : (None, ("unit.kilojoule_per_mole/unit.nanometer/unit.nanometer",)),
("HarmonicAngleForce", "addAngle") : (None, (None, None, None, "unit.radian", "unit.kilojoule_per_mole/(unit.radian*unit.radian)")),
("HarmonicAngleForce", "getAngleParameters") : (None, (None, None, None, "unit.radian", "unit.kilojoule_per_mole/(unit.radian*unit.radian)")),
("HarmonicAngleForce", "setAngleParameters") : (None, (None, None, None, None, "unit.radian", "unit.kilojoule_per_mole/(unit.radian*unit.radian)")),
("HarmonicBondForce", "addBond") : (None, (None, None, "unit.nanometer", "unit.kilojoule_per_mole/(unit.nanometer*unit.nanometer)")),
("HarmonicBondForce", "getBondParameters") : (None, (None, None, "unit.nanometer", "unit.kilojoule_per_mole/(unit.nanometer*unit.nanometer)")),
("HarmonicBondForce", "setBondParameters") : (None, (None, None, None, "unit.nanometer", "unit.kilojoule_per_mole/(unit.nanometer*unit.nanometer)")),
Evan Pretti's avatar
Evan Pretti committed
454
455
456
457
458
("LCPOForce", "getSurfaceTension") : ("unit.kilojoule_per_mole/unit.nanometer**2", ()),
("LCPOForce", "setSurfaceTension") : (None, ("unit.kilojoule_per_mole/unit.nanometer**2",)),
("LCPOForce", "addParticle") : (None, ("unit.nanometer", None, None, None, "unit.nanometer**-2")),
("LCPOForce", "getParticleParameters") : (None, ("unit.nanometer", None, None, None, "unit.nanometer**-2")),
("LCPOForce", "setParticleParameters") : (None, (None, "unit.nanometer", None, None, None, "unit.nanometer**-2")),
459
("MonteCarloBarostat", "getFrequency") : (None, ()),
Lee-Ping's avatar
Lee-Ping committed
460
("MonteCarloAnisotropicBarostat", "getFrequency") : (None, ()),
461
462
463
464
465
466
467
468
469
470
471
472
473
474
("NonbondedForce", "getPMEParameters") : (None, ("unit.nanometer**-1", None, None, None)),
("NonbondedForce", "setPMEParameters") : (None, ("unit.nanometer**-1", None, None, None)),
("NonbondedForce", "addException") : (None, (None, None, "unit.elementary_charge*unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("NonbondedForce", "getExceptionParameters") : (None, (None, None, "unit.elementary_charge*unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("NonbondedForce", "setExceptionParameters") : (None, (None, None, None, "unit.elementary_charge*unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("NonbondedForce", "addParticle") : (None, ("unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("NonbondedForce", "getParticleParameters") : (None, ("unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("NonbondedForce", "setParticleParameters") : (None, (None, "unit.elementary_charge", "unit.nanometer", "unit.kilojoule_per_mole")),
("PeriodicTorsionForce", "addTorsion") : (None, (None, None, None, None, None, "unit.radian", "unit.kilojoule_per_mole")),
("PeriodicTorsionForce", "getTorsionParameters") : (None, (None, None, None, None, None, "unit.radian", "unit.kilojoule_per_mole")),
("PeriodicTorsionForce", "setTorsionParameters") : (None, (None, None, None, None, None, None, "unit.radian", "unit.kilojoule_per_mole")),
("GayBerneForce", "addParticle") : (None, ("unit.nanometer", "unit.kilojoule_per_mole", None, None, "unit.nanometer", "unit.nanometer", "unit.nanometer", None, None, None)),
("GayBerneForce", "getParticleParameters") : (None, ("unit.nanometer", "unit.kilojoule_per_mole", None, None, "unit.nanometer", "unit.nanometer", "unit.nanometer", None, None, None)),
("GayBerneForce", "setParticleParameters") : (None, (None, "unit.nanometer", "unit.kilojoule_per_mole", None, None, "unit.nanometer", "unit.nanometer", "unit.nanometer", None, None, None)),
475
("Platform", "getDevices") : (None, (None,)),
476
477
478
479
480
("Platform", "getDefaultPluginsDirectory") : (None, ()),
("Platform", "getPropertyDefaultValue") : (None, ()),
("Platform", "getPropertyNames") : (None, ()),
("Platform", "getPropertyValue") : (None, ()),
("Platform", "getSpeed") : (None, ()),
481
482
483
484
("RBTorsionForce", "addTorsion") : (None, (None, None, None, None, "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole")),
("RBTorsionForce", "getTorsionParameters") : (None, (None, None, None, None, "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole")),
("RBTorsionForce", "setTorsionParameters") : (None, (None, None, None, None, None, "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole", "unit.kilojoules_per_mole")),
("State", "getTime") : ("unit.picosecond", ()),
485
("State", "getStepCount") : (None, ()),
486
487
488
489
("State", "getKineticEnergy") : ("unit.kilojoules_per_mole", ()),
("State", "getPotentialEnergy") : ("unit.kilojoules_per_mole", ()),
("State", "getPeriodicBoxVolume") : ("unit.nanometers**3", ()),
("State", "getPeriodicBoxVectors") : ("unit.nanometers", ()),
490
491
("State", "getParameters") : (None, ()),
("State", "getEnergyParameterDerivatives") : (None, ()),
492
493
494
495
("System", "addParticle") : (None, ("unit.amu",)),
("System", "addConstraint") : (None, (None, None, "unit.nanometer")),
("System", "getConstraintParameters") : (None, (None, None, "unit.nanometer")),
("System", "setConstraintParameters") : (None, (None, None, None, "unit.nanometer")),
496
497
("System", "getForce") : (None, ()),
("System", "getVirtualSite") : (None, ()),
498
499
500
501
502
503
504
505
506
507
508
509
("AndersenThemostat", "AndersenThemostat") : (None, ("unit.kelvin", "unit.picosecond**-1")),
("MonteCarloAnisotropicBarostat", "MonteCarloAnisotropicBarostat") : (None, ("unit.bar", "unit.kelvin", None, None, None, None)),
("MonteCarloBarostat", "MonteCarloBarostat") : (None, ("unit.bar", "unit.kelvin", None)),
("MonteCarloMembraneBarostat", "MonteCarloMembraneBarostat") : (None, ("unit.bar", "unit.bar*unit.nanometer", "unit.kelvin", None, None, None)),
("MonteCarloMembraneBarostat", "getXYMode") : (None, ()),
("MonteCarloMembraneBarostat", "getZMode") : (None, ()),
("CustomIntegrator", "CustomIntegrator") : (None, ("unit.picosecond",)),
("BrownianIntegrator", "BrownianIntegrator") : (None, ("unit.kelvin", "unit.picosecond**-1", "unit.picosecond")),
("LangevinIntegrator", "LangevinIntegrator") : (None, ("unit.kelvin", "unit.picosecond**-1", "unit.picosecond")),
("LangevinMiddleIntegrator", "LangevinMiddleIntegrator") : (None, ("unit.kelvin", "unit.picosecond**-1", "unit.picosecond")),
("VariableLangevinIntegrator", "VariableLangevinIntegrator") : (None, ("unit.kelvin", "unit.picosecond**-1", None)),
("VerletIntegrator", "VerletIntegrator") : (None, ("unit.picosecond",)),
510
("DrudeIntegrator", "getDrudeTemperature") : ("unit.kelvin", ()),
511
("DrudeIntegrator", "setDrudeTemperature") : (None, ("unit.kelvin",)),
512
("DrudeIntegrator", "getMaxDrudeDistance") : ("unit.nanometer", ()),
513
("DrudeIntegrator", "setMaxDrudeDistance") : (None, ("unit.nanometer",)),
514
("DrudeLangevinIntegrator", "getDrudeTemperature") : ("unit.kelvin", ()),
515
("DrudeLangevinIntegrator", "setDrudeTemperature") : (None, ("unit.kelvin",)),
516
("DrudeLangevinIntegrator", "getMaxDrudeDistance") : ("unit.nanometer", ()),
517
518
("DrudeLangevinIntegrator", "setMaxDrudeDistance") : (None, ("unit.nanometer",)),
("DrudeNoseHooverIntegrator", "getVelocitiesForTemperature") : ("unit.nanometers / unit.picosecond", (None, "unit.kelvin", None)),
Andy Simmonett's avatar
Andy Simmonett committed
519
("DrudeLangevinIntegrator", "getDrudeFriction") : ("unit.picosecond**-1", ()),
520
("DrudeLangevinIntegrator", "setDrudeFriction") : (None, ("unit.picosecond**-1",)),
521
("DrudeSCFIntegrator", "getMinimizationErrorTolerance") : ("unit.kilojoules_per_mole/unit.nanometer", ()),
522
("DrudeSCFIntegrator", "setMinimizationErrorTolerance") : (None, ("unit.kilojoules_per_mole/unit.nanometer",)),
523
("RPMDIntegrator", "getContractions") : (None, ()),
524
("RPMDIntegrator", "getTotalEnergy") : ("unit.kilojoules_per_mole", ()),
525
("RPMDIntegrator", "getState"): (None,(None, None, None, None)),
526
("RMSDForce", "getReferencePositions") : ("unit.nanometer", ()),
527
("RMSDForce", "setReferencePositions") : (None, ("unit.nanometer",)),
528
("RMSDForce", "getParticles") : (None, ()),
529
530
531
532
533
("OrientationRestraintForce", "getReferencePositions") : ("unit.nanometer", ()),
("OrientationRestraintForce", "setReferencePositions") : (None, ("unit.nanometer",)),
("OrientationRestraintForce", "getParticles") : (None, ()),
("OrientationRestraintForce", "getK") : ("unit.kilojoules_per_mole", ()),
("OrientationRestraintForce", "setK") : (None, ("unit.kilojoules_per_mole",)),
534
("RGForce", "getParticles") : (None, ()),
535
("NoseHooverChain", "NoseHooverChain") : (None, ("unit.kelvin", "unit.kelvin", "unit.picosecond**-1", "unit.picosecond**-1", None, None, None, None, None, None, None)),
536
537
("NoseHooverChain", "getThermostatedPairs") : (None, ()),
("NoseHooverChain", "getThermostatedAtoms") : (None, ()),
538
("NoseHooverChain", "getYoshidaSuzukiWeights") : (None, ()),
539
540
("NoseHooverIntegrator", "setTemperature") : (None, ("unit.kelvin", None)),
("NoseHooverIntegrator", "setRelativeTemperature") : (None, ("unit.kelvin", None) ),
Andy Simmonett's avatar
Andy Simmonett committed
541
542
("NoseHooverIntegrator", "setCollisionFrequency") : (None, ("unit.picosecond**-1", None)),
("NoseHooverIntegrator", "setRelativeCollisionFrequency") : (None, ("unit.picosecond**-1", None)),
543
("NoseHooverIntegrator", "computeHeatBathEnergy") : ( "unit.kilojoules_per_mole", ()),
Andy Simmonett's avatar
Andy Simmonett committed
544
("NoseHooverIntegrator", "addThermostat"): (None, ("unit.kelvin", "unit.picosecond**-1", None, None, None)),
545
("NoseHooverIntegrator", "addSubsystemThermostat"): (None, (None, None, "unit.kelvin", "unit.picosecond**-1", "unit.kelvin", "unit.picosecond**-1", None, None, None)),
546
547
("NoseHooverIntegrator", "getNumThermostats") : (None, ()),
("NoseHooverIntegrator", "getThermostat") : (None, ()),
548
549
550
551
("NoseHooverIntegrator", "getMaximumPairDistance") : ("unit.nanometer", ()),
("NoseHooverIntegrator", "setMaximumPairDistance") : (None, ("unit.nanometer",)),
("DrudeNoseHooverIntegrator", "getMaxDrudeDistance") : ("unit.nanometer", ()),
("DrudeNoseHooverIntegrator", "setMaxDrudeDistance") : (None, ("unit.nanometer",)),
Peter Eastman's avatar
Peter Eastman committed
552
553
554
555
556
("DPDIntegrator", "getDefaultFriction") : ("unit.picosecond**-1", ()),
("DPDIntegrator", "setDefaultFriction") : (None, ("unit.picosecond**-1",)),
("DPDIntegrator", "getDefaultCutoff") : ("unit.nanometer", ()),
("DPDIntegrator", "setDefaultCutoff") : (None, ("unit.nanometer",)),
("DPDIntegrator", "getParticleTypes") : (None, ()),
557
558
559
560
561
562
563
564
("QTBIntegrator", "getSegmentLength") : ("unit.picosecond", ()),
("QTBIntegrator", "setSegmentLength") : (None, ("unit.picosecond",)),
("QTBIntegrator", "getDefaultAdaptationRate") : (None, ()),
("QTBIntegrator", "setDefaultAdaptationRate") : (None, (None,)),
("QTBIntegrator", "getTypeAdaptationRates") : (None, ()),
("QTBIntegrator", "getParticleTypes") : (None, ()),
("QTBIntegrator", "getCutoffFrequency") : ("unit.picosecond**-1", ()),
("QTBIntegrator", "setCutoffFrequency") : (None, ("unit.picosecond**-1",)),
565
("LocalEnergyMinimizer", "minimize") : (None, (None, "unit.kilojoules_per_mole/unit.nanometer", None)),
566
567
568
569
570
571
572
573
574
575
576
("ATMForce", "getForce") : (None, ()),
("ATMForce", "getPerturbationEnergy") :  ('unit.kilojoule_per_mole', ()),
("ATMForce", "getDefaultLambda1") :  (None, ()),
("ATMForce", "getDefaultLambda2") :  (None, ()),
("ATMForce", "getDefaultAlpha") :  ('unit.kilojoule_per_mole**-1', ()),
("ATMForce", "getDefaultU0") :  ('unit.kilojoule_per_mole', ()),
("ATMForce", "getDefaultW0") :  ('unit.kilojoule_per_mole', ()),
("ATMForce", "getDefaultDirection") :  (None, ()),
("ATMForce", "getDefaultUmax") :  ('unit.kilojoule_per_mole', ()),
("ATMForce", "getDefaultUbcore") :  ('unit.kilojoule_per_mole', ()),
("ATMForce", "getDefaultAcore") :  (None, ()),
577
("ATMForce", "getParticleParameters") : (None, ("unit.nanometer", "unit.nanometer")),
578
579
580
("ATMForce", "getParticleTransformation") : (None, ()),
("FixedDisplacement", "getFixedDisplacement1") : ("unit.nanometer", ()),
("FixedDisplacement", "getFixedDisplacement0") : ("unit.nanometer", ()),
Peter Eastman's avatar
Peter Eastman committed
581
582
("PythonForce", "getComputation") : (None, ()),
("PythonForce", "getGlobalParameters") : (None, ()),
583
("PythonForce", "getParticles") : (None, ()),
Peter Eastman's avatar
Peter Eastman committed
584
("PythonForce", "getPickledFunction") : (None, ()),
585
}