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

coreform.job

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

ディレクトリツリー

1 artifacts.py

モジュールパス: coreform.job.artifacts

利用可能なAPIメンバー

名前 種別 説明
AbaqusArtifactPaths.prefix 属性 投入された Job とその主要成果物で共有するベース名。
AbaqusArtifactPaths.mesh_cf 属性 Mesh ステージが使用する Coreform 入力ファイル。
AbaqusArtifactPaths.interop_cf 属性 Abaqus interop ステージが使用する Coreform 入力ファイル。
AbaqusArtifactPaths.mesh_sql 属性 Mesh ステージが生成するメッシュデータベース。
AbaqusArtifactPaths.interop_sql 属性 interop ステージによって更新されるメッシュデータベース。
AbaqusArtifactPaths.main_inp 属性 翻訳され、次の名前で投入される Abaqus 入力デッキ prefix.
AbaqusArtifactPaths.source_inp 属性 未翻訳の Abaqus 入力デッキの保護コピー。
AbaqusArtifactPaths.geometry_inp 属性 IGA ジオメトリを含む生成済み入力デッキ。
AbaqusArtifactPaths.keyword_report 属性 Abaqus キーワード変換を記述する JSON レポート。
AbaqusArtifactPaths.completion_msg 属性 完了検出に使用する Abaqus メッセージファイル。
AbaqusArtifactPaths.results_odb 属性 解析ステージが生成する Abaqus 出力データベース。
AbaqusArtifactPaths.results_sql 属性 解析ステージが生成する Coreform 結果データベース。
abaqus_artifact_paths 関数 ポータブル計画と Abaqus アダプターで共有する成果物パスを解決します。
AbaqusArtifactPaths クラス 1つのポータブル Abaqus Job パイプラインについて解決済みの相対パス。

1.1 AbaqusArtifactPaths

オブジェクトパス: coreform.job.artifacts.AbaqusArtifactPaths

1つのポータブル Abaqus Job パイプラインについて解決済みの相対パス。

呼び出し構文

result = AbaqusArtifactPaths(prefix=prefix, mesh_cf=mesh_cf, interop_cf=interop_cf, mesh_sql=mesh_sql, interop_sql=interop_sql, main_inp=main_inp, source_inp=source_inp, geometry_inp=geometry_inp, keyword_report=keyword_report, completion_msg=completion_msg, results_odb=results_odb, results_sql=results_sql)

シグネチャ

AbaqusArtifactPaths(prefix: str, mesh_cf: str, interop_cf: str, mesh_sql: str, interop_sql: str, main_inp: str, source_inp: str, geometry_inp: str, keyword_report: str, completion_msg: str, results_odb: str, results_sql: str)

パラメータ

名前 型 必須 既定値 説明
prefix str はい — 投入された Job とその主要成果物で共有するベース名。
mesh_cf str はい — Mesh ステージが使用する Coreform 入力ファイル。
interop_cf str はい — Abaqus interop ステージが使用する Coreform 入力ファイル。
mesh_sql str はい — Mesh ステージが生成するメッシュデータベース。
interop_sql str はい — interop ステージによって更新されるメッシュデータベース。
main_inp str はい — 翻訳され、次の名前で投入される Abaqus 入力デッキ prefix.
source_inp str はい — 未翻訳の Abaqus 入力デッキの保護コピー。
geometry_inp str はい — IGA ジオメトリを含む生成済み入力デッキ。
keyword_report str はい — Abaqus キーワード変換を記述する JSON レポート。
completion_msg str はい — 完了検出に使用する Abaqus メッセージファイル。
results_odb str はい — 解析ステージが生成する Abaqus 出力データベース。
results_sql str はい — 解析ステージが生成する Coreform 結果データベース。

1.1.1 属性

名前 型 値 説明
prefix str — 投入された Job とその主要成果物で共有するベース名。
mesh_cf str — Mesh ステージが使用する Coreform 入力ファイル。
interop_cf str — Abaqus interop ステージが使用する Coreform 入力ファイル。
mesh_sql str — Mesh ステージが生成するメッシュデータベース。
interop_sql str — interop ステージによって更新されるメッシュデータベース。
main_inp str — 翻訳され、次の名前で投入される Abaqus 入力デッキ prefix.
source_inp str — 未翻訳の Abaqus 入力デッキの保護コピー。
geometry_inp str — IGA ジオメトリを含む生成済み入力デッキ。
keyword_report str — Abaqus キーワード変換を記述する JSON レポート。
completion_msg str — 完了検出に使用する Abaqus メッセージファイル。
results_odb str — 解析ステージが生成する Abaqus 出力データベース。
results_sql str — 解析ステージが生成する Coreform 結果データベース。

1.2 abaqus_artifact_paths

オブジェクトパス: coreform.job.artifacts.abaqus_artifact_paths

説明: ポータブル計画と Abaqus アダプターで共有する成果物パスを解決します。

呼び出し構文

result = coreform.job.artifacts.abaqus_artifact_paths(value=value)

戻り値

型 説明
AbaqusArtifactPaths パイプラインの各成果物について決定論的に導出されたファイル名。

シグネチャ

abaqus_artifact_paths(value: Union['IGAJob', 'CoreformIGAJobSpec']) -> AbaqusArtifactPaths

パラメータ

名前 型 必須 既定値 説明
value Union['IGAJob', 'CoreformIGAJobSpec'] はい — ポータブル Abaqus Job またはその完全な仕様。

2 context.py

モジュールパス: coreform.job.context

利用可能なAPIメンバー

名前 種別 説明
EnvironmentDelta.values 属性 厳密な値を割り当てる環境変数。
EnvironmentDelta.prepends 属性 パス形式の環境変数の先頭に追加する値。
ExecutionContext.plan 属性 実行またはスクリプト生成する順序付き Job パイプライン。
ExecutionContext.work_directory 属性 パイプラインが動作する既存ディレクトリ。
ExecutionContext.environment 属性 パイプラインに必要な最小限の環境変更。
EnvironmentDelta.apply インスタンスメソッド この差分を基準環境に適用し、結果を返します。
build_execution_context 関数 既存の1つの作業ディレクトリについて、ポータブル Job 計画を解決します。
EnvironmentDelta クラス 親環境全体をコピーせずに Job が必要とする環境。
ExecutionContext クラス 実行計画を作業ディレクトリと環境に束縛します。

2.1 EnvironmentDelta

オブジェクトパス: coreform.job.context.EnvironmentDelta

親環境全体をコピーせずに Job が必要とする環境。

呼び出し構文

result = EnvironmentDelta()

シグネチャ

EnvironmentDelta(values: Tuple[Tuple[str, str], ...] = (), prepends: Tuple[Tuple[str, str], ...] = ())

パラメータ

名前 型 必須 既定値 説明
values Tuple[Tuple[str, str], ...] いいえ () 厳密な値を割り当てる環境変数。
prepends Tuple[Tuple[str, str], ...] いいえ () パス形式の環境変数の先頭に追加する値。

2.1.1 属性

名前 型 値 説明
values Tuple[Tuple[str, str], ...] () 厳密な値を割り当てる環境変数。
prepends Tuple[Tuple[str, str], ...] () パス形式の環境変数の先頭に追加する値。

2.1.2 apply

定義先: coreform.job.context.EnvironmentDelta.apply

説明: この差分を基準環境に適用し、結果を返します。

呼び出し構文

result = environmentDelta.apply()

戻り値

型 説明
dict[str, str] この差分を基準環境に適用し、結果を返します。

シグネチャ

apply(base_environment: Optional[Mapping[str, str]] = None) -> dict[str, str]

パラメータ

名前 型 必須 既定値 説明
base_environment Optional[Mapping[str, str]] いいえ None 開始環境。現在のプロセス環境をコピーする場合は None を指定します。

2.2 ExecutionContext

オブジェクトパス: coreform.job.context.ExecutionContext

実行計画を作業ディレクトリと環境に束縛します。

呼び出し構文

result = ExecutionContext(plan=plan, work_directory=work_directory, environment=environment)

シグネチャ

ExecutionContext(plan: ExecutionPlan, work_directory: str, environment: EnvironmentDelta)

パラメータ

名前 型 必須 既定値 説明
plan ExecutionPlan はい — 実行またはスクリプト生成する順序付き Job パイプライン。
work_directory str はい — パイプラインが動作する既存ディレクトリ。
environment EnvironmentDelta はい — パイプラインに必要な最小限の環境変更。

2.2.1 属性

名前 型 値 説明
plan ExecutionPlan — 実行またはスクリプト生成する順序付き Job パイプライン。
work_directory str — パイプラインが動作する既存ディレクトリ。
environment EnvironmentDelta — パイプラインに必要な最小限の環境変更。

2.3 build_execution_context

オブジェクトパス: coreform.job.context.build_execution_context

説明: 既存の1つの作業ディレクトリについて、ポータブル Job 計画を解決します。

