TRNSYSのドキュメント

TRNSYSのドキュメントの話です。

一般にシミュレーションのツールって、アプリケーションの使い方はあたりまえとして、計算方法の「中身」についての記述に非常に多くのページが割かれています。

これって、テレビを買ったら取説に液晶パネルの技術解説書がついてくるようなレベルです。やはり研究用途のツールだと、「中身が見える」というのが重要なポイントのようです。

TRNSYSもご多分に漏れず、すごい量のドキュメントが付いてきます。PDF形式で添付されるものの他、HTML形式だったり、はてはソースコード(←ドキュメントか?)まで含め大量に用意されています。

でも、困ったことに慣れるまで、どこに何があるのか分かり難いんですよねー。ってことでまとめてみたいと思います。

はじめはPDF

アプリケーションの使いたや、TRNSYSのデータフォーマット、コンポーネントの機能についてPDF形式のファイルが用意されています。

スタートメニューやSimulation Stuidoの[ヘルプ]-[?]メニューの2か所から呼び出すことができます。

Vol.1 Getting Startedから始まって、Vol.8 Weather Data、それとオプション製品の数冊構成です。

印刷すると、それぞれ電話帳(そういや最近見ないですね電話帳)ぐらいのボリュームがあります。まともに読み始めると、かなりつらい量です。

何か調べるときは右上に検索ボタンが用意されているので、ここからキーワードを指定して検索するのが効率的です。

慣れてくると、目的の情報が、どのマニュアルにあるのか、だんだん見当がつくようになってきます。

コンポーネントの機能を調べる

コンポーネントの詳細については、次のPDFのドキュメントに詳しい記述があります。

  • Vol03. Standard Component Library Overview
  • Vol04. Component Mathematical Referenceに記載されています。

それ以外のもっとコンポーネントの実装というか、実際にSimulation Studioで利用する際の補足的な情報は以下の機能で確認することができます。いくつかあるので、覚えておくと重宝します。

Proforma

コンポーネントを選んで、右クリックで[Proforma]を選ぶと図のようなウィンドウが表示されます。これの「Description」タブを見るとコンポーネントの概要が書いてあります。なんのためのコンポーネントなのか確認することができます。

Variable Window

コンポーネントをダブルクリックすると、表示されるウィンドウです。まー、頻繁に使うウィンドウなので解説不要かと思いますが、Paramenter/Inputs/Outputsを確認することができます。

ここで、[more]ボタンを押すと、さらに個々の詳しい解説が表示されます。意外とこの機能は知られていないですが、パラメータの意味など不明な場合は、ここで表示される説明が参考になります。

Export as HTML…

前出のProformaのウィンドウを表示した状態でメニューから[File]-[Export as HTML…]を選ぶと、あら不思議。コンポーネントのParameter,Inputs,Outputsなどの説明が、まとめて一つのHTMLとして書き出されます。

このファイルをブラウザで開くと、コンポーネントの機能が一気に見渡せて読みやすいドキュメントになります。

以前は独立した一冊のドキュメントにまとめられていたんですが、いつのころからかHTML形式になりました。

おそらくコンポーネントの数が多く、また、バージョンアップにともなう更新が大変なので、この形式になったのだと思います。

参考:TRNSYSのコンポーネントの機能を調べる

ソースコード

これ見ると、実際何をどうしているかハッキリするので、ある意味究極の仕様書とも言えます。まあ、でも、ソースコードを見て、何やっているかわからないからドキュメントがある訳で、これを読むのは最終手段ですね。

通常は、以下のフォルダに、TRNSYSの基本処理から、コンポーネントなど内容別に収められています。

  • C:\Trnsys17\SourceCode
Type1のソースコード
Type1のソースコード

新しいコンポーネントを作る際には、似た処理を行っているコンポーネントが参考になります。

マニュアルに記載があると言っても、初めて使う関数など、実際に動くいているコンポーネントのソースコードは貴重な情報源になります。

以上、いろいろな情報が用意されているので、状況に応じて利用すると、効率的に作業を進めることができます。

TRNSYSのコンポーネントの説明を考える

TRNSYSはコンポーネントの組み合わせ次第でいろいろな計算に応用できます。この仕組、かなり便利なんですが、説明しにくいところでもあります。

まずコンポーネントの設定画面を見ると、なにかいっぱい項目が並んでいます。慣れないうちは、どこをいじっていいやら戸惑います。

とは言え、普段使うのは赤枠で囲ったParameter,Input,Outputの3項目です。ここさえ抑えれば、コンポーネントの仕組みは分かったも同然です。

コンポーネントの中身は、基本的にはなんらかの「式」なので、以下のような対応関係になります。

こうやって見ると簡単ですよね。あとは目的に合わせて、適切なコンポーネントをつなげればシミュレーションの完成です。

これに実際のコンポーネントだと、計算モードの指定とか、参照するファイルの指定などなど、項目が増えて少し複雑になります。

