src/minimizers/MinimizerParameterSet.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, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
 
#include "minimizers/MinimizerParameterSet.hpp"

namespace OpenMD {

  MinimizerParameterSet::MinimizerParameterSet(SimInfo* info) : defaultTolerance(1.0e-8) {
    setDefaultParameter();

    Globals* globals = info->getSimParams();

    if (globals->haveMinimizer()){
      setFTol(globals->getMinimizerFTol());
    }

    if (globals->haveMinimizerGTol()){
      setGTol(globals->getMinimizerGTol());
    }

    if (globals->haveMinimizerMaxIter()){
      setMaxIteration(globals->getMinimizerMaxIter());
    }

    if (globals->haveMinimizerWriteFreq()){
      setMaxIteration(globals->getMinimizerMaxIter());
    }

    if (globals->haveMinimizerWriteFreq()){
      setWriteFreq(globals->getMinimizerWriteFreq());
    }
    
    if (globals->haveMinimizerStepSize()){
      setStepSize(globals->getMinimizerStepSize());
    }

    if (globals->haveMinimizerLSMaxIter()){
      setLineSearchMaxIteration(globals->getMinimizerLSMaxIter());
    }    

    if (globals->haveMinimizerLSTol()){
      setLineSearchTol(globals->getMinimizerLSTol());
    }

  }

  void MinimizerParameterSet::setDefaultParameter() {
    maxIteration = 200;
    stepSize = 0.01;
    stepTol = defaultTolerance;
    fTol = defaultTolerance;
    gTol = defaultTolerance;
    writeFreq = maxIteration;
    lsMaxIteration = 50;
    lsTol = defaultTolerance;
  }


}
Revision:	1422
Committed:	Tue Mar 30 15:04:45 2010 UTC (15 years, 1 month ago) by gezelter
File size:	3459 byte(s)
Log Message:	Fixed a typo so that we use "Freq" instead of "Frq".
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	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			* [4] Vardeman & Gezelter, in progress (2009).
40	gezelter	246	*/
41
42			#include "minimizers/MinimizerParameterSet.hpp"
43
44	gezelter	1390	namespace OpenMD {
45	gezelter	246
46	gezelter	507	MinimizerParameterSet::MinimizerParameterSet(SimInfo* info) : defaultTolerance(1.0e-8) {
47	gezelter	246	setDefaultParameter();
48
49			Globals* globals = info->getSimParams();
50
51			if (globals->haveMinimizer()){
52	tim	665	setFTol(globals->getMinimizerFTol());
53	gezelter	246	}
54
55	tim	665	if (globals->haveMinimizerGTol()){
56			setGTol(globals->getMinimizerGTol());
57	gezelter	246	}
58
59	tim	665	if (globals->haveMinimizerMaxIter()){
60			setMaxIteration(globals->getMinimizerMaxIter());
61	gezelter	246	}
62
63	gezelter	1422	if (globals->haveMinimizerWriteFreq()){
64	tim	665	setMaxIteration(globals->getMinimizerMaxIter());
65	gezelter	246	}
66
67	gezelter	1422	if (globals->haveMinimizerWriteFreq()){
68			setWriteFreq(globals->getMinimizerWriteFreq());
69	gezelter	246	}
70
71	tim	665	if (globals->haveMinimizerStepSize()){
72			setStepSize(globals->getMinimizerStepSize());
73	gezelter	246	}
74
75	tim	665	if (globals->haveMinimizerLSMaxIter()){
76			setLineSearchMaxIteration(globals->getMinimizerLSMaxIter());
77	gezelter	246	}
78
79	tim	665	if (globals->haveMinimizerLSTol()){
80			setLineSearchTol(globals->getMinimizerLSTol());
81	gezelter	246	}
82
83	gezelter	507	}
84	gezelter	246
85	gezelter	507	void MinimizerParameterSet::setDefaultParameter() {
86	gezelter	246	maxIteration = 200;
87			stepSize = 0.01;
88			stepTol = defaultTolerance;
89			fTol = defaultTolerance;
90			gTol = defaultTolerance;
91	gezelter	1422	writeFreq = maxIteration;
92	gezelter	246	lsMaxIteration = 50;
93			lsTol = defaultTolerance;
94	gezelter	507	}
95	gezelter	246
96
97
98			}