呼び出し構文

result = coreform.job.context.build_execution_context(value=value, work_directory=work_directory)

戻り値

型 説明
ExecutionContext 解決済みの実行計画、作業ディレクトリ、環境変更。

シグネチャ

build_execution_context(value: Union['IGAJob', 'CoreformIGAJobSpec'], *, work_directory: str, base_environment: Optional[Mapping[str, str]] = None) -> ExecutionContext

パラメータ

名前 型 必須 既定値 説明
value Union['IGAJob', 'CoreformIGAJobSpec'] はい — ポータブル Job または完全な Job 仕様。
work_directory str はい — Job の入力成果物を含む既存ディレクトリ。
base_environment Optional[Mapping[str, str]] いいえ None 実行ファイルとパス追加を解決するために使用する環境。

3 export.py

モジュールパス: coreform.job.export

利用可能なAPIメンバー

名前 種別 説明
SCRIPT_DIALECTS 属性 次で受け付ける正規名: render_script.
to_bash 関数 Job または実行計画を、実行可能なローカル bash スクリプトとして生成します。
to_zsh 関数 Job または実行計画を、実行可能なローカル zsh スクリプトとして生成します。
to_powershell 関数 Job または実行計画を、実行可能なローカル PowerShell スクリプトとして生成します。
to_cmd 関数 Job または実行計画を、実行可能な Windows CMD バッチスクリプトとして生成します。
to_slurm 関数 SLURM バッチスクリプトの開始点を生成します。
to_pbs 関数 PBS/OpenPBS バッチスクリプトの開始点を生成します。
to_batch_script 関数 Job のリモートキューが選択したバッチスクリプト方言を生成します。
render_script 関数 明示的に選択した1つのスクリプト方言を生成します。
ExportError クラス 実行計画を要求された方言で生成できないことを報告します。

3.1 ExportError

オブジェクトパス: coreform.job.export.ExportError

実行計画を要求された方言で生成できないことを報告します。

3.2 SCRIPT_DIALECTS

オブジェクトパス: coreform.job.export.SCRIPT_DIALECTS

型: Tuple[str, ...]

次で受け付ける正規名: render_script.

3.3 to_bash

オブジェクトパス: coreform.job.export.to_bash

説明: Job または実行計画を、実行可能なローカル bash スクリプトとして生成します。

呼び出し構文

result = coreform.job.export.to_bash(plan_or_job=plan_or_job)

戻り値

型 説明
str Job または実行計画を、実行可能なローカル bash スクリプトとして生成します。

シグネチャ

to_bash(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.4 to_zsh

オブジェクトパス: coreform.job.export.to_zsh

説明: Job または実行計画を、実行可能なローカル zsh スクリプトとして生成します。

呼び出し構文

result = coreform.job.export.to_zsh(plan_or_job=plan_or_job)

戻り値

型 説明
str Job または実行計画を、実行可能なローカル zsh スクリプトとして生成します。

シグネチャ

to_zsh(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.5 to_powershell

オブジェクトパス: coreform.job.export.to_powershell

説明: Job または実行計画を、実行可能なローカル PowerShell スクリプトとして生成します。

呼び出し構文

result = coreform.job.export.to_powershell(plan_or_job=plan_or_job)

戻り値

型 説明
str Job または実行計画を、実行可能なローカル PowerShell スクリプトとして生成します。

シグネチャ

to_powershell(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.6 to_cmd

オブジェクトパス: coreform.job.export.to_cmd

説明: Job または実行計画を、実行可能な Windows CMD バッチスクリプトとして生成します。

呼び出し構文

result = coreform.job.export.to_cmd(plan_or_job=plan_or_job)

戻り値

型 説明
str Job または実行計画を、実行可能な Windows CMD バッチスクリプトとして生成します。

シグネチャ

to_cmd(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.7 to_slurm

オブジェクトパス: coreform.job.export.to_slurm

説明: SLURM バッチスクリプトの開始点を生成します。

呼び出し構文

result = coreform.job.export.to_slurm(plan_or_job=plan_or_job)

戻り値

型 説明
str SLURM バッチスクリプトの開始点を生成します。

シグネチャ

to_slurm(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.8 to_pbs

オブジェクトパス: coreform.job.export.to_pbs

説明: PBS/OpenPBS バッチスクリプトの開始点を生成します。

呼び出し構文

result = coreform.job.export.to_pbs(plan_or_job=plan_or_job)

戻り値

型 説明
str PBS/OpenPBS バッチスクリプトの開始点を生成します。

シグネチャ

to_pbs(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

3.9 to_batch_script

オブジェクトパス: coreform.job.export.to_batch_script

説明: Job のリモートキューが選択したバッチスクリプト方言を生成します。

呼び出し構文

result = coreform.job.export.to_batch_script(plan_or_job=plan_or_job)

戻り値

型 説明
str Job のリモートキューが選択したバッチスクリプト方言を生成します。

シグネチャ

to_batch_script(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

例外

型 条件
ExportError 対応する SLURM または PBS リモートキューが方言を選択していない場合。

3.10 render_script

オブジェクトパス: coreform.job.export.render_script

説明: 明示的に選択した1つのスクリプト方言を生成します。

呼び出し構文

result = coreform.job.export.render_script(plan_or_job=plan_or_job, dialect=dialect)

戻り値

型 説明
str 選択された方言による完全なスクリプトテキスト。

シグネチャ

render_script(plan_or_job: Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext], dialect: str, *, script_directory: bool = False) -> str

パラメータ

名前 型 必須 既定値 説明
plan_or_job Union['IGAJob', 'CoreformIGAJobSpec', ExecutionPlan, ExecutionContext] はい — 生成対象となる Job 定義、投影済み計画、または解決済み実行コンテキスト。
dialect str はい — 次に含まれる大文字名のいずれか: SCRIPT_DIALECTS.
script_directory bool いいえ False コンテキストの作業ディレクトリではなく、スクリプトのディレクトリから実行します。

例外

型 条件
ExportError 次の場合: dialect はサポートされていません。

4 model.py

モジュールパス: coreform.job.model

利用可能なAPIメンバー

名前 種別 説明
IGAJob.spec 属性 ラップする完全なポータブル Job 仕様。
IGAJob.name 属性 Job 名を返します。
IGAJob.model 属性 Abaqus モデル名を返します。ネイティブターゲットの場合は None です。
IGAJob.create クラスメソッド 汎用エントリ: 1つの位置引数 CoreformIGAJobSpec (インポートパス)または
ネストしたキーワード形式(name=, mesh=MeshStage(...),
solver=AbaqusTarget(...))。フラットな Abaqus 操作形式には
IGAJob.abaqus(...).
IGAJob.abaqus クラスメソッド 一般的な Abaqus Job 用のフラットで扱いやすいアセンブラー: フラットなキーワードを
ネストしたステージパイプライン仕様へ投影します。 num_iga_cpus は Mesh ステージの CPU
数(num_cpus は解析ステージの CPU 数)です。 queue= は全ステージに適用されます。ステージごとの
個別設定 mesh_queue= / interop_queue= / solve_queue= は
これを上書きします。これは公開されているフラットな Job(...) アダプター
コンストラクターのポータブル版です。あまり一般的でないステージ入力(parts、dedup_epsilon など)は
ネスト形式の仕様を使用します。
IGAJob.from_spec クラスメソッド 既存のポータブル Job 仕様をラップします。
IGAJob.to_spec インスタンスメソッド ラップされているポータブル Job 仕様を返します。
IGAJob.copy_with インスタンスメソッド 指定フィールドを置き換えた、検証済み Job のコピーを返します。
IGAJob クラス 1つのポータブル Coreform IGA Job 仕様をラップします。

4.1 IGAJob

オブジェクトパス: coreform.job.model.IGAJob

1つのポータブル Coreform IGA Job 仕様をラップします。

呼び出し構文

result = IGAJob(spec=spec)

シグネチャ

IGAJob(spec: CoreformIGAJobSpec)

パラメータ

名前 型 必須 既定値 説明
spec CoreformIGAJobSpec はい — ラップする完全なポータブル Job 仕様。

例

>>> job = IGAJob.abaqus(name="Job-1", model="Model-1")

4.1.1 属性

名前 型 値 説明
spec CoreformIGAJobSpec — ラップする完全なポータブル Job 仕様。
name str — Job 名を返します。
model Optional[str] — Abaqus モデル名を返します。ネイティブターゲットの場合は None です。

4.1.2 create

定義先: coreform.job.model.IGAJob.create

説明: 汎用エントリ: 1つの位置引数 CoreformIGAJobSpec (インポートパス)またはネストしたキーワード形式(name=, mesh=MeshStage(...), solver=AbaqusTarget(...))。フラットな Abaqus 操作形式には IGAJob.abaqus(...).

呼び出し構文

result = IGAJob.create(spec)
result = IGAJob.create(name=name, mesh=mesh, solver=solver)

戻り値

型 説明
IGAJob 汎用エントリ: 1つの位置引数 CoreformIGAJobSpec (インポートパス)または
ネストしたキーワード形式(name=, mesh=MeshStage(...),
solver=AbaqusTarget(...))。フラットな Abaqus 操作形式には
IGAJob.abaqus(...).

シグネチャ

create(spec: CoreformIGAJobSpec, /) -> IGAJob
create(name: str = None, description: str = '', mesh: Optional[MeshStage] = None, solver: Optional[Union[AbaqusTarget, NativeTarget]] = None) -> IGAJob

パラメータ

対象: create(spec: CoreformIGAJobSpec, /) -> IGAJob:

名前 型 必須 既定値 説明
spec CoreformIGAJobSpec はい — 完全なポータブル仕様。

対象: create(name: str = None, description: str = '', mesh: Optional[MeshStage] = None, solver: Optional[Union[AbaqusTarget, NativeTarget]] = None) -> IGAJob:

名前 型 必須 既定値 説明
name str はい — 一意で空でない Job 名。
description str いいえ '' 任意の、人が読める Job の説明。
mesh Optional[MeshStage] はい — 必須の Coreform IGA Mesh ステージ。
solver Optional[Union[AbaqusTarget, NativeTarget]] はい — 必須の後段ソルバーターゲット。

4.1.3 abaqus

定義先: coreform.job.model.IGAJob.abaqus

説明: 一般的な Abaqus Job 用のフラットで扱いやすいアセンブラー: フラットなキーワードをネストしたステージパイプライン仕様へ投影します。 num_iga_cpus は Mesh ステージの CPU 数(num_cpus は解析ステージの CPU 数)です。 queue= は全ステージに適用されます。ステージごとの mesh_queue= / interop_queue= / solve_queue= はこれを上書きします。これは公開されているフラットな Job(...) アダプターコンストラクターのポータブル版です。あまり一般的でないステージ入力(parts、dedup_epsilon など)はネスト形式の仕様を使用します。

呼び出し構文

result = IGAJob.abaqus()

戻り値

型 説明
IGAJob 一般的な Abaqus Job 用のフラットで扱いやすいアセンブラー: フラットなキーワードを
ネストしたステージパイプライン仕様へ投影します。 num_iga_cpus は Mesh ステージの CPU
数(num_cpus は解析ステージの CPU 数)です。 queue= は全ステージに適用されます。ステージごとの
個別設定 mesh_queue= / interop_queue= / solve_queue= は
これを上書きします。これは公開されているフラットな Job(...) アダプター
コンストラクターのポータブル版です。あまり一般的でないステージ入力(parts、dedup_epsilon など)は
ネスト形式の仕様を使用します。

シグネチャ

abaqus(name: Optional[str] = None, model: Optional[str] = None, description: str = '', mesh_executable: str = '', mpiexec: str = '', num_iga_cpus: int = 1, output_db: Optional[str] = None, interop_executable: str = '', inp_prefix: Optional[str] = None, num_cpus: int = 1, num_gpus: int = 0, parallel_mode: Union[ParallelMode, str] = ParallelMode.THREADS, threads_per_process: Optional[int] = None, num_domains: Optional[int] = None, memory: int = 90, memory_units: Union[MemoryUnits, str] = MemoryUnits.PERCENTAGE, queue: Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] = None, mesh_queue: Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] = None, interop_queue: Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] = None, solve_queue: Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] = None) -> 'IGAJob'

パラメータ

名前 型 必須 既定値 説明
name Optional[str] いいえ None 一意で空でない Job 名。
model Optional[str] いいえ None 解析パイプラインで使用する Abaqus モデル。
description str いいえ '' 任意の、人が読める Job の説明。
mesh_executable str いいえ '' Coreform IGA Mesh 実行ファイルの上書き指定。
mpiexec str いいえ '' Mesh ステージの MPI ランチャー上書き指定。
num_iga_cpus int いいえ 1 Mesh ステージの CPU 数。
output_db Optional[str] いいえ None メッシュデータベースのファイル名上書き。
interop_executable str いいえ '' Abaqus interop 実行ファイルの上書き指定。
inp_prefix Optional[str] いいえ None Abaqus 成果物ファミリーのベース名上書き。
num_cpus int いいえ 1 Abaqus 解析ステージの CPU 数。
num_gpus int いいえ 0 Abaqus 解析ステージの GPU 数。
parallel_mode Union[ParallelMode, str] いいえ ParallelMode.THREADS Abaqus のプロセス/スレッドモード。
threads_per_process Optional[int] いいえ None 各 Abaqus MPI プロセスに割り当てるスレッド数。
num_domains Optional[int] いいえ None Abaqus ソルバーのドメイン数。
memory int いいえ 90 次の単位で解釈される Abaqus メモリ上限: memory_units.
memory_units Union[MemoryUnits, str] いいえ MemoryUnits.PERCENTAGE 解釈に使用する単位 memory.
queue Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] いいえ None 全ステージのデフォルト投入設定。
mesh_queue Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] いいえ None Mesh ステージの投入設定の上書き。
interop_queue Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] いいえ None interop ステージの投入設定の上書き。
solve_queue Optional[Union[Local, RemoteQueue, Mapping[str, Any]]] いいえ None 解析ステージの投入設定の上書き。

