Coreform公式ドキュメントを基にした日本語版です。技術仕様・対応状況の最終的な基準は公式英語版です。

coreform.abaqus.probe

ソースディレクトリ: interop/abaqus/cf_app/coreform/abaqus/probe

ディレクトリツリー

probe/

1 records.py

モジュールパス: coreform.abaqus.probe.records

利用可能なAPIメンバー

名前	種別	説明
`CoreformIGA.probes`	属性	名前をキーに索引付けされた永続 Probe レコード。
`probes[probeName].name`	属性	リポジトリキーおよび Probe 名。
`probes[probeName].probeType`	属性	POINT_PROBE、LINE_PROBE、または MULTI_POINT_PROBE。
`probes[probeName].instanceNames`	属性	選択されたインスタンス名。別のターゲット種別が有効な場合は None。
`probes[probeName].setNames`	属性	選択されたアセンブリセット名。別のターゲット種別が有効な場合は None。
`probes[probeName].partNames`	属性	選択された Part 名。別のターゲット種別が有効な場合は None。
`probes[probeName].variables`	属性	選択された出力変数。シーケンスが空の場合は None。
`probes[probeName].instances`	属性	解決済みの Abaqus インスタンス。対象でない場合は空のタプル。
`probes[probeName].sets`	属性	解決済みの Abaqus アセンブリセット。対象でない場合は空のタプル。
`probes[probeName].parts`	属性	解決済みの Abaqus Part。対象でない場合は空のタプル。
`probes[probeName].location`	属性	Probe が変数を評価する点。
`probes[probeName].startLocation`	属性	Probe 線分の第1端点。
`probes[probeName].stopLocation`	属性	Probe 線分の第2端点。
`probes[probeName].numEvalPoints`	属性	両端点を含む、線上の評価点数。
`probes[probeName].locations`	属性	Probe が変数を評価する明示的な位置。
`CoreformIGA.model`	インスタンスメソッド	この Probe 名前空間を所有する Abaqus Model を返します。
`CoreformIGA.PointProbe`	インスタンスメソッド	この Steps 名前空間に point Probe を作成し、永続化します。
`CoreformIGA.LineProbe`	インスタンスメソッド	この Steps 名前空間に line Probe を作成し、永続化します。
`CoreformIGA.MultiPointProbe`	インスタンスメソッド	この Steps 名前空間に multi-point Probe を作成し、永続化します。
`CoreformIGA.deleteProbe`	インスタンスメソッド	この名前空間から指定名の Probe を削除します。
`probes[probeName].model`	インスタンスメソッド	この Probe レコードを所有する Abaqus Model を返します。
`probes[probeName].toSpec`	インスタンスメソッド	この Probe の変更不能な可搬仕様を返します。
`probes[probeName].validate`	インスタンスメソッド	Probe のターゲット名を、所有するモデルに対して検証します。
`probes[probeName].setValues`	インスタンスメソッド	この永続 Probe をその場で更新します。
`CoreformIGA`	クラス	Abaqus モデルの Steps リポジトリに付随する永続 Probe 名前空間。
`probes[probeName]`	クラス	読み込まれた公開フィールドを読み取り専用として扱う永続 Probe レコード。

1.1 `CoreformIGA`

公開パス: mdb.models[modelName].steps.customData.CoreformIGA

利用可能なAPIメンバー

名前	種別	説明
`probes`	属性	名前をキーに索引付けされた永続 Probe レコード。
`model`	インスタンスメソッド	この Probe 名前空間を所有する Abaqus Model を返します。
`PointProbe`	インスタンスメソッド	この Steps 名前空間に point Probe を作成し、永続化します。
`LineProbe`	インスタンスメソッド	この Steps 名前空間に line Probe を作成し、永続化します。
`MultiPointProbe`	インスタンスメソッド	この Steps 名前空間に multi-point Probe を作成し、永続化します。
`deleteProbe`	インスタンスメソッド	この名前空間から指定名の Probe を削除します。

1.1.1 属性

名前	型	値	説明
`probes`	`object`	—	名前をキーに索引付けされた永続 Probe レコード。

1.1.2 `model`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.model

説明: この Probe 名前空間を所有する Abaqus Model を返します。

呼び出し構文

result = probes.model()

戻り値

型	説明
`object`	この Probe 名前空間を所有する Abaqus Model を返します。

シグネチャ

model() -> object

パラメータ

なし。

1.1.3 `PointProbe`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.PointProbe

説明: この Steps 名前空間に point Probe を作成し、永続化します。

呼び出し構文

result = probes.PointProbe(spec=spec)
result = probes.PointProbe(name=name, instanceNames=instanceNames, location=location)

戻り値

型	説明
`PointProbe record`	新しく作成された永続 point-Probe レコード。

