Documentation updates.

This commit is contained in:
Rowan Cockett
2013-09-30 10:20:23 -07:00
parent 2330ae4ec1
commit 950fcc572f
11 changed files with 120 additions and 9 deletions
+8
View File
@@ -0,0 +1,8 @@
.. _api_DiffOperators:
Differential Operators
**********************
.. automodule:: SimPEG.DiffOperators
:members:
:undoc-members:
+8
View File
@@ -0,0 +1,8 @@
.. _api_GaussNewton:
Gauss Newton
************
.. automodule:: SimPEG.GaussNewton
:members:
:undoc-members:
+8
View File
@@ -0,0 +1,8 @@
.. _api_InnerProducts:
Inner Products
**************
.. automodule:: SimPEG.InnerProducts
:members:
:undoc-members:
+8
View File
@@ -0,0 +1,8 @@
.. _api_LOMView:
LOM View
***********
.. automodule:: SimPEG.LOMView
:members:
:undoc-members:
+8
View File
@@ -0,0 +1,8 @@
.. _api_LogicallyOrthogonalMesh:
Logically Orthogonal Mesh
*************************
.. automodule:: SimPEG.LogicallyOrthogonalMesh
:members:
:undoc-members:
+8
View File
@@ -0,0 +1,8 @@
.. _api_TensorView:
Tensor View
***********
.. automodule:: SimPEG.TensorView
:members:
:undoc-members:
+11
View File
@@ -0,0 +1,11 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG import TensorMesh
n = 20
h = np.ones(n)/n
M = TensorMesh([h, h])
I = np.sin(M.gridCC[:,0]*2*np.pi)*np.sin(M.gridCC[:,1]*2*np.pi)
M.plotImage(I)
plt.show()
+12
View File
@@ -0,0 +1,12 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG import TensorMesh
n = 20
h = np.ones(n)/n
M = TensorMesh([h,h,h])
I = np.sin(M.gridCC[:,0]*2*np.pi)*np.sin(M.gridCC[:,1]*2*np.pi)*np.sin(M.gridCC[:,2]*2*np.pi)
M.plotImage(I, annotationColor='k')
plt.show()
+13
View File
@@ -0,0 +1,13 @@
import numpy as np
import matplotlib.pyplot as plt
from SimPEG import TensorMesh
x0 = np.zeros(2)
h1 = np.linspace(.1,.5,3)
h2 = np.linspace(.1,.5,5)
M = TensorMesh([h1,h2],x0)
M.plotGrid()
plt.hold()
plt.plot(M.gridN[:,0], M.gridN[:,1], 'ks', markersize=10)
plt.show()
+21 -2
View File
@@ -16,8 +16,8 @@ The vision is to create a package for finite volume simulation with applications
* supports 2D and 3D problems
Contents
========
Meshing & Operators
===================
.. toctree::
:maxdepth: 2
@@ -25,6 +25,25 @@ Contents
api_BaseMesh
api_TensorMesh
api_TensorView
api_LogicallyOrthogonalMesh
api_LomView
api_DiffOperators
api_InnerProducts
Inversion
=========
.. toctree::
:maxdepth: 2
api_GaussNewton
Example Problems
================
.. toctree::
:maxdepth: 2
Project Index & Search