コマンド構文
CUBITの実行は、コマンドラインからコマンドを入力するか、ジャーナルファイルからコマンドを読み込むことで制御します。コマンドにはCubitコマンドとPythonステートメントのどちらも使用でき、ジャーナルファイルにも両方を含められます。既定では、ジャーナルファイルの処理開始時およびコマンドラインでは、入力はCubitコマンドとして解釈されます。 #!python ステートメントを指定すると、それ以降のコマンドをPythonステートメントとして解釈させることができます。 #!cubit を指定すると、同様に、それ以降のコマンドをCubitコマンドとして解釈させることができます。
このドキュメントでは、各機能や処理について対応するCUBITコマンドを説明しています。この節では、コマンド構文の一般的な規則を説明します。適切なコマンド形式をすばやく確認するには、 <keyword> help command;
see コマンドラインヘルプ を参照してください。
CUBITコマンドは、このマニュアルおよびヘルプ出力で以下の規則に従って記述されます。代表的なCUBITコマンドの例を示します。
Volume <range> Scheme Sweep [Source [Surface] <range>] [Target [Surface] <range>] [Rotate {on | OFF}]
CUBITが認識するコマンドはフリーフォーマットで、以下の構文規則に従います。
- 大文字と小文字は区別されません。
- コマンドライン中の「#」文字はコメントの開始を示し、「#」以降の同じ行の文字は無視されます。ただし「#」はAPREPROステートメントの開始にも使用できます。詳しくは APREPRO のドキュメントを参照してください。
- 他のコマンドと区別できるだけの文字数があれば、コマンドを省略して入力できます。
- コマンドパラメータの意味と型はキーワードによって異なります。CUBITコマンドで使用される主なパラメータは次のとおりです。
数値: 数値パラメータには実数または整数を指定できます。実数にはCまたはFORTRANで有効な数値形式(例:1、0.2、-1e-2)を使用できます。整数には有効な10進整数形式(例:1、100、1000)を使用できますが、1.5、1.0、0x1Fは使用できません。
文字列: 文字列パラメータは、シングルクォートまたはダブルクォートで囲んだリテラル文字列です。例:'This is a string'。
ファイル名: コマンドがファイル名を必要とする場合、ファイル名はシングルクォートまたはダブルクォートで囲む必要があります。パスを指定しない場合、ファイルは現在の作業ディレクトリにあるものとして扱われます。ファイル名の一部を入力して「?」を入力すると、一意に決まる場合はファイル名全体、複数候補がある場合は可能な範囲まで補完されます。
ファイル名パラメータには、CUBITが実行されているシステムで有効なファイル名を指定する必要があります。ファイル名は相対パス(../cubit/mesh.jou)、絶対パス(/home/jdoe/cubit/mesh.jou)、またはパスなしで指定できます。パスなしの場合、ファイルは作業ディレクトリに存在する必要があります( 環境コマンド を参照)。ファイル名指定には環境変数やエイリアスも使用できます。たとえば、ユーザーのログインディレクトリからの相対位置を表すC-Shellの省略記法(~jdoe/cubit/mesh.jou)も有効です。
トグル: 一部のコマンドでは、設定やオプションを有効/無効にするために「toggle」キーワードを使用します。有効化に使用できるトグルキーワードは「on", "yes」、および「true」です。無効化には「off", "no」、および「false」を使用します。
- 各コマンドは通常、次のいずれかの形式です。
* アクションを示すキーワード、すなわち「動詞」に可変個のパラメータが続く形式。例:
Mesh Volume 1
ここでは Mesh が動詞で、 Volume 1 がパラメータです。
* または、選択対象を示すキーワード、すなわち「名詞」に、対象エンティティの属性名と値が続く形式。例:
Volume 1 Scheme Sweep Source 1 Target 2
ここでは Volume 1 が名詞、 Scheme が属性で、残りのデータは Scheme キーワードのパラメータです。
このドキュメントのコマンド記述では、以下の表記規則を使用します。
- コマンドは このような形式:
- 山括弧で囲まれた語( <parameter> )は、ユーザーが指定するパラメータを表します。値には整数、整数範囲、実数、文字列、ファイル名を表す文字列、またはトグルを表す文字列を指定できます。有効な値の型は、コマンドまたはコマンド説明から判断できます。
- 縦棒「|」で区切られた語の並び( choice1 | choice2 | choice3 )は、列挙されたパラメータから1つを選択することを表します。
- トグルパラメータが すべて大文字 で表記されている場合、それが既定値です。
- 括弧で囲まれていない語、または波括弧で囲まれた語( {required} )は必須入力を表します。
- 角括弧で囲まれた語( [optional] )は省略可能な入力を表し、指定するとコマンドの既定動作を変更できます。
- 角括弧の内側に波括弧がある場合(例:
[Rotate {on|OFF}] )、その波括弧部分は、その省略可能な修飾子を使用する場合にのみ必須です。