ApplicationRuntime#

Generated reference

Source file:: ansys/api/fluent/v1/application_runtime.proto
Proto package:: ansys.api.fluent.v1.application_runtime
Contains:: 1 service, 37 messages, 6 enums

Services

Service: ApplicationRuntime

ApplicationRuntime service provides methods that span the Fluent application lifecycle but do not belong to a domain-specific service. Typical uses include retrieving version and build metadata, managing feature flags, and controlling application startup and shutdown.

GetProductVersion

Request:: GetProductVersionRequest
Response:: GetProductVersionResponse

Returns the product version of the running application.

GetBuildInfo

Request:: GetBuildInfoRequest
Response:: GetBuildInfoResponse

Returns build metadata for the running application (build time, build id, and other related information).

GetControllerProcessInfo

Request:: GetControllerProcessInfoRequest
Response:: GetControllerProcessInfoResponse

Retrieves Controller process information when running in client-server mode (Controller -> Solver) i.e., the Controller process commanding the Solver process.

GetSolverProcessInfo

Request:: GetSolverProcessInfoRequest
Response:: GetSolverProcessInfoResponse

Returns solver-process information for the running application.

GetMode

Request:: GetModeRequest
Response:: GetModeResponse

Returns the current application mode (for example, meshing or solver).

GetDimension

Request:: GetDimensionRequest
Response:: GetDimensionResponse

Returns the current application dimension (for example, 2d or 3d).

GetPrecision

Request:: GetPrecisionRequest
Response:: GetPrecisionResponse

Returns the current application precision (for example, single or double).

GetProcessorCount

Request:: GetProcessorCountRequest
Response:: GetProcessorCountResponse

Returns the current application processor count.

GetUIMode

Request:: GetUIModeRequest
Response:: GetUIModeResponse

Returns the current application UI mode.

GetGraphicsDriver

Request:: GetGraphicsDriverRequest
Response:: GetGraphicsDriverResponse

Returns the current application graphics driver.

GetGPUConfig

Request:: GetGPUConfigRequest
Response:: GetGPUConfigResponse

Returns the current application GPU configuration.

StartPythonJournal

Request:: StartPythonJournalRequest
Response:: StartPythonJournalResponse

Starts a Python journal recording session. If a journal file name is provided, the journal is written to that file.

StopPythonJournal

Request:: StopPythonJournalRequest
Response:: StopPythonJournalResponse

Stops a Python journal recording session.

IsBetaEnabled

Request:: IsBetaEnabledRequest
Response:: IsBetaEnabledResponse

Checks whether beta/experimental features are enabled for this session.

EnableBeta

Request:: EnableBetaRequest
Response:: EnableBetaResponse

Enables beta/experimental features for this session.

Exit

Request:: ExitRequest
Response:: ExitResponse

Terminates the application.

SetWorkingDirectory

Request:: SetWorkingDirectoryRequest
Response:: SetWorkingDirectoryResponse

Changes the application’s current working directory.

SetIdleTimeout

Request:: SetIdleTimeoutRequest
Response:: SetIdleTimeoutResponse

Sets the session idle timeout. When the session has been idle for the specified duration, Fluent will exit. Pass a zero duration to disable the idle timeout.

Messages

GetProductVersionRequest

Request to retrieve product version information.

GetProductVersionResponse

Contains the product version information.

major (1)int64: Major version number.
minor (2)int64: Minor version number.
patch (3)int64: Patch version number.

GetBuildInfoRequest

Request to retrieve build information.

GetBuildInfoResponse

Contains the build information.

build_time (1)string: Build timestamp (format is server-defined).
build_id (2)int64: Build identifier (server-defined).
vcs_revision (3)string: Version-control revision identifier (for example, a commit hash).
vcs_branch (4)string: Version-control branch name.

GetControllerProcessInfoRequest

Request to retrieve Controller process information.

GetControllerProcessInfoResponse

Contains the Controller process information.

hostname (1)string: Hostname where the Controller process is running.
process_id (2)int64: Operating-system process id of the Controller process.
working_directory (3)string: Controller process working directory.

GetSolverProcessInfoRequest

Request to retrieve Solver process information.

GetSolverProcessInfoResponse

Contains the Solver process information.

hostname (1)string: Hostname where the Solver process is running.
process_id (2)int64: Operating-system process id of the Solver process.
working_directory (3)string: Solver process working directory.

GetModeRequest

Request to retrieve the application mode.

GetModeResponse

Contains the application mode.

mode (1)Mode: Current application mode.

GetDimensionRequest

Request to retrieve the application dimension.

GetDimensionResponse

Contains the application dimension.

dimension (1)Dimension: Current application dimension.

GetPrecisionRequest

Request to retrieve the application precision.

GetPrecisionResponse

Contains the application precision.

precision (1)Precision: Current application precision.

GetProcessorCountRequest

Request to retrieve the application processor count.

GetProcessorCountResponse

Contains the application processor count.

processor_count (1)uint64: Current application processor count.

GetUIModeRequest

Request to retrieve the application UI mode.

GetUIModeResponse

Contains the application UI mode.

ui_mode (1)UIMode: Current application UI mode.

GetGraphicsDriverRequest

Request to retrieve the application graphics driver.

GetGraphicsDriverResponse

Contains the application graphics driver details.

windows_graphics_driver (1)oneof driver WindowsGraphicsDriver: Current Windows application graphics driver.
linux_graphics_driver (2)oneof driver LinuxGraphicsDriver: Current Linux application graphics driver.

GetGPUConfigRequest

Request to retrieve the application GPU configuration.

GetGPUConfigResponse

Contains the application GPU configuration details.

auto_allocate (1)oneof config bool: True when the GPUs are allocated automatically based on availability.
specific_gpu_ids (2)oneof config GpuIdList: A list of specific GPU device IDs explicitly allocated to the application.

GpuIdList

Wrapper message to hold a collection of GPU device IDs.

gpu_ids (1)repeated uint32: List of integer IDs corresponding to the allocated GPUs.

StartPythonJournalRequest

Initiates a Python journal recording session.

journal_name (1)oneof _journal_name string

Optional journal output file name.

If set, the journal is written to this file on the server side. If not set, the journal text can be retrieved from StopPythonJournal.

StartPythonJournalResponse

Contains the result of starting a Python journal.

journal_id (1)oneof _journal_id string

Optional journal identifier.

Returned when no journal file name was provided and the journal is tracked in-memory/session state. Provide this id to StopPythonJournal to stop the correct recording session.

StopPythonJournalRequest

Terminates a Python journal recording session.

journal_id (1)oneof _journal_id string

Optional journal identifier to stop.

Required when StartPythonJournal did not provide a file name and returned a journal_id.

StopPythonJournalResponse

Contains the result of stopping a Python journal.

journal_str (1)string

Journal content.

Typically populated when StartPythonJournal did not specify a file name. If the journal was written to a file, this string may be empty (server-defined behavior).

IsBetaEnabledRequest

Request to check if beta features are enabled.

IsBetaEnabledResponse

Indicates whether beta features are enabled.

is_beta_enabled (1)bool: True if beta/experimental features are enabled for this session.

EnableBetaRequest

Requests to enable beta features.

EnableBetaResponse

Result of enabling beta features.

ExitRequest

Requests to exit the application.

ExitResponse

Result of an exit request.

SetWorkingDirectoryRequest

Changes the application’s working directory.

path (1)string: New working directory path.

SetWorkingDirectoryResponse

Result of setting the working directory.

SetIdleTimeoutRequest

Requests to set the session idle timeout.

timeout (1)Duration: Idle timeout duration. When the session has been idle for this duration, Fluent will exit. Pass a zero duration to disable the idle timeout.

SetIdleTimeoutResponse

Result of setting the idle timeout.

Enumerations

Mode (enum)

Application operating mode.

MODE_UNSPECIFIED (0): Unspecified application mode.
MODE_MESHING (1): Meshing mode.
MODE_SOLVER (2): Solver mode.
MODE_SOLVER_ICING (3): Solver icing mode.
MODE_SOLVER_AERO (4): Solver aero mode.

Dimension (enum)

Application operating dimension.

DIMENSION_UNSPECIFIED (0): Unspecified application dimension.
DIMENSION_TWO (1): Two dimensional.
DIMENSION_THREE (2): Three dimensional.

Precision (enum)

Application operating precision.

PRECISION_UNSPECIFIED (0): Unspecified application precision.
PRECISION_SINGLE (1): Single precision.
PRECISION_DOUBLE (2): Double precision.

UIMode (enum)

Application UI mode.

UI_MODE_UNSPECIFIED (0): Unspecified application UI mode.
UI_MODE_NO_GUI_OR_GRAPHICS (1): No gui or graphics UI mode.
UI_MODE_NO_GRAPHICS (2): No graphics UI mode.
UI_MODE_NO_GUI (3): No gui UI mode.
UI_MODE_HIDDEN_GUI (4): Hidden gui UI mode.
UI_MODE_GUI (5): Gui UI mode.

LinuxGraphicsDriver (enum)

Application graphics driver (Linux specific).

LINUX_GRAPHICS_DRIVER_UNSPECIFIED (0): Unspecified graphics driver.
LINUX_GRAPHICS_DRIVER_NULL (1): Null graphics driver.
LINUX_GRAPHICS_DRIVER_X11 (2): X11 graphics driver.
LINUX_GRAPHICS_DRIVER_OPENGL2 (3): OpenGL2 graphics driver.
LINUX_GRAPHICS_DRIVER_OPENGL (4): OpenGL graphics driver.
LINUX_GRAPHICS_DRIVER_AUTO (5): Automatically choose graphics driver.

WindowsGraphicsDriver (enum)

Application graphics driver (Windows specific).

WINDOWS_GRAPHICS_DRIVER_UNSPECIFIED (0): Unspecified graphics driver.
WINDOWS_GRAPHICS_DRIVER_NULL (1): Null graphics driver.
WINDOWS_GRAPHICS_DRIVER_MSW (2): MSW graphics driver.
WINDOWS_GRAPHICS_DRIVER_DX11 (3): DX11 graphics driver.
WINDOWS_GRAPHICS_DRIVER_OPENGL2 (4): OpenGL2 graphics driver.
WINDOWS_GRAPHICS_DRIVER_OPENGL (5): OpenGL graphics driver.
WINDOWS_GRAPHICS_DRIVER_AUTO (6): Automatically choose graphics driver.