シグネチャ

PointProbe(*, spec) -> object
PointProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), location) -> object

パラメータ

対象: PointProbe(*, spec) -> object:

名前	型	必須	既定値	説明
`spec`	`PointProbeSpec or Mapping[str, object]`	はい	—	完全な可搬仕様、またはシリアライズ済み仕様のマッピング。

対象: PointProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), location) -> object:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	Probe リポジトリ内で一意かつ空でない名前。
`instanceNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリインスタンスのターゲット。
`setNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリセットのターゲット。
`partNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	モデル Part のターゲット。
`variables`	`Sequence[str]`	いいえ	`()`	評価する出力変数名。デフォルトは空のシーケンスです。
`location`	`Point3D`	はい	—	評価位置。

パラメータ規則

規則	要件
呼び出し形式	次の呼び出し形式のいずれか1つだけを使用します: `spec` または `abaqus_definition`.
必須グループ	次のうち厳密に1つを指定します `instanceNames`, `setNames`、または `partNames`.

例外

型	条件
`ValidationError`	仕様、ターゲット選択、名前、または位置が無効な場合。

例

>>> probe = probes.PointProbe(
...     name="Probe-1",
...     instanceNames=("PART-1-1",),
...     location=(0.0, 0.0, 0.0),
... )

1.1.4 `LineProbe`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.LineProbe

説明: この Steps 名前空間に line Probe を作成し、永続化します。

呼び出し構文

result = probes.LineProbe(spec=spec)
result = probes.LineProbe(name=name, instanceNames=instanceNames, startLocation=startLocation, stopLocation=stopLocation)

戻り値

型	説明
`LineProbe record`	新しく作成された永続 line-Probe レコード。

シグネチャ

LineProbe(*, spec) -> object
LineProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), startLocation, stopLocation, numEvalPoints=2) -> object

パラメータ

対象: LineProbe(*, spec) -> object:

名前	型	必須	既定値	説明
`spec`	`LineProbeSpec or Mapping[str, object]`	はい	—	完全な可搬仕様、またはシリアライズ済み仕様のマッピング。

対象: LineProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), startLocation, stopLocation, numEvalPoints=2) -> object:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	Probe リポジトリ内で一意かつ空でない名前。
`instanceNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリインスタンスのターゲット。
`setNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリセットのターゲット。
`partNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	モデル Part のターゲット。
`variables`	`Sequence[str]`	いいえ	`()`	評価する出力変数名。デフォルトは空のシーケンスです。
`startLocation`	`Point3D`	はい	—	線分の第1端点。
`stopLocation`	`Point3D`	はい	—	線分の第2端点。startLocation と異なる必要があります。
`numEvalPoints`	`int`	いいえ	`2`	両端点を含む評価点数。2以上である必要があります。

パラメータ規則

規則	要件
呼び出し形式	次の呼び出し形式のいずれか1つだけを使用します: `spec` または `abaqus_definition`.
必須グループ	次のうち厳密に1つを指定します `instanceNames`, `setNames`、または `partNames`.

例外

型	条件
`ValidationError`	仕様、ターゲット選択、名前、または幾何が無効な場合。

1.1.5 `MultiPointProbe`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.MultiPointProbe

説明: この Steps 名前空間に multi-point Probe を作成し、永続化します。

呼び出し構文

result = probes.MultiPointProbe(spec=spec)
result = probes.MultiPointProbe(name=name, instanceNames=instanceNames, locations=locations)

戻り値

型	説明
`MultiPointProbe record`	新しく作成された永続 multi-point-Probe レコード。

シグネチャ

MultiPointProbe(*, spec) -> object
MultiPointProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), locations) -> object

パラメータ

対象: MultiPointProbe(*, spec) -> object:

名前	型	必須	既定値	説明
`spec`	`MultiPointProbeSpec or Mapping[str, object]`	はい	—	完全な可搬仕様、またはシリアライズ済み仕様のマッピング。

対象: MultiPointProbe(*, name, instanceNames=None, setNames=None, partNames=None, variables=(), locations) -> object:

名前	型	必須	既定値	説明
`name`	`str`	はい	—	Probe リポジトリ内で一意かつ空でない名前。
`instanceNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリインスタンスのターゲット。
`setNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	アセンブリセットのターゲット。
`partNames`	`Sequence[str]`	次のうち厳密に1つを指定します: `instanceNames`, `setNames`、または `partNames`	`None`	モデル Part のターゲット。
`variables`	`Sequence[str]`	いいえ	`()`	評価する出力変数名。デフォルトは空のシーケンスです。
`locations`	`Sequence[Point3D]`	はい	—	1つ以上の明示的な評価位置。

パラメータ規則

