simpeg/SimPEG/regularization/Regularization.py

from SimPEG.utils import sdiag

class Regularization(object):
    """docstring for Regularization"""

    @property
    def mref(self):
        return self._mref
    @mref.setter
    def mref(self, value):
        self._mref = value

    @property
    def Wx(self):
        if self._Wx is None:
            self._Wx = mesh.cellGradx
        return self._Wx

    @property
    def Wy(self):
        if self._Wy is None:
            self._Wy = mesh.cellGrady
        return self._Wy

    @property
    def Wz(self):
        if self._Wz is None:
            self._Wz = mesh.cellGradz
        return self._Wz

    @property
    def Ws(self):
        if self._Ws is None:
            self._Ws = sdiag(self.mesh.vol)
        return self._Ws


    def __init__(self, mesh):
        self.mesh = mesh
        self._Wx = None
        self._Wy = None
        self._Wz = None
        self.alpha_s = 1e-6
        self.alpha_x = 1
        self.alpha_y = 1
        self.alpha_z = 1

    def pnorm(self, r):
        return 0.5*r.dot(r)

    def modelObj(self, m):
        mresid = m - self.mref

        mobj = self.alpha_s * self.pnorm( self.Ws * mresid )

        mobj += self.alpha_x * self.pnorm( self.Wx * mresid )

        if self.mesh.dim > 1:
            mobj += self.alpha_y * self.pnorm( self.Wy * mresid )
        if self.mesh.dim > 2:
            mobj += self.alpha_z * self.pnorm( self.Wz * mresid )

        return mobj

    def modelObjDeriv(self, m):
        """

        In 1D:

        .. math::

            m_{\\text{obj}} = {1 \over 2}\\alpha_s  \left\| W_s  (m- m_{\\text{ref}})\\right\|^2_2
                            + {1 \over 2}\\alpha_x  \left\| W_x  (m- m_{\\text{ref}})\\right\|^2_2

            \\frac{ \partial m_{\\text{obj}} }{\partial m} =
                            \\alpha_s  W_s^{\\top} W_s  (m - m_{\\text{ref}}) +
                            \\alpha_x  W_x^{\\top} W_x  (m - m_{\\text{ref}})


            \\frac{ \partial^2 m_{\\text{obj}} }{\partial m^2} =
                            \\alpha_s  W_s^{\\top} W_s +
                            \\alpha_x  W_x^{\\top} W_x

        """

        mresid = m - self.mref

        mobjDeriv = self.alpha_s * self.Ws.T * ( self.Ws * mresid)

        mobjDeriv += self.alpha_x * self.Wx.T * ( self.Wx * mresid)

        if self.mesh.dim > 1:
            mobjDeriv += self.alpha_y * self.Wy.T * ( self.Wy * mresid)
        if self.mesh.dim > 2:
            mobjDeriv += self.alpha_z * self.Wz.T * ( self.Wz * mresid)

        return mobjDeriv


    def modelObj2Deriv(self, m):
        mresid = m - self.mref

        mobj2Deriv = self.alpha_s * self.Ws.T * self.Ws

        mobj2Deriv += self.alpha_x * self.Wx.T * self.Wx

        if self.mesh.dim > 1:
            mobj2Deriv += self.alpha_y * self.Wy.T * self.Wy
        if self.mesh.dim > 2:
            mobj2Deriv += self.alpha_z * self.Wz.T * self.Wz

        return mobj2Deriv