Field data interfaces#

Common interfaces for field data.

Classes:

`PathlinesFieldDataRequest`(field_name, surfaces)	Container storing parameters for path-lines field data request.
`ScalarFieldDataRequest`(field_name, surfaces)	Container storing parameters for scalar field data request.
`SurfaceDataType`(*values)	Provides surface data types.
`SurfaceFieldDataRequest`(data_types, surfaces)	Container storing parameters for surface data request.
`VectorFieldDataRequest`(field_name, surfaces)	Container storing parameters for vector field data request.

Bases: NamedTuple

Container storing parameters for path-lines field data request.

Attributes:

`accuracy_control_on`	Whether adaptive accuracy control is enabled.
`additional_field_name`	Optional additional scalar field to include in the response.
`coarsen`	Coarsening factor applied to pathline output.
`field_name`	Scalar field name to sample along computed pathlines.
`flatten_connectivity`	Whether line connectivity is returned in flattened format.
`node_value`	Whether to request nodal values.
`provide_particle_time_field`	Whether to include a particle-time field in the output.
`reverse`	Whether to integrate pathlines in reverse direction.
`skip`	Number of sampled points to skip.
`step_size`	Integration step size.
`steps`	Maximum number of integration steps per pathline.
`surfaces`	A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).
`tolerance`	Tolerance used when accuracy control is enabled.
`velocity_domain`	Velocity domain used for pathline integration.
`zones`	Optional zones used to constrain pathline computation.

accuracy_control_on: Optional[bool]#: Whether adaptive accuracy control is enabled.

additional_field_name: str#: Optional additional scalar field to include in the response.

coarsen: Optional[int]#: Coarsening factor applied to pathline output.

field_name: str#: Scalar field name to sample along computed pathlines.

flatten_connectivity: bool#: Whether line connectivity is returned in flattened format.

node_value: Optional[bool]#: Whether to request nodal values.

provide_particle_time_field: Optional[bool]#: Whether to include a particle-time field in the output.

reverse: Optional[bool]#: Whether to integrate pathlines in reverse direction.

skip: Optional[int]#: Number of sampled points to skip.

step_size: Optional[float]#: Integration step size.

steps: Optional[int]#: Maximum number of integration steps per pathline.

surfaces: list[Union[int, str, object]]#: A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

tolerance: Optional[float]#: Tolerance used when accuracy control is enabled.

velocity_domain: Optional[str]#: Velocity domain used for pathline integration.

zones: Optional[list]#: Optional zones used to constrain pathline computation.

class ansys.fluent.core.field_data_interfaces.ScalarFieldDataRequest(field_name: str, surfaces: list[int | str | object], node_value: bool | None = True, boundary_value: bool | None = True)#

Bases: NamedTuple

Container storing parameters for scalar field data request.

Attributes:

`boundary_value`	Whether to request boundary values when supported.
`field_name`	Scalar field name to request.
`node_value`	Whether to request nodal values.
`surfaces`	A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

boundary_value: Optional[bool]#: Whether to request boundary values when supported.

field_name: str#: Scalar field name to request.

node_value: Optional[bool]#: Whether to request nodal values. If False, element values are requested.

surfaces: list[Union[int, str, object]]#: A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

class ansys.fluent.core.field_data_interfaces.SurfaceDataType(*values)#

Bases: Enum

Provides surface data types.

Attributes:

`FacesCentroid`
`FacesConnectivity`
`FacesNormal`
`Vertices`

FacesCentroid = 'centroid'#

FacesConnectivity = 'faces'#

FacesNormal = 'face-normal'#

Vertices = 'vertices'#

class ansys.fluent.core.field_data_interfaces.SurfaceFieldDataRequest(data_types: list[SurfaceDataType] | list[str], surfaces: list[int | str | object], overset_mesh: bool | None = False, flatten_connectivity: bool = False)#

Bases: NamedTuple

Container storing parameters for surface data request.

Attributes:

`data_types`	Surface data entries to request: vertices, face connectivity, face normals, and face centroids.
`flatten_connectivity`	Whether face connectivity is returned in flattened format.
`overset_mesh`	Whether overset mesh entities should be included when available.
`surfaces`	A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

data_types: Union[list[SurfaceDataType], list[str]]#: Surface data entries to request: vertices, face connectivity, face normals, and face centroids.

flatten_connectivity: bool#: Whether face connectivity is returned in flattened format.

overset_mesh: Optional[bool]#: Whether overset mesh entities should be included when available.

surfaces: list[Union[int, str, object]]#: A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

class ansys.fluent.core.field_data_interfaces.VectorFieldDataRequest(field_name: str, surfaces: list[int | str | object])#

Bases: NamedTuple

Container storing parameters for vector field data request.

Attributes:

`field_name`	Vector field name to request.
`surfaces`	A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).

field_name: str#: Vector field name to request.

surfaces: list[Union[int, str, object]]#: A sequence of valid Fluent surfaces, each identified by either an integer ID, a name string, or a settings API surface object (or any object with a name() -> str method).