From 631896f3012ba759e092b11edf8cd88d5eb4d905 Mon Sep 17 00:00:00 2001 From: Orso Meneghini Date: Wed, 17 Jul 2024 14:16:31 -0700 Subject: [PATCH] update documentation --- docs/MULTIPHASE.html | 2 +- docs/OTHER.html | 25 +++++++++++++++++++++---- docs/pre/MULTIPHASE.txt | 2 +- docs/pre/OTHER.txt | 25 +++++++++++++++++++++---- 4 files changed, 44 insertions(+), 10 deletions(-) diff --git a/docs/MULTIPHASE.html b/docs/MULTIPHASE.html index 89ba17a..ded3d8e 100644 --- a/docs/MULTIPHASE.html +++ b/docs/MULTIPHASE.html @@ -808,7 +808,7 @@

TwoPortReservoir(; name, P = 0.1)

  • DESCRIPTION:

    - Basic eleemnt + Basic

  • diff --git a/docs/OTHER.html b/docs/OTHER.html index ec0acd6..dea0cf4 100644 --- a/docs/OTHER.html +++ b/docs/OTHER.html @@ -163,6 +163,7 @@

    OTHER

  • Water_loop(; name, Pmin = 32, Pmax = 40)
  • available_grid_position_with_size(G, vj)
  • available_grid_positions(G)
    • +
  • brayton_cycle(; flowrate = 50, TminCycle = 300, PminCycle = 15)
  • brayton_regenerator(; flowrate = 50, TminCycle = 300, PminCycle = 15)
  • breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 +273.15, Tmax = 900+273.15, load = 100e6)
  • breeder_loop(; name, Pmin = 32, Pmax = 40, Tmin = 600)
    • @@ -237,7 +238,8 @@

    L2S_HeatExchanger(; name, ϵ = 0.95, A = Steam.SteamHeatTransfer(), B = Liq.
  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Liquid to steam heat exchanger
    + OPTIONAL INPUTS
    - `name`: DESCRIPTION
    - `ϵ = 0.95`: DESCRIPTION
    - `A = Steam.SteamHeatTransfer()`: DESCRIPTION
    @@ -278,7 +280,8 @@

    wall_circuit(; max_pressure = 80, pressrue_drop = 5, Tmin = 450 + 273.15, Tm
  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 80`: DESCRIPTION
    - `pressrue_drop = 5`: DESCRIPTION
    - `Tmin = 450 + 273.15`: DESCRIPTION
    @@ -293,7 +296,8 @@

    divertor_circuit(; max_pressure = 80, pressrue_drop = 5, Tmin = 450 + 273.15
  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 80`: DESCRIPTION
    - `pressrue_drop = 5`: DESCRIPTION
    - `Tmin = 450 + 273.15`: DESCRIPTION
    @@ -308,7 +312,8 @@

    breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 + 273.15,
  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for PbLi as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 40`: DESCRIPTION
    - `pressrue_drop = 8`: DESCRIPTION
    - `Tmin = 750 + 273.15`: DESCRIPTION
    @@ -789,6 +794,18 @@

    DESCRIPTION:
    • +

    visibility_graph(G::AbstractGraph, dir = 1)

    +
      +
    • +
      DESCRIPTION:
      +

      + # Arguments:
      + - `G::AbstractGraph`: DESCRIPTION
      + - `dir = 1`: DESCRIPTION +

      +
      • +
    + diff --git a/docs/pre/MULTIPHASE.txt b/docs/pre/MULTIPHASE.txt index 572cc7b..2f685be 100644 --- a/docs/pre/MULTIPHASE.txt +++ b/docs/pre/MULTIPHASE.txt @@ -659,7 +659,7 @@
  • DESCRIPTION:

    - Basic eleemnt + Basic

  • diff --git a/docs/pre/OTHER.txt b/docs/pre/OTHER.txt index 7e8dfd9..8ecb609 100644 --- a/docs/pre/OTHER.txt +++ b/docs/pre/OTHER.txt @@ -14,6 +14,7 @@
  • Water_loop(; name, Pmin = 32, Pmax = 40)
  • available_grid_position_with_size(G, vj)
  • available_grid_positions(G)
    • +
  • brayton_cycle(; flowrate = 50, TminCycle = 300, PminCycle = 15)
  • brayton_regenerator(; flowrate = 50, TminCycle = 300, PminCycle = 15)
  • breeder_circuit(; max_pressure = 40, pressrue_drop = 8, Tmin = 750 +273.15, Tmax = 900+273.15, load = 100e6)
  • breeder_loop(; name, Pmin = 32, Pmax = 40, Tmin = 600)
    • @@ -88,7 +89,8 @@
  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Liquid to steam heat exchanger
    + OPTIONAL INPUTS
    - `name`: DESCRIPTION
    - `ϵ = 0.95`: DESCRIPTION
    - `A = Steam.SteamHeatTransfer()`: DESCRIPTION
    @@ -129,7 +131,8 @@

  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 80`: DESCRIPTION
    - `pressrue_drop = 5`: DESCRIPTION
    - `Tmin = 450 + 273.15`: DESCRIPTION
    @@ -144,7 +147,8 @@

  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for helium as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 80`: DESCRIPTION
    - `pressrue_drop = 5`: DESCRIPTION
    - `Tmin = 450 + 273.15`: DESCRIPTION
    @@ -159,7 +163,8 @@

  • DESCRIPTION:

    - OPTIONAL INPUTS
    + Returns a simple fluid circuit for a helium heat extraction circuit. Currently only allows for PbLi as the fluid.
    + OPTIONAL INPUTS
    - `max_pressure = 40`: DESCRIPTION
    - `pressrue_drop = 8`: DESCRIPTION
    - `Tmin = 750 + 273.15`: DESCRIPTION
    @@ -640,4 +645,16 @@

    • +

    visibility_graph(G::AbstractGraph, dir = 1)

    +
      +
    • +
      DESCRIPTION:
      +

      + # Arguments:
      + - `G::AbstractGraph`: DESCRIPTION
      + - `dir = 1`: DESCRIPTION +

      +
      • +
    +