TextFileFormat - msolids/musen GitHub Wiki
Each line of a text file describes a single object or specific scene property and can have the following format:
IDENTIFIER OBJ_ID OBJ_TYPE_IDENT OBJ_TYPE OBJ_GEOM_IDENT OBJ_GEOM OBJ_MATERIAL_IDENT MATERIAL_ID OBJ_ACTIVITY_IDENT OBJECT_ACTIVITY OBJ_TIME_IDENT OBJECT_TIME OBJ_COORD_IDENT OBJECT_COORD …
Each line starts with one of the following indicators, which define the type of information stored in this line. There exist eight possible types of main identifiers:
IDENTIFIER | Description |
---|---|
0 | Line with one of the physical objects (Particle, Wall, Solid bond, etc.) |
22 | Line with simulation domain (more information about simulation domain is given here ) |
25 | Line with main description of a geometrical object |
26 | Line with time-dependent properties of specific geometrical object |
27 | Line with the number of planes and indexes of walls included into this geometry |
28 | Line with information about periodic boundary conditions |
29 | A flag indicating whether anisotropy of particles is taken into account during the simulation |
30 | A flag indicating whether particles have increased contact radius |
32 | Line with compound |
33 | Line with compound interaction |
34 | Line with compound mixture |
38 | Line with information about analysis volume |
39 | Line with main description of package generator |
40 | Line with additional configuration of package generator |
41 | Line with description of bonds generator |
Each line starting with the main identifier equal to 0 contains complete information about a particular physical object. This information is separated by internal identifiers (marked as blue) and for all objects have a similar format:
Information about a sphere:
0 | OBJ_ID 1 1 5 RADIUS
CONTACT-RADIUS 23 MATERIAL_ID 24 START_ACTIV END_ACTIV 2 TP_1 16
ANGL_VEL 12 COORD 20 FORCE 18 FORCE_AMPL 31 ORIENTATION 42 PRINC_STRESS
36 STRESS_TENSOR 37 TEMPERATURE 15 VEL 2 TP_2 …
Information about a solid bond:
0 | OBJ_ID 1 9 5 ID1 ID2
DIAMETER INIT_LENGTH 23 MATERIAL_ID 24 START_ACTIV END_ACTIV 2 TP_1 12
COORD 20 FORCE 18 FORCE_AMPL 45 TANG_OVERLAP 37 TEMPERATURE 43
TOT_TORQUE 15 VEL 2 TP_2 …
Information about a wall:
0 | OBJ_ID 1 14 5 _ 23 MATERIAL_ID
24 START_ACTIV END_ACTIV2 TP_1 44 PLANE_COORD 20 FORCE 18 FORCE_AMPL 15
VEL 2 TP_2 …
Lines that do not start from 0 describe specific properties of the scene and have the following format:
Information about the simulation domain:
22 | coordMin coordMax
Information about a geometrical object:
25
GeometryName
GeometryKey
Mass
FreeMotionX
FreeMotionY
FreeMotionZ
RotateAroundCenterFlag
26 | Time-dependent velocity properties
27 | NumberOfPlanes IndexesOfPlanesInTheGeometry
Information about boundary conditions:
28 | Boundary conditions
Information about anisotropy:
29 | Flag
Information about contact radius:
30 | Flag
Information about materials:
32 | compound_key compound_name 0 density 2 dynamic_viscosity 7 young_modulus 8 normal_strength 9 tangential_strength 10 poisson_ratio 11 surface_energy 12 atomic_volume 13 surface_tension 14 time_therm_exp_coeff 15 yield_strength
33 | compound_key_1 compound_key_2 200 restitution_coefficient 201 static_friction 202 rolling_friction |
34 | mixture_key mixture_name 0 compound diameter contact_diameter fraction 1 compound diameter contact_diameter fraction 2 …
Table 2. Description of properties.
<textarea> </textarea>ID | Name | Value | Description |
---|---|---|---|
Time-independent data: |
|||
OBJ_ID | ID | Unique identifier of the object | |
1 |
OBJ_TYPE |
1 | Sphere |
9 | Solid bond | ||
14 | Triangular wall | ||
5 |
OBJ_GEOM |
R, CR | Radius and contact radius of a sphere |
ID1, ID2, D, L | Unique identifiers of connected particles, diameter and initial length of a solid bond | ||
- | Triangular wall | ||
23 | MATERIAL_ID | key | Material identifier of an object |
24 | START_ACTIV END_ACTIV | t1 t2 | Two time points which define activity interval of an object |
Time-dependent data: |
|||
2 | TP_X | t | New time point |
12 |
COORD | X Y Z | Object coordinates |
15 | VEL | X Y Z | Velocity |
16 | ANGL_VEL | X Y Z | Angular velocity |
18 | FORCE_AMPL | F | Magnitude of force (for bonds can be negative) |
20 | FORCE | X Y Z | Vector of force |
31 | ORIENTATION | q0 q1 q2 q3 | Quaternion of orientation |
36 | STRESS_TENSOR | t[0][0] t[0][1] t[0][2] t[1][0] t[1][1] t[1][2] t[2][0] t[2][1] t[2][2] |
Stress tensor of particles |
37 | TEMPERATURE | T | Temperature of object |
42 | PRINCIPAL_STRESS | X Y Z | Principal stress |
43 | TOT_TORQUE | X Y Z | Total torque |
44 | PLANE_COORD | X1 Y1 Z1 X2 Y2 Z2 X3 Y3 Z3 |
Corrdinates of each vertex of a wall |
45 | TANG_OVERLAP | X Y Z | Vector of tangential overlap |
Examples:
Several examples of text files are given in the MUSEN installation
folder at PathToMUSEN\Examples\InitScenes\.