Unit クラスの継承(1)

バイオ・リファイナリー（再生可能資源であるバイオマスを原料にバイオ燃料や樹脂などを製造するプラントや技術)のシミュレーションソフト"BioSTEAM"で、プロセス・パラメータを動的に変更する方法について説明しています。 オリジナルのページはInheriting from Unitです。 ソースコードは以下の実行環境で確認しています。
  • Visual Studio Code バージョン: 1.104.2
  • 拡張機能:Jupyter バージョン 2025.8.0
  • Python 3.12.10
  • biosteam 2.52.13
  • graphviz-14.0.2
<< 目次 >>

Unit クラスの継承

共通の設定

サブクラスの例

シミュレーション テスト

Graphvizで作図

装置のコスト計算

付随設備

参考文献

<< 本文 >>

Unit クラスの継承

共通の設定

Unit クラスを継承する各機器のモデル(サブクラス)は、以下のクラス変数を持ち、特に指定のない時のデフォルトの値が決められています。

  • _F_BM_default : [str, float]の組み合わせの辞書型配列で、設置に関するコストを見積るための係数のデフォルト値。
  • _units :[str, float]の組み合わせの辞書型配列で、計算結果である辞書型配列 design_results の値の単位。
  • _N_ins =1:[int]流入ストリームの数。デフォルトは1。
  • _N_outs =1:[int]流出ストリームの数。デフォルトは1。
  • _ins_size_is_fixed =True:[bool]流入ストリームの数が固定値かどうか。デフォルトはTrue。
  • _out_size_is_fixed =True:[bool]流出ストリームの数が固定値かどうか。デフォルトはTrue。
  • auxiliary_unit_names =():tuple[str]補助装置の名前。
  • _graphics =():[biosteam Graphics]機器を表す図のグラフィック オブジェクト。デフォルトは四角。
  • _default_equipment_lifetime =():[int] または [str, int]の組み合わせの辞書型配列 装置の寿命のデフォルト値。生産事業の存続期間。
  • _line =():[str] 機器を図にするときのラベル。デフォルトはその機器のクラス名。

各機器の熱や物質収支、コストを計算するための抽象メソッドが設定されています。

  • _run() システムの収束計算時に呼び出され、流出ストリームを決定します。
  • _design() :システムの収束後にに呼び出され、設計要求を決定します。
  • _cost() :_design()実行後に呼び出され、コストを決定します。

以下の抽象メソッドは、それぞれのインスタンス変数によって設定されます。

  • ins [Stream] 流入ストリーム。
  • outs:[Stream] 流出ストリーム。
  • power_utilities:[Stream] 電力消費量。
  • heat_utilities:list[Stream] 加熱、冷却要求。
  • baseline_purchase_costs : dict [str, float] 設計、圧力、材料の係数を考慮する前の購入価格(ベースライン購入価格)の一覧。
  • parallel: dict [str, int] 並列で配置するパーツの名前と個数。並列で設置されるパーツがない時は{}。
  • F_BM : dict [str, float] 設備コスト計算時の設置に関する係数。
  • F_D : dict [str, float] 設備コスト計算時の設計の係数。
  • F_P : dict [str, float] 設備コスト計算時の圧力の係数。
  • F_M : dict [str, float] 設備コスト計算時の材料の係数。
  • equipment_lifetime:[dict] 各パーツの寿命。
  • thermo:[Thermo] 機器で使用される成分の熱力学的特性

サブクラスの例

次の例では、新しい Boiler クラスを作成することで Unit クラスから継承する変数をどう設定するか示しています。

  1. 新しい Boiler クラスを作成
    2. import biosteam as bst
from math import ceil
bst.nbtutorial()