4.1.4 from_spec

定義先: coreform.job.model.IGAJob.from_spec

説明: 既存のポータブル Job 仕様をラップします。

呼び出し構文

result = IGAJob.from_spec(spec=spec)

戻り値

型 説明
IGAJob 既存のポータブル Job 仕様をラップします。

シグネチャ

from_spec(spec: CoreformIGAJobSpec) -> 'IGAJob'

パラメータ

名前 型 必須 既定値 説明
spec CoreformIGAJobSpec はい — ラップする完全なポータブル Job 仕様。

4.1.5 to_spec

定義先: coreform.job.model.IGAJob.to_spec

説明: ラップされているポータブル Job 仕様を返します。

呼び出し構文

result = job.to_spec()

戻り値

型 説明
CoreformIGAJobSpec ラップされているポータブル Job 仕様を返します。

シグネチャ

to_spec() -> CoreformIGAJobSpec

パラメータ

なし。

4.1.6 copy_with

定義先: coreform.job.model.IGAJob.copy_with

説明: 指定フィールドを置き換えた、検証済み Job のコピーを返します。

呼び出し構文

result = job.copy_with(...)

戻り値

型 説明
IGAJob 指定フィールドを置き換えた、検証済み Job のコピーを返します。

シグネチャ

copy_with(*, name: str = ..., description: str = ..., mesh: Optional[MeshStage] = ..., solver: Optional[Union[AbaqusTarget, NativeTarget]] = ...) -> IGAJob

パラメータ

名前 型 必須 既定値 説明
name str いいえ 現在値 一意で空でない Job 名。
description str いいえ 現在値 任意の、人が読める Job の説明。
mesh Optional[MeshStage] いいえ 現在値 必須の Coreform IGA Mesh ステージ。
solver Optional[Union[AbaqusTarget, NativeTarget]] いいえ 現在値 必須の後段ソルバーターゲット。

5 plan.py

モジュールパス: coreform.job.plan

利用可能なAPIメンバー

名前 種別 説明
Command.argv 属性 プロセス起動順に並んだ実行ファイルと引数。
RestoreFirst.protected_copy 属性 保護付き再実行の前に所定位置へコピーされるバックアップ入力。
RestoreFirst.destination 属性 翻訳済みマーカーを含む場合に復元される入力パス。
RestoreFirst.translated_marker 属性 以前に翻訳された出力先を識別するテキスト。
PlanStep.name 属性 依存関係と結果で使用する安定したステージ名。
PlanStep.command 属性 このステージの実行ファイル呼び出し。
PlanStep.submission 属性 要求されたローカル実行またはスケジューラ実行のポリシー。
PlanStep.inputs 属性 このステージが読み込む成果物パス。
PlanStep.outputs 属性 このステージが生成する成果物パス。
PlanStep.depends_on 属性 このステージの実行前に完了している必要があるステージ名。
PlanStep.restore_first 属性 コマンド実行前に適用する任意の再実行ガード。
ExecutionPlan.job_name 属性 パイプラインに関連付けられた論理 Job 名。
ExecutionPlan.steps 属性 決定論的な実行順序で並んだパイプラインステージ。
build_execution_plan 関数 Job(IGAJob または CoreformIGAJobSpec)を順序付き ExecutionPlan に投影します。
PlanError クラス ポータブル Job を実行計画へ投影できないことを報告します。
Command クラス 1回の実行ファイル呼び出し。
RestoreFirst クラス 非冪等ステップ用の再実行ガード: 実行前に destination
にすでに translated_marker が含まれている場合(つまり、これはそのステップ自身の直前の出力であり、
生の入力ではありません)、さらに protected_copy が存在する場合は、protected_copy を元に戻して
destination を上書きします。
PlanStep クラス 実行可能なステップとしての1つのパイプラインステージ: コマンド、実行場所、
読み書きする成果物、先行すべきステップ、および任意の再実行
ガード(RestoreFirst を参照)。
ExecutionPlan クラス 1つの Job について、順序付きでバックエンド非依存のステージを記述します。

