Added reference page for output

i-RIC · Mar 27, 2024 · 0efd9fe · 0efd9fe
1 parent b321522
commit 0efd9fe
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 8 deletions.
diff --git a/source/05/03_04_02_int.rst b/source/05/03_04_02_int.rst
@@ -11,10 +11,8 @@
 
    <Item name="obst" caption="Obstacle">
      <Definition valueType="integer" position="cell">
-       <Enumerations>
-         <Enumeration value="0" caption="Normal cell" />
-         <Enumeration value="1" caption="Obstacle" />
-       </Enumerations>
+       <Enumeration value="0" caption="Normal cell" />
+       <Enumeration value="1" caption="Obstacle" />
      </Definition>
    </Item>
 

diff --git a/source/05/03_05_02_int.rst b/source/05/03_05_02_int.rst
@@ -11,10 +11,8 @@
 
    <Output name="wet" caption="Wet">
      <Definition valueType="integer" position="node">
-       <Enumerations>
-         <Enumeration value="0" caption="Dry" />
-         <Enumeration value="1" caption="Wet" />
-       </Enumerations>
+       <Enumeration value="0" caption="Dry" />
+       <Enumeration value="1" caption="Wet" />
      </Definition>
    </Output>
 

diff --git a/source/05/04/definition_output.rst b/source/05/04/definition_output.rst
@@ -0,0 +1,49 @@
+Definition (計算結果の定義)
+===============================================================
+
+計算結果の定義情報を保持します。
+
+例
+----
+
+.. code-block:: xml
+   :caption: Definition の定義例1
+   :name: ref_definition_output_example1
+   :linenos:
+
+   <Definition valueType="real" position="node" />
+
+.. code-block:: xml
+   :caption: Definition の定義例2
+   :name: ref_definition_output_example2
+   :linenos:
+
+   <Definition valueType="integer" position="cell" >
+     <Enumeration value="0" caption="Dry" />
+     <Enumeration value="1" caption="Wet" />
+   </Definition>
+
+例は :ref:`examples_of_output_at_grid` も参照して下さい。
+
+属性
+-----
+
+.. csv-table:: Definition の属性
+   :file: definition_output_attributes.csv
+   :header-rows: 1
+
+.. csv-table:: valueType の値
+   :file: definition_output_att_valuetype.csv
+   :header-rows: 1
+
+.. csv-table:: position の値
+   :file: definition_output_att_position.csv
+   :header-rows: 1
+
+子要素
+--------
+
+.. csv-table:: Definition の子要素
+   :file: definition_output_elements.csv
+   :header-rows: 1
+
diff --git a/source/05/04/definition_output_att_position.csv b/source/05/04/definition_output_att_position.csv
@@ -0,0 +1,7 @@
+値,意味
+node,格子点
+cell,セル
+iface,I方向の格子セルの境界面 (エッジ)
+jface,J方向の格子セルの境界面 (エッジ)
+particle,パーティクル
+polydata,ポリゴン・折れ線
diff --git a/source/05/04/definition_output_att_valuetype.csv b/source/05/04/definition_output_att_valuetype.csv
@@ -0,0 +1,3 @@
+値,意味
+integer,整数
+real,実数
diff --git a/source/05/04/definition_output_attributes.csv b/source/05/04/definition_output_attributes.csv
@@ -0,0 +1,3 @@
+名前,値,必須,説明
+valueType,下の表を参照,○,値の種類
+position,下の表を参照,○,定義位置
diff --git a/source/05/04/definition_output_elements.csv b/source/05/04/definition_output_elements.csv
@@ -0,0 +1,2 @@
+名前,必須,説明
+Enumeration,,"値の選択肢が限られている場合に指定する。valueType が integer の場合のみ指定できる。"
diff --git a/source/05/04/output.rst b/source/05/04/output.rst
@@ -0,0 +1,32 @@
+Output
+==========
+
+計算結果の出力値の定義情報を保持します。
+
+例
+----
+
+.. code-block:: xml
+   :caption: Output の定義例
+   :name: ref_output_example
+   :linenos:
+
+   <Output name="depth" caption="Depth">
+     <Definition valueType="real" position="node" />
+   </Output>
+
+定義例は :ref:`examples_of_output_at_grid` も参照して下さい。
+
+属性
+-----
+
+.. csv-table:: Output の属性
+   :file: output_attributes.csv
+   :header-rows: 1
+
+子要素
+--------
+
+.. csv-table:: Output の子要素
+   :file: output_elements.csv
+   :header-rows: 1
diff --git a/source/05/04/output_attributes.csv b/source/05/04/output_attributes.csv
@@ -0,0 +1,3 @@
+名前,値,必須,説明
+name,文字列,○,要素名
+caption,文字列,o,名前 (オブジェクトブラウザや可視化ウィンドウに表示される)
diff --git a/source/05/04/output_elements.csv b/source/05/04/output_elements.csv
@@ -0,0 +1,4 @@
+名前,必須,説明
+Definition,○,要素の定義
+ColorMapSetting,,デフォルトのカラーマップ設定 (実数値の場合)
+EnumerateColorMapSetting,,デフォルトのカラーマップ設定 (整数値の場合)
diff --git a/source/05/04_reference.rst b/source/05/04_reference.rst
@@ -9,6 +9,7 @@
    04/condition
    04/definition_cc
    04/definition_ga
+   04/definition_output
    04/dimension
    04/enumeration
    04/errorcode
@@ -23,6 +24,7 @@
    04/hboxlayout
    04/item
    04/label
+   04/output
    04/parameter
    04/solverdefinition
    04/tab