Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge documentation improvements from main into develop #178

Merged
merged 4 commits into from
Dec 30, 2024
Merged

Merge documentation improvements from main into develop #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0a6322
Add documentation link to website
leon-vv Dec 17, 2024
bcadac4
Merge pull request #162 from leon-vv/add-doc-link-to-website
leon-vv Dec 17, 2024
a2f5201
Update documentation in docs/latest/
leon-vv Dec 17, 2024
a711544
Merge pull request #163 from leon-vv/update-latest-documentation
leon-vv Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/contact.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
justify-content: center;
flex-direction: column;
text-align: center;
width:850px;
width:1100px;
margin:0px auto;
padding-top:35px;
padding-bottom:80px;
Expand All @@ -41,7 +41,7 @@
color:blue;
font-family:sans-serif;
font-size:25px;
padding:20px 25px;
padding:18px 23px;
}
#header h1 {
font-family:'Roboto';
Expand Down Expand Up @@ -157,6 +157,7 @@ <h1>Traceon</h1>
<div id='buttons'>
<a class='button' href='index.html'>Applications</a>
<a class='button' href='technology.html'>Technology</a>
<a class='button' href='https://traceon.org/docs/latest/index.html'>Documentation</a>
<a class='button' href="download.html">Download</a>
<a class='button' href="contact.html">Contact us</a>
</div>
Expand Down
18 changes: 13 additions & 5 deletions docs/docs/latest/excitation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
assert name in self.electrodes, f&#39;Cannot add {name} to excitation, since it\&#39;s not present in the mesh&#39;
self.excitation_types[name] = (ExcitationType.DIELECTRIC, permittivity)

def add_electrostatic_boundary(self, *args):
def add_electrostatic_boundary(self, *args, ensure_inward_normals=True):
&#34;&#34;&#34;
Specify geometry elements as electrostatic boundary elements. At the boundary we require E·n = 0 at every point on the boundary. This
is equivalent to stating that the directional derivative of the electrostatic potential through the boundary is zero. Placing boundaries between
Expand All @@ -189,9 +189,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
*args: list of str
The geometry names that should be considered a boundary.
&#34;&#34;&#34;
if ensure_inward_normals:
for electrode in args:
self.mesh.ensure_inward_normals(electrode)

self.add_dielectric(**{a:0 for a in args})

def add_magnetostatic_boundary(self, *args):
def add_magnetostatic_boundary(self, *args, ensure_inward_normals=True):
&#34;&#34;&#34;
Specify geometry elements as magnetostatic boundary elements. At the boundary we require H·n = 0 at every point on the boundary. This
is equivalent to stating that the directional derivative of the magnetostatic potential through the boundary is zero. Placing boundaries between
Expand All @@ -203,7 +207,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
*args: list of str
The geometry names that should be considered a boundary.
&#34;&#34;&#34;

if ensure_inward_normals:
for electrode in args:
print(&#39;flipping normals&#39;, electrode)
self.mesh.ensure_inward_normals(electrode)

self.add_magnetizable(**{a:0 for a in args})

def _split_for_superposition(self):
Expand Down Expand Up @@ -325,7 +333,7 @@ <h2 id="parameters">Parameters</h2>
</dl></div>
</dd>
<dt id="traceon.excitation.Excitation.add_electrostatic_boundary"><code class="name flex">
<span>def <span class="ident">add_electrostatic_boundary</span></span>(<span>self, *args)</span>
<span>def <span class="ident">add_electrostatic_boundary</span></span>(<span>self, *args, ensure_inward_normals=True)</span>
</code></dt>
<dd>
<div class="desc"><p>Specify geometry elements as electrostatic boundary elements. At the boundary we require E·n = 0 at every point on the boundary. This
Expand All @@ -351,7 +359,7 @@ <h2 id="parameters">Parameters</h2>
</dl></div>
</dd>
<dt id="traceon.excitation.Excitation.add_magnetostatic_boundary"><code class="name flex">
<span>def <span class="ident">add_magnetostatic_boundary</span></span>(<span>self, *args)</span>
<span>def <span class="ident">add_magnetostatic_boundary</span></span>(<span>self, *args, ensure_inward_normals=True)</span>
</code></dt>
<dd>
<div class="desc"><p>Specify geometry elements as magnetostatic boundary elements. At the boundary we require H·n = 0 at every point on the boundary. This
Expand Down
Loading
Loading