Monitor#

Generated reference

Source file:

ansys/api/fluent/v1/monitor.proto

Proto package:

ansys.api.fluent.v1.monitor

Contains:

1 service, 9 messages, 2 enums

Services

Service: Monitor

Monitor service for querying monitor metadata and streaming monitor data.

GetMonitors
Request:

GetMonitorsRequest

Response:

GetMonitorsResponse

Returns monitor set definitions (names and properties such as labels and title).

BeginStreaming
Request:

StreamingRequest

Response:

stream of StreamingResponse

Begins streaming monitor data (x-values and corresponding y-values).

Messages

UnitData

Unit conversion information.

name (1)string

Unit name.

unit (2)string

Unit label (for example, “Fahrenheit”).

factor (3)double

Unit factor (for example, for Fahrenheit it may be 0.5555556).

offset (4)double

Unit offset (for example, for Fahrenheit it may be 459.67).

MonitorSet

Monitor set definition returned by GetMonitors.

name (1)string

Monitor set name.

title (2)string

Monitor set title.

x_label (3)string

X-axis label.

y_label (4)string

Y-axis label.

frequency (5)sint64

Sampling frequency.

type (6)MonitorType

Monitor set type.

unit_info (7)UnitData

Unit conversion info.

axis (8)XAxisType

X-axis type.

monitors (9)repeated string

Monitor names included in this set.

XAxisData

X-axis data emitted in the monitor data stream.

x_axis_type (1)XAxisType

X-axis type.

x_axis_index (2)sint64

X-axis index.

MonitorData

Y-axis (monitor) sample emitted in the monitor data stream.

name (1)string

Monitor name.

value (2)double

Monitor value.

GetMonitorsRequest

Request message for GetMonitors.

GetMonitorsResponse

Response message for GetMonitors.

monitor_sets (1)repeated MonitorSet

Monitor set definitions.

MonitorFilter

Filter criteria applied when streaming monitor data.

x_axis_type (1)XAxisType

Restrict results to samples with the specified x-axis type.

monitor_names (2)repeated string

Restrict results to the specified monitor names.

frequency (3)sint32

Restrict results to the specified sampling frequency.

StreamingRequest

Request message for BeginStreaming.

filters (1)repeated MonitorFilter

Optional filters for the monitor stream.

StreamingResponse

Response streamed by BeginStreaming.

x_axis_data (1)XAxisData

X-axis data for this sample.

y_axis_values (2)repeated MonitorData

Y-axis values (one per monitor).

Enumerations

MonitorType (enum)

Monitor category.

MONITOR_TYPE_UNSPECIFIED (0)

Default value. Do not use.

MONITOR_TYPE_RESIDUAL (1)

Solver residual monitors.

MONITOR_TYPE_SOLUTION (2)

Solution monitors.

XAxisType (enum)

X-axis type.

XAXIS_TYPE_UNSPECIFIED (0)

Default value. Do not use.

XAXIS_TYPE_ITERATION (1)

Iteration axis.

XAXIS_TYPE_TIME (2)

Time axis.