Skip to content

Commit 9f746e5

Browse files
committed
docu
1 parent cb8a403 commit 9f746e5

File tree

9 files changed

+304
-38
lines changed

9 files changed

+304
-38
lines changed

_data/sidebars/function_reference_sidebar.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4822,6 +4822,10 @@ entries:
48224822
url: /S2FunHarmonic.acos.html
48234823
output: web
48244824

4825+
- title: "adjoint"
4826+
url: /S2FunHarmonic.adjoint.html
4827+
output: web
4828+
48254829
- title: "approximate"
48264830
url: /S2FunHarmonic.approximate.html
48274831
output: web
@@ -4886,6 +4890,10 @@ entries:
48864890
url: /S2FunHarmonic.horzcat.html
48874891
output: web
48884892

4893+
- title: "interpolate"
4894+
url: /S2FunHarmonic.interpolate.html
4895+
output: web
4896+
48894897
- title: "isempty"
48904898
url: /S2FunHarmonic.isempty.html
48914899
output: web
@@ -5122,6 +5130,10 @@ entries:
51225130
url: /S2AxisFieldHarmonic.eval.html
51235131
output: web
51245132

5133+
- title: "interpolate"
5134+
url: /S2AxisFieldHarmonic.interpolate.html
5135+
output: web
5136+
51255137
- title: "quadrature"
51265138
url: /S2AxisFieldHarmonic.quadrature.html
51275139
output: web
@@ -5232,6 +5244,10 @@ entries:
52325244
url: /S2VectorFieldHarmonic.eval.html
52335245
output: web
52345246

5247+
- title: "interpolate"
5248+
url: /S2VectorFieldHarmonic.interpolate.html
5249+
output: web
5250+
52355251
- title: "mean"
52365252
url: /S2VectorFieldHarmonic.mean.html
52375253
output: web
@@ -6449,6 +6465,10 @@ entries:
64496465
url: /plottingOverview.html
64506466
output: web
64516467

6468+
- title: "plottingConvention"
6469+
url: /plottingConvention.html
6470+
output: web
6471+
64526472
- title: "mapPlot"
64536473
url: /mapPlot.html
64546474
output: web

pages/documentation_matlab/AxesAlignment.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
north : (0,1,0)
4747
east : (1,0,0)
4848
{% endhighlight %}
49-
<p>The property <code class="language-plaintext highlighter-rouge">how2plot</code> is a handle class of type @plottingConvention and tells MTEX how to align the corresponding coordinate system on screen.</p>
49+
<p>The property <code class="language-plaintext highlighter-rouge">how2plot</code> is a handle class of type <code class="language-plaintext highlighter-rouge"><a href="plottingConvention.plottingConvention.html">plottingConvention</a></code> and tells MTEX how to align the corresponding coordinate system on screen.</p>
5050
{% highlight matlab %}
5151
plot(v1,'label','v_1','figSize','small')
5252
annotate([xvector,yvector,zvector],'labeled','backgroundcolor','w')
@@ -69,7 +69,7 @@
6969
<center>
7070
{% include inline_image.html file="AxesAlignment_02.png" %}
7171
</center>
72-
<p>Note that @plottingConvention is a handle class, i.e. changing <code class="language-plaintext highlighter-rouge">v1.how2plot</code> changes also <code class="language-plaintext highlighter-rouge">v2.how2plot</code>
72+
<p>Note that <code class="language-plaintext highlighter-rouge"><a href="plottingConvention.plottingConvention.html">plottingConvention</a></code> is a handle class, i.e. changing <code class="language-plaintext highlighter-rouge">v1.how2plot</code> changes also <code class="language-plaintext highlighter-rouge">v2.how2plot</code>
7373
</p>
7474
{% highlight matlab %}
7575
v2.how2plot
@@ -88,7 +88,7 @@
8888
<center>
8989
{% include inline_image.html file="AxesAlignment_03.png" %}
9090
</center>
91-
<p>In order to have different plotting axes alignments within one MTEX session we have to define a new @plottingConvention by</p>
91+
<p>In order to have different plotting axes alignments within one MTEX session we have to define a new <code class="language-plaintext highlighter-rouge"><a href="plottingConvention.plottingConvention.html">plottingConvention</a></code> by</p>
9292
{% highlight matlab %}
9393
% instantiate a new plotting convention and sets it up
9494
pC2 = plottingConvention; pC2.north = yvector
@@ -114,7 +114,7 @@
114114
<center>
115115
{% include inline_image.html file="AxesAlignment_04.png" %}
116116
</center>
117-
<p>When initiating a new <a href="vector3d.vector3d.html">vector3d</a> MTEX uses <code class="language-plaintext highlighter-rouge">plottingConvention.default</code> as default plotting convention. This default plotting convention can be changed by</p>
117+
<p>When initiating a new <code class="language-plaintext highlighter-rouge"><a href="vector3d.vector3d.html">vector3d</a></code> MTEX uses <code class="language-plaintext highlighter-rouge">plottingConvention.default</code> as default plotting convention. This default plotting convention can be changed by</p>
118118
{% highlight matlab %}
119119
plotx2north
120120
plotzOutOfPlane

pages/documentation_matlab/HarmonicApproximationTheory.html

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
<head>
1111
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
1212
<!--
13-
This HTML was auto-generated from MATLAB code.
14-
To make changes, update the MATLAB code and republish this document.
13+
This HTML was auto-generated from MATLAB code.
14+
To make changes, update the MATLAB code and republish this document.
1515
-->
1616
<title>Harmonic Approximation from Discrete Data</title>
1717
<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
@@ -62,7 +62,9 @@ <h2 id="5">Harmonic Approximation (without Regularization)</h2>
6262
{% endhighlight %}
6363

