src/CollectionPlugin/doc/fieldFeature.rst

   1
   2 Field
   3 =====
   4
   5 A field object assigns some values to geometrical entities. These values can be later transferred to mesh entities generated on the geometrical entities during export to MED file in Mesh module. Geometrical fields can be stored in/restored from XAO format files. Note that only integer and double values can be exported into the MED file.
   6
   7 The field can hold several named values (components) per geometrical entity.
   8
   9 The field can include several sets of data called steps, each dedicated to a certain time moment.
  10
  11 To create a Field in the active part:
  12
  13 #. select in the Main Menu *Features - > Field* item  or
  14 #. click **Field** button in Shaper toolbar:
  15
  16 .. image:: images/field.png
  17   :align: center
  18
  19 .. centered::
  20    Field button
  21
  22 The following property panel appears.
  23
  24 .. image:: images/field_property_panel.png
  25   :align: center
  26
  27 .. centered::
  28   Create a field
  29
  30 Input fields:
  31
  32 - **Type of shapes** selects geometrical entities to which field values will be assigned from drop-down list:
  33
  34   - Vertices;
  35   - Edges;
  36   - Faces;
  37   - Solids;
  38   - Objects;
  39   - Parts;
  40
  41 - **Type of field** selects type of field values from drop-down list:
  42
  43   - Boolean;
  44   - Integer;
  45   - Double;
  46   - String;
  47
  48 - **Nb. Components** defines number of named values (components) assigned to each geometrical entity;
  49 - **Stamp** sets time stamp for the current time step;
  50 - **Current step** slider navigates through added steps;
  51 - table of values for each step contains:
  52
  53   - rows whose number depends on the number of entities selected in OCC 3D viewer;
  54   - **Default value** row contains values assigned to non-selected entities of the parent shape with given type;
  55   - columns whose number depends on **Nb. Components**;
  56   - to rename a component double-click a column header;
  57
  58 - **Add Step** button adds a new time step;
  59 - **Remove Step** button deletes the current time step.
  60
  61
  62 **TUI Command**: *model.addField(Part_1_doc, 2, "DOUBLE", 2, ["DX", "DY"], [model.selection("FACE", "Box_1_1/Left"), model.selection("FACE", "Box_1_1/Top")])*
  63
  64 **Arguments**:  1 part + integer (number of steps) + text (Type of field) + integer (number of components) + list of text (names of components) + list of objects
  65
  66 **TUI Command**: *Field_1.addStep(step, stamp, [[0.1, 0.2], [2.1, 1.7], [3.7, 1.95]])*
  67
  68 **Arguments**:  2 integers + list of lists of values with Type of field
  69
  70 **See Also** a sample TUI Script of :ref:`tui_create_field` operation.