gradient_norm_controller.py 2.94 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# Copyright(C) 2013-2017 Max-Planck-Society
#
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik
# and financially supported by the Studienstiftung des deutschen Volkes.

from .iteration_controller import IterationController
Martin Reinecke's avatar
Martin Reinecke committed
20
from .. import dobj
Martin Reinecke's avatar
Martin Reinecke committed
21

Martin Reinecke's avatar
Martin Reinecke committed
22

23
class GradientNormController(IterationController):
Martin Reinecke's avatar
Martin Reinecke committed
24
    def __init__(self, tol_abs_gradnorm=None, tol_rel_gradnorm=None,
25
                 convergence_level=1, iteration_limit=None,
26
                 name=None, verbose=None):
27
        super(GradientNormController, self).__init__()
28
        self._tol_abs_gradnorm = tol_abs_gradnorm
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
29
        self._tol_rel_gradnorm = tol_rel_gradnorm
Martin Reinecke's avatar
Martin Reinecke committed
30 31
        self._convergence_level = convergence_level
        self._iteration_limit = iteration_limit
32 33
        self._name = name
        self._verbose = verbose
Martin Reinecke's avatar
Martin Reinecke committed
34

35
    def start(self, energy):
Martin Reinecke's avatar
Martin Reinecke committed
36 37
        self._itcount = -1
        self._ccount = 0
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
38
        if self._tol_rel_gradnorm is not None:
Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
39 40
            self._tol_rel_gradnorm_now = self._tol_rel_gradnorm \
                                       * energy.gradient_norm
41
        return self.check(energy)
Martin Reinecke's avatar
Martin Reinecke committed
42

43
    def check(self, energy):
Martin Reinecke's avatar
Martin Reinecke committed
44
        self._itcount += 1
45

46
        inclvl = False
47 48
        if self._tol_abs_gradnorm is not None:
            if energy.gradient_norm <= self._tol_abs_gradnorm:
49
                inclvl = True
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
50
        if self._tol_rel_gradnorm is not None:
Martin Reinecke's avatar
cleanup  
Martin Reinecke committed
51
            if energy.gradient_norm <= self._tol_rel_gradnorm_now:
52 53 54 55 56
                inclvl = True
        if inclvl:
            self._ccount += 1
        else:
            self._ccount = max(0, self._ccount-1)
57 58 59 60 61 62 63

        # report
        if self._verbose:
            msg = ""
            if self._name is not None:
                msg += self._name+":"
            msg += " Iteration #" + str(self._itcount)
Martin Reinecke's avatar
update  
Martin Reinecke committed
64
            msg += " energy=" + str(energy.value)
65
            msg += " gradnorm=" + str(energy.gradient_norm)
Martin Reinecke's avatar
Martin Reinecke committed
66
            msg += " clvl=" + str(self._ccount)
Martin Reinecke's avatar
Martin Reinecke committed
67
            dobj.mprint(msg)
Martin Reinecke's avatar
Martin Reinecke committed
68
            # self.logger.info(msg)
69 70 71 72

        # Are we done?
        if self._iteration_limit is not None:
            if self._itcount >= self._iteration_limit:
73 74
                dobj.mprint(
                    "Warning:Iteration limit reached. Assuming convergence")
75
                return self.CONVERGED
Martin Reinecke's avatar
tweaks  
Martin Reinecke committed
76 77
        if self._ccount >= self._convergence_level:
            return self.CONVERGED
Martin Reinecke's avatar
Martin Reinecke committed
78 79

        return self.CONTINUE