Skip to content

Commit

Permalink
API: adjust "to top" arrow + superscript 3 in mumax³
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanMaes committed Nov 25, 2024
1 parent 5b6e910 commit ccf5561
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
8 changes: 8 additions & 0 deletions doc/static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,18 @@ figcaption {
border-radius: 0 0 10px 10px;
transition: opacity 0.3s ease-in-out;
}

#api-to-top.visible {
opacity: 1;
}

.api-to-top-arrow {
font-size: 20px; /* Make the arrow slightly larger than text */
line-height: 1;
vertical-align: middle;
margin: 0 5px; /* Add spacing around the arrow */
}

.api-content {
float: left;
flex: 1;
Expand Down
14 changes: 10 additions & 4 deletions doc/templates/api-template.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ <h3>Advanced Features</h3>
<p style="font-size:8px; margin-top: 4em"><a href="api310.html"> Go to mumax3.10 API</a></p>
<p style="font-size:8px"><a href="api39c.html"> Go to mumax3.9c API</a></p>

<h3 id="api-to-top" onclick="window.scrollTo({top: 0, behavior: 'smooth'})"><sup><b>&uarr;</b></sup>&nbsp; Back to top &nbsp;<sup><b>&uarr;</b></sup></h3>
<h3 id="api-to-top" onclick="window.scrollTo({top: 0, behavior: 'smooth'})">
<sup><span class="api-to-top-arrow">&uarr;</span></sup>
&nbsp; Back to top &nbsp;
<sup><span class="api-to-top-arrow">&uarr;</span></sup>
</h3>
</div>

<div class="api-content">
Expand Down Expand Up @@ -295,7 +299,7 @@ <h1> Excitation </h1>
<h1> Spin currents </h1>

The effect of spin-polarized currents on the magnetization dynamics can be modelled in different ways.
In Mumax3 you can use the Zhang-Li model or the Slonczewski model.
In mumax<sup>3</sup> you can use the Zhang-Li model or the Slonczewski model.
For both models, a spin-polarized current field needs to be defined. This is done by setting the current density field <code>J</code>
and the polarization <code>Pol</code>.

Expand Down Expand Up @@ -334,9 +338,11 @@ <h2>Slonczewski model</h2>

<h1> Magnetic Force Microscopy </h1>

<p>Mumax3 has built-in generation of MFM images from a 2D magnetization. The MFM tip lift can be freely chosen. By default the tip magnetization is modeled as a point monopole at the apex. This is sufficient for most situations. Nevertheless, it is also possible to model partially magnetized tips by setting MFMDipole to the magnetized portion of the tip, in meters. E.g., if only the first 20nm of the tip is (vertically) magnetized, set MFMDipole=20e-9.</p>
<p>Mumax<sup>3</sup> has built-in generation of MFM images from a 2D magnetization. The MFM tip lift can be freely chosen. By default the tip magnetization is modeled as a point monopole at the apex. This is sufficient for most situations. Nevertheless, it is also possible to model partially magnetized tips by setting MFMDipole to the magnetized portion of the tip, in meters. E.g., if only the first 20nm of the tip is (vertically) magnetized, set MFMDipole=20e-9.</p>

<p><img width=400px src="mfm.svg" /></p>

<hr/>

{{range .FilterPrefix "MFM"}} {{template "entry" .}} {{end}}

Expand Down Expand Up @@ -567,7 +573,7 @@ <h1> Custom quantities </h1>
<h1> Custom effective field terms </h1>
It is possible to define additional effective field terms by promoting a custom quantity to an effective field term.
The corresponding energy density term can also be added by promoting a custom quantity.
E.g.: instead of using the existing anistropy field in mumax3, you could define the uniaxial anisotropy field
E.g.: instead of using the existing anistropy field in mumax<sup>3</sup>, you could define the uniaxial anisotropy field
(and the corresponding energy density) yourselves:

<pre><code>
Expand Down

0 comments on commit ccf5561

Please sign in to comment.