project_tbrom_on_mesh#

TwinModel.project_tbrom_on_mesh(rom_name, target_mesh, interpolate, named_selection=None, nodal_values=False, sharpness=5.0, radius=0.0001, strategy='closest_point', null_value=0.0, n_points=None, all_points=False)#

Project the field ROM data onto a targeted mesh, using the current states of the TwinModel. The returned PyVista DataSet object is automatically updated whenever the TwinModel is evaluated.

Parameters:

rom_namestr: Name of the TBROM considered to project the results.
target_mesh: pyvista.DataSet: PyVista DataSet object of the targeted mesh.
interpolate: bool: Flag to indicate whether the point cloud data are interpolated (True) or not (False) on the targeted mesh. Interpolation is recommended when point cloud data and mesh data are not ordered in the same way, and when the target mesh is different from the one used to generate the ROM. Interpolation is automatically enforced if the target mesh size (i.e. number of cells/points) is different from the point cloud size.
nodal_values: bool (optional): Control whether the interpolated results are returned as nodal values, or cell values (default)
named_selection: str (optional): Named selection from the ROM (i.e. subset of points cloud) that will be projected on the targeted mesh. The default is None, in which case the entire domain is considered.
sharpnessfloat, default: 5.0: Set the sharpness (i.e., falloff) of the Gaussian interpolation kernel. As the sharpness increases the effects of distant points are reduced.
radiusfloat, default: 0.0001: Specify the radius within which the interpolation basis points must lie.
strategystr, default: “closest_point”: Specify a strategy to use when encountering a “null” point during the interpolation process. Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to 'mask_points', then only cells with some or all valid points (according to the all_points setting) are included in the returned PyVista DataSet. If the strategy is set to 'null_value', then the output data value(s) are set to the null_value (specified in the output point data). Finally, the strategy 'closest_point' is to simply use the closest point to perform the interpolation.
null_valuefloat, default: 0.0: Specify the null point value. When a null point is encountered then all components of field ROM data associated with that point are set to this value.
n_pointsint, optional: If given, specifies the number of the closest points used to form the interpolation basis. This will invalidate the radius argument in favor of an N closest points approach. This typically has poorer results.
all_points: bool, default: False: When strategy='mask_points', when this value is True only cells where all points are valid are kept. When False cells are kept if any of their points are valid and invalid points are given the null_value.

Returns:

pyvista.DataSet: PyVista DataSet object of the targeted mesh with projected field ROM data.

Raises:

TwinModelError:: If TwinModel object has not been initialized. If rom_name is not included in the Twin’s list of TBROM If TBROM hasn’t its mode coefficients outputs connected to the twin’s outputs If target_mesh is not a valid grid dataset If name_selection is not included in the TBROM’s list of Named Selections If interpolate is True and no points file is available with the TBROM If strategy is 'mask_points' and all points are removed.
TwinModelWarning:: If interpolate is False and the targeted mesh has a number of cells and points different from TBROM point cloud. In that case, interpolate is automatically switched to True.