Skip to content

Commit 4ba6321

Browse files
Update generated code for DPF 261_daily on main (#2857)
Co-authored-by: PProfizi <[email protected]>
1 parent 076895a commit 4ba6321

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

doc/source/_static/dpf_operators.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14393,8 +14393,8 @@ <h2>LaTeX</h2>
1439314393
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="25" ellipsis = "false"></pin-number-optional></td><td><pin-name name="region_scoping"></pin-name></td><td><req-type typeName="(scoping | int32 | vector<int32>)"></req-type></td><td><div class = "pin-des-text"><p>region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results).</p>
1439414394
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="1000" ellipsis = "true"></pin-number-optional></td><td><pin-name name="qualifiers"></pin-name></td><td><req-type typeName="(label_space)"></req-type></td><td><div class = "pin-des-text"><p>(for Fluid results only) LabelSpace with combination of zone, phases or species ids</p>
1439514395
</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="surface_heat_rate" license="none" cat="result" plugin="core" cpp-name="Q"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="extract scoping" scripting_name="extract_scoping"plugin="core"cat="utility"><h1 class="op-des-h1">utility: extract scoping</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Takes a field type object, mesh or a collection of them and extracts its scoping or scopings container.</p>
14396-
</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-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="field_or_fields_container"></pin-name></td><td><req-type typeName="(field | fields_container | property_field | property_fields_container | custom_type_field | custom_type_fields_container | string_field | scoping | scopings_container | meshed_region | meshes_container)"></req-type></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="requested_location"></pin-name></td><td><req-type typeName="(int32)"></req-type></td><td><div class = "pin-des-text"><p>If input 0 is a mesh or a meshes_container, the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental</p>
14397-
</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping | scopings_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="extract_scoping" license="none" cat="utility" plugin="core" cpp-name="extract_scoping"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="thermal conductivity" scripting_name="thermal_conductivity"plugin="core"cat="result"><h1 class="op-des-h1">result: thermal conductivity</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Read Thermal Conductivity by calling the readers defined by the datasources.</p>
14396+
</div></figure><div class="op-version">Version 0.0.1</div><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="field_or_fields_container"></pin-name></td><td><req-type typeName="(field | fields_container | property_field | property_fields_container | custom_type_field | custom_type_fields_container | string_field | scoping | scopings_container | meshed_region | meshes_container)"></req-type></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="requested_location"></pin-name></td><td><req-type typeName="(int32)"></req-type></td><td><div class = "pin-des-text"><p>If input 0 is a mesh or a meshes_container, the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental</p>
14397+
</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping | scopings_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="extract_scoping" license="none" cat="utility" plugin="core" cpp-name="extract_scoping"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New","0.0.1":"Error with license"}'></op-changelog></div><div class="operator" id="thermal conductivity" scripting_name="thermal_conductivity"plugin="core"cat="result"><h1 class="op-des-h1">result: thermal conductivity</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Read Thermal Conductivity by calling the readers defined by the datasources.</p>
1439814398
</div></figure><div class="op-version">Version 0.0.0</div><h2 class="op-des-h2">Supported file types</h2><supported-file-types content='{"cff":["cas","flprj"]}'></supported-file-types><h2 class="op-des-h2">Inputs</h2><div><table class="pin-box"><tbody><tr><td><pin-number-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="time_scoping"></pin-name></td><td><req-type typeName="(scoping | int32 | vector<int32> | double | field | vector<double>)"></req-type></td><td><div class = "pin-des-text"><p>time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on &quot;TimeFreq_steps&quot;. Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.</p>
1439914399
</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scopings_container | scoping)"></req-type></td><td><div class = "pin-des-text"><p>nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains</p>
1440014400
</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="streams_container"></pin-name></td><td><req-type typeName="(streams_container)"></req-type></td><td><div class = "pin-des-text"><p>result file container allowed to be kept open to cache data</p>
@@ -14621,11 +14621,11 @@ <h2>LaTeX</h2>
1462114621
</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="(fields_container)"></req-type></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="abs_value"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>Should use absolute value.</p>
1462214622
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="4" ellipsis = "false"></pin-number-optional></td><td><pin-name name="compute_amplitude"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>Do calculate amplitude.</p>
1462314623
</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="incremental" default="true" doc="This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range." 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="max_over_time_by_entity" license="none" cat="min_max" plugin="core" cpp-name="max_over_time_by_entity"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="transpose" scripting_name="transpose"plugin="core"cat="scoping"><h1 class="op-des-h1">scoping: transpose</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Transposes the input scoping or scopings container (Elemental/Faces --&gt; Nodal, or Nodal ---&gt; Elemental/Faces), based on the input mesh region.</p>
14624-
</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping | scopings_container)"></req-type></td><td><div class = "pin-des-text"><p>Scoping or scopings container (the input type is the output type)</p>
14624+
</div></figure><div class="op-version">Version 0.1.1</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping | scopings_container)"></req-type></td><td><div class = "pin-des-text"><p>Scoping or scopings container (the input type is the output type)</p>
1462514625
</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="meshed_region"></pin-name></td><td><req-type typeName="(meshed_region | meshes_container)"></req-type></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="inclusive"></pin-name></td><td><req-type typeName="(int32)"></req-type></td><td><div class = "pin-des-text"><p>if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included</p>
1462614626
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="9" ellipsis = "false"></pin-number-optional></td><td><pin-name name="requested_location"></pin-name></td><td><req-type typeName="(string)"></req-type></td><td><div class = "pin-des-text"><p>Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental.</p>
1462714627
</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="mesh_scoping"></pin-name></td><td><req-type typeName="(scoping | scopings_container)"></req-type></td><td><div class = "pin-des-text"><p>Scoping or scopings container (the input type is the output type)</p>
14628-
</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="transpose" license="none" cat="scoping" plugin="core" cpp-name="transpose_scoping"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New","0.1.0":"Improvement of performance"}'></op-changelog></div><div class="operator" id="overlap fields" scripting_name="overlap_fields"plugin="core"cat="utility"><h1 class="op-des-h1">utility: overlap fields</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Take two fields and superpose them, the overlapping field will override values of base_field.</p>
14628+
</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="transpose" license="none" cat="scoping" plugin="core" cpp-name="transpose_scoping"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New","0.1.0":"Improvement of performance","0.1.1":"Error with license"}'></op-changelog></div><div class="operator" id="overlap fields" scripting_name="overlap_fields"plugin="core"cat="utility"><h1 class="op-des-h1">utility: overlap fields</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Take two fields and superpose them, the overlapping field will override values of base_field.</p>
1462914629
</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-optional n="0" ellipsis = "false"></pin-number-optional></td><td><pin-name name="base_field"></pin-name></td><td><req-type typeName="(field)"></req-type></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="overlapping_field"></pin-name></td><td><req-type typeName="(field)"></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="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="overlap_fields" license="none" cat="utility" plugin="core" cpp-name="overlap_fields"></scripting-part><h2 class="op-des-h2">Changelog</h2><op-changelog content='{"0.0.0":"New"}'></op-changelog></div><div class="operator" id="find reduced coordinates" scripting_name="find_reduced_coordinates"plugin="core"cat="mapping"><h1 class="op-des-h1">mapping: find reduced coordinates</h1><figure class="figure-op-des"> <figcaption > Description </figcaption><div class = "figure-op-des-text"><p>Finds the elements corresponding to the given coordinates in input and computes their reduced coordinates in those elements.</p>
1463014630
</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="1" ellipsis = "false"></pin-number></td><td><pin-name name="coordinates"></pin-name></td><td><req-type typeName="(field | fields_container | abstract_meshed_region | meshes_container)"></req-type></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 | meshes_container)"></req-type></td><td><div class = "pin-des-text"><p>If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container.</p>
1463114631
</div></td></tr></tbody></table><table class="pin-box"><tbody><tr><td><pin-number-optional n="200" ellipsis = "false"></pin-number-optional></td><td><pin-name name="use_quadratic_elements"></pin-name></td><td><req-type typeName="(bool)"></req-type></td><td><div class = "pin-des-text"><p>If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false.</p>
512 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)