Field data interfaces#

Common interfaces for field data.

Classes:

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

class ansys.fluent.core.field_data_interfaces.PathlinesFieldDataRequest(surfaces, field_name, additional_field_name='', provide_particle_time_field=False, node_value=True, steps=500, step_size=500, skip=0, reverse=False, accuracy_control_on=False, tolerance=0.001, coarsen=1, velocity_domain='all-phases', zones=None, flatten_connectivity=False)#

Bases: BaseDataRequest

Container storing parameters for path-lines field data request.

Attributes:

`accuracy_control_on`
`additional_field_name`
`coarsen`
`field_name`
`flatten_connectivity`
`node_value`
`provide_particle_time_field`
`reverse`
`skip`
`step_size`
`steps`
`tolerance`
`velocity_domain`
`zones`

accuracy_control_on: bool | None = False#

additional_field_name: str = ''#

coarsen: int | None = 1#

field_name: str | ScalarVariableDescriptor#

flatten_connectivity: bool = False#

node_value: bool | None = True#

provide_particle_time_field: bool | None = False#

reverse: bool | None = False#

skip: int | None = 0#

step_size: float | None = 500#

steps: int | None = 500#

surfaces: list[int | str | object]#

tolerance: float | None = 0.001#

velocity_domain: str | None = 'all-phases'#

zones: list | None = None#

class ansys.fluent.core.field_data_interfaces.ScalarFieldDataRequest(surfaces, field_name, node_value=True, boundary_value=True)#

Bases: BaseDataRequest

Container storing parameters for scalar field data request.

Attributes:

`boundary_value`
`field_name`
`node_value`

boundary_value: bool | None = True#

field_name: str | ScalarVariableDescriptor#

node_value: bool | None = True#

surfaces: list[int | str | object]#

class ansys.fluent.core.field_data_interfaces.SurfaceDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)#

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(surfaces, data_types, overset_mesh=False, flatten_connectivity=False)#