SolutionVariable#

Generated reference

Source file:: ansys/api/fluent/v1/solution_variable.proto
Proto package:: ansys.api.fluent.v1.solution_variable
Contains:: 1 service, 15 messages, 1 enum

Services

Service: SolutionVariable

SolutionVariable service provides methods for retrieving and setting solution variable data and metadata.

GetZonesInfo

Request:: GetZonesInfoRequest
Response:: GetZonesInfoResponse

Retrieves domain and zone metadata.

GetSolutionVariableInfo

Request:: GetSolutionVariableInfoRequest
Response:: GetSolutionVariableInfoResponse

Retrieves solution variable metadata for a domain and zone.

GetSolutionVariableData

Request:: GetSolutionVariableDataRequest
Response:: stream of GetSolutionVariableDataResponse

Retrieves solution variable data, streamed in chunks.

SetSolutionVariableData

Request:: SetSolutionVariableDataRequest
Response:: SetSolutionVariableDataResponse

Sets solution variable data by streaming data chunks to the server.

Messages

GetZonesInfoRequest

Request to retrieve domain and zone metadata.

GetZonesInfoResponse

Response containing domain and zone metadata.

domains_info (1)repeated DomainInfo: Domains info.
zones_info (2)repeated ZoneInfo: Zones info.

DomainInfo

Domain metadata.

name (1)string: Domain name.
domain_id (2)uint32: Domain ID.

ZoneInfo

Zone metadata.

name (1)string: Zone name.
zone_id (2)uint64: Zone ID.
zone_type (3)string: Zone type, e.g., velocity-inlet.
thread_type (4)ThreadType: Zone thread type.
partitions_info (5)repeated PartitionInfo: Partitions info.

PartitionInfo

Partition range metadata.

count (1)uint64: Count in partition
start_index (2)uint64: Global start index
end_index (3)uint64: Global end index

GetSolutionVariableInfoRequest

Request to retrieve solution metadata for a given domain and zone.

domain_id (1)uint32: Domain ID.
zone_id (2)uint64: Zone ID.

GetSolutionVariableInfoResponse

Response containing solution metadata.

svars_info (1)repeated SolutionVariableInfo: Solution variable info.

SolutionVariableInfo

Solution variable information.

name (1)string: Solution variable name.
dimension (2)uint32: Dimension e.g. for centroid it will be 3.
field_type (3)FieldType: Data type defined in field_data.proto.

GetSolutionVariableDataRequest

Request to retrieve solution variable data, possibly streamed in chunks.

chunk_size (1)uint32: Chunk size.
provide_bytes_stream (2)bool: If true, streams bytes; if false, streams typed arrays.
name (3)string: Solution variable Name.
domain_id (4)uint32: Domain ID.
zones (5)repeated uint64: List of zone IDs.

GetSolutionVariableDataResponse

Streamed response containing payload or payload info.

payload (1)oneof array Payload: Payload.
payload_info (2)oneof array Info: Payload info.

Info

Payload metadata.

field_type (1)FieldType: Field type.
field_size (2)uint64: Field size. For bytes it will be number of bytes otherwise array size.
zone (3)uint64: Zone ID.

Payload

Payload chunk union.

byte_payload (1)oneof chunk bytes: Bytes payload.
double_payload (2)oneof chunk DoublePayload: Double payload.
float_payload (3)oneof chunk FloatPayload: Float payload.
long_payload (4)oneof chunk LongPayload: Long payload.
int_payload (5)oneof chunk IntPayload: Int payload.

SetSolutionVariableDataRequest

Request to set solution variable data via a streaming API.

header (1)oneof array SolutionVariableHeader: Solution variable name and domain ID.
payload (2)oneof array Payload: Payload.
payload_info (3)oneof array Info: Payload info.

SolutionVariableHeader

Solution variable header containing the name and domain ID.

name (1)string: Solution variable Name.
domain_id (2)uint32: Domain ID.

SetSolutionVariableDataResponse

Response to the SetSolutionVariableData request.

Enumerations

ThreadType (enum)

Thread type of the zone.

THREAD_TYPE_UNSPECIFIED (0): Default value. Thread type is unspecified.
THREAD_TYPE_CELL (1): Zone uses cell threads.
THREAD_TYPE_FACE (2): Zone uses face threads.