abstract_field_data

Abstract contracts for Fluent field-data transports and sources.

Classes:

AbstractFieldData()	Abstract base class for the field data service.
BaseFieldDataSource()	Abstract contract for a user-facing field-data source.
FieldBatch()	Abstract contract for collecting and executing field-data requests.
FieldDataSource()	Abstract contract for a field-data source that supports batching.

class ansys.fluent.core.fields.field_data.abstract_field_data.AbstractFieldData

Bases: ABC

Abstract base class for the field data service.

Methods:

extract_fields(chunk_iterator)	Extract fields from the chunk iterator.
get_batched_fields()	Get the batched fields from the service.
get_scalar_field_range(field[, node_value, ...])	Get the range (minimum and maximum values) of the field.
get_scalar_fields_info()	Get fields information (field name, domain, and section).
get_solver_mesh_elements(domain_id, thread_id)	Get mesh elements.
get_solver_mesh_nodes_double(domain_id, ...)	Get mesh node -> double precision.
get_solver_mesh_nodes_float(domain_id, thread_id)	Get mesh node -> floating point precision.
get_surfaces_info()	Get surfaces information (surface name, ID, and type).
get_vector_fields_info()	Get vector fields information (vector components).

abstract extract_fields(chunk_iterator)

Extract fields from the chunk iterator.

abstract get_batched_fields()

Get the batched fields from the service.

abstract get_scalar_field_range(field, node_value=False, surface_ids=None)

Get the range (minimum and maximum values) of the field.

Parameters:

field: str

Field name

node_value: bool

surface_idsList[int], optional

List of surface IDS for the surface data.

Returns:

List[float]

abstract get_scalar_fields_info()

Get fields information (field name, domain, and section).

Returns:

Dict

abstract get_solver_mesh_elements(domain_id, thread_id)

Get mesh elements.

Returns:

List[float]

abstract get_solver_mesh_nodes_double(domain_id, thread_id)

Get mesh node -> double precision.

Returns:

List[float]

abstract get_solver_mesh_nodes_float(domain_id, thread_id)

Get mesh node -> floating point precision.

Returns:

List[float]

abstract get_surfaces_info()

Get surfaces information (surface name, ID, and type).

Returns:

Dict

abstract get_vector_fields_info()

Get vector fields information (vector components).

Returns:

Dict

class ansys.fluent.core.fields.field_data.abstract_field_data.BaseFieldDataSource

Bases: ABC

Abstract contract for a user-facing field-data source.

This contract belongs to the wrapper layer, not to a transport service. It describes how callers resolve surfaces and retrieve data after a transport specific AbstractFieldData implementation has been connected.

LiveFieldData is the standard implementation.

Methods:

get_field_data(obj)	Retrieve the field data for a given request.
get_surface_ids(surfaces)	Retrieve a list of surface IDs based on input surface names or numerical identifiers.

abstract get_field_data(obj)

Retrieve the field data for a given request.

This method processes the specified request and returns the corresponding field data in a structured format.

Returns:

Dict[int | str, SurfaceData | PathlinesData | np.ndarray]: A dictionary where keys represent surface

IDs or names, and values contain the corresponding field data.

abstract get_surface_ids(surfaces)

Retrieve a list of surface IDs based on input surface names or numerical identifiers.

class ansys.fluent.core.fields.field_data.abstract_field_data.FieldBatch

Bases: ABC

Abstract contract for collecting and executing field-data requests.

A batch belongs to a FieldDataSource. It accepts request models, sends them through the source’s transport adapter, and returns a field-data source containing the response.

Batch is the standard implementation and BatchFieldData is its response container.

Methods:

add_requests(obj, *args)	Add field data requests for surfaces, scalars, vectors, or pathlines.
get_response()	Retrieve the response containing data for previously added field requests.
get_surface_ids(surfaces)	Retrieve a list of surface IDs based on input surface names or numerical identifiers.

abstract add_requests(obj, *args)

Add field data requests for surfaces, scalars, vectors, or pathlines.

This method allows users to specify multiple field data requests, which will later be processed when retrieving responses.

abstract get_response()

Retrieve the response containing data for previously added field requests.

This method processes all pending requests and returns the corresponding field data.

abstract get_surface_ids(surfaces)

Retrieve a list of surface IDs based on input surface names or numerical identifiers.

class ansys.fluent.core.fields.field_data.abstract_field_data.FieldDataSource

Bases: BaseFieldDataSource, ABC

Abstract contract for a field-data source that supports batching.

This extends BaseFieldDataSource with the factory method needed to create a FieldBatch. The concrete source uses that batch to collect requests and return a batched response.

LiveFieldData fulfills this contract and returns a Batch from new_batch().

Methods:

new_batch()

Create a new field batch.

abstract new_batch()

Create a new field batch.