Introduction¶
This manual describes in details the format and structure of OOFEM text input file. Input file can be prepared in any text editor or can be generated by a conversion program or FEM pre-processor.
Running the code¶
oofem [option [parameter]] ...| -v | Prints oofem version. |
| -f path | Path to oofem input file name, if not present, program interactively reads this parameter. |
| -r int | Restarts the analysis from given solution step. The corresponding context file (*.osf) must exist. |
| -rn | Turns on the equation renumbering. Default is off. |
| -ar int | Restarts the adaptive computation from given solution step. Requires the corresponding context file (*.osf) and domain input file (*.din) to exists. The domain input file describes the new mesh, its syntax is identical to syntax of input file, but it does not contains the output file record, job description record and analysis record. |
| -l int | Sets treshold for log messages (Errors=0, Warnings=1, Relevant=2, Info=3, Debug=4). |
| -qo path | Redirect the standard output stream (stdout) to given file. |
| -qe path | Redirect standard error stream (stderr) to given file. |
| -c | Forces the creation of context file for each solution step. |
| -t int | Determines the number of threads to use (requires OpenMP support compiled) |
| -p | Runs in parallel mode using MPI (requires MPI support compiled) |
mpirun -np 8 oofem -p program_optionsSyntax and general rules¶
Input file is composed of records. In the current implementation, each record is represented by one line in input file. The order of records in file is compulsory, and it has following structure:
- output file record, see section Output file record,
- job description record, see section Job description record,
- analysis record, see section Analysis record,
- domain record, see section Domain record(s),
- output manager record, see section Output manager record,
- components size record, see section Components size record,
- node record(s), see section Dof manager records,
- element record(s), see section Element records,
- set record(s), see section Set records,
- cross section record(s), see section Cross section records,
- material type record(s), see section Material type records,
- nonlocal barriers record(s), see section Nonlocal barrier records,
- load, boundary conditions record(s), see section Load and boundary conditions,
- initial conditions record(s), see section Initial conditions,
- time functions record(s), see section Time functions records.
- optional xfem manager and associated record(s), see section Xfem manager record and associated records
When input line begins with ’#’ character, then it is ignored by the parser and can serve as a comment inside input file.
The individual records consist of record keyword followed by one or more attributes. Each attribute is identified by its keyword, which can be followed by attribute value(s). Some attributes have no values. The order of attributes in the record is optional.
Sometimes, the record keyword itself can be variable, taking on a
restricted range of possible values. As an example, OOFEM has element
record, desribing particulat element, and record keyword determines the
particular element type. In this case, the record keyword is preceded by
star. We call such record keyword as entity keyword. The possible
substitutions for entity keyword are typed using Typewriter font
family. Often, some attributes are specific to particular entity
keyword. Then the general format of record is described and entity
specific attributes are described separately. The possible attributes
are then union of general and entity specific attributes.
# nodal records
Node 1 coords 3 0. 0. 0.
Node 2 coords 3 0. 0. 2. dofidmask 3 1 2 3
# element record
Truss2d 1 nodes 2 1 2 crossSect 1
Each attribute value has a specific type, which describe its size and
layout. To describe the type of an attribute, the following notation is
used: Keyword #(type), where type determines the attribute type and
# is the placeholder for the attribute value. The possible types of
attribute values are following:
in - integer number.
val1 25
rn - real number.
val2 -0.234e-3
ch - character (usually for description of unknown type (’d’ for displacement, ’t’ for temperature, etc.).
val3 t
ia - integer array. The format of integer array is
size val(1) ... val(size), where size, val(1),…,val(size) are integer numbers. Values are separated by one or more spaces. As an example, consider the integer array attribute callednodes\(=\{1,4,23\}\):nodes 3 1 4 23
ra - real array. The format of real array is
size val(1) ... val(size), where size is integer number and val(1), …, val(size) are real numbers. Values are separated by one or more spaces. As an example, consider the real array attribute calledcoords\(=\{1.0,2.0,3.0\}\):coords 3 1.0 2.0 3.0
- rm - real matrix, format of real matrix is
rows columns {val(1,1) val(1,2) ...; val(2,1) ...}, where “rows” and “columns” are integer numbers and val(1,1), …, are real numbers. Columns are seperated by space or comma and lines by semicolon. As an example, consider the real matrix attribute called \(\texttt{mat1}=\left[\begin{array}{ccc}1.0&-1.0&0.0\\2.0&2.5&5.0\end{array}\right]\):mat1 2 3 \{1.0 -1.0; 0.0 2.0; 2.5 5.0\}
dc - dictionary. Dictionary consist of pairs, each pair has key (character type) and its associated value (integer type). Format of dictionary is
size key(1) val(1) ... key(size) val(size), where size is integer number, key(1),…,key(size) are single character values, and val(1), …, val(size) are real numbers. Values are separated by one or more spaces;dict1 2 a 1.0 v 0.0
rl - range list. Range list syntax is { number1 .. numberN (start1 end1) (start2 end2)}. The enclosing brackets are compulsory. The range list represent list of integer values. Single values can be specified using single values (number1, .., NumberN). The range of values (all numbers from startI to endI including startI and endI can be specified using range value in the form (startI endI). The range is described using its start and end values enclosed in parenthesis. Any number of ranges and single values can be used to specify range list.
range1 { 1 7 8 (10 20) (25 30) }
et - entity type. For example, it describes the finite element type. Possible type values are mentioned in specific sections.
s - character string. The string have to be enclosed in quotes (“”) following after corresponding keyword.
string1 ``string example''
expr - function expression. The expression have to be enclosed in quotes (“”). The expression is evaluated by internal parser and represent mathematical expressions as a function of certain variables. The variable names and meaning are described in specific sections. The usual arithmetic operators like -,+,*,/ are supported and their evaluation order is taken into account. The evaluation order can be changed using parenthesis. Several built-in functions are supported (sqrt, sin, cos, tan, atan, asin and acos) - these must be typed using lowercase letters and their arguments must be enclosed in parenthesis.
expr1 ``2.0*sin(t)/3.0''
attribute1_keyword #(type)] ...
[attributeXX_keyword #(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.
When some attribute 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).
Particle color #(in) mass #(rn) coords #(ra)
name #(s)
The following listing shows the corresponding,
properly formatted, input record:Particle 2 color 5 mass 0.18 coords 3 0.0 1.0 2.0 name "P1_36"
Output and Job description Records¶
Output file record¶
This record has no keywords and contains a character string, which describes the path to output file. If the file with the same name exists, it will be overwritten.
Job description record¶
This record has no keywords and contains a character string, which describes the job. This description will appear in the output file.