規則	要件
呼び出し形式	次の呼び出し形式のいずれか1つだけを使用します: `spec` または `abaqus_definition`.
必須グループ	次のうち厳密に1つを指定します `instanceNames`, `setNames`、または `partNames`.

例外

型	条件
`ValidationError`	仕様、ターゲット選択、名前、または位置群が無効な場合。

1.1.6 `deleteProbe`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.deleteProbe

説明: この名前空間から指定名の Probe を削除します。

呼び出し構文

probes.deleteProbe(name=name)

戻り値

型	説明
`None`	—

シグネチャ

deleteProbe(name: str) -> None

パラメータ

名前	型	必須	既定値	説明
`name`	`str`	はい	—	削除する Probe レコードの名前。

例外

型	条件
`KeyError`	リポジトリに指定した名前が存在しない場合。

1.2 `probes[probeName]`

公開パス: mdb.models[modelName].steps.customData.CoreformIGA.probes[probeName]

利用可能なAPIメンバー

名前	種別	説明
`name`	属性	リポジトリキーおよび Probe 名。
`probeType`	属性	POINT_PROBE、LINE_PROBE、または MULTI_POINT_PROBE。
`instanceNames`	属性	選択されたインスタンス名。別のターゲット種別が有効な場合は None。
`setNames`	属性	選択されたアセンブリセット名。別のターゲット種別が有効な場合は None。
`partNames`	属性	選択された Part 名。別のターゲット種別が有効な場合は None。
`variables`	属性	選択された出力変数。シーケンスが空の場合は None。
`instances`	属性	解決済みの Abaqus インスタンス。対象でない場合は空のタプル。
`sets`	属性	解決済みの Abaqus アセンブリセット。対象でない場合は空のタプル。
`parts`	属性	解決済みの Abaqus Part。対象でない場合は空のタプル。
`location`	属性	Probe が変数を評価する点。
`startLocation`	属性	Probe 線分の第1端点。
`stopLocation`	属性	Probe 線分の第2端点。
`numEvalPoints`	属性	両端点を含む、線上の評価点数。
`locations`	属性	Probe が変数を評価する明示的な位置。
`model`	インスタンスメソッド	この Probe レコードを所有する Abaqus Model を返します。
`toSpec`	インスタンスメソッド	この Probe の変更不能な可搬仕様を返します。
`validate`	インスタンスメソッド	Probe のターゲット名を、所有するモデルに対して検証します。
`setValues`	インスタンスメソッド	この永続 Probe をその場で更新します。

1.2.1 属性

名前	型	適用対象	値	説明
`name`	`str`	すべて	—	リポジトリキーおよび Probe 名。
`probeType`	`object`	すべて	—	POINT_PROBE、LINE_PROBE、または MULTI_POINT_PROBE。
`instanceNames`	`Optional[Tuple[str, ...]]`	すべて	—	選択されたインスタンス名。別のターゲット種別が有効な場合は None。
`setNames`	`Optional[Tuple[str, ...]]`	すべて	—	選択されたアセンブリセット名。別のターゲット種別が有効な場合は None。
`partNames`	`Optional[Tuple[str, ...]]`	すべて	—	選択された Part 名。別のターゲット種別が有効な場合は None。
`variables`	`Optional[Tuple[str, ...]]`	すべて	—	選択された出力変数。シーケンスが空の場合は None。
`instances`	`tuple[object, ...]`	すべて	—	解決済みの Abaqus インスタンス。対象でない場合は空のタプル。
`sets`	`tuple[object, ...]`	すべて	—	解決済みの Abaqus アセンブリセット。対象でない場合は空のタプル。
`parts`	`tuple[object, ...]`	すべて	—	解決済みの Abaqus Part。対象でない場合は空のタプル。
`location`	`Point3D`	`PointProbe`	—	Probe が変数を評価する点。
`startLocation`	`Point3D`	`LineProbe`	—	Probe 線分の第1端点。
`stopLocation`	`Point3D`	`LineProbe`	—	Probe 線分の第2端点。
`numEvalPoints`	`int`	`LineProbe`	—	両端点を含む、線上の評価点数。
`locations`	`Tuple[Point3D, ...]`	`MultiPointProbe`	—	Probe が変数を評価する明示的な位置。

1.2.2 `model`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.probes[probeName].model

説明: この Probe レコードを所有する Abaqus Model を返します。

呼び出し構文

result = probe.model()

戻り値

型	説明
`object`	この Probe レコードを所有する Abaqus Model を返します。

シグネチャ

model() -> object

パラメータ

なし。

1.2.3 `toSpec`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.probes[probeName].toSpec

説明: この Probe の変更不能な可搬仕様を返します。

呼び出し構文

result = probe.toSpec()

戻り値

