Skip to content

Commit 6cb9cf4

Browse files
committed
Improve HTML documentation by enhancing paragraph formatting and adding external link target attributes in tutorialSolidHeatTransfer01.html
1 parent ef6312a commit 6cb9cf4

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

tutorialSolidHeatTransfer01/tutorialSolidHeatTransfer01.html

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -127,23 +127,20 @@ <h2 id="solvingwithfeascript">
127127
>
128128
files.
129129
</p>
130-
<p>
131-
The first JSON file, solverConfig.json, determines the solver
132-
type:
133-
</p>
130+
<p>The first JSON file, solverConfig.json, determines the solver type:</p>
134131
<pre class="prettyprint">
135132
{
136133
"solverConfig": "solidHeatTransferScript"
137134
}</pre
138135
>
139136
<p>
140-
The second JSON file, meshConfig.json, concerns the
141-
computational mesh parameters. In particular, the parameters numElementsX
142-
and numElementsY represent the number of elements along the x-axis and
143-
y-axis, respectively. Additionally, maxX and maxY denote the final
144-
x-coordinate and y-coordinate of the mesh, respectively. When this file is
145-
fetched into FEAScript, a simple mapped mesh will be generated. The JSON
146-
file is structured as follows:
137+
The second JSON file, meshConfig.json, concerns the computational mesh
138+
parameters. In particular, the parameters numElementsX and numElementsY
139+
represent the number of elements along the x-axis and y-axis,
140+
respectively. Additionally, maxX and maxY denote the final x-coordinate
141+
and y-coordinate of the mesh, respectively. When this file is fetched into
142+
FEAScript, a simple mapped mesh will be generated. The JSON file is
143+
structured as follows:
147144
</p>
148145
<pre class="prettyprint">
149146
{
@@ -155,19 +152,18 @@ <h2 id="solvingwithfeascript">
155152
}</pre
156153
>
157154
<p>
158-
The third essential JSON file, boundaryConditionsConfig.json,
159-
concerns the boundary conditions. Initially the numbers at the left side
160-
(from 0 to 3) indicate the boundaries of the geometry (the mesh generator
161-
of FEAScript has assigned numbers to the boundaries, starting from the
162-
bottom boundary and proceeding clockwise). The `constantTemp` condition
163-
sets a constant temperature value. The `symmetry` boundary condition
164-
represents a zero-flux type. Finally, the `convection` condition describes
165-
a convective heat transfer scenario. In addition, the second argument of
166-
the `constantTemp` boundary condition corresponds to the constant
167-
temperature value. For a `convection` boundary condition, the second
168-
argument represents the \({\frac{h}{k}}\) value, and the third argument
169-
indicates the external temperature \(T_0\). The JSON file is structured as
170-
follows:
155+
The third essential JSON file, boundaryConditionsConfig.json, concerns the
156+
boundary conditions. Initially the numbers at the left side (from 0 to 3)
157+
indicate the boundaries of the geometry (the mesh generator of FEAScript
158+
has assigned numbers to the boundaries, starting from the bottom boundary
159+
and proceeding clockwise). The `constantTemp` condition sets a constant
160+
temperature value. The `symmetry` boundary condition represents a
161+
zero-flux type. Finally, the `convection` condition describes a convective
162+
heat transfer scenario. In addition, the second argument of the
163+
`constantTemp` boundary condition corresponds to the constant temperature
164+
value. For a `convection` boundary condition, the second argument
165+
represents the \({\frac{h}{k}}\) value, and the third argument indicates
166+
the external temperature \(T_0\). The JSON file is structured as follows:
171167
</p>
172168
<pre class="prettyprint">
173169
{
@@ -257,7 +253,12 @@ <h2 id="solvingwithfeascript">
257253
<h2 id="results"><a name="Results"></a>Results</h2>
258254
<p>
259255
The results visualized in the following contour plot are generated
260-
real-time in your browser, according to the JSON files provided.
256+
real-time in your browser, according to the JSON files provided. The
257+
source code of the above tutorial can be found at the corresponding
258+
<a
259+
href="https://github.com/FEAScript/FEAScript/tree/main/examples/solidHeatTransferScript/exampleSolidHeatTransfer01" target="_blank"
260+
>example directory</a
261+
>.
261262
</p>
262263

263264
<!-- Container element where the solution plot will be rendered -->
@@ -268,7 +269,7 @@ <h2 id="results"><a name="Results"></a>Results</h2>
268269
<div id="plot"></div>
269270

270271
<ul id="menu">
271-
<li><a href="https://feascript.com/index.html">Return</a></li>
272+
<li><a href="https://feascript.com/index.html" target="_blank">Return</a></li>
272273
</ul>
273274

274275
<script>

0 commit comments

Comments
 (0)