:tocdepth: 1

.. role:: bred

==================================
potoptionタグ
==================================

.. index::
	single: potoptionタグ

[|today| 更新]

| 解析に用いる変数，座標系の種類や，係数マトリクスの解法における条件の設定など，ハンドブックの
|    3. ポテンシャルとゲージ条件
| の節に属する項目の設定を行います．

| 基本的に基準値のままで良いですが，計算時間を短縮する目的として

* **POTENTIAL** ラベルに **2** を設定（動磁場解析のケースにおいて）
* **REGULARIZATION** ラベルに **1** を設定
* **LINE_SEARCH** ラベルに **1** を設定（非線形解析のケースにおいて）

を設定すると良いでしょう(:doc:`configファイルを利用して既定値を変更することもできます <config>`)．

.. csv-table:: potoptionタグ
	:header: ラベル, 既定値, 説明
	:widths: 3, 1, 7 

	**POTENTIAL**, 0, "| 未知変数の種類
	| 0: A法
	| 2: A-Φ法
	| 4: As法"
	**NODAL_FORCE_METHOD**, 0, "| 磁性体に働く電磁力の計算において
	| 0: 磁性体内部の応力も計算する
	| 1: 磁性体内部の応力は計算しない"
	**PHI_OPTION**, 0, "| 直流場渦電流解析において
	| 0: Φの時間積分を用いる
	| 1: Φそのものを用いる"
	**FIXED_COORDINATE**, 0, "| 直流場渦電流解析において
	| 0: 導体に固定された運動座標系
	| 1: 空間に固定された座標系"
	**TREE_GAUGE**, -1, "| ゲージ条件の設定
	| -1: ゲージを課さない
	| 0: 完全なゲージの固定"
	**REGULARIZATION**, :bred:`0`, "| コイルに流れる電流に正則化を施すか否か
	| 1: 電流の不連続性を正則化で解消する"
	**RENUMBERING**, 0, "| 係数マトリクスのリナンバリングの有無
	| -1: リナンバリングしない"
	**SCALING**, 0, "| 係数マトリクスのスケーリングの有無
	| -1: スケーリングしない"
	**LINE_SEARCH**, :bred:`0`, "| 非線形解析において減速係数を自動設定するか
	| 1: 自動設定する"
	**MATRIX_ASYMMETRICITY**, 0, "| 二次元非線形磁気異方性, Jiles&Athertonモデル, プレイモデルにおいて
	| 0: (強制的に)対称磁気特性とする
	| 1: 非対称磁気特性する"

:bred:`赤字の既定値`: :doc:`configファイル<config>` で既定値の変更が可能

使用例（渦電流解析でA-Φ法を選択）
---------------------------------

.. code-block:: YAML

	potoption:
	  POTENTIAL: 2

使用例（非線形解析で収束性改善のため直線探索法を用いる）
---------------------------------------------------------

.. code-block:: YAML

	potoption:
	  LINE_SEARCH: 1

使用例（COILソース使用時に収束性改善のため電流の正則化を用いる）
----------------------------------------------------------------

.. code-block:: YAML

	potoption:
	  REGULARIZATION: 1

使用例（Jiles&Athertonモデルもしくはプレイモデルを用いる）
----------------------------------------------------------

.. code-block:: YAML

	potoption:
	  MATRIX_ASYMMETRICITY: 1
