src/minimizers/CGFamilyMinimizer.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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
#include <cmath>

#include "minimizers/CGFamilyMinimizer.hpp"
#include "primitives/Molecule.hpp"
#include "utils/Utility.hpp"
#ifdef IS_MPI
#include <mpi.h>
#endif

namespace OpenMD {

  CGFamilyMinimizer::CGFamilyMinimizer(SimInfo *info) : Minimizer(info){
    prevG.resize(ndim);
    prevX.resize(ndim);
    direction.resize(ndim);

    stepSize = paramSet->getStepSize();
  }

  int CGFamilyMinimizer::checkConvg(){
    RealType fTol;
    RealType relativeFTol;  // relative tolerance
    RealType deltaF;
    RealType gTol;
    RealType relativeGTol;
    RealType gnorm;
  

    // test function tolerance test
    fTol =paramSet->getFTol();
    relativeFTol = fTol * std::max(1.0,fabs(curF));  // relative tolerance
    deltaF = prevF - curF;
  
    if (fabs(deltaF) <= relativeFTol) {

      if (bVerbose){
        std::cout << "function value tolerance test passed" << std::endl;
        std::cout << "ftol = " << fTol
                  << "\tdeltaf = " << deltaF<< std::endl;
      }
      return CONVG_FTOL;
    }
  
    //gradient tolerance test
    gTol = paramSet->getGTol();
    relativeGTol = gTol * std::max(1.0,fabs(curF));

#ifndef IS_MPI
    gnorm = sqrt(dotProduct(curG, curG));
#else
    RealType localDP;
    RealType globalDP;

    localDP = dotProduct(curG, curG);
    MPI_Allreduce(&localDP, &globalDP, 1, MPI_REALTYPE,MPI_SUM, MPI_COMM_WORLD);  
    gnorm  = sqrt(globalDP);
#endif

    if (gnorm <= relativeGTol) {
      std::cout << "gradient tolerance test" << std::endl;
      std::cout << "gnorm = " << gnorm
                << "\trelativeGTol = " << relativeGTol<< std::endl;
      return CONVG_GTOL;
    }
  
    //absolute gradient tolerance test

    if (gnorm <= gTol) {
      std::cout << "absolute gradient tolerance test" << std::endl;
      std::cout << "gnorm = " << gnorm
                << "\tgTol = " << gTol<< std::endl;
      return CONVG_ABSGTOL;
    }

    // did not converge yet
    return CONVG_UNCONVG;
  }

}
Revision:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4088 byte(s)
Log Message:	updated copyright notices
#	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	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			#include <cmath>
44	gezelter	2
45	gezelter	246	#include "minimizers/CGFamilyMinimizer.hpp"
46			#include "primitives/Molecule.hpp"
47	tim	3	#include "utils/Utility.hpp"
48	gezelter	1627	#ifdef IS_MPI
49			#include <mpi.h>
50			#endif
51	gezelter	2
52	gezelter	1390	namespace OpenMD {
53	gezelter	2
54	gezelter	507	CGFamilyMinimizer::CGFamilyMinimizer(SimInfo *info) : Minimizer(info){
55	gezelter	246	prevG.resize(ndim);
56			prevX.resize(ndim);
57			direction.resize(ndim);
58	gezelter	2
59	gezelter	246	stepSize = paramSet->getStepSize();
60	gezelter	507	}
61	gezelter	246
62	gezelter	507	int CGFamilyMinimizer::checkConvg(){
63	tim	963	RealType fTol;
64			RealType relativeFTol; // relative tolerance
65			RealType deltaF;
66			RealType gTol;
67			RealType relativeGTol;
68			RealType gnorm;
69	gezelter	2
70
71	gezelter	507	// test function tolerance test
72			fTol =paramSet->getFTol();
73			relativeFTol = fTol * std::max(1.0,fabs(curF)); // relative tolerance
74			deltaF = prevF - curF;
75	gezelter	2
76	gezelter	507	if (fabs(deltaF) <= relativeFTol) {
77	gezelter	2
78	gezelter	507	if (bVerbose){
79			std::cout << "function value tolerance test passed" << std::endl;
80			std::cout << "ftol = " << fTol
81			<< "\tdeltaf = " << deltaF<< std::endl;
82			}
83			return CONVG_FTOL;
84	gezelter	2	}
85
86	gezelter	507	//gradient tolerance test
87			gTol = paramSet->getGTol();
88			relativeGTol = gTol * std::max(1.0,fabs(curF));
89	gezelter	2
90			#ifndef IS_MPI
91	gezelter	507	gnorm = sqrt(dotProduct(curG, curG));
92	gezelter	2	#else
93	tim	963	RealType localDP;
94			RealType globalDP;
95	gezelter	2
96	gezelter	507	localDP = dotProduct(curG, curG);
97	tim	963	MPI_Allreduce(&localDP, &globalDP, 1, MPI_REALTYPE,MPI_SUM, MPI_COMM_WORLD);
98	gezelter	507	gnorm = sqrt(globalDP);
99	gezelter	2	#endif
100
101	gezelter	507	if (gnorm <= relativeGTol) {
102	gezelter	246	std::cout << "gradient tolerance test" << std::endl;
103			std::cout << "gnorm = " << gnorm
104	gezelter	507	<< "\trelativeGTol = " << relativeGTol<< std::endl;
105			return CONVG_GTOL;
106			}
107	gezelter	2
108	gezelter	507	//absolute gradient tolerance test
109	gezelter	2
110	gezelter	507	if (gnorm <= gTol) {
111	gezelter	246	std::cout << "absolute gradient tolerance test" << std::endl;
112			std::cout << "gnorm = " << gnorm
113	gezelter	507	<< "\tgTol = " << gTol<< std::endl;
114			return CONVG_ABSGTOL;
115			}
116
117			// did not converge yet
118			return CONVG_UNCONVG;
119	gezelter	2	}
120
121			}