Skip to content

Commit a6a5bb3

Browse files
committed
Complete meshing docs and add global_evaluate
1 parent b9cb199 commit a6a5bb3

File tree

2 files changed

+117
-7
lines changed

2 files changed

+117
-7
lines changed

docs/api/function.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,30 @@
2727

2828
## Evaluation
2929

30+
### evaluate
31+
3032
```{eval-rst}
3133
.. autofunction:: underworld3.function.evaluate
3234
```
3335

36+
### global_evaluate
37+
38+
```{eval-rst}
39+
.. autofunction:: underworld3.function.global_evaluate
40+
```
41+
42+
### evalf
43+
3444
```{eval-rst}
3545
.. autofunction:: underworld3.function.evalf
3646
```
3747

48+
### evaluate_gradient
49+
50+
```{eval-rst}
51+
.. autofunction:: underworld3.function.evaluate_gradient
52+
```
53+
3854
## Analytic Functions
3955

4056
```{eval-rst}

docs/api/meshing.md

Lines changed: 101 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,50 @@
1919
.. autofunction:: underworld3.meshing.UnstructuredSimplexBox
2020
```
2121

22+
### BoxInternalBoundary
23+
24+
```{eval-rst}
25+
.. autofunction:: underworld3.meshing.BoxInternalBoundary
26+
```
27+
28+
## Annulus Meshes
29+
30+
### Annulus
31+
32+
```{eval-rst}
33+
.. autofunction:: underworld3.meshing.Annulus
34+
```
35+
36+
### QuarterAnnulus
37+
38+
```{eval-rst}
39+
.. autofunction:: underworld3.meshing.QuarterAnnulus
40+
```
41+
42+
### SegmentofAnnulus
43+
44+
```{eval-rst}
45+
.. autofunction:: underworld3.meshing.SegmentofAnnulus
46+
```
47+
48+
### AnnulusWithSpokes
49+
50+
```{eval-rst}
51+
.. autofunction:: underworld3.meshing.AnnulusWithSpokes
52+
```
53+
54+
### AnnulusInternalBoundary
55+
56+
```{eval-rst}
57+
.. autofunction:: underworld3.meshing.AnnulusInternalBoundary
58+
```
59+
60+
### DiscInternalBoundaries
61+
62+
```{eval-rst}
63+
.. autofunction:: underworld3.meshing.DiscInternalBoundaries
64+
```
65+
2266
## Spherical Meshes
2367

2468
### SphericalShell
@@ -27,28 +71,78 @@
2771
.. autofunction:: underworld3.meshing.SphericalShell
2872
```
2973

74+
### CubedSphere
75+
76+
```{eval-rst}
77+
.. autofunction:: underworld3.meshing.CubedSphere
78+
```
79+
80+
### SegmentofSphere
81+
82+
```{eval-rst}
83+
.. autofunction:: underworld3.meshing.SegmentofSphere
84+
```
85+
86+
### SphericalShellInternalBoundary
87+
88+
```{eval-rst}
89+
.. autofunction:: underworld3.meshing.SphericalShellInternalBoundary
90+
```
91+
92+
## Geographic Meshes
93+
94+
Regional meshes defined using longitude/latitude coordinates.
95+
3096
### RegionalSphericalBox
3197

3298
```{eval-rst}
3399
.. autofunction:: underworld3.meshing.RegionalSphericalBox
34100
```
35101

36-
### CubedSphere
102+
### RegionalGeographicBox
37103

38104
```{eval-rst}
39-
.. autofunction:: underworld3.meshing.CubedSphere
105+
.. autofunction:: underworld3.meshing.RegionalGeographicBox
40106
```
41107

42-
## Annulus Meshes
108+
## Segmented Meshes
43109

44-
### Annulus
110+
Meshes with internal segment boundaries for multi-region problems.
111+
112+
### SegmentedSphericalShell
45113

46114
```{eval-rst}
47-
.. autofunction:: underworld3.meshing.Annulus
115+
.. autofunction:: underworld3.meshing.SegmentedSphericalShell
48116
```
49117

50-
### QuarterAnnulus
118+
### SegmentedSphericalSurface2D
51119

52120
```{eval-rst}
53-
.. autofunction:: underworld3.meshing.QuarterAnnulus
121+
.. autofunction:: underworld3.meshing.SegmentedSphericalSurface2D
122+
```
123+
124+
### SegmentedSphericalBall
125+
126+
```{eval-rst}
127+
.. autofunction:: underworld3.meshing.SegmentedSphericalBall
128+
```
129+
130+
## Faults and Internal Boundaries
131+
132+
Tools for creating meshes with fault surfaces and internal boundaries.
133+
134+
### FaultSurface
135+
136+
```{eval-rst}
137+
.. autoclass:: underworld3.meshing.FaultSurface
138+
:members:
139+
:show-inheritance:
140+
```
141+
142+
### FaultCollection
143+
144+
```{eval-rst}
145+
.. autoclass:: underworld3.meshing.FaultCollection
146+
:members:
147+
:show-inheritance:
54148
```

0 commit comments

Comments
 (0)