5.1 PlanError

オブジェクトパス: coreform.job.plan.PlanError

ポータブル Job を実行計画へ投影できないことを報告します。

5.2 Command

オブジェクトパス: coreform.job.plan.Command

1回の実行ファイル呼び出し。

呼び出し構文

result = Command(argv=argv)

シグネチャ

Command(argv: Tuple[str, ...])

パラメータ

名前 型 必須 既定値 説明
argv Tuple[str, ...] はい — プロセス起動順に並んだ実行ファイルと引数。

5.2.1 属性

名前 型 値 説明
argv Tuple[str, ...] — プロセス起動順に並んだ実行ファイルと引数。

5.3 RestoreFirst

オブジェクトパス: coreform.job.plan.RestoreFirst

非冪等ステップ用の再実行ガード: 実行前に destination にすでに translated_marker (つまり、そのステップ自身の直前の出力であり、生の入力ではありません)、さらに protected_copy が存在する場合は、protected_copy を destination に戻して上書きします。

呼び出し構文

result = RestoreFirst(protected_copy=protected_copy, destination=destination, translated_marker=translated_marker)

シグネチャ

RestoreFirst(protected_copy: str, destination: str, translated_marker: str)

パラメータ

名前 型 必須 既定値 説明
protected_copy str はい — 保護付き再実行の前に所定位置へコピーされるバックアップ入力。
destination str はい — 翻訳済みマーカーを含む場合に復元される入力パス。
translated_marker str はい — 以前に翻訳された出力先を識別するテキスト。

5.3.1 属性

名前 型 値 説明
protected_copy str — 保護付き再実行の前に所定位置へコピーされるバックアップ入力。
destination str — 翻訳済みマーカーを含む場合に復元される入力パス。
translated_marker str — 以前に翻訳された出力先を識別するテキスト。

5.4 PlanStep

オブジェクトパス: coreform.job.plan.PlanStep

実行可能なステップとしての1つのパイプラインステージ: コマンド、実行場所、読み書きする成果物、先行すべきステップ、および任意の再実行ガード(RestoreFirst を参照)。

呼び出し構文

result = PlanStep(name=name, command=command, submission=submission, inputs=inputs, outputs=outputs, depends_on=depends_on)

シグネチャ

PlanStep(name: str, command: Command, submission: Optional[Union[Local, RemoteQueue]], inputs: Tuple[str, ...], outputs: Tuple[str, ...], depends_on: Tuple[str, ...], restore_first: Optional[RestoreFirst] = None)

パラメータ

名前 型 必須 既定値 説明
name str はい — 依存関係と結果で使用する安定したステージ名。
command Command はい — このステージの実行ファイル呼び出し。
submission Optional[Union[Local, RemoteQueue]] はい — 要求されたローカル実行またはスケジューラ実行のポリシー。
inputs Tuple[str, ...] はい — このステージが読み込む成果物パス。
outputs Tuple[str, ...] はい — このステージが生成する成果物パス。
depends_on Tuple[str, ...] はい — このステージの実行前に完了している必要があるステージ名。
restore_first Optional[RestoreFirst] いいえ None コマンド実行前に適用する任意の再実行ガード。

5.4.1 属性

名前 型 値 説明
name str — 依存関係と結果で使用する安定したステージ名。
command Command — このステージの実行ファイル呼び出し。
submission Optional[Union[Local, RemoteQueue]] — 要求されたローカル実行またはスケジューラ実行のポリシー。
inputs Tuple[str, ...] — このステージが読み込む成果物パス。
outputs Tuple[str, ...] — このステージが生成する成果物パス。
depends_on Tuple[str, ...] — このステージの実行前に完了している必要があるステージ名。
restore_first Optional[RestoreFirst] None コマンド実行前に適用する任意の再実行ガード。

5.5 ExecutionPlan

オブジェクトパス: coreform.job.plan.ExecutionPlan

1つの Job について、順序付きでバックエンド非依存のステージを記述します。

呼び出し構文

result = ExecutionPlan(job_name=job_name, steps=steps)

シグネチャ

ExecutionPlan(job_name: str, steps: Tuple[PlanStep, ...])

パラメータ

名前 型 必須 既定値 説明
job_name str はい — パイプラインに関連付けられた論理 Job 名。
steps Tuple[PlanStep, ...] はい — 決定論的な実行順序で並んだパイプラインステージ。

例

>>> plan = ExecutionPlan(
...     job_name="Job-1",
...     steps=(PlanStep(
...         name="mesh",
...         command=Command(("coreform_iga_mesh", "model.cf")),
...         submission=None,
...         inputs=("model.cf",),
...         outputs=("model.sql",),
...         depends_on=(),
...     ),),
... )

5.5.1 属性

名前 型 値 説明
job_name str — パイプラインに関連付けられた論理 Job 名。
steps Tuple[PlanStep, ...] — 決定論的な実行順序で並んだパイプラインステージ。

5.6 build_execution_plan

オブジェクトパス: coreform.job.plan.build_execution_plan

説明: Job(IGAJob または CoreformIGAJobSpec)を順序付き ExecutionPlan に投影します。

呼び出し構文

result = coreform.job.plan.build_execution_plan(job=job)

戻り値

型 説明
ExecutionPlan 順序付きでバックエンド非依存の Mesh、interop、解析ステージ。

シグネチャ

build_execution_plan(job: Union['IGAJob', CoreformIGAJobSpec]) -> ExecutionPlan

パラメータ

名前 型 必須 既定値 説明
job Union['IGAJob', CoreformIGAJobSpec] はい — 投影対象のポータブル Job または完全な Job 仕様。

例外

型 条件
PlanError Job がネイティブまたは未対応のソルバーターゲットを使用する場合。

6 results.py

モジュールパス: coreform.job.results

利用可能なAPIメンバー

名前 種別 説明
JobStepResult.name 属性 安定したパイプラインステージ名。
JobStepResult.returncode 属性 完了したステージが返したプロセス終了コード。
JobStepResult.ok 属性 ステージが正常に完了したかを報告します。
JobExecutionResult.results 属性 パイプラインの実行順序に並んだ結果。
JobExecutionResult.ok 属性 完了したすべてのステージが成功したかを報告します。
JobExecutionResult.get インスタンスメソッド 指定したステージの結果を返します。実行されなかった場合は None です。
JobStepResult クラス 完了した1つの Job パイプラインステージの終了状態を報告します。
JobExecutionResult クラス Job 実行操作の順序付きステージ結果を報告します。

6.1 JobStepResult

オブジェクトパス: coreform.job.results.JobStepResult

完了した1つの Job パイプラインステージの終了状態を報告します。

呼び出し構文

result = JobStepResult(name=name, returncode=returncode)

シグネチャ

JobStepResult(name: str, returncode: int)

パラメータ

名前 型 必須 既定値 説明
name str はい — 安定したパイプラインステージ名。
returncode int はい — 完了したステージが返したプロセス終了コード。

6.1.1 属性

名前 型 値 説明
name str — 安定したパイプラインステージ名。
returncode int — 完了したステージが返したプロセス終了コード。
ok bool — ステージが正常に完了したかを報告します。

6.2 JobExecutionResult

オブジェクトパス: coreform.job.results.JobExecutionResult

Job 実行操作の順序付きステージ結果を報告します。

呼び出し構文

result = JobExecutionResult(results=results)

シグネチャ

JobExecutionResult(results: Tuple[JobStepResult, ...])

パラメータ

名前 型 必須 既定値 説明
results Tuple[JobStepResult, ...] はい — パイプラインの実行順序に並んだ結果。

6.2.1 属性

名前 型 値 説明
results Tuple[JobStepResult, ...] — パイプラインの実行順序に並んだ結果。
ok bool — 完了したすべてのステージが成功したかを報告します。

6.2.2 get

定義先: coreform.job.results.JobExecutionResult.get

説明: 指定したステージの結果を返します。実行されなかった場合は None です。

呼び出し構文

result = jobExecutionResult.get(name=name)

戻り値

型 説明
JobStepResult \| None 指定したステージの結果を返します。実行されなかった場合は None です。

シグネチャ

get(name: str) -> JobStepResult | None

パラメータ

名前 型 必須 既定値 説明
name str はい — 検索するパイプラインステージ名。

7 specs.py

モジュールパス: coreform.job.specs

利用可能なAPIメンバー

