Syntax and general rules

Input file is created by records. In the current implementation, the particular record is represented by one line in input file. The order of records in file is compulsory, and is following

  1. output file record, see section 4,
  2. job description record, see section 5,
  3. analysis record, see section 6,
  4. domain record, see section 7,
  5. output manager record, see section 7.1,
  6. components size record, see section 7.2,
  7. node & element-side record(s), see section 7.3,
  8. element record(s), see section 7.4,
  9. cross section record(s), see section 7.5,
  10. material type record(s), see section 7.6,
  11. nonlocal barriers record(s), see section 7.7,
  12. load, boundary conditions record(s), see section 7.8,
  13. initial conditions record(s), see section 7.9,
  14. time functions record(s), see section 7.10.
  15. optional xfem manager and associated record(s), see section 7.11
When line begins with '#' character, then it is skipped by parser and provide a way, how to include comments inside input file.

Records contain many fields, each field is characterized by keyword and its associated field value. Some keywords have no field values. Except the first field, the order of remaining fields in record is optional. There are several exceptions, which will be described in particular sections. The type of field value is specific to keyword. General format of field, characterized by keyword ``Keyword'' with corresponding value (marked as #) of type ``type'' is Keyword(type) #. If keyword is variable, depending on entity type which is described by particular record, then the keyword is preceded by star. We call such keyword as entity keyword (For example keyword, which describes element type). The possible substitutions for entity keyword are typed using Typewriter font family. Often, many fields are specific to particular entity keyword. Then we describe general format of record without these specific fields and we describe them in entity keyword specific part of record description. Sometimes, there are fields without keywords. These are usually compulsory, with fixed position in record. Their occurrence is described using so called named values. The format of named value is ``(name#)(type)'', where a value of required type should be substituted.

In a special case of analysis record, the input record can be followed by optional meta-step input records (see section 6). Then certain fields originally in analysis record should appear in meta-step record instead. This is marked by adding ``M'' superscript to keyword. Then the field format is Keyword$ ^M$(type) #.

As already mentioned, each field value is typed. The possible types are:

The general format of record is

  keyword1(type) # [keyword2(type) #]
  ...
  [keywordXX(type) #]

The keywords and their values are separated by one or more spaces. Please note, that a single record cooresponds to one input line in input file. If any keyword or field value is enclosed within angle brackets $ \langle$ $ \rangle$ then it is related to parallel version of oofem is not available in sequential version. When some field is enclosed in brackets [ ], then it's use is optional and often overwrites the default behavior or adds additional (but optional) information or property (for example adds a loading to node).

Borek Patzak 2011-12-29