Update generated code for DPF 261_daily on main (#2621)

Co-authored-by: PProfizi <[email protected]>

Author: 2 people

doc/source/_static/dpf_operators.html

@@ -6229,10 +6229,10 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fields_container"></pin-name></td><td><req-type typeName="(fields_container)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="elementary_data_selector_fc" license="none" cat="logic" plugin="core" cpp-name="elementary_data_selector_fc"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="convert to scoping" scripting_name="ints_to_scoping"plugin="core"cat="utility"><h1 class="op-des-h1">utility: convert to scoping</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>take a int or a vector of int and transform it in a one entity field of location &quot;numeric&quot;.</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="int_or_vector_int"></pin-name></td><td><req-type typeName="(int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>int or vector of int</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="1" ellipsis = "false"></pin-number-optional></td><td><pin-name name="location"></pin-name></td><td><req-type typeName="(string)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="scoping"></pin-name></td><td><req-type typeName="(scoping)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="ints_to_scoping" license="none" cat="utility" plugin="core" cpp-name="scopingify"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="elementary data selector (field)" scripting_name="elementary_data_selector"plugin="core"cat="logic"><h1 class="op-des-h1">logic: elementary data selector (field)</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Creates a scalar/vector field based on the selected elementary data.</p>
-</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field | fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="elementary_data_index"></pin-name></td><td><req-type typeName="(int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract.</p>
+</div></figure><div class="op-version">Version 0.1.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field | fields_container)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="elementary_data_index"></pin-name></td><td><req-type typeName="(int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="2" ellipsis = "false"></pin-number-optional></td><td><pin-name name="default_value"></pin-name></td><td><req-type typeName="(double)"></req-type></td><td><div class = "pin-des-text"><p>Set a default value for elementary data that do not exist.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="3" ellipsis = "false"></pin-number-optional></td><td><pin-name name="elementary_data_index_2"></pin-name></td><td><req-type typeName="(int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>For field with nature matrix, this is the column indices to extract.</p>
-</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="elementary_data_selector" license="none" cat="logic" plugin="core" cpp-name="elementary_data_selector"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="change location" scripting_name="change_location"plugin="core"cat="utility"><h1 class="op-des-h1">utility: change location</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>change the location of a field.</p>
+</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="elementary_data_selector" license="none" cat="logic" plugin="core" cpp-name="elementary_data_selector"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New","0.1.0":"fix of crash when input field data pointer is empty, the operator will output an empty field in this case moving forward."}'></op-changelog></div><div class="operator" id="change location" scripting_name="change_location"plugin="core"cat="utility"><h1 class="op-des-h1">utility: change location</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>change the location of a field.</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="new_location"></pin-name></td><td><req-type typeName="(string)"></req-type></td><td><div class = "pin-des-text"><p>new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'...</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="change_location" license="none" cat="utility" plugin="core" cpp-name="change_location"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="extract field" scripting_name="extract_field"plugin="core"cat="utility"><h1 class="op-des-h1">utility: extract field</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Extracts the fields at the indices defined in the vector (in 1) from the fields container (in 0).</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="fields_container"></pin-name></td><td><req-type typeName="(field | fields_container)"></req-type></td><td><div class = "pin-des-text"><p>if a field is in input, it is passed on as an output</p>
@@ -14314,9 +14314,9 @@ <h2 class="h2-main">Configurating operators</h2>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="operator_to_iterate"></pin-name></td><td><req-type typeName="(operator)"></req-type></td><td><div class = "pin-des-text"><p>Operator that must be reconnected with the range values.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="2" ellipsis = "false"></pin-number></td><td><pin-name name="pin_index"></pin-name></td><td><req-type typeName="(int32)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="3" ellipsis = "false"></pin-number></td><td><pin-name name="valueA"></pin-name></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="4" ellipsis = "false"></pin-number></td><td><pin-name name="valueB"></pin-name></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="5" ellipsis = "true"></pin-number></td><td><pin-name name="valueC"></pin-name></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1000" ellipsis = "true"></pin-number></td><td><pin-name name="producer_op1"></pin-name></td><td><req-type typeName="(operator)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1001" ellipsis = "true"></pin-number></td><td><pin-name name="output_pin_of_producer_op1"></pin-name></td><td><req-type typeName="(int32)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1002" ellipsis = "true"></pin-number></td><td><pin-name name="input_pin_of_consumer_op1"></pin-name></td><td><req-type typeName="(int32)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1003" ellipsis = "true"></pin-number></td><td><pin-name name="consumer_op1"></pin-name></td><td><req-type typeName="(operator)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="iterator"></pin-name></td><td><div class = "pin-des-text"><p>to connect to producer_consumer_for_each</p>
 </div></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="make_producer_consumer_for_each_iterator" license="none" cat="utility" plugin="core" cpp-name="make_producer_consumer_for_each_iterator"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="producer consumer for each" scripting_name="producer_consumer_for_each"plugin="core"cat="utility"><h1 class="op-des-h1">utility: producer consumer for each</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Allows to write a loop over operators by connecting data to iterate and by requesting the incrementally output merged.The chain of Operators are split into a first part: the producers and a second part: the consumers. These 2 parts will run asynchronously on 2 threads.</p>
-</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="producer_consumer_iterableq"></pin-name></td><td><div class = "pin-des-text"><p>The result of the make_producer_consumer_for_each_iterator operator.</p>
+</div></figure><div class="op-version">Version 0.1.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="producer_consumer_iterableq"></pin-name></td><td><div class = "pin-des-text"><p>The result of the make_producer_consumer_for_each_iterator operator.</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="3" ellipsis = "true"></pin-number></td><td><pin-name name="forward"></pin-name></td><td><div class = "pin-des-text"><p>output of the last operators of the workflow</p>
-</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="empty"></pin-name></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="3" ellipsis = "true"></pin-number></td><td><pin-name name="output"></pin-name></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="evaluate_inputs_before_run" default="false" doc="If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status." types="bool" ></config-spec><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="producer_consumer_for_each" license="none" cat="utility" plugin="core" cpp-name="producer_consumer_for_each"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="extend to mid nodes (field)" scripting_name="extend_to_mid_nodes"plugin="core"cat="averaging"><h1 class="op-des-h1">averaging: extend to mid nodes (field)</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Extends an Elemental Nodal or Nodal field defined on corner nodes to a field defined also on the mid nodes.</p>
+</div></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="empty"></pin-name></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="3" ellipsis = "true"></pin-number></td><td><pin-name name="output"></pin-name></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="evaluate_inputs_before_run" default="false" doc="If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status." types="bool" ></config-spec><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="producer_consumer_for_each" license="none" cat="utility" plugin="core" cpp-name="producer_consumer_for_each"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New","0.1.0":"Addition of events to monitor the status of the operator."}'></op-changelog></div><div class="operator" id="extend to mid nodes (field)" scripting_name="extend_to_mid_nodes"plugin="core"cat="averaging"><h1 class="op-des-h1">averaging: extend to mid nodes (field)</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Extends an Elemental Nodal or Nodal field defined on corner nodes to a field defined also on the mid nodes.</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field | fields_container)"></req-type></td><td><div class = "pin-des-text"><p>field or fields container with only one field is expected</p>
 </div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="7" ellipsis = "false"></pin-number-optional></td><td><pin-name name="mesh"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Outputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="field"></pin-name></td><td><req-type typeName="(field)"></req-type></td></tr></tbody></table></div><h2 class="op-des-h2">Configurations</h2><config-spec name="inplace" default="false" doc="The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input." types="bool" ></config-spec><config-spec name="mutex" default="false" doc="If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads." types="bool" ></config-spec><h2 class="op-des-h2">Scripting</h2><scripting-part scripting_name="extend_to_mid_nodes" license="any_dpf_supported_increments" cat="averaging" plugin="core" cpp-name="extend_to_mid_nodes"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="mesh get attribute" scripting_name="mesh_get_attribute"plugin="core"cat="mesh"><h1 class="op-des-h1">mesh: mesh get attribute</h1><figure class="figure-op-des"> <figcaption > Description  </figcaption><div class = "figure-op-des-text"><p>Uses the MeshedRegion APIs to return a given attribute of the mesh in input.</p>
 </div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number n="0" ellipsis = "false"></pin-number></td><td><pin-name name="abstract_meshed_region"></pin-name></td><td><req-type typeName="(abstract_meshed_region)"></req-type></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number n="1" ellipsis = "false"></pin-number></td><td><pin-name name="property_name"></pin-name></td><td><req-type typeName="(string)"></req-type></td><td><div class = "pin-des-text"><p>Supported property names are: &quot;connectivity&quot;, &quot;reverse_connectivity&quot;, &quot;mat&quot;, &quot;faces_nodes_connectivity&quot;, &quot;elements_faces_connectivity&quot; (or any mesh's property field), &quot;coordinates&quot;, &quot;named_selection&quot;, &quot;num_named_selections&quot;, &quot;named_selection_names&quot;, &quot;named_selection_locations&quot;, &quot;node_scoping&quot;, &quot;element_scoping&quot;, &quot;face_scoping&quot;...</p>