ansys.fluent.core.services.field_data.FieldData.get_scalar_field_data

FieldData.get_scalar_field_data(field_name, surface_ids=None, surface_name=None, node_value=True, boundary_value=False)

Get scalar field data on a surface.

Parameters:

field_namestr

Name of the scalar field.

surface_idsList[int], optional

List of surface IDs for scalar field data.

surface_name: str, optional

Surface Name for scalar field data.

node_valuebool, optional

Whether to provide data for the nodal location. The default is True. When False, data is provided for the element location.

boundary_valuebool, optional

Whether to provide slip velocity at the wall boundaries. The default is False. When True, no slip velocity is provided.

Returns:

Union[ScalarFieldData, Dict[int, ScalarFieldData]]

If a surface name is provided as input, scalar field data is returned. If surface IDs are provided as input, a dictionary containing a map of surface IDs to scalar field data.