get_tbrom_output_field

TwinModel.get_tbrom_output_field(rom_name)

Return the TBROM output field as a PyVista DataSet object, in the form of point cloud data. The resulting field is based on current states of the TwinModel and is automatically updated whenever the TwinModel is evaluated.

Parameters:

rom_namestr

Name of the ROM. To get a list of available ROMs, see the pytwin.TwinModel.tbrom_names attribute.

Returns:

pyvista.DataSet

PyVista DataSet object of the TBROM output field in the form of point cloud data.

Raises:

TwinModelError:

If TwinModel object does not include any TBROMs. If the provided ROM name is not available. If the TBROM does not have any point file available. If TBROM hasn’t its mode coefficients outputs connected to the twin’s outputs.

Examples

>>> from pytwin import TwinModel
>>> model = TwinModel(model_filepath='path_to_twin_model_with_TBROM_in_it.twin')
>>> romname = model.tbrom_names[0]
>>> rom_results = model.get_tbrom_output_field(romname)
>>> model.initialize_evaluation()