6464
{% highlight plaintext %}
65-
65+
SO3F1 = SO3FunHarmonic (1 → xyz)
66+
bandwidth: 17
67+
weight: 0.99
6668
{% endhighlight %}
6769
<center>
6870
{% include inline_image.html file="HarmonicApproximationTheory_02.png" %}
@@ -73,7 +75,8 @@ <h2 id="5">Harmonic Approximation (without Regularization)</h2>
7375
{% endhighlight %}
7476

7577
{% highlight plaintext %}
76-
78+
ans =
79+
0.0779
7780
{% endhighlight %}
7881
<p>If we choose the bandwidth to high and try to compute more Fourier coefficients as there are data points given, then we are in the overdetermined case and obtain oversampling.</p>
7982
{% highlight matlab %}
@@ -82,7 +85,15 @@ <h2 id="5">Harmonic Approximation (without Regularization)</h2>
8285
{% endhighlight %}
8386

8487
{% highlight plaintext %}
85-
88+
Warning: The oversampling factor in the
89+
approximation process is 0.43553. This could lead to
90+
a bad approximation. You may should not set the
91+
regularization parameter to 0 in the approximation
92+
method.
93+
94+
SO3F2 = SO3FunHarmonic (1 → xyz)
95+
bandwidth: 32
96+
weight: 0.25
8697
{% endhighlight %}
8798
<center>
8899
{% include inline_image.html file="HarmonicApproximationTheory_03.png" %}
@@ -93,7 +104,8 @@ <h2 id="5">Harmonic Approximation (without Regularization)</h2>
93104
{% endhighlight %}
94105

95106
{% highlight plaintext %}
96-
107+
ans =
108+
0.0123
97109
{% endhighlight %}
98110
<p>Lets take a look on the Fourier coefficients of this approximations.</p>
99111
{% highlight matlab %}
@@ -120,7 +132,9 @@ <h2 id="12">Harmonic Approximation with Regularization</h2>
120132
{% endhighlight %}
121133

122134
{% highlight plaintext %}
123-
135+
SO3F3 = SO3FunHarmonic (1 → xyz)
136+
bandwidth: 32
137+
weight: 0.99
124138
{% endhighlight %}
125139
<center>
126140
{% include inline_image.html file="HarmonicApproximationTheory_05.png" %}
@@ -132,7 +146,8 @@ <h2 id="12">Harmonic Approximation with Regularization</h2>
132146
{% endhighlight %}
133147

134148
{% highlight plaintext %}
135-
149+
ans =
150+
0.0824
136151
{% endhighlight %}
137152
<p>Note that this Error is not the value of the above energy functional which is minimized by lsqr.</p>
138153
<p>It is not easy to specify the parameter \(\lambda\), which describes the intensity of regularization. If we choose a value that is too large, we smooth the function too much. If \(\lambda\) is chosen too small, there is almost no regularization and we get oscillations.</p>
@@ -176,7 +191,9 @@ <h2 id="12">Harmonic Approximation with Regularization</h2>
176191
{% endhighlight %}
177192

178193
{% highlight plaintext %}
179-
194+
SO3F5 = SO3FunHarmonic (1 → xyz)
195+
bandwidth: 32
196+
weight: 0.98
180197
{% endhighlight %}
181198
<center>
182199
{% include inline_image.html file="HarmonicApproximationTheory_08.png" %}
@@ -203,7 +220,13 @@ <h2 id="21">LSQR-Parameters</h2>
203220
{% endhighlight %}
204221

205222
{% highlight plaintext %}
223+
Elapsed time is 1.691727 seconds.
224+
Number of iterations = 6
225+
Value of energy functional = 100.132
206226

227+
Elapsed time is 8.968955 seconds.
228+
Number of iterations = 36
229+
Value of energy functional = 100.0924
207230
{% endhighlight %}
208231
</div>
209232
</body>

pages/examples_matlab/ExSeismicPlots.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,18 @@ <h2 id="1">Crystal Symmetry and definition of the elastic stiffness tensor</h2>
5353
{% endhighlight %}
5454

5555
{% highlight plaintext %}
56-
56+
C = stiffnessTensor (Olivine)
57+
density: 3.355
58+
unit : GPa
59+
rank : 4 (3 x 3 x 3 x 3)
60+
61+
tensor in Voigt matrix representation:
62+
320.5 68.2 71.6 0 0 0
63+
68.2 196.5 76.8 0 0 0
64+
71.6 76.8 233.5 0 0 0
65+
0 0 0 64 0 0
66+
0 0 0 0 77 0
67+
0 0 0 0 0 78.7
5768
{% endhighlight %}
5869
<p>Compute seismic velocities as functions on the sphere</p>
5970
{% highlight matlab %}

pages/examples_matlab/ExSlipSystemAlumina.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,10 @@ <h2 id="7">Schmid Factor Analysis</h2>
153153
{% endhighlight %}
154154

155155
{% highlight plaintext %}
156-
156+
sS = slipSystem (Corundum)
157+
158+
U V T W | H K I L CRSS
159+
-1 2 -1 0 1 0 -1 1 1
157160
{% endhighlight %}
158161
<p>Next we determine the Schmid factor for all symmetrically equivalent slip systems.</p>
159162
{% highlight matlab %}

0 commit comments

Comments
 (0)