steepest_descent.py 1.54 KB
Newer Older
Martin Reinecke's avatar
Martin Reinecke committed
1
from __future__ import division
2 3 4 5 6 7 8 9 10 11 12 13
# 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/>.
Theo Steininger's avatar
Theo Steininger committed
14 15 16 17 18
#
# 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.
19

Martin Reinecke's avatar
Martin Reinecke committed
20
from __future__ import division
21
from .descent_minimizer import DescentMinimizer
22 23


24
class SteepestDescent(DescentMinimizer):
25
    def get_descent_direction(self, energy):
26 27 28
        """ Implementation of the steepest descent minimization scheme.

        Also known as 'gradient descent'. This algorithm simply follows the
Martin Reinecke's avatar
Martin Reinecke committed
29
        functional's gradient for minization.
30 31 32 33 34 35 36 37 38

        Parameters
        ----------
        energy : Energy
            An instance of the Energy class which shall be minized. The
            position of `energy` is used as the starting point of minization.

        Returns
        -------
39
        descent_direction : Field
Martin Reinecke's avatar
Martin Reinecke committed
40
            the descent direction.
41
        """
42
        return -energy.gradient