update documentation

ProjectTorreyPines · Jul 17, 2024 · 631896f · 631896f
1 parent 0336db2
commit 631896f
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 10 deletions.
diff --git a/docs/MULTIPHASE.html b/docs/MULTIPHASE.html
@@ -808,7 +808,7 @@ <h4>TwoPortReservoir(; name, P = 0.1)</h4>
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				Basic eleemnt
+				Basic
 			</p>
 		</li>
 		<li>

diff --git a/docs/OTHER.html b/docs/OTHER.html
@@ -163,6 +163,7 @@ <h1>OTHER<h1>
 			<li>Water_loop(; name, Pmin = 32, Pmax = 40)</li>
 			<li>available_grid_position_with_size(G, vj)</li>
 			<li>available_grid_positions(G)</li>
+			<li>brayton_cycle(; flowrate = 50, TminCycle = 300, PminCycle = 15)</li>
 			<li>brayton_regenerator(; flowrate = 50, TminCycle = 300, PminCycle = 15)</li>
 			<li>breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 +273.15, Tmax = 900+273.15, load = 100e6)</li>
 			<li>breeder_loop(; name, Pmin = 32, Pmax = 40, Tmin = 600)</li>
@@ -237,7 +238,8 @@ <h4>L2S_HeatExchanger(; name, ϵ = 0.95, A = Steam.SteamHeatTransfer(), B = Liq.
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Liquid to steam heat exchanger<br>
+			OPTIONAL INPUTS<br>
 			- `name`: DESCRIPTION<br>
 			- `ϵ = 0.95`: DESCRIPTION<br>
 			- `A = Steam.SteamHeatTransfer()`: DESCRIPTION<br>
@@ -278,7 +280,8 @@ <h4>wall_circuit(; max_pressure = 80, pressrue_drop = 5, Tmin = 450 + 273.15, Tm
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 80`: DESCRIPTION<br>
 			- `pressrue_drop = 5`: DESCRIPTION<br>
 			- `Tmin = 450 + 273.15`: DESCRIPTION<br>
@@ -293,7 +296,8 @@ <h4>divertor_circuit(; max_pressure = 80, pressrue_drop = 5, Tmin = 450 + 273.15
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 80`: DESCRIPTION<br>
 			- `pressrue_drop = 5`: DESCRIPTION<br>
 			- `Tmin = 450 + 273.15`: DESCRIPTION<br>
@@ -308,7 +312,8 @@ <h4>breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 + 273.15,
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for PbLi as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 40`: DESCRIPTION<br>
 			- `pressrue_drop = 8`: DESCRIPTION<br>
 			- `Tmin = 750 + 273.15`: DESCRIPTION<br>
@@ -789,6 +794,18 @@ <h5>DESCRIPTION:</h5>
 		</li>
 			</ul>
 
+	<h4>visibility_graph(G::AbstractGraph, dir = 1)</h4>
+		<ul>
+		<li>
+			<h5>DESCRIPTION:</h5>
+			<p>
+				# Arguments:<br>
+			- `G::AbstractGraph`: DESCRIPTION<br>
+			- `dir = 1`: DESCRIPTION
+			</p>
+		</li>
+			</ul>
+
 </section></div>
 </main>
 

diff --git a/docs/pre/MULTIPHASE.txt b/docs/pre/MULTIPHASE.txt
@@ -659,7 +659,7 @@
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				Basic eleemnt
+				Basic
 			</p>
 		</li>
 		<li>

diff --git a/docs/pre/OTHER.txt b/docs/pre/OTHER.txt
@@ -14,6 +14,7 @@
 			<li>Water_loop(; name, Pmin = 32, Pmax = 40)</li>
 			<li>available_grid_position_with_size(G, vj)</li>
 			<li>available_grid_positions(G)</li>
+			<li>brayton_cycle(; flowrate = 50, TminCycle = 300, PminCycle = 15)</li>
 			<li>brayton_regenerator(; flowrate = 50, TminCycle = 300, PminCycle = 15)</li>
 			<li>breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 +273.15, Tmax = 900+273.15, load = 100e6)</li>
 			<li>breeder_loop(; name, Pmin = 32, Pmax = 40, Tmin = 600)</li>
@@ -88,7 +89,8 @@
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Liquid to steam heat exchanger<br>
+			OPTIONAL INPUTS<br>
 			- `name`: DESCRIPTION<br>
 			- `ϵ = 0.95`: DESCRIPTION<br>
 			- `A = Steam.SteamHeatTransfer()`: DESCRIPTION<br>
@@ -129,7 +131,8 @@
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 80`: DESCRIPTION<br>
 			- `pressrue_drop = 5`: DESCRIPTION<br>
 			- `Tmin = 450 + 273.15`: DESCRIPTION<br>
@@ -144,7 +147,8 @@
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 80`: DESCRIPTION<br>
 			- `pressrue_drop = 5`: DESCRIPTION<br>
 			- `Tmin = 450 + 273.15`: DESCRIPTION<br>
@@ -159,7 +163,8 @@
 		<li>
 			<h5>DESCRIPTION:</h5>
 			<p>
-				OPTIONAL INPUTS<br>
+				Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for PbLi as the fluid.<br>
+			OPTIONAL INPUTS<br>
 			- `max_pressure = 40`: DESCRIPTION<br>
 			- `pressrue_drop = 8`: DESCRIPTION<br>
 			- `Tmin = 750 + 273.15`: DESCRIPTION<br>
@@ -640,4 +645,16 @@
 		</li>
 			</ul>
 
+	<h4>visibility_graph(G::AbstractGraph, dir = 1)</h4>
+		<ul>
+		<li>
+			<h5>DESCRIPTION:</h5>
+			<p>
+				# Arguments:<br>
+			- `G::AbstractGraph`: DESCRIPTION<br>
+			- `dir = 1`: DESCRIPTION
+			</p>
+		</li>
+			</ul>
+
 </section></div>