というような説明だと解りやすいですかね?そろそろTRNSYSの入門シリーズを始めようかと、解りやすい説明を考え中です。

TRNSYSマニュアルの検索機能

TRNSYSのドキュメントって、かなりボリュームがあります。なにか調べたい機能やデータがあっても、なかなか記載箇所を探すのも一苦労。

そんな時に便利なのがマニュアルの検索機能。とういうか元々PDF形式なので検索はできるのですが、複数あるドキュメントを一個一個開いて検索するのも面倒です。ドキュメントに用意されている複数ドキュメントの検索機能を使うと、まとめて検索することができます。

使用方法はいたって簡単です。(この説明ではTRNSYS16を使用していますがTRNSYS17でも同様です)

以下、日本の気象データを探す例で説明します。(建築関係だと学会の拡張アメダスが定番ですが、TRNSYSに標準で添付されている気象データもいくつかあるので、それを検索してみます)

1. TRNSYSのマニュアルを表示する

[スタート]メニューから[TRNSYS 16]をポイントし、[TRNSYS 16 Manual]をクリックします。

2. 「検索ウィンドウ」を表示する

TRNSYS 16 Documentationの右上の「Search entire collection」をクリックして「検索ウィンドウ」を表示します。

3. 検索を開始する

「検索ウィンドウ」で調べたい単語を入力して検索を開始します。

以下の例では、日本の気象データを調べるため「Japan」を入力して検索を行っています。

4. 検索結果を表示する

複数の検索結果が表示されるので、関連しそうな項目をクリックしながら内容を確認していきます。

この例では気象データを調べているので、関連していそうな「Weather Data」ドキュメントから検索結果を選んで内容を表示しています。

無事に日本の気象データのリストが表示できました。

TRNSYSのコンポーネントの機能を調べる

またまたTRNSYSネタです。

コンポーネントの機能を調べる簡単な方法です。まず調べたいコンポーネントのProformaを以下のいずれかの方法で開きます。

  • Direct Access Toolbarから目的のコンポーネントのアイコンをダブルクリックする
  • 配置済みのアイコンを選んで、右ボタンメニューから「Proforma」を選ぶ

画面にProformaのウィンドウが表示された状態で、メニューバーから[File] – [Export to HTML…]の順で選択します。

メニューバーから[File] - [Export to HTML...]
メニューバーから[File] – [Export to HTML…]

HTMLの書き出し先のフォルダを指定すると、ブラウザが起動してコンポーネントの説明が表示されます。

調べたいときに説明がさっと呼び出せるので便利ですね。

これ、内容はTRNSYS16までドキュメントして提供されていた「Component Input – Output – Parameters」と内容一緒ですね。

このTypeはDirect Access Toolbarのどこにある?

前回の「Typeがわからない」の続きです。

あるTypeを使いたいとき、さて配置しようと思ったらどこにあるのか判らない、なんてことないですか?

Direct Access Toolbarって、フォルダの数も多いし、階層もあるので慣れないとTypeを探すのも一苦労です。

Direact Access Toolbar
Direact Access Toolbar

フォルダを一つ一つ開いて探すのもありですが、こういう時はマニュアルを検索するのが楽です。

マニュアルにはフォルダのパスまで書かれいるので、Typeの名前が判っていれば検索ですぐに見つけることができます。

以下、具体的な方法です。さがすのはType14です。

1.TRNSYSのマニュアルから「Standard Component Overview」を開く。

2.検索する

検索のボックスに”Type14″と入力して検索開始。

PDFの検索機能で検索する
PDFの検索機能で検索する

3.該当箇所が表示されたら、パスをチェック

Typeの説明箇所が表示されたら、Proformaという項目をチェックします。(下図の赤い線のところ)

コンポーネントのパスを確認する
コンポーネントのパスを確認する

ここにパスが書いてあるので、これを参考にしてDirect Access Toolbarのフォルダをたどると、無事に目的のTypeにたどり着けます。

以上。

TRNSYS17でマニュアルが減っている?

TRNSYS17のマニュアルの構成を見てて気がついた、

「Input – Output – Parameter Reference」がなくなってる!Σ(゚д゚lll)ガーン


結構使っていたのでショックです。このマニュアル、コンポーネントの入出力調べるのに便利だったのに。。。

これからはSimulation Studioで確認しろって事かな?(内容は一緒です)

2013/06/18追記
その後、HTML形式で「Input – Output – Parameter Reference」相当のドキュメントが書きさせるようになっているのに気が付きました。

参照:TRNSYSのコンポーネントの機能を調べる

Moreボタン

以下、コンポーネントの入出力内容を調べる方法

Simulation Studioで、調べたいコンポーネントをダブルクリックする。

すると、以下のようなダイアログが表示されるので、調べたいパラメータ、入出力項目の[More…]ボタンをクリックする。

「More」ボタンをクリックする
「More」ボタンをクリックする

その項目が使用する単位系や値の範囲など、詳しい説明が表示される。

詳しい説明が表示される
詳しい説明が表示される