名前 種別 説明
MemoryUnits.PERCENTAGE 属性 Abaqus が使用可能な物理メモリの割合。
MemoryUnits.MEGA_BYTES 属性 メガバイト単位のメモリ上限。
MemoryUnits.GIGA_BYTES 属性 ギガバイト単位のメモリ上限。
ParallelMode.DEFAULT 属性 プロセスとスレッドの配置を Abaqus のデフォルト選択に任せます。
ParallelMode.MPI 属性 各 MPI プロセスで1スレッドを使用します。
ParallelMode.THREADS 属性 1プロセスで複数スレッドを使用します。
ParallelMode.HYBRID 属性 MPI プロセスと各プロセス内の複数スレッドを組み合わせます。
Scheduler.ABAQUS 属性 キュー投入を Abaqus のサイト環境に委任します。
Scheduler.SLURM 属性 SLURM スケジューラ指令を生成します。
Scheduler.PBS 属性 PBS/OpenPBS スケジューラ指令を生成します。
Scheduler.LSF 属性 後段処理用の LSF キューを記述します。
Local.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
Local.submission_type 属性 ローカル実行を表すシリアライズ済み識別子。
RemoteQueue.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
RemoteQueue.scheduler 属性 リモート資源割り当てを担当するスケジューラ。
RemoteQueue.queue_name 属性 サイトのキュー名またはパーティション名。
RemoteQueue.account 属性 スケジューラのアカウントまたはプロジェクト識別子。
RemoteQueue.walltime 属性 スケジューラの実行時間上限。
RemoteQueue.nodes 属性 要求するノード数。
RemoteQueue.extra_directives 属性 追加のサイト固有スケジューラ指令行。
RemoteQueue.submission_type 属性 リモートキュー実行を表すシリアライズ済み識別子。
MeshStage.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
MeshStage.mesh_executable 属性 Coreform IGA Mesh 実行ファイルの名前またはパスの上書き。
MeshStage.mpiexec 属性 使用する MPI ランチャー名またはパス。 num_cpus が1より大きい場合に使用します。
MeshStage.num_cpus 属性 Mesh 生成に使用する正の CPU 数。
MeshStage.cf_file 属性 Coreform 入力ファイル名。または None を指定すると Job から導出します。
MeshStage.output_db 属性 メッシュデータベースのファイル名。または None を指定すると入力から導出します。
MeshStage.parts 属性 メッシュ対象のパート名。空のタプルの場合は全パート。
MeshStage.extra_args 属性 Mesh 実行ファイルへ渡す追加のコマンドライン引数。
MeshStage.queue 属性 Mesh ステージの投入ポリシー。
AbaqusInterop.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
AbaqusInterop.interop_executable 属性 Coreform Abaqus interop 実行ファイルの名前またはパスの上書き。
AbaqusInterop.cf_file 属性 Coreform 入力ファイル名。または None を指定すると Mesh ステージの入力を使用します。
AbaqusInterop.sql_file 属性 メッシュデータベースのファイル名。または None を指定すると Mesh ステージの出力を使用します。
AbaqusInterop.inp_prefix 属性 Abaqus 入力および結果成果物ファミリーのベース名。
AbaqusInterop.parts 属性 変換対象のパート名。空のタプルの場合は全パート。
AbaqusInterop.dedup_epsilon 属性 任意の0以上のノード重複除去許容値。
AbaqusInterop.keyword_report 属性 キーワードレポートのファイル名。または None を指定すると prefix から導出します。
AbaqusInterop.extra_args 属性 interop 実行ファイルへ渡す追加引数。
AbaqusInterop.queue 属性 interop ステージの投入ポリシー。
AbaqusSolve.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
AbaqusSolve.num_cpus 属性 Abaqus 解析で使用する正の CPU 数。
AbaqusSolve.num_gpus 属性 Abaqus 解析で使用する0以上の GPU 数。
AbaqusSolve.parallel_mode 属性 ソルバーのプロセス/スレッドモード。
AbaqusSolve.threads_per_process 属性 明示的なハイブリッド配置における MPI プロセスあたりのスレッド数。
AbaqusSolve.num_domains 属性 Abaqus ソルバーのドメイン数。次の値の整数倍である必要があります: num_cpus.
AbaqusSolve.memory 属性 正のソルバーメモリ上限。
AbaqusSolve.memory_units 属性 解釈に使用する単位 memory.
AbaqusSolve.queue 属性 解析ステージの投入ポリシー。
NativeSolve.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
NativeSolve.num_cpus 属性 ネイティブ解析で使用する正の CPU 数。
NativeSolve.queue 属性 ネイティブ解析ステージの投入ポリシー。
AbaqusTarget.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
AbaqusTarget.model 属性 空でない Abaqus モデル名。
AbaqusTarget.interop 属性 必須の Coreform-to-Abaqus interop ステージ。
AbaqusTarget.solve 属性 必須の Abaqus 解析ステージ。
AbaqusTarget.solver_type 属性 Abaqus ターゲットを表すシリアライズ済み識別子。
NativeTarget.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
NativeTarget.solve 属性 必須のネイティブ Coreform IGA 解析ステージ。
NativeTarget.solver_type 属性 ネイティブターゲットを表すシリアライズ済み識別子。
CoreformIGAJobSpec.schemaVersion 属性 シリアライズされた仕様スキーマのバージョン。
CoreformIGAJobSpec.name 属性 一意で空でない Job 名。
CoreformIGAJobSpec.description 属性 任意の、人が読める Job の説明。
CoreformIGAJobSpec.mesh 属性 必須の Coreform IGA Mesh ステージ。
CoreformIGAJobSpec.solver 属性 必須の後段ソルバーターゲット。
Local.validate インスタンスメソッド この仕様の検証上の問題を返します。
Local.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
Local.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
Local.from_dict クラスメソッド マッピングペイロードから検証済み投入仕様を作成します。
Local.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
Local.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
RemoteQueue.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
RemoteQueue.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
RemoteQueue.from_dict クラスメソッド マッピングペイロードから検証済み投入仕様を作成します。
RemoteQueue.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
RemoteQueue.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
RemoteQueue.validate インスタンスメソッド リモートキュー設定の検証上の問題を返します。
MeshStage.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
MeshStage.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
MeshStage.from_dict クラスメソッド マッピングペイロードから検証済み仕様を作成します。
MeshStage.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
MeshStage.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
MeshStage.validate インスタンスメソッド Mesh ステージの検証上の問題を返します。
AbaqusInterop.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
AbaqusInterop.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
AbaqusInterop.from_dict クラスメソッド マッピングペイロードから検証済み仕様を作成します。
AbaqusInterop.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
AbaqusInterop.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
AbaqusInterop.validate インスタンスメソッド Abaqus interop ステージの検証上の問題を返します。
AbaqusSolve.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
AbaqusSolve.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
AbaqusSolve.from_dict クラスメソッド マッピングペイロードから検証済み仕様を作成します。
AbaqusSolve.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
AbaqusSolve.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
AbaqusSolve.validate インスタンスメソッド Abaqus 解析設定の検証上の問題を返します。
NativeSolve.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
NativeSolve.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
NativeSolve.from_dict クラスメソッド マッピングペイロードから検証済み仕様を作成します。
NativeSolve.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
NativeSolve.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
NativeSolve.validate インスタンスメソッド ネイティブ解析設定の検証上の問題を返します。
AbaqusTarget.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
AbaqusTarget.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
AbaqusTarget.from_dict クラスメソッド マッピングペイロードから検証済みソルバーターゲットを作成します。
AbaqusTarget.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
AbaqusTarget.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
AbaqusTarget.validate インスタンスメソッド Abaqus ソルバーターゲットの検証上の問題を返します。
NativeTarget.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
NativeTarget.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
NativeTarget.from_dict クラスメソッド マッピングペイロードから検証済みソルバーターゲットを作成します。
NativeTarget.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
NativeTarget.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
NativeTarget.validate インスタンスメソッド ネイティブソルバーターゲットの検証上の問題を返します。
CoreformIGAJobSpec.to_dict インスタンスメソッド この仕様をバージョン付き辞書へシリアライズします。
CoreformIGAJobSpec.to_json インスタンスメソッド この仕様をバージョン付き JSON 文書へシリアライズします。
CoreformIGAJobSpec.from_dict クラスメソッド マッピングペイロードから検証済み仕様を作成します。
CoreformIGAJobSpec.from_json クラスメソッド JSON 文書から検証済み仕様を作成します。
CoreformIGAJobSpec.copy_with インスタンスメソッド 指定フィールドを置き換えた検証済みコピーを返します。
CoreformIGAJobSpec.validate インスタンスメソッド 完全な Job 仕様の検証上の問題を返します。
MemoryUnits クラス Abaqus Job のメモリ上限を解釈するための単位。
ParallelMode クラス Abaqus 解析ステージでサポートされるプロセス/スレッドモード。
Scheduler クラス ポータブル Job の投入設定でサポートされるリモートスケジューラ。
Local クラス ローカルプロセス環境で Job ステージを実行します。
RemoteQueue クラス リモートスケジューラキューを介して Job ステージを投入します。
MeshStage クラス Coreform IGA メッシュ構築 — coreform_iga_mesh 呼び出し。常に
存在し、ソルバーに依存しません。
AbaqusInterop クラス Coreform IGA → Abaqus interop ステージ — coreform_interop_abaqus
呼び出し。interop はソルバー固有で(ソルバーの入力デッキを生成するため)、
Abaqus ソルバーターゲットの配下に置かれます。
AbaqusSolve クラス Abaqus 解析の計算形態(Abaqus の mdb.Job / abaqus job= インターフェース)。
これらの設定は Abaqus 固有です。別のソルバーは、そのソルバーがサポートする
リソースだけを持つ独自の解析型を使用します(NativeSolve を参照)。 num_gpus -> numGPUs
および parallel_mode -> multiprocessingMode はフィールド単位の公開名上書きです
(Abaqus 自身の大文字小文字規則は不規則で、 numCpus に対して numGPUs).
NativeSolve クラス ネイティブ Coreform IGA 解析。設計上最小限にしており、ネイティブソルバーが公開する設定項目は
Abaqus より大幅に少ないため、Abaqus の GPU/ドメイン/
並列モード/メモリ上限フィールドは持ちません。ここにフィールドを追加するのは、ネイティブ
ソルバーの実行インターフェースで定義された場合だけです。
AbaqusTarget クラス Abaqus モデル、interop ステージ、解析ステージを記述します。
NativeTarget クラス ネイティブ Coreform IGA ソルバーターゲットを記述します。
CoreformIGAJobSpec クラス ポータブル Coreform IGA Job パイプラインを定義します。