class Boiler(bst.Unit):
    """
    供給ストリームの一部を沸騰させるボイラー オブジェクトを生成

    Parameters
    ----------
    ins :
        供給ストリーム
    outs :
        * [0] 蒸気
        * [1] 液体
    V : float
        モル蒸気分率
    P : float
        操作圧力 [Pa].

    """
    # ここでは`ID` や `thermo`パラメータを設定していませんが
    # BioSTEAMのほとんどのサブクラスはこのように記載されていて、問題ありません。
    # 全ての機器ユニットはインデックス付きのリスト化された流入/流出ストリームを指定しますが、
    # 流入ストリームもしくは流出ストリームが１つの場合は、リスト化する必要はありません。
    # `ins` や `outs`を書く必要もありません。
    # BioSTEAM はしい型を自動的に追加します。
    # 機器に対する追加の引数も列挙する必要があります（例：V や P）。

    _N_ins = 1 # 流入ストリームの数
    _N_outs = 2 # 流出ストリームの数
    _units = {'Area': 'm^2'}

    def _init(self, V, P):
        # _init メソッドで 新規作成時に指定された引数が追加されます。
        self.V = V #: モル蒸気分率
        self.P = P #: 操作圧力 [Pa].

    def _run(self):
        # 流入ストリームの数が１つのときは、self.ins[0] と等価。
        feed = self.feed
        vap, liq = self.outs

        # 気液平衡計算を実施
        stream = feed.copy()
        stream.vle(V=self.V, P=self.P)

        # 流出ストリームを更新します。
        vap.copy_like(stream['g'])
        liq.copy_like(stream['l'])

    def _design(self):
        # 加熱要求を出入口のエンタルピー差から計算します。
        T_operation = self.outs[0].T
        duty = self.H_out - self.H_in
        if duty < 0: raise RuntimeError(f'{repr(self)} is cooling.')
        heat_utility = self.add_heat_utility(duty, T_operation) # 新しい加熱要求を self.heat_utilities に設定

        # 熱交換器の入口温度の設定
        T_utility = heat_utility.inlet_utility_stream.T

        # 熱交換器の温度差の設定
        dT = T_utility - T_operation

        # 熱伝達係数 kJ/(hr*m2*K)
        U = 8176.699

        # 必要な熱交換面積 (m^2) = 要求熱量 / (熱伝達係数 * 出入口温度差)
        A = duty /(U * dT)

        # １つの熱交換器の熱交換面積の上限
        A_max = 743.224

        # 必要な熱交換機の数 = A / A_max
        N = ceil(A / A_max)

        # 設計要求に計算結果を保存
        self.design_results['Area'] = A / N

        # ボイラー全体の設備費は、１つのボイラーの費用にボイラーの台数を掛けたものとします。
        self.parallel['Boiler'] = N

    def _cost(self):
        A = self.design_results['Area']

        # 長管式縦型ボイラーのコストは以下を参照しています。
        # "Product process and design". Warren et. al. (2016) Table 22.32, pg 592
        purchase_cost = bst.settings.CEPCI * 3.086 * A **0.55

        # ベースライン購入価格として保存
        self.baseline_purchase_costs['Boiler'] = purchase_cost # 材質の係数は未考慮

        # 設計、圧力、材質による係数は1とします。
        self.F_D['Boiler'] = self.F_P['Boiler'] = self.F_M['Boiler'] = 1.

        # ボイラーの設置に関する係数を使用します。
        self.F_BM['Boiler'] = 2.45

シミュレーション テスト

  1. オブジェクトの生成
    2. import biosteam as bst
bst.settings.set_thermo(['Water'])
water = bst.Stream('water', Water=300)
B1 = Boiler('B1', ins=water, outs=('gas', 'liq'),
            V=0.5, P=101325)
B1.diagram(format='png')
B1.show()
    Boiler: B1
ins...
[0] water  
    phase: 'l', T: 298.15 K, P: 101325 Pa
    flow (kmol/hr): Water  300
outs...
[0] gas  
    phase: 'l', T: 298.15 K, P: 101325 Pa
    flow: 0
[1] liq  
    phase: 'l', T: 298.15 K, P: 101325 Pa
    flow: 0
  2. シミュレーションの実行
    3. B1.simulate()
B1.show()
    Boiler: B1
ins...
[0] water  
    phase: 'l', T: 298.15 K, P: 101325 Pa
    flow (kmol/hr): Water  300
outs...
[0] gas  
    phase: 'g', T: 373.12 K, P: 101325 Pa
    flow (kmol/hr): Water  150
