基本事項
ソース
- 文字コードは UTF-8 とする．
- 改行コードは LF とする．
- 以下の文字は使用しないこと．
- 可読性確保のため 1 行が 80 バイト以内程度になるよう適宜改行を行う．改行は主に以下の位置において行う．
- 和文の文節間・文末
- 欧文の単語間・文末
- 和文・欧文間
- 和文・数式間
- 数式中では，なるべく演算子・括弧類の直前
- 改行の位置によっては，pTeX が自動的に空白を挿入することがあるので注意すること．そのような場所で改行する必要がある場合には，改行前に%を挿入しなければならない．特に注意すべきは以下の位置．
PDF化
スタイル
表記の原則
和文
- 常用漢字以外の漢字も使ってよい．難読漢字には必要に応じてルビをつける．
- 句読点は「，」「．」とする．
- 分かち書きについては，人名の姓・名の区切り以外では原則として禁止とする．
- 語尾の長音符号の使用法は原則として以下に従う．固有名詞はこの限りではない．
- 3 音以上の場合にはつけない． 例：レーザ，エネルギ
- 2 音以下の場合にはつける． 例：エコー，カラー
- 複合語は，それぞれの成分語について a，b を適用する． 例：エネルギスペクトル，ピトー管
- 長音・撥音・促音は1音と数え，拗音は数えない． 例：サーバ，センサ，ニッパ，メジャー
- 一つ，二つ，……は漢字表記とし，1 つ，2 つ，……とは表記しない．
- その他，用字・用語の統一は後述．
欧文
- 以下の語の直後では改行しない（改行しない空白 ~ を挿入する）．
- Mr.，Mrs.，Miss.，Ms.，Dr.
- Vol.，No.，p.，pp.
- ハイフン，ダッシュ，マイナスは厳密に使い分ける
- ハイフン (-)：単語の分割，複数の単語を一語として機能させる
- enダッシュ (--)：数字の範囲，andの意味 ( 例: Navier--Stokes )
- emダッシュ (
---)：引用文
- マイナス ($-$)：負号
和欧混在
用字・用語の統一
- 以下の語が形式名詞として使われているときは，かな表記とする．
| 可 |
不可 |
| あたり |
辺り |
| うえ |
上 |
| おりに |
折に |
| かぎり |
限り |
| くらい |
位 |
| こと |
事 |
| ごと |
毎 |
| たび |
度 |
| つもり |
積もり |
| とおり |
通り |
| とき |
時 |
| ところ |
所 |
| はず |
筈 |
| ほう |
方 |
| ほど |
程 |
| もの |
物 |
| よう |
様 |
| わけ |
訳 |
- 以下の語は，動詞として使われるときは漢字表記，補助動詞として使われるときにはかな表記とする．
| 可 |
不可 |
| いう |
言う |
| いく |
行く |
| いる |
居る |
| おく |
置く |
| かける |
掛ける |
| かねる |
兼ねる |
| きる |
切る |
| くる |
来る |
| だす |
出す |
| つく |
付く |
| みる |
見る |
- 以下の漢字の送り仮名には，「本則」と「許容」の 2 パターンあるが，本書では全て本則に統一する．
| 可 |
不可 |
| 当たる |
当る |
| 表す |
表わす |
| 著す |
著わす |
| 現れる |
現われる |
| 浮かぶ |
浮ぶ |
| 打ち合わせ |
打ち合せ・打合せ |
| 移り変わり |
移り変り |
| 生まれる |
生れる |
| 行う |
行なう |
| 起こる |
起る |
| 押さえる |
押える |
| 落とす |
落す |
| 終わる |
終る |
| 代わり |
代り |
| 変わる |
変る |
| 聞こえる |
聞える |
| 答え |
答 |
| 断る |
断わる |
| 差し支える |
差支える |
| 積もる |
積る |
| 問い |
問 |
| 届け |
届 |
| 捕らえる |
捕える |
| 取り扱い |
取扱い・取扱 |
| 引き換え |
引換え・引換 |
| 向かい |
向い |
| 向かい合わせ |
向い合せ |
| 群れ |
群 |
| 申し込み |
申込み・申込 |
| 申し込む |
申込む |
以下の漢字は当て字であり，多くの人の目にふれる文書にはふさわしくないので使用しない．
| 可 |
不可 |
| いかに |
如何に |
| いつ |
何時 |
| おいしい |
美味しい |
| かじ |
鍛冶 |
| ガス |
瓦斯 |
| ガラス |
硝子 |
| きめ |
肌理 |
| ごまかす |
誤魔化す |
| さすが |
流石 |
| しける |
湿気る |
| しっぽ |
尻尾 |
| たやすい |
容易い |
| でたらめ |
出鱈目 |
| なぜ |
何故 |
| はやる |
流行る |
| ふさわしい |
相応しい |
| ふぶく |
吹雪く |
| まじめ |
真面目 |
| まずい |
不味い |
| まねる |
真似る |
| むくみ |
浮腫み |
| メッキ |
鍍金 |
| めったに |
滅多に |
| メリハリ |
減り張り |
| ゆえん |
所以 |
- 専門用語によっては表記に複数の流儀があるが，本書では以下のように統一する．【要更新】
| 可 |
不可 |
| 粘性係数 |
粘度 |
| スペクトル |
スペクトラム |
| 線形 |
線型 |
| 関数 |
函数 |
図
- Inkscape による編集用の svg を正とし，LaTeX 文書には pdf エクスポートしたものを挿入する．
- ラスタ画像については，UserGuideJa? 1.7.1 では同様に svg・pdf としていたが，ProgrammersGuideJa? 2.0.0 から png に方針変更した．UserGuideJa? においても徐々に移行していく．
- 図中のフォントについては，現時点では Computer Modern を使用しているが，今後 Latin Modern に変更していく．
ラベル
- 各種 \label は OpenFOAM 1.5 の時点の番号で振っている．
- バージョンアップに伴い番号がずれた場合，新たに挿入される \label に @version を加えて対処するものとする．
- 例：バージョン 1.6 において，従来の ssec:2.3.5 の前に新たに一項が追加された．このとき新たな 2.3.5 項を ssec:2.3.5@1.6 として挿入する．それまでの 2.3.5 を ssec:2.3.6 に変えたりはしない．
索引
索引の和訳作業の流れはこちらを参照．
※ 以下の説明において \index の基本的な使い方，! による階層化などは習得済みとする．
- \index は本文中の該当語句の直前に付ける．
- 語句が長くてページをまたいだ場合，その語句の先頭を参照させるため
- \index は TeX ソース中で単一行に書く．
- \index の直後の改行は % でエスケープする．
- 例
\index{icoFoam@\OFtool{icoFoam}!ソルバ}%
\index{ソルバ!icoFoam@\OFtool{icoFoam}}%
\OFtool{icoFoam}のケースはすべて
- tabularx 環境内で \index を使う場合，引数の中で使ったマクロが意図せず展開されてしまうことがある．このような場合は，そのマクロの前に \string を付ける．
その他
- ところどころ \end{OFverbatim} の後に %$ と書いてある箇所がある．これは，OFverbatim 環境中に登場した $ をエディタが数式の始まりとみなし，次の $ が見つかるまで色付けしてしまうため，それを終わらせるためのものである．
独自のコマンド
キーワードのマークアップ
| コマンド |
意味 |
スタイル |
| \OFboundary |
境界条件 |
サンセリフ |
| \OFcase |
OpenFOAM のケース |
サンセリフ |
| \OFclass |
C++ のクラス |
サンセリフ |
| \OFdictionary |
ディクショナリ |
サンセリフ・斜体 |
| \OFsubdictionary |
サブディクショナリ |
サンセリフ・斜体 |
| \OFenv |
環境変数 |
サンセリフ |
| \OFpath |
パス |
サンセリフ・斜体 |
| \OFtool |
ツール名 |
サンセリフ |
| \OFkeyword |
OpenFOAM におけるキーワード |
タイプライタ体 |
| \OFemph |
その他の強調 |
サンセリフ |
無次元数
そのまま数式中に 2 文字を並べて書くと，二つ別々の変数とみなされてしまいカーニングが効かないので，2 文字からなる単一の変数としてマークアップするために以下を使う．
| コマンド |
表示 |
意味 |
| \nCo |
$\mathord{\mathit{Co}}$ |
クーラン数 |
| \nHa |
$\mathord{\mathit{Ha}}$ |
ハルトマン数 |
| \nPr |
$\mathord{\mathit{Pr}}$ |
プラントル数 |
| \nPe |
$\mathord{\mathit{Pe}}$ |
ペクレ数 |
| \nRe |
$\mathord{\mathit{Re}}$ |
レイノルズ数 |
単位
| \unit |
単位のマークアップに使う． |
| \micro |
単位は全て直立体で書かなければならないが，\mu だと斜体 ($\mu$) になってしまうので，マイクロにはこちらを使う． |
| \degC |
摂氏温度 ℃ |
- 使用例
| 入力例 |
出力例 |
備考 |
| 10\unit{m/s} |
$10\ \mathrm{m/s}$ |
数値との間に適切な空白が自動で挿入される． |
| \unit*{kPa} |
$\mathrm{kPa}$ |
数値を伴わない場合は * を付ければ空白を挿入しない． |
| \unit{kJ/(kg.K)} |
$\mathrm{kJ/(kg{\cdot}K)}$ |
ピリオド . を打てば中点に変わる． |
演算子
Programmers Guide で解説されているテンソル代数の演算子．
| \inProd |
内積 |
| \biInProd |
二重内積 |
| \triInProd |
三重内積 |
（表示例準備中．ProgrammersGuideJa の 1 章を参照）
その他のコマンド
| \OpenFOAM |
OpenFOAM ロゴ |
|
| \OFrevision |
校正メモ |
ドキュメントオプションに draft を加えたときだけ表示される．ソース中にコメントアウトして残すメモより重要度の高いときに使う． |
