add_scalar_fields_request#
- FieldTransaction.add_scalar_fields_request(field_name, surface_ids=None, surface_names=None, node_value=True, boundary_value=False)#
Add request to get scalar field data on surfaces.
- Parameters:
- field_name
str
Name of the scalar field.
- surface_ids
List
[int
],optional
List of surface IDs for scalar field data.
- surface_names: List[str], optional
List of surface names for scalar field data.
- node_valuebool,
optional
Whether to provide the nodal location. The default is
True
. IfFalse
, the element location is provided.- boundary_valuebool,
optional
Whether to provide the slip velocity at the wall boundaries. The default is
False
. WhenTrue
, no slip velocity is provided.
- field_name
- Returns:
- Return type: