Application runtime#

High-level application runtime wrappers.

This module owns the business-logic layer on top of the ApplicationRuntime gRPC service. The grpc service implementation lives in:

ansys.fluent.core._grpc_services.application_runtime_service (v1 proto API)
ansys.fluent.core._grpc_services.application_runtime_service_v0 (v0 proto API)

Class hierarchy#

ApplicationRuntime: gRPC-based implementation (v1 proto API).
ApplicationRuntimeV261V252: Shared implementation for 25R2 and 26R1.
ApplicationRuntimeV261(ApplicationRuntimeV261V252): gRPC-based implementation valid till 26R1 (v0 proto API).
ApplicationRuntimeV252(ApplicationRuntimeV261V252): gRPC-based implementation valid till 25R2 (v0 proto API). EnableBeta was not yet implemented; delegates to Scheme instead.
ApplicationRuntimeOld: Scheme-based fallback used for Fluent versions before 25R2.

Classes:

`ApplicationRuntime`(service)	Application runtime backed by the ApplicationRuntime gRPC service.
`ApplicationRuntimeOld`(scheme_eval)	Application runtime backed by Scheme evaluation (Fluent < 25R2).
`ApplicationRuntimeV252`(service, scheme)	Application runtime for Fluent 25R2.
`ApplicationRuntimeV261`(service, scheme)	Application runtime for Fluent 26R1.
`ApplicationRuntimeV261V252`(service, scheme)	Application runtime for Fluent 26R1 and 25R2.

class ansys.fluent.core.services.application_runtime.ApplicationRuntime(service)#

Bases: AbstractApplicationRuntime

Application runtime backed by the ApplicationRuntime gRPC service.

Methods:

`__init__`(service)	Initialize ApplicationRuntime.
`enable_beta`()	Enable beta features.
`exit`()	Exit the server.
`get_app_mode`()	Get app mode.
`get_build_info`()	Get build info.
`get_controller_process_info`()	Get controller process info.
`get_dimension`()	Get dimension.
`get_gpu_config`()	Get GPU config.
`get_graphics_driver`()	Get graphics driver.
`get_precision`()	Get precision.
`get_processor_count`()	Get processor count.
`get_product_version`()	Get product version.
`get_solver_process_info`()	Get solver process info.
`get_ui_mode`()	Get UI mode.
`is_beta_enabled`()	Return whether beta features are enabled.
`set_idle_timeout`(timeout)	Set the Fluent session idle timeout.
`set_working_directory`(path)	Change the client cortex working directory.
`start_python_journal`([journal_name])	Start python journal.
`stop_python_journal`([journal_id])	Stop python journal.

__init__(service)#: Initialize ApplicationRuntime.

enable_beta()#: Enable beta features.

exit()#: Exit the server.

get_app_mode()#: Get app mode.

get_build_info()#: Get build info.

get_controller_process_info()#: Get controller process info.

get_dimension()#: Get dimension.

get_gpu_config()#: Get GPU config.

get_graphics_driver()#: Get graphics driver.

get_precision()#: Get precision.

get_processor_count()#: Get processor count.

get_product_version()#: Get product version.

get_solver_process_info()#: Get solver process info.

get_ui_mode()#: Get UI mode.

is_beta_enabled()#: Return whether beta features are enabled.

set_idle_timeout(timeout)#: Set the Fluent session idle timeout.

set_working_directory(path)#: Change the client cortex working directory.

start_python_journal(journal_name=None)#: Start python journal.

stop_python_journal(journal_id=None)#: Stop python journal.

class ansys.fluent.core.services.application_runtime.ApplicationRuntimeOld(scheme_eval)#

Bases: object

Application runtime backed by Scheme evaluation (Fluent < 25R2).

Methods:

`__init__`(scheme_eval)	Initialize ApplicationRuntimeOld.
`enable_beta`()	Enable beta features.
`exit`()	Exit the server.
`get_app_mode`()	Get app mode.
`get_build_info`()	Get build info.
`get_controller_process_info`()	Get controller process info.
`get_dimension`()	Get dimension.
`get_gpu_config`()	Get GPU config.
`get_graphics_driver`()	Get graphics driver.
`get_precision`()	Get precision.
`get_processor_count`()	Get processor count.
`get_product_version`()	Get product version.
`get_solver_process_info`()	Get solver process info.
`get_ui_mode`()	Get UI mode.
`is_beta_enabled`()	Return whether beta features are enabled.
`is_solution_data_available`()	Return whether solution data is currently available.
`is_wildcard`([input])	Return whether input contains a wildcard pattern.
`register_pause_on_solution_events`(solution_event)	Register pause on solution events.
`resume_on_solution_event`(registration_id)	Resume on solution event.
`set_idle_timeout`(timeout)	Set the Fluent session idle timeout.
`set_working_directory`(path)	Change the client cortex working directory.
`start_python_journal`([journal_name])	Start python journal.
`stop_python_journal`([journal_id])	Stop python journal.
`unregister_pause_on_solution_events`(...)	Unregister pause on solution events.

__init__(scheme_eval)#: Initialize ApplicationRuntimeOld.

enable_beta()#

Enable beta features.

Raises:

RuntimeError: Not supported before Fluent 2025 R2.

exit()#: Exit the server.

get_app_mode()#: Get app mode.

get_build_info()#: Get build info.