7.1 MemoryUnits

オブジェクトパス: coreform.job.specs.MemoryUnits

Abaqus Job のメモリ上限を解釈するための単位。

7.1.1 属性

名前 型 値 説明
PERCENTAGE MemoryUnits 'PERCENTAGE' Abaqus が使用可能な物理メモリの割合。
MEGA_BYTES MemoryUnits 'MEGA_BYTES' メガバイト単位のメモリ上限。
GIGA_BYTES MemoryUnits 'GIGA_BYTES' ギガバイト単位のメモリ上限。

7.2 ParallelMode

オブジェクトパス: coreform.job.specs.ParallelMode

Abaqus 解析ステージでサポートされるプロセス/スレッドモード。

7.2.1 属性

名前 型 値 説明
DEFAULT ParallelMode 'DEFAULT' プロセスとスレッドの配置を Abaqus のデフォルト選択に任せます。
MPI ParallelMode 'MPI' 各 MPI プロセスで1スレッドを使用します。
THREADS ParallelMode 'THREADS' 1プロセスで複数スレッドを使用します。
HYBRID ParallelMode 'HYBRID' MPI プロセスと各プロセス内の複数スレッドを組み合わせます。

7.3 Scheduler

オブジェクトパス: coreform.job.specs.Scheduler

ポータブル Job の投入設定でサポートされるリモートスケジューラ。

7.3.1 属性

名前 型 値 説明
ABAQUS Scheduler 'ABAQUS' キュー投入を Abaqus のサイト環境に委任します。
SLURM Scheduler 'SLURM' SLURM スケジューラ指令を生成します。
PBS Scheduler 'PBS' PBS/OpenPBS スケジューラ指令を生成します。
LSF Scheduler 'LSF' 後段処理用の LSF キューを記述します。

7.4 Local

オブジェクトパス: coreform.job.specs.Local

ローカルプロセス環境で Job ステージを実行します。

呼び出し構文

result = Local()

シグネチャ

Local()

パラメータ

なし。

7.4.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
submission_type str 'Local' ローカル実行を表すシリアライズ済み識別子。

7.4.2 validate

定義先: coreform.job.specs.Local.validate

説明: この仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] 検出されたすべての問題。仕様が有効な場合は空のタプル。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.4.3 to_dict

定義先: coreform.job.specs.Local.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.4.4 to_json

定義先: coreform.job.specs.Local.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.4.5 from_dict

定義先: coreform.job.specs.Local.from_dict

説明: マッピングペイロードから検証済み投入仕様を作成します。

呼び出し構文

result = Local.from_dict(payload=payload)

戻り値

型 説明
_SubmissionT マッピングペイロードから検証済み投入仕様を作成します。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> Local

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 投入フィールドと、検証および読み込みに使用する任意の識別子。

7.4.6 from_json

定義先: coreform.job.specs.Local.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = Local.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> Local

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.4.7 copy_with

定義先: coreform.job.specs.Local.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.5 RemoteQueue

オブジェクトパス: coreform.job.specs.RemoteQueue

リモートスケジューラキューを介して Job ステージを投入します。

呼び出し構文

result = RemoteQueue()

シグネチャ

RemoteQueue(scheduler: Scheduler = Scheduler.ABAQUS, queue_name: str = '', account: str = '', walltime: str = '', nodes: Optional[int] = None, extra_directives: Tuple[str, ...] = ())

パラメータ

名前 型 必須 既定値 説明
scheduler Scheduler いいえ Scheduler.ABAQUS リモート資源割り当てを担当するスケジューラ。
queue_name str いいえ '' サイトのキュー名またはパーティション名。
account str いいえ '' スケジューラのアカウントまたはプロジェクト識別子。
walltime str いいえ '' スケジューラの実行時間上限。
nodes Optional[int] いいえ None 要求するノード数。
extra_directives Tuple[str, ...] いいえ () 追加のサイト固有スケジューラ指令行。

7.5.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
scheduler Scheduler Scheduler.ABAQUS リモート資源割り当てを担当するスケジューラ。
queue_name str '' サイトのキュー名またはパーティション名。
account str '' スケジューラのアカウントまたはプロジェクト識別子。
walltime str '' スケジューラの実行時間上限。
nodes Optional[int] None 要求するノード数。
extra_directives Tuple[str, ...] () 追加のサイト固有スケジューラ指令行。
submission_type str 'RemoteQueue' リモートキュー実行を表すシリアライズ済み識別子。

7.5.2 to_dict

定義先: coreform.job.specs.RemoteQueue.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.5.3 to_json

定義先: coreform.job.specs.RemoteQueue.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.5.4 from_dict

定義先: coreform.job.specs.RemoteQueue.from_dict

説明: マッピングペイロードから検証済み投入仕様を作成します。

呼び出し構文

result = RemoteQueue.from_dict(payload=payload)

戻り値

型 説明
_SubmissionT マッピングペイロードから検証済み投入仕様を作成します。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> RemoteQueue

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 投入フィールドと、検証および読み込みに使用する任意の識別子。

7.5.5 from_json

定義先: coreform.job.specs.RemoteQueue.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = RemoteQueue.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> RemoteQueue

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.5.6 copy_with

定義先: coreform.job.specs.RemoteQueue.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.5.7 validate

定義先: coreform.job.specs.RemoteQueue.validate

説明: リモートキュー設定の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] リモートキュー設定の検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.6 MeshStage

オブジェクトパス: coreform.job.specs.MeshStage

Coreform IGA メッシュ構築 — coreform_iga_mesh 呼び出し。常に存在し、ソルバーに依存しません。

呼び出し構文

result = MeshStage()

シグネチャ

MeshStage(mesh_executable: str = '', mpiexec: str = '', num_cpus: int = 1, cf_file: Optional[str] = None, output_db: Optional[str] = None, parts: Tuple[str, ...] = (), extra_args: Tuple[str, ...] = (), queue: Optional[Union[Local, RemoteQueue]] = None)

パラメータ

名前 型 必須 既定値 説明
mesh_executable str いいえ '' Coreform IGA Mesh 実行ファイルの名前またはパスの上書き。
mpiexec str いいえ '' 使用する MPI ランチャー名またはパス。 num_cpus が1より大きい場合に使用します。
num_cpus int いいえ 1 Mesh 生成に使用する正の CPU 数。
cf_file Optional[str] いいえ None Coreform 入力ファイル名。または None を指定すると Job から導出します。
output_db Optional[str] いいえ None メッシュデータベースのファイル名。または None を指定すると入力から導出します。
parts Tuple[str, ...] いいえ () メッシュ対象のパート名。空のタプルの場合は全パート。
extra_args Tuple[str, ...] いいえ () Mesh 実行ファイルへ渡す追加のコマンドライン引数。
queue Optional[Union[Local, RemoteQueue]] いいえ None Mesh ステージの投入ポリシー。

7.6.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
mesh_executable str '' Coreform IGA Mesh 実行ファイルの名前またはパスの上書き。
mpiexec str '' 使用する MPI ランチャー名またはパス。 num_cpus が1より大きい場合に使用します。
num_cpus int 1 Mesh 生成に使用する正の CPU 数。
cf_file Optional[str] None Coreform 入力ファイル名。または None を指定すると Job から導出します。
output_db Optional[str] None メッシュデータベースのファイル名。または None を指定すると入力から導出します。
parts Tuple[str, ...] () メッシュ対象のパート名。空のタプルの場合は全パート。
extra_args Tuple[str, ...] () Mesh 実行ファイルへ渡す追加のコマンドライン引数。
queue Optional[Union[Local, RemoteQueue]] None Mesh ステージの投入ポリシー。

