Control file format

From FFDevel Wiki
Jump to navigation Jump to search

Navigation: Documentation / Files / Control files / Control file format


Control files employed by FFDevel are plain ASCII text files consisting from three type of entries:

  • {groups}
  • [sections]
  • keyword lines

Keyword lines can only be placed into sections, sections can only be placed into groups. If no group is specified then sections are placed into the {MAIN} group, which is implicit group. Empty lines are silently ignored. The setup can be commented. Comments begin with '#', '!', '*' characters, which can be placed anywhere on a line. If the leading comment character is not in the first column then it must be preceded by a white space character.

FFDevel strictly controls if all parts of an input file were loaded and understood correctly. All keyword lines that were successfully read and used are marked as processed. If some line (including sections or groups) are left unprocessed then the calculation cannot proceed and is prematurely terminated. User has then to examine the input control file and fix all inconsistencies reported.

Keyword lines are composed at least from two records. The first word is a key name. The remaining words are its value(s). Keys might be of several types that are described here.