GenericResponse

Model ElementGenericResponseは、標準のMotionSolve Rvオブジェクトの上の層にすぎません。追加の層によって、基礎となるRvがプロット機能や最適化機能に結合されます。

クラス名

GenericResponse

属性の概要

名前 プロパティ コマンドで変更可能か 設計可能か
label Str ()    
function Function ()  
routine Routine ()    
scale Double (1)    
useDeriv Bool (False)    
plot Bool ()    

使用法

#1: GenericResponse specified as an expression
GenericResponse (function=expressionString, optional_attributes)

#2: Defined in a compiled user-subroutine
GenericResponse (function=userString, routine=string, optional_attributes)

#3: Defined in a Python function
GenericResponse (function=userString, routine=functionPointer, optional_attributes)

属性

MotionSolve式として定義
function
有効なMotionSolve式を定義する文字列。
GenericResponseを定義するMotionSolve式。
function属性は必須です。
コンパイルされたDLL内のユーザーサブルーチンとして定義
function
有効なユーザー関数MotionSolve式を定義する文字列。
データファイルから、GenericResponseが定義されるユーザー定義のサブルーチンに渡されるパラメータのリスト。
function属性は必須です。
routine
文字列
ユーザーサブルーチンの代替名を指定します。この名前は、“∷”で区切られた情報の2つの部分で構成されます。1つ目は、ユーザー定義のGenericResponseの応答を計算する関数を含む共有ライブラリへのパス名です。2つ目は、計算を実行する共有ライブラリ内の関数の名前です。
例: routine="/staff/Altair/engine.dllmyGenericResponse"
  • "/staff/Altair/engine.dllはDLLです。
  • "myGenericResponse"は、計算を実行するこのDLL内の関数です。
属性routineは省略可能です。
指定しない場合、routineはデフォルトでVARSUBになります。
Pythonスクリプト内のユーザーサブルーチンとして定義
function
有効なユーザー関数MotionSolve式を定義する文字列。
データファイルから、GenericResponseが定義されるユーザー定義のサブルーチンに渡されるパラメータのリスト。
function属性は必須です。
routine
Python内の呼び出し可能な関数へのポインタ。
例: routine= myGenericResponse
  • myGenericResponseは、モデルが存在する場所ならどこからでも呼び出すことが可能なPython関数またはメソッドです。
属性routineは省略可能です。
指定しない場合、routineはデフォルトでVARSUBになります。
オプション属性 - すべてのバリアントに使用できます。
label
文字列
GenericResponseオブジェクトの名前を指定します。
この属性は省略可能です。
指定しない場合は、MotionSolveが代わりにラベルを作成します。
scale
倍精度
GenericResponse値をスケーリングするためのスケールファクターを指定します。指定しない場合は、デフォルトで1.0になります。
この属性は省略可能です。
useDeriv
ブール
関数の導関数を応答として使用するかどうかを指定するためのフラグ。指定しない場合、useDerivはデフォルトでFalseになります。
属性useDerivは省略可能です。
plot
ブール
Trueに設定した場合、サブプロットが生成され、サポートされている最適化エンジンが使用されていれば動的に更新されます。

例:

#1: GenericResponse of type expression
energy = GenericResponse (label="Energy", function = "WZ(21,31)*FZ(21,31)", scale=10)

#2: GenericResponse of type interpreted user subroutine
energy = GenericResponse (label="Energy", function = myPowerFunction, scale=10)

#3: GenericResponse of type compiled user subroutine
energy = GenericResponse (label="Energy", function = "myPowerFunction", scale=10)

コメント

  1. プロパティの概要、使用理由、および拡張方法については、プロパティをご参照ください。