7.6.2 to_dict

定義先: coreform.job.specs.MeshStage.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.6.3 to_json

定義先: coreform.job.specs.MeshStage.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.6.4 from_dict

定義先: coreform.job.specs.MeshStage.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = MeshStage.from_dict(payload=payload)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> MeshStage

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 検証および読み込みに使用するバージョン付き仕様フィールド。

7.6.5 from_json

定義先: coreform.job.specs.MeshStage.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = MeshStage.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> MeshStage

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.6.6 copy_with

定義先: coreform.job.specs.MeshStage.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.6.7 validate

定義先: coreform.job.specs.MeshStage.validate

説明: Mesh ステージの検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] Mesh ステージの検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.7 AbaqusInterop

オブジェクトパス: coreform.job.specs.AbaqusInterop

Coreform IGA → Abaqus interop ステージ — coreform_interop_abaqus 呼び出し。interop はソルバー固有で(ソルバーの入力デッキを生成するため)、Abaqus ソルバーターゲットの配下に置かれます。

呼び出し構文

result = AbaqusInterop()

シグネチャ

AbaqusInterop(interop_executable: str = '', cf_file: Optional[str] = None, sql_file: Optional[str] = None, inp_prefix: Optional[str] = None, parts: Tuple[str, ...] = (), dedup_epsilon: Optional[float] = None, keyword_report: Optional[str] = None, extra_args: Tuple[str, ...] = (), queue: Optional[Union[Local, RemoteQueue]] = None)

パラメータ

名前 型 必須 既定値 説明
interop_executable str いいえ '' Coreform Abaqus interop 実行ファイルの名前またはパスの上書き。
cf_file Optional[str] いいえ None Coreform 入力ファイル名。または None を指定すると Mesh ステージの入力を使用します。
sql_file Optional[str] いいえ None メッシュデータベースのファイル名。または None を指定すると Mesh ステージの出力を使用します。
inp_prefix Optional[str] いいえ None Abaqus 入力および結果成果物ファミリーのベース名。
parts Tuple[str, ...] いいえ () 変換対象のパート名。空のタプルの場合は全パート。
dedup_epsilon Optional[float] いいえ None 任意の0以上のノード重複除去許容値。
keyword_report Optional[str] いいえ None キーワードレポートのファイル名。または None を指定すると prefix から導出します。
extra_args Tuple[str, ...] いいえ () interop 実行ファイルへ渡す追加引数。
queue Optional[Union[Local, RemoteQueue]] いいえ None interop ステージの投入ポリシー。

7.7.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
interop_executable str '' Coreform Abaqus interop 実行ファイルの名前またはパスの上書き。
cf_file Optional[str] None Coreform 入力ファイル名。または None を指定すると Mesh ステージの入力を使用します。
sql_file Optional[str] None メッシュデータベースのファイル名。または None を指定すると Mesh ステージの出力を使用します。
inp_prefix Optional[str] None Abaqus 入力および結果成果物ファミリーのベース名。
parts Tuple[str, ...] () 変換対象のパート名。空のタプルの場合は全パート。
dedup_epsilon Optional[float] None 任意の0以上のノード重複除去許容値。
keyword_report Optional[str] None キーワードレポートのファイル名。または None を指定すると prefix から導出します。
extra_args Tuple[str, ...] () interop 実行ファイルへ渡す追加引数。
queue Optional[Union[Local, RemoteQueue]] None interop ステージの投入ポリシー。

7.7.2 to_dict

定義先: coreform.job.specs.AbaqusInterop.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.7.3 to_json

定義先: coreform.job.specs.AbaqusInterop.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.7.4 from_dict

定義先: coreform.job.specs.AbaqusInterop.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = AbaqusInterop.from_dict(payload=payload)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> AbaqusInterop

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 検証および読み込みに使用するバージョン付き仕様フィールド。

7.7.5 from_json

定義先: coreform.job.specs.AbaqusInterop.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = AbaqusInterop.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> AbaqusInterop

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.7.6 copy_with

定義先: coreform.job.specs.AbaqusInterop.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.7.7 validate

定義先: coreform.job.specs.AbaqusInterop.validate

説明: Abaqus interop ステージの検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] Abaqus interop ステージの検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.8 AbaqusSolve

オブジェクトパス: coreform.job.specs.AbaqusSolve

Abaqus 解析の計算形態(Abaqus の mdb.Job / abaqus job= インターフェース)。これらの設定は Abaqus 固有です。別のソルバーは、そのソルバーがサポートするリソースだけを持つ独自の解析型を使用します(NativeSolve を参照)。 num_gpus -> numGPUs および parallel_mode -> multiprocessingMode はフィールド単位の公開名上書きです(Abaqus 自身の大文字小文字規則は不規則で、 numCpus に対して numGPUs).

呼び出し構文

result = AbaqusSolve()

シグネチャ

AbaqusSolve(num_cpus: int = 1, num_gpus: int = 0, parallel_mode: ParallelMode = ParallelMode.THREADS, threads_per_process: Optional[int] = None, num_domains: Optional[int] = None, memory: int = 90, memory_units: MemoryUnits = MemoryUnits.PERCENTAGE, queue: Optional[Union[Local, RemoteQueue]] = None)

パラメータ

名前 型 必須 既定値 説明
num_cpus int いいえ 1 Abaqus 解析で使用する正の CPU 数。
num_gpus int いいえ 0 Abaqus 解析で使用する0以上の GPU 数。
parallel_mode ParallelMode いいえ ParallelMode.THREADS ソルバーのプロセス/スレッドモード。
threads_per_process Optional[int] いいえ None 明示的なハイブリッド配置における MPI プロセスあたりのスレッド数。
num_domains Optional[int] いいえ None Abaqus ソルバーのドメイン数。次の値の整数倍である必要があります: num_cpus.
memory int いいえ 90 正のソルバーメモリ上限。
memory_units MemoryUnits いいえ MemoryUnits.PERCENTAGE 解釈に使用する単位 memory.
queue Optional[Union[Local, RemoteQueue]] いいえ None 解析ステージの投入ポリシー。

7.8.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
num_cpus int 1 Abaqus 解析で使用する正の CPU 数。
num_gpus int field(default=0, metadata={'camel_case': 'numGPUs'}) Abaqus 解析で使用する0以上の GPU 数。
parallel_mode ParallelMode field(default=(ParallelMode.THREADS), metadata={'camel_case': 'multiprocessingMode'}) ソルバーのプロセス/スレッドモード。
threads_per_process Optional[int] None 明示的なハイブリッド配置における MPI プロセスあたりのスレッド数。
num_domains Optional[int] None Abaqus ソルバーのドメイン数。次の値の整数倍である必要があります: num_cpus.
memory int 90 正のソルバーメモリ上限。
memory_units MemoryUnits MemoryUnits.PERCENTAGE 解釈に使用する単位 memory.
queue Optional[Union[Local, RemoteQueue]] None 解析ステージの投入ポリシー。

7.8.2 to_dict

定義先: coreform.job.specs.AbaqusSolve.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.8.3 to_json

定義先: coreform.job.specs.AbaqusSolve.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.8.4 from_dict

定義先: coreform.job.specs.AbaqusSolve.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = AbaqusSolve.from_dict(payload=payload)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> AbaqusSolve

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 検証および読み込みに使用するバージョン付き仕様フィールド。

7.8.5 from_json

定義先: coreform.job.specs.AbaqusSolve.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = AbaqusSolve.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> AbaqusSolve

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.8.6 copy_with

定義先: coreform.job.specs.AbaqusSolve.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.8.7 validate

定義先: coreform.job.specs.AbaqusSolve.validate

説明: Abaqus 解析設定の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] Abaqus 解析設定の検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.9 NativeSolve

オブジェクトパス: coreform.job.specs.NativeSolve

ネイティブ Coreform IGA 解析。設計上最小限にしており、ネイティブソルバーが公開する設定項目は Abaqus より大幅に少ないため、Abaqus の GPU/ドメイン/並列モード/メモリ上限フィールドは持ちません。ここにフィールドを追加するのは、ネイティブソルバーの実行インターフェースで定義された場合だけです。

呼び出し構文

result = NativeSolve()

シグネチャ

NativeSolve(num_cpus: int = 1, queue: Optional[Union[Local, RemoteQueue]] = None)

パラメータ

名前 型 必須 既定値 説明
num_cpus int いいえ 1 ネイティブ解析で使用する正の CPU 数。
queue Optional[Union[Local, RemoteQueue]] いいえ None ネイティブ解析ステージの投入ポリシー。