[1] liq  
    phase: 'l', T: 373.12 K, P: 101325 Pa
    flow (kmol/hr): Water  150
  3. 結果の確認
    4. ユーティリティの要求は`design_results`に辞書型配列として保存されます。購入価格は自動的に結果一覧に追加されます。 
    B1.results()
    Boiler Units B1
    Low pressure steam Duty kJ/hr 8.21e+06
    Flow kmol/hr 212
    Cost USD/hr 50.4
    Design Area m^2 24.4
    Purchase cost Boiler USD 1.02e+04
    Total purchase cost USD 1.02e+04
    Utility cost USD 50.4
  4. 供給量の変更

    5. プラントの規模が大きくなった時には、ボイラーの個数は辞書型配列の`parallel`を使って自動的に個数が増えます。

    B1.feed.scale(100) # 供給流量を 100倍にします。
B1.simulate()
B1.results()
    Boiler Units B1
    Low pressure steam Duty kJ/hr 8.21e+08
    Flow kmol/hr 2.12e+04
    Cost USD/hr 5.04e+03
    Design Area m^2 610
    Purchase cost Boiler (x4) USD 2.38e+05
    Total purchase cost USD 2.38e+05
    Utility cost USD 5.04e+03
    ここで、 
    B1.parallel
    {'Boiler': 4}
    となります。

Graphvizで作図

Graphvizで作られた図は_graphicsにグラフィック オブジェクトとして保存されています。 グラフィック オブジェクトはそれぞれの機器 サブクラスに一つ作成されます。

  1. 作図情報
    2. graphics = Boiler._graphics
edge_in = graphics.edge_in
edge_out = graphics.edge_out
node = graphics.node
  2. エッジ イン

    3. 流入ストリーム一つにつき、一つのエッジ インが生成されます。例えば、B1.ins[0]にはedge_in[0]が対応して生成されます。

    edge_in
    [{'headport': 'c'}]
  3. エッジ アウト

    4. 流出ストリーム一つにつき、一つのエッジ アウトが生成されます。例えば、B1.outs[0]にはedge_outs[0]が対応して生成されます。

    edge_out
    [{'tailport': 'c'}, {'tailport': 'c'}]
  4. ノード

    5. ノードが機器に対応します。

    node
    {'shape': 'box',
 'style': 'filled',
 'gradientangle': '0',
 'width': '0.6',
 'height': '0.6',
 'orientation': '0.0',
 'peripheries': '1',
 'margin': 'default',
 'fontname': 'Arial'}
  5. デフォルトの設定での図
    6. B1.diagram(format='png')
  6. 設定の変更

    7. 図の設定はユーザーの好みに応じて変更できます。

    edge_out[0]['tailport'] = 'n'
edge_out[1]['tailport'] = 's'
node['width'] = '1'
node['height'] = '1.2'

B1.diagram(format='png')
  7. 設定の動的な変更

    8. 図の設定はtailor_node_to_unitの設定をすることで動的に変更できます。以下の例では、ストリームの流量がゼロの時に機器内に-empty-という文字が追加されるようにしています。

    def tailor_node_to_unit(node, unit):
    if unit.feed.isempty(): node['label'] += '\n-empty-'
graphics.tailor_node_to_unit = tailor_node_to_unit
B1.ins[0].empty()
B1.diagram(format='png')

    注意：tailor_node_to_unit関数のサンプル実装は推奨されません。図はシンプルに保つのが最適です。

このブログの人気の投稿

さあ、始めよう！

イメージ
バイオ・リファイナリー（再生可能資源であるバイオマスを原料にバイオ燃料や樹脂などを製造するプラントや技術)のシミュレーションソフト" BioSTEAM "の基本的な使い方を解説しています。 オリジナルのページは Getting started です。 ソースコードは以下の実行環境で確認しています。 Visual Studio Code バージョン: 1.104.2 拡張機能:Jupyter バージョン 2025.8.0 Python 3.12.10 biosteam 2.52.13 graphviz-14.0.2 では、 さあ、始めよう！ ストリームの初期化 「ストリーム」 は物質の流れを、流量と熱力学的状態として定義されます。ストリームを作成する前に、 「Thermo(熱)」 物性を設定します。あるいは、化学物質の名前を渡すだけで、BioSTEAMが理想的な混合則とUNIFAC活量係数に基づいて、相平衡のための物性パッケージを自動的に作成してくれます。より複雑な物性パッケージは、BioSTEAMの主要な熱力学エンジンである Thermosteam を通じて設定することができます。詳細は Thermosteam 101 を見てください。ここでのサンプルは、いくつかの良く知られている化学物質からなる単純な流入ストリームを初期化しています。 ストリームの設定 水が50kmol/hr、メタノール20kmol/hrの混合物が流入してくる状況を考えます。 import biosteam as bst from biosteam import settings bst.nbtutorial() # Light-mode html diagrams and filter warnings settings.set_thermo(['Water', 'Methanol']) feed = bst.Stream(Water=50, Methanol=20) feed.show() 結果：流れは液相(phase:'l')で、なにも指定していないと、温度と圧力はデフォルトで25℃、101.325kPaになります。 Stre...
続きを読む

