mapping:prepare mechanical native mapping
Version: 0.0.0
Description
Prepare mapping of source data from source mesh to target mesh by operating the source_mesh/target_mesh weights computation. This operator needs to be used with the apply mechanical native mapping associated one. At least one of the optional DataTree inputs need to be set, in order to chose the mapping algorithm and set the mapping options.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | source_mesh | abstract_meshed_region | Source mesh |
| Pin 1 Required | target_mesh | abstract_meshed_region, field | Target mesh. Can be a meshed region or a node coordinates field depending on the algorithm that is used. Refer to the dedicated algorithm operator documentation. |
| Pin 3 | target_mesh_scoping | scoping | Target mesh scoping. If used, ensure to give only the elements where results are expected into source mesh input to have optimized computation. |
| Pin 8 | html_report_path | string | Path for html report (for example 'my_disk/my_report.html'). If set, an html report will be generated and exported to the html file. If not set, nothing will be generated. |
| Pin 30 | shape_function_volumes_mapping | data_tree | Mapping options as DataTree object with 'mapping_options' subtree for mapping with shape function algorithm. Another 'data_definition' subtree needs to be contained, with at least 'dimensionality' int and 'location' string attributes. The other 'data_definition' and 'mapping_options' attributes can be found looking at the corresponding operator definition. The available mapping_options are: scale (int), edge_tolerance (double), conservative (bool), ignore_outside_nodes (bool). Corresponding operator definition can be checked to know the default values of the mapping options. |
| Pin 31 | shape_function_surfaces_mapping | data_tree | Mapping options as DataTree object with 'mapping_options' subtree for mapping with shape function algorithm. Another 'data_definition' subtree needs to be contained, with at least 'dimensionality' int and 'location' string attributes. The other 'data_definition' and 'mapping_options' attributes can be found looking at the corresponding operator definition. The available mapping_options are: scale (int), edge_tolerance (double), conservative (bool), ignore_outside_nodes (bool), key (string), normal_distance_check (bool), normal_tolerance (double), pinball_controll (bool), pinball_key (string), exclude_elements_outside_pinball (bool), pinball_value (double). Corresponding operator definition can be checked to know the default values of the mapping options. |
| Pin 32 | point_cloud_mapping | data_tree | Mapping options as DataTree object with 'mapping_options' subtree for mapping with point cloud algorithm. Another 'data_definition' subtree needs to be contained, with at least 'dimensionality' int and 'location' string attributes. The other 'data_definition' and 'mapping_options' attributes can be found looking at the corresponding operator definition. The available mapping_options are: weighting_type (string), outside_option (string), num_outside_nodes (int), max_outside_distance (double), search_limit (int), bouding_box_range (double), geometry_type (string),shell_thickness_factor (double). Corresponding operator definition can be checked to know the default values of the mapping options. |
| Pin 33 | kriging_mapping | data_tree | Mapping options as DataTree object with 'mapping_options' subtree for mapping with kriging algorithm. Another 'data_definition' subtree needs to be contained, with at least 'dimensionality' int and 'location' string attributes. The other 'data_definition' and 'mapping_options' attributes can be found looking at the corresponding operator definition. The available mapping_options are: samples_limit (int), correlation_function_type (string), polynomial_type (string), outside_distance_checking (bool), bouding_box_tolerance (double), adaptive_tolerance_percent (double), geometry_type (string). Corresponding operator definition can be checked to know the default values of the mapping options. |
| Pin 100 | is_element_centroidal_data_mapping | bool | Default is 'false'. Set to 'true' if the source elemental data is representing as element centroidal nodal data |
| Pin 101 | projection_options | data_tree | Default is empty. This data tree contains 2D projection options for mapping 2D to 3D |
| Pin 102 | dynamic_coordinate_system | data_tree | Default is empty. This data tree contains the dynamic coordinate system for performing rigid body transformation on the source mesh |
| Pin 103 | source_dimension | string | Default is empty string. The string contains either "2D" or "3D" which specifies the source dimension |
| Pin 104 | wb_external_data_info | data_tree | Default is empty. This data tree contains the Rigid & Analytical transformations specified in the workbench external data system |
| Pin 105 | target_dimension | string | Default is empty string. The string contains either "2D" or "3D" which specifies the target dimension |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | source_mesh | abstract_meshed_region | Source mesh |
| Pin 1 | source_mesh_id | int32 | Source mesh id |
| Pin 2 | target_mesh | abstract_meshed_region | Target mesh |
| Pin 3 | target_mesh_id | int32 | Target mesh id |
| Pin 4 | mapping_manager_data | ||
| Pin 6 | target_scoping | scoping | Target scoping |
| Pin 7 | prepare_output | A Map containing the outputs of the mapping as a key value pair |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: mapping
Plugin: N/A
Scripting name: prepare_mechanical_native_mapping
Full name: mapping.prepare_mechanical_native_mapping
Internal name: mechanical_native_mapping::prepare
License: any_dpf_supported_increments
Changelog
- Version 0.0.0: Initial release.