Skip to content

Commit 9c9df67

Browse files
Update generated code for DPF 261_daily on main (#2710)
Co-authored-by: PProfizi <[email protected]>
1 parent 34ac00c commit 9c9df67

File tree

4 files changed

+2
-2
lines changed

4 files changed

+2
-2
lines changed

doc/source/_static/dpf_operators.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14363,9 +14363,9 @@ <h2 class="h2-main">Configurating operators</h2>
1436314363
</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="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>
1436414364
</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>
1436514365
</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="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>
14366-
</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>
14366+
</div></figure><div class="op-version">Version 0.2.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>
1436714367
</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>
14368-
</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="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>
14368+
</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.","0.2.0":"Moving event of progress bar at the beggining of the loop and changing input stream."}'></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>
1436914369
</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>
1437014370
</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="property_identifier"></pin-name></td><td><req-type typeName="(int32 | string)"></req-type></td><td><div class = "pin-des-text"><p>Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name.</p>
1437114371
</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="property"></pin-name></td><td><req-type typeName="(scoping | field | property_field | int32 | string_field)"></req-type></td><td><div class = "pin-des-text"><p>Returns a property field for properties: &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), a field for property: &quot;coordinates&quot;, a scoping for properties:&quot;named_selection&quot;, &quot;node_scoping&quot;, &quot;element_scoping&quot;, &quot;face_scoping&quot;, a string field for properties: &quot;named_selection_names&quot;, &quot;named_selection_locations&quot; and an int for property: &quot;num_named_selections&quot;.</p>
125 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)