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_name
str
Name of the scalar field.
- surface_ids
List
[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
. WhenFalse
, data is provided for the element location.- boundary_valuebool,
optional
Whether to provide slip velocity at the wall boundaries. The default is
False
. WhenTrue
, no slip velocity is provided.
- field_name
- Returns:
Dict
[int
,np.array
]Dictionary containing a map of surface IDs to the scalar field.
- Return type: