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

coreform.abaqus.job

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

ディレクトリツリー

job/

1 errors.py

モジュールパス: coreform.abaqus.job.errors

利用可能なAPIメンバー

名前	種別	説明
`JobFileCollisionError.files`	属性	決定的な報告順序で並べた既存の出力パス。
`JobRuntimeError`	クラス	ユーザーが対処可能なメッセージを伴う、Coreform IGA Job のビルドまたは投入の失敗。
`JobFileCollisionError`	クラス	Job の投入を妨げる既知の Abaqus 出力ファイルを報告します。

1.1 `JobRuntimeError`

オブジェクトパス: coreform.abaqus.job.errors.JobRuntimeError

ユーザーが対処可能なメッセージを伴う、Coreform IGA Job のビルドまたは投入の失敗。

1.2 `JobFileCollisionError`

オブジェクトパス: coreform.abaqus.job.errors.JobFileCollisionError

Job の投入を妨げる既知の Abaqus 出力ファイルを報告します。

呼び出し構文

result = JobFileCollisionError(files=files)

シグネチャ

JobFileCollisionError(files: Union['JobFileCollisionError', Iterable[str]])

パラメータ

名前	型	必須	デフォルト	説明
`files`	`Union['JobFileCollisionError', Iterable[str]]`	はい	—	投入時に上書きされる既存の出力パス。

1.2.1 属性

名前	型	値	説明
`files`	`Tuple[str, ...]`	`tuple(files)`	決定的な報告順序で並べた既存の出力パス。

2 records.py

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

利用可能なAPIメンバー

