Start of DC documentation.

This commit is contained in:
Rowan Cockett
2013-10-03 12:16:10 -07:00
parent 21501e7482
commit 56aa003a3c
4 changed files with 35 additions and 0 deletions
+14
View File
@@ -32,6 +32,20 @@ class DCProblem(Problem):
return phi
def J(self, m, v, u=None, solve=None):
"""
:param numpy.array m: model
:param numpy.array v: vector to multiply
:param numpy.array u: fields
:rtype: numpy.array
:return: Jv
.. math::
c(m,u) = A(m)u - q = G\\text{sdiag}(M(mT(m)))Du - q = 0
\\nabla_u (A(m)u - q) = A(m)
\\nabla_m (A(m)u - q) = G\\text{sdiag}(Du)\\nabla_m (M(mT(m)))
"""
P = self.P
D = self.mesh.faceDiv
G = self.mesh.cellGrad
+2
View File
@@ -0,0 +1,2 @@
from DCProblem import *
from DCutils import *
+1
View File
@@ -1 +1,2 @@
from Problem import *
import DCProblem
+18
View File
@@ -1,8 +1,26 @@
.. _api_Problem:
Problem
*******
.. automodule:: SimPEG.forward.Problem
:members:
:undoc-members:
DCProblem
*********
.. automodule:: SimPEG.forward.DCProblem.DCProblem
:members:
:undoc-members:
DCutils
*******
.. automodule:: SimPEG.forward.DCProblem.DCutils
:members:
:undoc-members: