src/io/ForceFieldOptions.cpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
#define __OPENMD_C
#include "io/ForceFieldOptions.hpp"

namespace OpenMD {

    ForceFieldOptions::ForceFieldOptions() {
      DefineOptionalParameter(Name, "Name");
      DefineOptionalParameterWithDefaultValue(vdWtype, "vdWtype", "Lennard-Jones");
      DefineOptionalParameterWithDefaultValue(DistanceMixingRule, "DistanceMixingRule", "arithmetic");
      DefineOptionalParameterWithDefaultValue(DistanceType, "DistanceType", "sigma");
      DefineOptionalParameterWithDefaultValue(EnergyMixingRule, "EnergyMixingRule", "geometric");
      DefineOptionalParameterWithDefaultValue(EnergyUnitScaling, "EnergyUnitScaling", 1.0);
      DefineOptionalParameterWithDefaultValue(MetallicEnergyUnitScaling, "MetallicEnergyUnitScaling", 1.0);
      DefineOptionalParameterWithDefaultValue(DistanceUnitScaling, "DistanceUnitScaling", 1.0);
      DefineOptionalParameterWithDefaultValue(AngleUnitScaling, "AngleUnitScaling", 1.0);
      DefineOptionalParameterWithDefaultValue(TorsionAngleConvention, "TorsionAngleConvention", "180_is_trans");
      DefineOptionalParameter(vdw12scale, "vdW-12-scale");
      DefineOptionalParameter(vdw13scale, "vdW-13-scale");
      DefineOptionalParameter(vdw14scale, "vdW-14-scale");
      DefineOptionalParameter(electrostatic12scale, "electrostatic-12-scale");
      DefineOptionalParameter(electrostatic13scale, "electrostatic-13-scale");
      DefineOptionalParameter(electrostatic14scale, "electrostatic-14-scale");

      // DefineOptionalParameterWithDefaultValue(vdw12scale, "vdW-12-scale", 0.0);
      // DefineOptionalParameterWithDefaultValue(vdw13scale, "vdW-13-scale", 0.0);
      // DefineOptionalParameterWithDefaultValue(vdw14scale, "vdW-14-scale", 0.0);
      // DefineOptionalParameterWithDefaultValue(electrostatic12scale, "electrostatic-12-scale", 0.0);
      // DefineOptionalParameterWithDefaultValue(electrostatic13scale, "electrostatic-13-scale", 0.0);
      // DefineOptionalParameterWithDefaultValue(electrostatic14scale, "electrostatic-14-scale", 0.0);
      DefineOptionalParameterWithDefaultValue(GayBerneMu, "GayBerneMu", 2.0);
      DefineOptionalParameterWithDefaultValue(GayBerneNu, "GayBerneNu", 1.0);
      DefineOptionalParameterWithDefaultValue(EAMMixingMethod, "EAMMixingMethod", "Johnson");

      deprecatedKeywords_.insert("cutoffPolicy");
    }
}
Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	4500 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	gezelter	805	/*
2			* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	805	* 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	805	* 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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (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	805	*/
42	gezelter	1390	#define __OPENMD_C
43	gezelter	805	#include "io/ForceFieldOptions.hpp"
44	chuckv	822
45	gezelter	1390	namespace OpenMD {
46	gezelter	805
47			ForceFieldOptions::ForceFieldOptions() {
48	tim	789	DefineOptionalParameter(Name, "Name");
49			DefineOptionalParameterWithDefaultValue(vdWtype, "vdWtype", "Lennard-Jones");
50			DefineOptionalParameterWithDefaultValue(DistanceMixingRule, "DistanceMixingRule", "arithmetic");
51			DefineOptionalParameterWithDefaultValue(DistanceType, "DistanceType", "sigma");
52			DefineOptionalParameterWithDefaultValue(EnergyMixingRule, "EnergyMixingRule", "geometric");
53			DefineOptionalParameterWithDefaultValue(EnergyUnitScaling, "EnergyUnitScaling", 1.0);
54	chuckv	1150	DefineOptionalParameterWithDefaultValue(MetallicEnergyUnitScaling, "MetallicEnergyUnitScaling", 1.0);
55	tim	789	DefineOptionalParameterWithDefaultValue(DistanceUnitScaling, "DistanceUnitScaling", 1.0);
56			DefineOptionalParameterWithDefaultValue(AngleUnitScaling, "AngleUnitScaling", 1.0);
57	tim	850	DefineOptionalParameterWithDefaultValue(TorsionAngleConvention, "TorsionAngleConvention", "180_is_trans");
58	gezelter	1587	DefineOptionalParameter(vdw12scale, "vdW-12-scale");
59			DefineOptionalParameter(vdw13scale, "vdW-13-scale");
60			DefineOptionalParameter(vdw14scale, "vdW-14-scale");
61			DefineOptionalParameter(electrostatic12scale, "electrostatic-12-scale");
62			DefineOptionalParameter(electrostatic13scale, "electrostatic-13-scale");
63			DefineOptionalParameter(electrostatic14scale, "electrostatic-14-scale");
64
65			// DefineOptionalParameterWithDefaultValue(vdw12scale, "vdW-12-scale", 0.0);
66			// DefineOptionalParameterWithDefaultValue(vdw13scale, "vdW-13-scale", 0.0);
67			// DefineOptionalParameterWithDefaultValue(vdw14scale, "vdW-14-scale", 0.0);
68			// DefineOptionalParameterWithDefaultValue(electrostatic12scale, "electrostatic-12-scale", 0.0);
69			// DefineOptionalParameterWithDefaultValue(electrostatic13scale, "electrostatic-13-scale", 0.0);
70			// DefineOptionalParameterWithDefaultValue(electrostatic14scale, "electrostatic-14-scale", 0.0);
71	gezelter	981	DefineOptionalParameterWithDefaultValue(GayBerneMu, "GayBerneMu", 2.0);
72			DefineOptionalParameterWithDefaultValue(GayBerneNu, "GayBerneNu", 1.0);
73	gezelter	1479	DefineOptionalParameterWithDefaultValue(EAMMixingMethod, "EAMMixingMethod", "Johnson");
74	gezelter	1528
75			deprecatedKeywords_.insert("cutoffPolicy");
76	tim	789	}
77	gezelter	805	}