名前	種別	説明
`CoreformIGA.jobs`	属性	名前をキーに索引付けされた永続的な Coreform IGA Job レコード。
`jobs[jobName].name`	属性	リポジトリキーおよび Job 名。
`jobs[jobName].model`	属性	該当する場合、Job が使用する Abaqus モデル。
`jobs[jobName].description`	属性	ユーザー向けの Job 説明。
`jobs[jobName].meshExecutable`	属性	Coreform IGA Mesh 実行ファイルの上書き指定。
`jobs[jobName].mpiexec`	属性	Mesh ステージの MPI ランチャー上書き指定。
`jobs[jobName].numIgaCpus`	属性	Mesh ステージに割り当てる CPU 数。
`jobs[jobName].interopExecutable`	属性	該当する場合、Abaqus interop 実行ファイルの上書き指定。
`jobs[jobName].numCpus`	属性	解析ステージに割り当てる CPU 数。
`jobs[jobName].numGPUs`	属性	Abaqus 解析ステージに割り当てる GPU 数。
`jobs[jobName].multiprocessingMode`	属性	Abaqus 解析ステージの並列化モード。
`jobs[jobName].threadsPerProcess`	属性	各 Abaqus ソルバープロセスに割り当てるスレッド数。
`jobs[jobName].numDomains`	属性	Abaqus ソルバーが使用するドメイン数。
`jobs[jobName].memory`	属性	Abaqus 解析ステージのメモリ上限。
`jobs[jobName].memoryUnits`	属性	Abaqus ソルバーのメモリ上限を解釈する単位。
`CoreformIGA.deleteJob`	インスタンスメソッド	この名前空間から、指定名の永続 Job を削除します。
`CoreformIGA.Job`	インスタンスメソッド	MDB 名前空間に Coreform IGA Job を作成し、永続化します。
`CoreformIGA.renameJob`	インスタンスメソッド	準備または投入されていない Job の名前を変更します。
`jobs[jobName].toSpec`	インスタンスメソッド	この Job レコードの情報を失わない可搬仕様を返します。
`jobs[jobName].setValues`	インスタンスメソッド	Abaqus 向け camelCase フィールドを介して、この永続 Job を更新します。
`jobs[jobName].buildMesh`	インスタンスメソッド	この Job の Mesh ステージと interop ステージを実行します。
`jobs[jobName].writeInput`	インスタンスメソッド	interop ステージが使用する未処理の Abaqus 入力デッキを書き出します。
`jobs[jobName].submit`	インスタンスメソッド	設定済みパイプラインでこの Job を準備し、投入します。
`jobs[jobName].waitForCompletion`	インスタンスメソッド	投入済み Job が完了するまで待機します。
`jobs[jobName].kill`	インスタンスメソッド	この Job に関連する実行中プロセスを終了します。
`jobs[jobName].getRuntimeStatus`	インスタンスメソッド	この Job の現在の実行状態のスナップショットを返します。
`jobs[jobName].writeRunScript`	インスタンスメソッド	この Job パイプラインを実行可能なスクリプトファイルとして書き出します。
`jobs[jobName].openOdb`	インスタンスメソッド	この Job の Abaqus 出力データベースを開いて返します。
`CoreformIGA`	クラス	MDB レベルの Coreform IGA 名前空間（`mdb.customData.CoreformIGA`）は、この `jobs` リポジトリと公開 `Job(...)` コンストラクタを保持します。
`jobs[jobName]`	クラス	永続 Job レコード: ネストされた仕様は情報を失わず JSON として保存されます (`_spec_json`。これは `toSpec`の正本です）。また、共通のスカラーフィールドは読み取り専用の camelCase 確認属性として読み込まれます。編集は `setValues(...)` これにより、検証、保存済み仕様、ジャーナリングの整合性が維持されます。

2.1 `CoreformIGA`

公開パス: mdb.customData.CoreformIGA

利用可能なAPIメンバー

名前	種別	説明
`jobs`	属性	名前をキーに索引付けされた永続的な Coreform IGA Job レコード。
`deleteJob`	インスタンスメソッド	この名前空間から、指定名の永続 Job を削除します。
`Job`	インスタンスメソッド	MDB 名前空間に Coreform IGA Job を作成し、永続化します。
`renameJob`	インスタンスメソッド	準備または投入されていない Job の名前を変更します。

2.1.1 属性

名前	型	値	説明
`jobs`	`object`	—	名前をキーに索引付けされた永続的な Coreform IGA Job レコード。

2.1.2 `deleteJob`

定義先: mdb.customData.CoreformIGA.deleteJob

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

呼び出し構文

jobs.deleteJob(name=name)

戻り値

型	説明
`None`	—

シグネチャ

deleteJob(name: str) -> None

パラメータ

名前	型	必須	デフォルト	説明
`name`	`str`	はい	—	削除する Job のリポジトリキー。

2.1.3 `Job`

定義先: mdb.customData.CoreformIGA.Job

説明: MDB 名前空間に Coreform IGA Job を作成し、永続化します。

呼び出し構文

result = jobs.Job(spec=spec)
result = jobs.Job(name=name, model=model)

戻り値

型	説明
`Job レコード`	新しく作成された永続 Job レコード。

シグネチャ

Job(*, spec) -> object
Job(*, name, model, description='', meshExecutable='', mpiexec='', numIgaCpus=1, interopExecutable='', numCpus=1, numGPUs=0, multiprocessingMode=ParallelMode.THREADS, threadsPerProcess=None, numDomains=None, memory=90, memoryUnits=MemoryUnits.PERCENTAGE, queue=None, meshQueue=None, interopQueue=None, solveQueue=None) -> object

パラメータ

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

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

対象: Job(*, name, model, description='', meshExecutable='', mpiexec='', numIgaCpus=1, interopExecutable='', numCpus=1, numGPUs=0, multiprocessingMode=ParallelMode.THREADS, threadsPerProcess=None, numDomains=None, memory=90, memoryUnits=MemoryUnits.PERCENTAGE, queue=None, meshQueue=None, interopQueue=None, solveQueue=None) -> object:

名前	型	必須	デフォルト	説明
`name`	`str`	はい	—	一意で空でない Job 名。
`model`	`str`	はい	—	解析パイプラインで使用する Abaqus モデル。
`description`	`str`	いいえ	`''`	任意の Job 説明。
`meshExecutable`	`str`	いいえ	`''`	Coreform IGA Mesh 実行ファイルの上書き指定。
`mpiexec`	`str`	いいえ	`''`	Mesh ステージの MPI ランチャー上書き指定。
`numIgaCpus`	`int`	いいえ	`1`	Mesh ステージで使用する CPU 数。
`interopExecutable`	`str`	いいえ	`''`	Abaqus interop 実行ファイルの上書き指定。
`numCpus`	`int`	いいえ	`1`	解析ステージで使用する CPU 数。
`numGPUs`	`int`	いいえ	`0`	解析ステージで使用する GPU 数。
`multiprocessingMode`	`ParallelMode or str`	いいえ	`ParallelMode.THREADS`	Abaqus ソルバーの並列化モード。
`threadsPerProcess`	`int or None`	いいえ	`None`	各ソルバープロセスに割り当てるスレッド数。
`numDomains`	`int or None`	いいえ	`None`	Abaqus ソルバーのドメイン数。
`memory`	`int`	いいえ	`90`	Abaqus ソルバーのメモリ上限。
`memoryUnits`	`MemoryUnits or str`	いいえ	`MemoryUnits.PERCENTAGE`	解釈に使用する単位 `memory`.
`queue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	`None`	全ステージのデフォルト投入設定。
`meshQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	`None`	Mesh ステージの投入設定の上書き。
`interopQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	`None`	interop ステージの投入設定の上書き。
`solveQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	`None`	解析ステージの投入設定の上書き。

パラメータ規則

規則	要件
呼び出し形式	次の呼び出し形式のいずれか1つだけを使用します: `spec` または `abaqus_definition`.

例外

型	条件
`ValidationError`	仕様、モデル、名前、または実行設定が無効な場合。

2.1.4 `renameJob`

定義先: mdb.customData.CoreformIGA.renameJob

説明: 準備または投入されていない Job の名前を変更します。

呼び出し構文

jobs.renameJob(fromName=fromName, toName=toName)

戻り値

型	説明
`None`	—

シグネチャ

renameJob(fromName: str, toName: str) -> None

パラメータ

名前	型	必須	デフォルト	説明
`fromName`	`str`	はい	—	既存 Job のリポジトリキー。
`toName`	`str`	はい	—	新しい一意の Job 名およびリポジトリキー。

2.2 `jobs[jobName]`

公開パス: mdb.customData.CoreformIGA.jobs[jobName]

利用可能なAPIメンバー

名前	種別	説明
`name`	属性	リポジトリキーおよび Job 名。
`model`	属性	該当する場合、Job が使用する Abaqus モデル。
`description`	属性	ユーザー向けの Job 説明。
`meshExecutable`	属性	Coreform IGA Mesh 実行ファイルの上書き指定。
`mpiexec`	属性	Mesh ステージの MPI ランチャー上書き指定。
`numIgaCpus`	属性	Mesh ステージに割り当てる CPU 数。
`interopExecutable`	属性	該当する場合、Abaqus interop 実行ファイルの上書き指定。
`numCpus`	属性	解析ステージに割り当てる CPU 数。
`numGPUs`	属性	Abaqus 解析ステージに割り当てる GPU 数。
`multiprocessingMode`	属性	Abaqus 解析ステージの並列化モード。
`threadsPerProcess`	属性	各 Abaqus ソルバープロセスに割り当てるスレッド数。
`numDomains`	属性	Abaqus ソルバーが使用するドメイン数。
`memory`	属性	Abaqus 解析ステージのメモリ上限。
`memoryUnits`	属性	Abaqus ソルバーのメモリ上限を解釈する単位。
`toSpec`	インスタンスメソッド	この Job レコードの情報を失わない可搬仕様を返します。
`setValues`	インスタンスメソッド	Abaqus 向け camelCase フィールドを介して、この永続 Job を更新します。
`buildMesh`	インスタンスメソッド	この Job の Mesh ステージと interop ステージを実行します。
`writeInput`	インスタンスメソッド	interop ステージが使用する未処理の Abaqus 入力デッキを書き出します。
`submit`	インスタンスメソッド	設定済みパイプラインでこの Job を準備し、投入します。
`waitForCompletion`	インスタンスメソッド	投入済み Job が完了するまで待機します。
`kill`	インスタンスメソッド	この Job に関連する実行中プロセスを終了します。
`getRuntimeStatus`	インスタンスメソッド	この Job の現在の実行状態のスナップショットを返します。
`writeRunScript`	インスタンスメソッド	この Job パイプラインを実行可能なスクリプトファイルとして書き出します。
`openOdb`	インスタンスメソッド	この Job の Abaqus 出力データベースを開いて返します。

2.2.1 属性

名前	型	値	説明
`name`	`str`	—	リポジトリキーおよび Job 名。
`model`	`Optional[str]`	—	該当する場合、Job が使用する Abaqus モデル。
`description`	`str`	—	ユーザー向けの Job 説明。
`meshExecutable`	`str`	—	Coreform IGA Mesh 実行ファイルの上書き指定。
`mpiexec`	`str`	—	Mesh ステージの MPI ランチャー上書き指定。
`numIgaCpus`	`int`	—	Mesh ステージに割り当てる CPU 数。
`interopExecutable`	`Optional[str]`	—	該当する場合、Abaqus interop 実行ファイルの上書き指定。
`numCpus`	`int`	—	解析ステージに割り当てる CPU 数。
`numGPUs`	`Optional[int]`	—	Abaqus 解析ステージに割り当てる GPU 数。
`multiprocessingMode`	`Optional[Union[ParallelMode, str]]`	—	Abaqus 解析ステージの並列化モード。
`threadsPerProcess`	`Optional[int]`	—	各 Abaqus ソルバープロセスに割り当てるスレッド数。
`numDomains`	`Optional[int]`	—	Abaqus ソルバーが使用するドメイン数。
`memory`	`Optional[int]`	—	Abaqus 解析ステージのメモリ上限。
`memoryUnits`	`Optional[Union[MemoryUnits, str]]`	—	Abaqus ソルバーのメモリ上限を解釈する単位。

2.2.2 `toSpec`

定義先: mdb.customData.CoreformIGA.jobs[jobName].toSpec

説明: この Job レコードの情報を失わない可搬仕様を返します。

呼び出し構文

result = job.toSpec()

戻り値

型	説明
`CoreformIGAJobSpec`	この Job レコードの情報を失わない可搬仕様を返します。

シグネチャ

toSpec() -> CoreformIGAJobSpec

パラメータ

なし。

2.2.3 `setValues`

定義先: mdb.customData.CoreformIGA.jobs[jobName].setValues

説明: Abaqus 向け camelCase フィールドを介して、この永続 Job を更新します。

呼び出し構文

job.setValues(...)

戻り値

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

シグネチャ

setValues(*, model=..., description=..., meshExecutable=..., mpiexec=..., numIgaCpus=..., interopExecutable=..., numCpus=..., numGPUs=..., multiprocessingMode=..., threadsPerProcess=..., numDomains=..., memory=..., memoryUnits=..., meshQueue=..., interopQueue=..., solveQueue=...) -> None

パラメータ

名前	型	必須	デフォルト	説明
`model`	`str`	いいえ	現在値	Abaqus モデル名を置き換えます。
`description`	`str`	いいえ	現在値	Job の説明を置き換えます。
`meshExecutable`	`str`	いいえ	現在値	Mesh 実行ファイルの上書き指定を置き換えます。
`mpiexec`	`str`	いいえ	現在値	MPI ランチャーの上書き指定を置き換えます。
`numIgaCpus`	`int`	いいえ	現在値	Mesh ステージの CPU 数を置き換えます。
`interopExecutable`	`str`	いいえ	現在値	interop 実行ファイルの上書き指定を置き換えます。
`numCpus`	`int`	いいえ	現在値	解析ステージの CPU 数を置き換えます。
`numGPUs`	`int`	いいえ	現在値	解析ステージの GPU 数を置き換えます。
`multiprocessingMode`	`ParallelMode or str`	いいえ	現在値	ソルバーの並列化モードを置き換えます。
`threadsPerProcess`	`int or None`	いいえ	現在値	プロセスあたりのスレッド数設定を置き換えます。
`numDomains`	`int or None`	いいえ	現在値	Abaqus ソルバーのドメイン数を置き換えます。
`memory`	`int`	いいえ	現在値	ソルバーのメモリ上限を置き換えます。
`memoryUnits`	`MemoryUnits or str`	いいえ	現在値	ソルバーのメモリ単位を置き換えます。
`meshQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	現在値	Mesh ステージの投入設定を置き換えます。
`interopQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	現在値	interop ステージの投入設定を置き換えます。
`solveQueue`	`Local, RemoteQueue, Mapping[str, object], or None`	いいえ	現在値	解析ステージの投入設定を置き換えます。

例外

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

2.2.4 `buildMesh`

定義先: mdb.customData.CoreformIGA.jobs[jobName].buildMesh

説明: この Job の Mesh ステージと interop ステージを実行します。

呼び出し構文

result = job.buildMesh()

戻り値

型	説明
`JobExecutionResult`	この Job の Mesh ステージと interop ステージを実行します。

シグネチャ

buildMesh(workDirectory: object = None) -> JobExecutionResult

パラメータ

名前	型	必須	デフォルト	説明
`workDirectory`	`object`	いいえ	`None`	既存の作業ディレクトリ。未指定の場合は `None` Job のデフォルト値を使用します。

2.2.5 `writeInput`

定義先: mdb.customData.CoreformIGA.jobs[jobName].writeInput

説明: interop ステージが使用する未処理の Abaqus 入力デッキを書き出します。

呼び出し構文

job.writeInput()

戻り値

型	説明
`None`	—

シグネチャ

writeInput(workDirectory: object = None) -> None

パラメータ

名前	型	必須	デフォルト	説明
`workDirectory`	`object`	いいえ	`None`	既存の作業ディレクトリ。未指定の場合は `None` Job のデフォルト値を使用します。

2.2.6 `submit`

定義先: mdb.customData.CoreformIGA.jobs[jobName].submit

説明: 設定済みパイプラインでこの Job を準備し、投入します。

呼び出し構文

result = job.submit()

戻り値

型	説明
`JobExecutionResult`	設定済みパイプラインでこの Job を準備し、投入します。

シグネチャ

submit(workDirectory: object = None, overwriteExistingFiles: bool = False, consistencyChecking: str = 'ON') -> JobExecutionResult

パラメータ

名前	型	必須	デフォルト	説明
`workDirectory`	`object`	いいえ	`None`	既存の作業ディレクトリ。未指定の場合は `None` Job のデフォルト値を使用します。
`overwriteExistingFiles`	`bool`	いいえ	`False`	既知の既存 Job 出力を置き換えてよいかどうか。
`consistencyChecking`	`str`	いいえ	`'ON'`	Abaqus 入力生成時の整合性チェック値。

2.2.7 `waitForCompletion`

定義先: mdb.customData.CoreformIGA.jobs[jobName].waitForCompletion

説明: 投入済み Job が完了するまで待機します。

呼び出し構文

job.waitForCompletion()

戻り値

型	説明
`None`	—

シグネチャ

waitForCompletion() -> None

パラメータ

なし。

2.2.8 `kill`

定義先: mdb.customData.CoreformIGA.jobs[jobName].kill

説明: この Job に関連する実行中プロセスを終了します。

呼び出し構文

job.kill()

戻り値

型	説明
`None`	—

シグネチャ

kill() -> None

パラメータ

なし。

2.2.9 `getRuntimeStatus`

定義先: mdb.customData.CoreformIGA.jobs[jobName].getRuntimeStatus

説明: この Job の現在の実行状態のスナップショットを返します。

呼び出し構文

result = job.getRuntimeStatus()

戻り値

型	説明
`dict[str, object]`	この Job の現在の実行状態のスナップショットを返します。

シグネチャ

getRuntimeStatus() -> dict[str, object]

パラメータ

なし。

2.2.10 `writeRunScript`

定義先: mdb.customData.CoreformIGA.jobs[jobName].writeRunScript

説明: この Job パイプラインを実行可能なスクリプトファイルとして書き出します。

呼び出し構文

job.writeRunScript(fileName=fileName)

戻り値

型	説明
`None`	—

シグネチャ

writeRunScript(fileName: object, dialect: str = 'POWERSHELL', prepareInputs: bool = True) -> None

パラメータ

名前	型	必須	デフォルト	説明
`fileName`	`object`	はい	—	Abaqus file API が受け付ける出力先スクリプトパス。
`dialect`	`str`	いいえ	`'POWERSHELL'`	次で受け付ける大文字のスクリプト方言 `render_script`.
`prepareInputs`	`bool`	いいえ	`True`	スクリプトを生成する前に、必要な Abaqus 入力を書き出すかどうか。

2.2.11 `openOdb`

定義先: mdb.customData.CoreformIGA.jobs[jobName].openOdb

説明: この Job の Abaqus 出力データベースを開いて返します。

呼び出し構文

result = job.openOdb()

戻り値

型	説明
`object`	この Job の Abaqus 出力データベースを開いて返します。

シグネチャ

openOdb() -> object

パラメータ

なし。

ディレクトリツリー

1 errors.py

1.1 JobRuntimeError

1.2 JobFileCollisionError

1.2.1 属性

2 records.py

2.1 CoreformIGA

2.1.1 属性

2.1.2 deleteJob

2.1.3 Job

2.1.4 renameJob

2.2 jobs[jobName]

2.2.1 属性

2.2.2 toSpec

2.2.3 setValues

2.2.4 buildMesh

2.2.5 writeInput

2.2.6 submit

2.2.7 waitForCompletion

2.2.8 kill

2.2.9 getRuntimeStatus

2.2.10 writeRunScript

2.2.11 openOdb

1.1 `JobRuntimeError`

1.2 `JobFileCollisionError`

2.1 `CoreformIGA`

2.1.2 `deleteJob`

2.1.3 `Job`

2.1.4 `renameJob`

2.2 `jobs[jobName]`

2.2.2 `toSpec`

2.2.3 `setValues`

2.2.4 `buildMesh`

2.2.5 `writeInput`

2.2.6 `submit`

2.2.7 `waitForCompletion`

2.2.8 `kill`

2.2.9 `getRuntimeStatus`

2.2.10 `writeRunScript`

2.2.11 `openOdb`