型	説明
`ProbeSpec`	この Probe の変更不能な可搬仕様を返します。

シグネチャ

toSpec() -> ProbeSpec

パラメータ

なし。

1.2.4 `validate`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.probes[probeName].validate

説明: Probe のターゲット名を、所有するモデルに対して検証します。

呼び出し構文

probe.validate()

戻り値

型	説明
`None`	—

シグネチャ

validate() -> None

パラメータ

なし。

1.2.5 `setValues`

定義先: mdb.models[modelName].steps.customData.CoreformIGA.probes[probeName].setValues

説明: この永続 Probe をその場で更新します。

呼び出し構文

probe.setValues(...)

戻り値

型	説明
`None`	レコードをその場で更新します。

シグネチャ

PointProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., location=...) -> None
LineProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., startLocation=..., stopLocation=..., numEvalPoints=...) -> None
MultiPointProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., locations=...) -> None

パラメータ

対象: PointProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., location=...) -> None:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str or None`	いいえ	現在値	省略、空、 `None`、または変更なしにできます。Probe の名前変更はサポートされません。
`instanceNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリインスタンスへ切り替えます。
`setNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリセットへ切り替えます。
`partNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをモデル Part へ切り替えます。
`variables`	すべて	`Sequence[str] or None`	いいえ	現在値	出力変数名を置き換えます。 `None` を指定するとクリアします。
`location`	`PointProbe`	`Point3D`	いいえ	現在値	point Probe の評価位置を置き換えます。

対象: LineProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., startLocation=..., stopLocation=..., numEvalPoints=...) -> None:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str or None`	いいえ	現在値	省略、空、 `None`、または変更なしにできます。Probe の名前変更はサポートされません。
`instanceNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリインスタンスへ切り替えます。
`setNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリセットへ切り替えます。
`partNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをモデル Part へ切り替えます。
`variables`	すべて	`Sequence[str] or None`	いいえ	現在値	出力変数名を置き換えます。 `None` を指定するとクリアします。
`startLocation`	`LineProbe`	`Point3D`	いいえ	現在値	line Probe の第1端点を置き換えます。
`stopLocation`	`LineProbe`	`Point3D`	いいえ	現在値	line Probe の第2端点を置き換えます。
`numEvalPoints`	`LineProbe`	`int`	いいえ	現在値	line Probe の評価点数を置き換えます。

対象: MultiPointProbe.setValues(*, name=..., instanceNames=..., setNames=..., partNames=..., variables=..., locations=...) -> None:

名前	適用対象	型	必須	既定値	説明
`name`	すべて	`str or None`	いいえ	現在値	省略、空、 `None`、または変更なしにできます。Probe の名前変更はサポートされません。
`instanceNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリインスタンスへ切り替えます。
`setNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをアセンブリセットへ切り替えます。
`partNames`	すべて	`Sequence[str]`	いいえ	現在値	ターゲットをモデル Part へ切り替えます。
`variables`	すべて	`Sequence[str] or None`	いいえ	現在値	出力変数名を置き換えます。 `None` を指定するとクリアします。
`locations`	`MultiPointProbe`	`Sequence[Point3D]`	いいえ	現在値	multi-point Probe の明示的な位置群を置き換えます。

パラメータ規則

規則	要件
任意の排他的グループ	このグループを更新する場合、次のうち厳密に1つを指定します `instanceNames`, `setNames`、または `partNames`.
適用範囲	`location` は次の場合にのみ適用されます: `PointProbe`.
適用範囲	`startLocation` は次の場合にのみ適用されます: `LineProbe`.
適用範囲	`stopLocation` は次の場合にのみ適用されます: `LineProbe`.
適用範囲	`numEvalPoints` は次の場合にのみ適用されます: `LineProbe`.
適用範囲	`locations` は次の場合にのみ適用されます: `MultiPointProbe`.

例外

型	条件
`ValidationError`	サポートされない更新、または無効な Probe になる更新の場合。

例

>>> probe.setValues(setNames=("TIP",))

ディレクトリツリー

1 records.py

1.1 CoreformIGA

1.1.1 属性

1.1.2 model

1.1.3 PointProbe

1.1.4 LineProbe

1.1.5 MultiPointProbe

1.1.6 deleteProbe

1.2 probes[probeName]

1.2.1 属性

1.2.2 model

1.2.3 toSpec

1.2.4 validate

1.2.5 setValues

1.1 `CoreformIGA`

1.1.2 `model`

1.1.3 `PointProbe`

1.1.4 `LineProbe`

1.1.5 `MultiPointProbe`

1.1.6 `deleteProbe`

1.2 `probes[probeName]`

1.2.2 `model`

1.2.3 `toSpec`

1.2.4 `validate`

1.2.5 `setValues`