蒸留塔

バイオ・リファイナリー（再生可能資源であるバイオマスを原料にバイオ燃料や樹脂などを製造するプラントや技術)のシミュレーションソフト" BioSTEAM "の蒸留塔モデルの解説をしています。蒸留塔モデルはいくつか種類がありますが、ここでは基となる抽象クラスの説明をしています。 オリジナルのページは distillation です。また、ソースコードは以下の実行環境で確認しています。 Visual Studio Code バージョン: 1.104.2 拡張機能:Jupyter バージョン 2025.8.0 Python 3.12.10 biosteam 2.52.13 graphviz-14.0.2 蒸留塔 class distillation ( ID='', ins=None, outs=(), thermo=None, **kwargs ) [source] 蒸留塔のモデル distillation column クラスの抽象クラス。マーフリー効率は、修正されたオコンネル相関式に基づいています [2] 。塔の直径はトレイ間隔およびフラッディング速度に基づいて決定されます [1] [3] 。購入価格は、Warren らによってまとめられた相関式 [4] に基づいています。 パラメータ ID ( str 、省略可) 他で使われていない、一意の識別子(ID)。IDが None の場合、ストリームはフローシートに登録されません。IDが指定されていない場合は、自動的に一意のIDが付与されます。 ins ( Sequence(順序付きコレクション) [ Stream | str ]、省略可) フィード層で混合される流入ストリーム。 outs ( Sequence(順序付きコレクション) [ Stream | str ]、省略可) [0] 塔頂留出物 [1] ボトム生成物 LHK ( tuple [ str] ) 軽質成分と重質成分としたい成分。 y_top ( float ) 塔頂留出物の...
続きを読む

機器ユニットの計算結果

イメージ
バイオ・リファイナリー（再生可能資源であるバイオマスを原料にバイオ燃料や樹脂などを製造するプラントや技術)のシミュレーションソフト" BioSTEAM "の機器ユニットの計算結果(シミュレーション結果)の見方を蒸留塔のモデルを使って解説しています。 オリジナルのページは Unit operation results です。 ソースコードは以下の実行環境で確認しています。 Visual Studio Code バージョン: 1.104.2 拡張機能:Jupyter バージョン 2025.8.0 Python 3.12.10 biosteam 2.52.13 graphviz-14.0.2 機器ユニットの計算結果 設計とモデル化に関するメモ BioSTEAM には、設計の教科書や文献 [1–5] をもとに構成された、幅広い 機器モデル とコスト相関式が含まれています。 ポンプ 、 熱交換器 、 フラッシュ蒸留器 、 ミキサーセトラー (媒抽出を行いながら2液に比重分離する装置)、 蒸留塔 などの基本的な機器ユニットは、非常に厳密にモデル化され、設計されています。 これらの基本的な機器ユニットは、運転温度と圧力、供給条件、構造材料、分離温度といった設計仕様に基づいて生成できます。 これらの設計仕様には、熱交換器の伝熱面積、圧力容器のサイズや板厚、蒸留塔の段数(ステージ数)が含まれますが、これらに限定されているわけではありません。 他の単位操作モデルは、 分離器(スプリッター) としてモデル化されることが多く、これは「ユニットに流入する各成分の所定の割合が分離される」という意味です。 また、これらの装置の購入価格は、 サイズ係数 との相関を用いて推定されます。この相関式は最終的に、物質の流量を基にした関数として表されます。 BioSTEAMでは、各機器ユニットの設計仕様や要件に基づいて、購入コストの相関や、建設係数を選定します。 各機器ユニットの詳細なドキュメントや使用例については、 機器ユニット の説明をご参照ください。 蒸留塔モデル BioSTEAMの機器ユニットモデルがどの様に結果を算出するか、蒸留塔モデルを例に説明します。 蒸留塔モデル fr...
続きを読む