src/io/ForceFieldOptions.hpp

/*
 * 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).
 */
 
#ifndef IO_FORCEFIELDOPTIONS_HPP
#define IO_FORCEFIELDOPTIONS_HPP
#include "utils/simError.h"
#include "types/DataHolder.hpp"
#include "utils/ParameterManager.hpp"
#include "utils/StringUtils.hpp"
#include "io/ParamConstraint.hpp"

namespace OpenMD {
  
  class ForceFieldOptions : public DataHolder {
    DeclareParameter(Name, std::string);
    DeclareParameter(vdWtype, std::string);
    DeclareParameter(DistanceMixingRule, std::string);
    DeclareParameter(DistanceType, std::string);
    DeclareParameter(EnergyMixingRule, std::string);
    DeclareParameter(CutoffPolicy, std::string);
    DeclareParameter(EnergyUnitScaling, RealType);
    DeclareParameter(MetallicEnergyUnitScaling, RealType);
    DeclareParameter(DistanceUnitScaling, RealType);
    DeclareParameter(AngleUnitScaling, RealType);
    DeclareParameter(TorsionAngleConvention, std::string);
    DeclareParameter(vdw12scale, RealType);
    DeclareParameter(vdw13scale, RealType);
    DeclareParameter(vdw14scale, RealType);
    DeclareParameter(electrostatic12scale, RealType);
    DeclareParameter(electrostatic13scale, RealType);
    DeclareParameter(electrostatic14scale, RealType);
    DeclareParameter(GayBerneMu, RealType);
    DeclareParameter(GayBerneNu, RealType);
    DeclareParameter(EAMMixingMethod, std::string);
    
  public:
    ForceFieldOptions();
    ForceFieldOptions(const ForceFieldOptions&);
    ForceFieldOptions& operator = (const ForceFieldOptions&);
    
    void validateOptions() {
      CheckParameter(vdWtype, isEqualIgnoreCase(std::string("Lennard-Jones")));
      CheckParameter(DistanceMixingRule, isEqualIgnoreCase(std::string("arithmetic")) || isEqualIgnoreCase(std::string("geometric")) || isEqualIgnoreCase(std::string("cubic")));
      CheckParameter(DistanceType, isEqualIgnoreCase(std::string("sigma")) || isEqualIgnoreCase(std::string("Rmin")));
      CheckParameter(EnergyMixingRule, isEqualIgnoreCase(std::string("arithmetic")) || isEqualIgnoreCase(std::string("geometric")) || isEqualIgnoreCase(std::string("hhg")));
      CheckParameter(TorsionAngleConvention, isEqualIgnoreCase(std::string("180_is_trans")) || isEqualIgnoreCase(std::string("0_is_trans")));
      CheckParameter(CutoffPolicy, isEqualIgnoreCase(std::string("MIX")) || isEqualIgnoreCase(std::string("MAX")) || isEqualIgnoreCase(std::string("TRADITIONAL")));
      CheckParameter(EAMMixingMethod, isEqualIgnoreCase(std::string("JOHNSON")) || isEqualIgnoreCase(std::string("DAW")));
   }
    
    bool setData(const std::string& keyword, const std::string& value) {
      bool result;
      ParamMap::iterator i =parameters_.find(keyword);
      if (i != parameters_.end()) {
        if(isInteger(value)){
          int ival = lexi_cast<int>(value);
          result = i->second->setData(ival);
        }      
        else if (isType<RealType>(value)){
          RealType dval = lexi_cast<RealType>(value);
          result = i->second->setData(dval);
        } else{
          result = i->second->setData(value);
        }

        if (!result) {
          sprintf(painCave.errMsg,  
                  "Unrecognized data type for keyword: %s = %s\n",
                  keyword.c_str(), value.c_str() );
          painCave.isFatal = 1;
          simError();                  
        }
      } else {
        sprintf(painCave.errMsg,  "%s is an unrecognized keyword\n", keyword.c_str() );
        painCave.isFatal = 0;
        simError();        
      }
      
      return result;
    }

