Scheme interpreter#

High-level scheme interpreter wrappers.

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

ansys.fluent.core._grpc_services.scheme_interpreter_service (v1 proto API)
ansys.fluent.core._grpc_services.scheme_interpreter_service_v0 (v0 proto API)

Class hierarchy#

SchemeInterpreter: gRPC-based implementation (v1 and v0 proto API).

Example#

>>> session.scheme.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
>>> # Returns TUI output string
>>> session.scheme.eval("(+ 2 3)")
5
>>> session.scheme.eval("(rpgetvar 'mom/relax)")
0.7

Classes:

SchemeInterpreter(service)

SchemeInterpreter backed by the SchemeInterpreter gRPC service.

class ansys.fluent.core.services.scheme_interpreter.SchemeInterpreter(service)#

Bases: AbstractSchemeInterpreter

SchemeInterpreter backed by the SchemeInterpreter gRPC service.

Methods:

`__init__`(service)	Initialize SchemeInterpreter.
`eval`(scm_input[, suppress_prompts])	Evaluates a scheme expression in string format.
`exec`(commands[, wait, silent])	Executes a sequence of scheme commands.
`is_defined`(symbol)	Check if a symbol is defined in the scheme environment.
`scheme_eval`(scm_input[, suppress_prompts])	Evaluates a scheme expression in string format.
`string_eval`(input)	Evaluates a scheme expression in string format.

__init__(service)#: Initialize SchemeInterpreter.

eval(scm_input, suppress_prompts=True)#

Evaluates a scheme expression in string format.

Parameters:

scm_inputstr: Input scheme expression in string format
suppress_promptsbool, optional: Whether to suppress prompts in Fluent, by default True

Returns:

Any: Output scheme value represented as Python datatype

exec(commands, wait=True, silent=True)#

Executes a sequence of scheme commands.

Parameters:

commandsSequence[str]: Sequence of scheme commands in string format
waitbool, optional: Specifies whether to wait until execution completes, by default True
silentbool, optional: Specifies whether to execute silently, by default True

Returns:

str: Output as string

is_defined(symbol)#

Check if a symbol is defined in the scheme environment.

Parameters:

symbolstr: Name of the symbol

Returns:

bool: True if symbol is defined, False otherwise

scheme_eval(scm_input, suppress_prompts=True)#: Evaluates a scheme expression in string format.

Deprecated since version 0.32: Use session.scheme.

string_eval(input)#

Evaluates a scheme expression in string format.

Parameters:

inputstr: Input scheme expression in string format

Returns:

str: Output scheme value in string format