Events#

Generated reference

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

Services

Service: Events

Events service provides streaming of solver and workflow events to clients.

BeginStreaming

Request:: BeginStreamingRequest
Response:: stream of BeginStreamingResponse

Streams solver events to the client.

PauseSolveFor

Request:: PauseSolveForRequest
Response:: PauseSolveForResponse

Registers a solution-event pause trigger; the solver pauses when the selected event occurs and waits until the client calls ResumeSolve.

ResumeSolve

Request:: ResumeSolveRequest
Response:: ResumeSolveResponse

Resumes solver execution after it was paused by a PauseSolveFor trigger.

CancelPauseSolve

Request:: CancelPauseSolveRequest
Response:: CancelPauseSolveResponse

Unregisters a pause trigger previously registered with PauseSolveFor.

Messages

TimestepStartedEvent

Event at start of the time step.

index (1)sint64: Time step index.
size (2)double: Time step size.

TimestepEndedEvent

Event at end of the time step.

index (1)sint64: Time step index.
size (2)double: Time step size.

IterationStartedEvent

Event at start of the iteration.

index (1)sint64: Iteration index.

IterationEndedEvent

Event at end of the iteration.

index (1)sint64: Iteration index.

CalculationsStartedEvent

Event at start of calculation.

CalculationsEndedEvent

Event at end of calculation.

CalculationsPausedEvent

Event when calculations are paused.

CalculationsResumedEvent

Event when calculations are resumed.

PreReadCaseEvent

Event before a case file is read.

case_file_path (1)string: Case file path.

CaseReadEvent

Event after a case file is read.

case_file_path (1)string: Case file path.

PreReadDataEvent

Event before a data file is read.

data_file_path (1)string: Data file path.

DataReadEvent

Event after a data file is read.

data_file_path (1)string: Data file path.

PreInitializeEvent

Event before solution initialization.

InitializedEvent

Event after solution initialization.

ReportDefinitionChangedEvent

Event when a report definition changes.

PlotSetChangedEvent

Event when a plot set changes.

ResidualPlotChangedEvent

Event when residual plot settings change.

ClearSettingsDoneEvent

Event after settings are cleared.

AutoPauseEvent

Event when auto-pause occurs.

level (1)sint32: Auto-pause level.
index (2)sint64: Associated iteration or time-step index.

ProgressEvent

Event during solution progress.

message (1)string: Progress message text.
percent_complete (2)sint32: Estimated solution progress, expressed as a percentage (0–100). This value is an estimate of the solution run progress only and does not apply to other operations. Percent completed.

SolverTimeEstimateEvent

Event estimating remaining solver time.

hours (1)double: Estimated hours remaining.
minutes (2)double: Estimated minutes remaining.
seconds (3)double: Estimated seconds remaining.

ErrorEvent

Event when a fatal error is encountered.

message (1)string: Error message.
error_code (2)sint32: Error code.

CommandCompletedEvent

Event when a command completes.

BeginStreamingRequest

Request to begin streaming solver events.

PauseSolveForRequest

Request to register a solution-event pause trigger. protolint:disable:next MESSAGE_NAMES_EXCLUDE_PREPOSITIONS

solution_event (1)SolutionEvent: Solution event that triggers a pause.

PauseSolveForResponse

Contains the registration identifier. protolint:disable:next MESSAGE_NAMES_EXCLUDE_PREPOSITIONS

registration_id (1)int64: Registration id used to resume and/or unregister this pause registration.

ResumeSolveRequest

Request to resume solver execution after a PauseSolveFor trigger.

registration_id (1)int64: Identifier of the registration to resume.

ResumeSolveResponse

Response for ResumeSolve.

CancelPauseSolveRequest

Request to unregister a PauseSolveFor trigger.

registration_id (1)int64: Identifier of the registration to unregister.

CancelPauseSolveResponse

Response for CancelPauseSolve.

DataModelChangedEvent

Event when the data model changes.

paths (1)repeated string: Data model paths that changed.

ClientExecuteEvent

Event to execute a function call in the client. Internal event used by Fluent workflows to request a client-side function call. Not intended for end-user integrations; user-facing clients should ignore this event.

function (1)string: Client-side function to invoke.
arguments (2)repeated SchemePointer: Arguments passed to the function.

BeginStreamingResponse

BeginStreamingResponse contains the server-streamed event union.

pre_read_case_event (1)oneof as PreReadCaseEvent: Before reading a case file.
case_read_event (2)oneof as CaseReadEvent: After reading a case file.
pre_initialize_event (3)oneof as PreInitializeEvent: Before solution initialization.
initialized_event (4)oneof as InitializedEvent: After solution initialization.
pre_read_data_event (5)oneof as PreReadDataEvent: Before reading a data file.
data_read_event (6)oneof as DataReadEvent: After reading a data file.
iteration_started_event (7)oneof as IterationStartedEvent: Iteration start.
iteration_ended_event (8)oneof as IterationEndedEvent: Iteration end.
timestep_started_event (9)oneof as TimestepStartedEvent: Time step start.
timestep_ended_event (10)oneof as TimestepEndedEvent: Time step end.
calculations_started_event (11)oneof as CalculationsStartedEvent: Calculations start.
calculations_ended_event (12)oneof as CalculationsEndedEvent: Calculations end.
report_definition_changed_event (13)oneof as ReportDefinitionChangedEvent: Report definition changed.
plot_set_changed_event (14)oneof as PlotSetChangedEvent: Plot set changed.
residual_plot_changed_event (15)oneof as ResidualPlotChangedEvent: Residual plot changed.
clear_settings_done_event (16)oneof as ClearSettingsDoneEvent: Settings cleared.
auto_pause_event (17)oneof as AutoPauseEvent: Auto-pause occurred.
calculations_paused_event (18)oneof as CalculationsPausedEvent: Calculations paused.
calculations_resumed_event (19)oneof as CalculationsResumedEvent: Calculations resumed.
progress_event (20)oneof as ProgressEvent: Solver progress.
error_event (21)oneof as ErrorEvent: Fatal error encountered.
command_completed_event (22)oneof as CommandCompletedEvent: Command completed.
data_model_changed_event (23)oneof as DataModelChangedEvent: Data model changed.
solver_time_estimate_event (24)oneof as SolverTimeEstimateEvent: Remaining time estimate.
client_execute_event (25)oneof as ClientExecuteEvent: Internal workflow event; ignore in end-user clients.

Enumerations

SolutionEvent (enum)

Solution-related events that can be used to pause/resume execution.

SOLUTION_EVENT_UNSPECIFIED (0): Unspecified solution event.
SOLUTION_EVENT_ITERATION (1): Fired after an iteration completes.
SOLUTION_EVENT_TIME_STEP (2): Fired after a time step completes.