  private:
    typedef std::map<std::string, ParameterBase*> ParamMap;
    ParamMap parameters_;                  
  };
  
}
#endif
Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 8 months ago) by gezelter
File size:	5789 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	tim	750	/*
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	tim	750	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	750	* 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	tim	750	*/
42
43	gezelter	788	#ifndef IO_FORCEFIELDOPTIONS_HPP
44			#define IO_FORCEFIELDOPTIONS_HPP
45			#include "utils/simError.h"
46	gezelter	1528	#include "types/DataHolder.hpp"
47	gezelter	788	#include "utils/ParameterManager.hpp"
48			#include "utils/StringUtils.hpp"
49			#include "io/ParamConstraint.hpp"
50
51	gezelter	1390	namespace OpenMD {
52	gezelter	788
53	gezelter	1528	class ForceFieldOptions : public DataHolder {
54	gezelter	788	DeclareParameter(Name, std::string);
55			DeclareParameter(vdWtype, std::string);
56			DeclareParameter(DistanceMixingRule, std::string);
57			DeclareParameter(DistanceType, std::string);
58			DeclareParameter(EnergyMixingRule, std::string);
59	chuckv	834	DeclareParameter(CutoffPolicy, std::string);
60	tim	963	DeclareParameter(EnergyUnitScaling, RealType);
61	chuckv	1150	DeclareParameter(MetallicEnergyUnitScaling, RealType);
62	tim	963	DeclareParameter(DistanceUnitScaling, RealType);
63			DeclareParameter(AngleUnitScaling, RealType);
64	gezelter	788	DeclareParameter(TorsionAngleConvention, std::string);
65	gezelter	1287	DeclareParameter(vdw12scale, RealType);
66			DeclareParameter(vdw13scale, RealType);
67	tim	963	DeclareParameter(vdw14scale, RealType);
68	gezelter	1287	DeclareParameter(electrostatic12scale, RealType);
69			DeclareParameter(electrostatic13scale, RealType);
70	tim	963	DeclareParameter(electrostatic14scale, RealType);
71	gezelter	981	DeclareParameter(GayBerneMu, RealType);
72			DeclareParameter(GayBerneNu, RealType);
73	gezelter	1479	DeclareParameter(EAMMixingMethod, std::string);
74	gezelter	788
75			public:
76	tim	789	ForceFieldOptions();
77	gezelter	788	ForceFieldOptions(const ForceFieldOptions&);
78			ForceFieldOptions& operator = (const ForceFieldOptions&);
79
80			void validateOptions() {
81			CheckParameter(vdWtype, isEqualIgnoreCase(std::string("Lennard-Jones")));
82	gezelter	981	CheckParameter(DistanceMixingRule, isEqualIgnoreCase(std::string("arithmetic")) \|\| isEqualIgnoreCase(std::string("geometric")) \|\| isEqualIgnoreCase(std::string("cubic")));
83	gezelter	788	CheckParameter(DistanceType, isEqualIgnoreCase(std::string("sigma")) \|\| isEqualIgnoreCase(std::string("Rmin")));
84	gezelter	981	CheckParameter(EnergyMixingRule, isEqualIgnoreCase(std::string("arithmetic")) \|\| isEqualIgnoreCase(std::string("geometric")) \|\| isEqualIgnoreCase(std::string("hhg")));
85	gezelter	1715	CheckParameter(TorsionAngleConvention, isEqualIgnoreCase(std::string("180_is_trans")) \|\| isEqualIgnoreCase(std::string("0_is_trans")));
86	chuckv	834	CheckParameter(CutoffPolicy, isEqualIgnoreCase(std::string("MIX")) \|\| isEqualIgnoreCase(std::string("MAX")) \|\| isEqualIgnoreCase(std::string("TRADITIONAL")));
87	gezelter	1479	CheckParameter(EAMMixingMethod, isEqualIgnoreCase(std::string("JOHNSON")) \|\| isEqualIgnoreCase(std::string("DAW")));
88	chuckv	834	}
89	gezelter	788
90			bool setData(const std::string& keyword, const std::string& value) {
91			bool result;
92			ParamMap::iterator i =parameters_.find(keyword);
93			if (i != parameters_.end()) {
94	tim	838	if(isInteger(value)){
95	gezelter	788	int ival = lexi_cast<int>(value);
96			result = i->second->setData(ival);
97			}
98	tim	963	else if (isType<RealType>(value)){
99			RealType dval = lexi_cast<RealType>(value);
100	gezelter	788	result = i->second->setData(dval);
101			} else{
102			result = i->second->setData(value);
103			}
104	gezelter	1629
105			if (!result) {
106			sprintf(painCave.errMsg,
107			"Unrecognized data type for keyword: %s = %s\n",
108			keyword.c_str(), value.c_str() );
109			painCave.isFatal = 1;
110			simError();
111			}
112	gezelter	788	} else {
113			sprintf(painCave.errMsg, "%s is an unrecognized keyword\n", keyword.c_str() );
114			painCave.isFatal = 0;
115			simError();
116			}
117
118			return result;
119			}
120	chuckv	822
121	gezelter	788	private:
122			typedef std::map<std::string, ParameterBase*> ParamMap;
123			ParamMap parameters_;
124			};
125
126			}
127			#endif