settings#

Wrapper to settings gRPC service of Fluent.

Classes:

SettingsService(channel, metadata, ...)

Service for accessing and modifying Fluent settings.

class ansys.fluent.core.services.settings.SettingsService(channel, metadata, scheme_eval, fluent_error_state)#

Bases: object

Service for accessing and modifying Fluent settings.

Methods:

__init__(channel, metadata, scheme_eval, ...)

__init__ method of SettingsService class.

create(path, name)

Create a named object child for the given path.

delete(path, name)

Delete the object with the given name at the given path.

execute_cmd(path, command, **kwds)

Execute a given command with the provided keyword arguments.

execute_query(path, query, **kwds)

Execute a given query with the provided keyword arguments.

get_attrs(path, attrs[, recursive])

Return values of given attributes.

get_list_size(path)

Get the number of elements in a list object.

get_object_names(path)

Get a list of named objects.

get_static_info()

Get static-info for settings.

get_var(path)

Get the value for the given path.

has_wildcard(name)

Checks whether a name has a wildcard pattern.

is_interactive_mode()

Checks whether commands can be executed interactively.

rename(path, new, old)

Rename the object at the given path.

resize_list_object(path, size)

Resize a list object.

set_var(path, value)

Set the value for the given path.

__init__(channel, metadata, scheme_eval, fluent_error_state)#

__init__ method of SettingsService class.

create(path, name)#

Create a named object child for the given path.

delete(path, name)#

Delete the object with the given name at the given path.

execute_cmd(path, command, **kwds)#

Execute a given command with the provided keyword arguments.

execute_query(path, query, **kwds)#

Execute a given query with the provided keyword arguments.

get_attrs(path, attrs, recursive=False)#

Return values of given attributes.

get_list_size(path)#

Get the number of elements in a list object.

get_object_names(path)#

Get a list of named objects.

get_static_info()#

Get static-info for settings.

Raises:
RuntimeError

If type is empty.

get_var(path)#

Get the value for the given path.

has_wildcard(name)#

Checks whether a name has a wildcard pattern.

is_interactive_mode()#

Checks whether commands can be executed interactively.

rename(path, new, old)#

Rename the object at the given path.

resize_list_object(path, size)#

Resize a list object.

set_var(path, value)#

Set the value for the given path.