get_controller_process_info()#: Get controller process info.

get_dimension()#: Get dimension.

get_gpu_config()#

Get GPU config.

Raises:

ValueError: If the GPU ID string cannot be parsed.

get_graphics_driver()#

Get graphics driver.

Raises:

ValueError: If the graphics driver is unknown.

get_precision()#: Get precision.

get_processor_count()#: Get processor count.

get_product_version()#: Get product version.

get_solver_process_info()#: Get solver process info.

get_ui_mode()#: Get UI mode.

is_beta_enabled()#: Return whether beta features are enabled.

is_solution_data_available()#: Return whether solution data is currently available.

is_wildcard(input=None)#: Return whether input contains a wildcard pattern.

register_pause_on_solution_events(solution_event)#: Register pause on solution events.

resume_on_solution_event(registration_id)#: Resume on solution event.

set_idle_timeout(timeout)#: Set the Fluent session idle timeout.

set_working_directory(path)#: Change the client cortex working directory.

start_python_journal(journal_name=None)#: Start python journal.

stop_python_journal(journal_id=None)#: Stop python journal.

unregister_pause_on_solution_events(registration_id)#: Unregister pause on solution events.

class ansys.fluent.core.services.application_runtime.ApplicationRuntimeV252(service, scheme)#

Bases: ApplicationRuntimeV261V252

Application runtime for Fluent 25R2.

enable_beta is not implemented on the 25R2 server so it falls back to a Scheme call.

Methods:

`__init__`(service, scheme)	Initialize ApplicationRuntimeV252.
`enable_beta`()	Enable beta features via Scheme (25R2 fallback).

__init__(service, scheme)#: Initialize ApplicationRuntimeV252.

enable_beta()#: Enable beta features via Scheme (25R2 fallback).

class ansys.fluent.core.services.application_runtime.ApplicationRuntimeV261(service, scheme)#

Bases: ApplicationRuntimeV261V252

Application runtime for Fluent 26R1.

enable_beta is implemented in the 26R1 server.

Methods:

`__init__`(service, scheme)	Initialize ApplicationRuntimeV252.
`enable_beta`()	Enable beta features.

__init__(service, scheme)#: Initialize ApplicationRuntimeV252.

enable_beta()#: Enable beta features.

class ansys.fluent.core.services.application_runtime.ApplicationRuntimeV261V252(service, scheme)#

Bases: object

Application runtime for Fluent 26R1 and 25R2.

is_wildcard is migrated to settings in 27R1. is_solution_data_available is migrated to field_data in 27R1. register_pause_on_solution_events is migrated to events in 27R1. resume_on_solution_event is migrated to events in 27R1. unregister_pause_on_solution_events is migrated to events in 27R1.

Methods:

`__init__`(service, scheme)	Initialize ApplicationRuntime.
`exit`()	Exit the server.
`get_app_mode`()	Get app mode.
`get_build_info`()	Get build info.
`get_controller_process_info`()	Get controller process info.
`get_dimension`()	Get dimension.
`get_gpu_config`()	Get GPU config.
`get_graphics_driver`()	Get graphics driver.
`get_precision`()	Get precision.
`get_processor_count`()	Get processor count.
`get_product_version`()	Get product version.
`get_solver_process_info`()	Get solver process info.
`get_ui_mode`()	Get UI mode.
`is_beta_enabled`()	Return whether beta features are enabled.
`is_solution_data_available`()	Return whether solution data is currently available.
`is_wildcard`([input])	Return whether input contains a wildcard pattern.
`register_pause_on_solution_events`(solution_event)	Register pause on solution events.
`resume_on_solution_event`(registration_id)	Resume on solution event.
`set_idle_timeout`(timeout)	Set the Fluent session idle timeout.
`set_working_directory`(path)	Change the client cortex working directory.
`start_python_journal`([journal_name])	Start python journal.
`stop_python_journal`([journal_id])	Stop python journal.
`unregister_pause_on_solution_events`(...)	Unregister pause on solution events.

__init__(service, scheme)#: Initialize ApplicationRuntime.

exit()#: Exit the server.

get_app_mode()#: Get app mode.

get_build_info()#: Get build info.

get_controller_process_info()#: Get controller process info.

get_dimension()#: Get dimension.

get_gpu_config()#

Get GPU config.

Raises:

ValueError: If the GPU ID string cannot be parsed.

get_graphics_driver()#

Get graphics driver.

Raises:

ValueError: If the graphics driver is unknown.

get_precision()#: Get precision.

get_processor_count()#: Get processor count.

get_product_version()#: Get product version.

get_solver_process_info()#: Get solver process info.

get_ui_mode()#: Get UI mode.

is_beta_enabled()#: Return whether beta features are enabled.

is_solution_data_available()#: Return whether solution data is currently available.

is_wildcard(input=None)#: Return whether input contains a wildcard pattern.

register_pause_on_solution_events(solution_event)#: Register pause on solution events.

resume_on_solution_event(registration_id)#: Resume on solution event.

set_idle_timeout(timeout)#: Set the Fluent session idle timeout.

set_working_directory(path)#: Change the client cortex working directory.

start_python_journal(journal_name=None)#: Start python journal.

stop_python_journal(journal_id=None)#: Stop python journal.

unregister_pause_on_solution_events(registration_id)#: Unregister pause on solution events.