7.9.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
num_cpus int 1 ネイティブ解析で使用する正の CPU 数。
queue Optional[Union[Local, RemoteQueue]] None ネイティブ解析ステージの投入ポリシー。

7.9.2 to_dict

定義先: coreform.job.specs.NativeSolve.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.9.3 to_json

定義先: coreform.job.specs.NativeSolve.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.9.4 from_dict

定義先: coreform.job.specs.NativeSolve.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = NativeSolve.from_dict(payload=payload)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> NativeSolve

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 検証および読み込みに使用するバージョン付き仕様フィールド。

7.9.5 from_json

定義先: coreform.job.specs.NativeSolve.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = NativeSolve.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> NativeSolve

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.9.6 copy_with

定義先: coreform.job.specs.NativeSolve.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.9.7 validate

定義先: coreform.job.specs.NativeSolve.validate

説明: ネイティブ解析設定の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] ネイティブ解析設定の検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.10 AbaqusTarget

オブジェクトパス: coreform.job.specs.AbaqusTarget

Abaqus モデル、interop ステージ、解析ステージを記述します。

呼び出し構文

result = AbaqusTarget(model=model, interop=interop, solve=solve)

シグネチャ

AbaqusTarget(model: str = None, interop: Optional[AbaqusInterop] = None, solve: Optional[AbaqusSolve] = None)

パラメータ

名前 型 必須 既定値 説明
model str はい — 空でない Abaqus モデル名。
interop Optional[AbaqusInterop] はい — 必須の Coreform-to-Abaqus interop ステージ。
solve Optional[AbaqusSolve] はい — 必須の Abaqus 解析ステージ。

7.10.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
model str None 空でない Abaqus モデル名。
interop Optional[AbaqusInterop] field(default=None, metadata={'required': True}) 必須の Coreform-to-Abaqus interop ステージ。
solve Optional[AbaqusSolve] field(default=None, metadata={'required': True}) 必須の Abaqus 解析ステージ。
solver_type str 'AbaqusTarget' Abaqus ターゲットを表すシリアライズ済み識別子。

7.10.2 to_dict

定義先: coreform.job.specs.AbaqusTarget.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.10.3 to_json

定義先: coreform.job.specs.AbaqusTarget.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.10.4 from_dict

定義先: coreform.job.specs.AbaqusTarget.from_dict

説明: マッピングペイロードから検証済みソルバーターゲットを作成します。

呼び出し構文

result = AbaqusTarget.from_dict(payload=payload)

戻り値

型 説明
_SolverTargetT マッピングペイロードから検証済みソルバーターゲットを作成します。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> AbaqusTarget

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — ソルバーターゲットのフィールドと、検証および読み込みに使用する任意の識別子。

7.10.5 from_json

定義先: coreform.job.specs.AbaqusTarget.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = AbaqusTarget.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> AbaqusTarget

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.10.6 copy_with

定義先: coreform.job.specs.AbaqusTarget.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.10.7 validate

定義先: coreform.job.specs.AbaqusTarget.validate

説明: Abaqus ソルバーターゲットの検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] Abaqus ソルバーターゲットの検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.11 NativeTarget

オブジェクトパス: coreform.job.specs.NativeTarget

ネイティブ Coreform IGA ソルバーターゲットを記述します。

呼び出し構文

result = NativeTarget(solve=solve)

シグネチャ

NativeTarget(solve: Optional[NativeSolve] = None)

パラメータ

名前 型 必須 既定値 説明
solve Optional[NativeSolve] はい — 必須のネイティブ Coreform IGA 解析ステージ。

7.11.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
solve Optional[NativeSolve] field(default=None, metadata={'required': True}) 必須のネイティブ Coreform IGA 解析ステージ。
solver_type str 'NativeTarget' ネイティブターゲットを表すシリアライズ済み識別子。

7.11.2 to_dict

定義先: coreform.job.specs.NativeTarget.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.11.3 to_json

定義先: coreform.job.specs.NativeTarget.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.11.4 from_dict

定義先: coreform.job.specs.NativeTarget.from_dict

説明: マッピングペイロードから検証済みソルバーターゲットを作成します。

呼び出し構文

result = NativeTarget.from_dict(payload=payload)

戻り値

型 説明
_SolverTargetT マッピングペイロードから検証済みソルバーターゲットを作成します。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> NativeTarget

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — ソルバーターゲットのフィールドと、検証および読み込みに使用する任意の識別子。

7.11.5 from_json

定義先: coreform.job.specs.NativeTarget.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = NativeTarget.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> NativeTarget

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.11.6 copy_with

定義先: coreform.job.specs.NativeTarget.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.11.7 validate

定義先: coreform.job.specs.NativeTarget.validate

説明: ネイティブソルバーターゲットの検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] ネイティブソルバーターゲットの検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。

7.12 CoreformIGAJobSpec

オブジェクトパス: coreform.job.specs.CoreformIGAJobSpec

ポータブル Coreform IGA Job パイプラインを定義します。

呼び出し構文

result = CoreformIGAJobSpec(name=name, mesh=mesh, solver=solver)

シグネチャ

CoreformIGAJobSpec(name: str = None, description: str = '', mesh: Optional[MeshStage] = None, solver: Optional[Union[AbaqusTarget, NativeTarget]] = None)

パラメータ

名前 型 必須 既定値 説明
name str はい — 一意で空でない Job 名。
description str いいえ '' 任意の、人が読める Job の説明。
mesh Optional[MeshStage] はい — 必須の Coreform IGA Mesh ステージ。
solver Optional[Union[AbaqusTarget, NativeTarget]] はい — 必須の後段ソルバーターゲット。

7.12.1 属性

名前 型 値 説明
schemaVersion int 0 シリアライズされた仕様スキーマのバージョン。
name str None 一意で空でない Job 名。
description str '' 任意の、人が読める Job の説明。
mesh Optional[MeshStage] field(default=None, metadata={'required': True}) 必須の Coreform IGA Mesh ステージ。
solver Optional[Union[AbaqusTarget, NativeTarget]] field(default=None, metadata={'required': True}) 必須の後段ソルバーターゲット。

7.12.2 to_dict

定義先: coreform.job.specs.CoreformIGAJobSpec.to_dict

説明: この仕様をバージョン付き辞書へシリアライズします。

呼び出し構文

result = spec.to_dict()

戻り値

型 説明
Dict[str, Any] トップレベルのスキーマメタデータを含む正規仕様フィールド。

シグネチャ

to_dict() -> Dict[str, Any]

パラメータ

なし。

7.12.3 to_json

定義先: coreform.job.specs.CoreformIGAJobSpec.to_json

説明: この仕様をバージョン付き JSON 文書へシリアライズします。

呼び出し構文

result = spec.to_json()

戻り値

型 説明
str この仕様のバージョン付き JSON 表現。

シグネチャ

to_json(indent: Optional[int] = 2) -> str

パラメータ

名前 型 必須 既定値 説明
indent Optional[int] いいえ 2 JSON のインデントに使用する空白数。コンパクトな JSON の場合は None を指定します。

7.12.4 from_dict

定義先: coreform.job.specs.CoreformIGAJobSpec.from_dict

説明: マッピングペイロードから検証済み仕様を作成します。

呼び出し構文

result = CoreformIGAJobSpec.from_dict(payload=payload)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_dict(payload: Mapping[str, Any]) -> CoreformIGAJobSpec

パラメータ

名前 型 必須 既定値 説明
payload Mapping[str, Any] はい — 検証および読み込みに使用するバージョン付き仕様フィールド。

7.12.5 from_json

定義先: coreform.job.specs.CoreformIGAJobSpec.from_json

説明: JSON 文書から検証済み仕様を作成します。

呼び出し構文

result = CoreformIGAJobSpec.from_json(text=text)

戻り値

型 説明
CoreformSpec 具体的な仕様クラスの検証済みインスタンス。

シグネチャ

from_json(text: str) -> CoreformIGAJobSpec

パラメータ

名前 型 必須 既定値 説明
text str はい — バージョン付き JSON 仕様文書。

7.12.6 copy_with

定義先: coreform.job.specs.CoreformIGAJobSpec.copy_with

説明: 指定フィールドを置き換えた検証済みコピーを返します。

呼び出し構文

result = spec.copy_with(...)

戻り値

型 説明
CoreformSpec 同じ具体的な仕様型の検証済みコピー。

シグネチャ

copy_with(**kwargs: Any) -> CoreformSpec

パラメータ

名前 型 必須 既定値 説明
kwargs Any いいえ — 仕様フィールドとその置換値。

7.12.7 validate

定義先: coreform.job.specs.CoreformIGAJobSpec.validate

説明: 完全な Job 仕様の検証上の問題を返します。

呼び出し構文

result = spec.validate()

戻り値

型 説明
Tuple[ValidationIssue, ...] 完全な Job 仕様の検証上の問題を返します。

シグネチャ

validate() -> Tuple[ValidationIssue, ...]

パラメータ

なし。