Settings#

Generated reference

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

Services

Service: Settings

Settings service provides methods for reading, writing, and commanding the Fluent solver settings hierarchy. The caller must explicitly use root=”fluent” within every PathInfo message.

GetSchema

Request:: GetSchemaRequest
Response:: GetSchemaResponse

Returns the API schema for the settings hierarchy, describing object types, children, commands, queries, and arguments.

GetState

Request:: GetStateRequest
Response:: GetStateResponse

Returns the state of the settings object at the specified path.

SetState

Request:: SetStateRequest
Response:: SetStateResponse

Updates the state of the settings object at the specified path.

Rename

Request:: RenameRequest
Response:: RenameResponse

Renames the named object at the specified path.

CreateObject

Request:: CreateObjectRequest
Response:: CreateObjectResponse

Creates a new named object at the specified path.

DeleteObject

Request:: DeleteObjectRequest
Response:: DeleteObjectResponse

Deletes the named object at the specified path.

GetObjectNames

Request:: GetObjectNamesRequest
Response:: GetObjectNamesResponse

Returns the names of all named objects at the specified path.

GetListSize

Request:: GetListSizeRequest
Response:: GetListSizeResponse

Returns the number of elements in the list object at the specified path.

ResizeListObject

Request:: ResizeListObjectRequest
Response:: ResizeListObjectResponse

Resizes the list object at the specified path.

ExecuteCommand

Request:: ExecuteCommandRequest
Response:: ExecuteCommandResponse

Executes the named command on the settings object at the specified path.

ExecuteQuery

Request:: ExecuteQueryRequest
Response:: ExecuteQueryResponse

Executes the named query on the settings object at the specified path and returns the result.

GetAttrs

Request:: GetAttrsRequest
Response:: GetAttrsResponse

Returns named attributes of the settings object at the specified path.

IsWildcard

Request:: IsWildcardRequest
Response:: IsWildcardResponse

Checks whether the provided string is treated as a wildcard by the solver.

Messages

Value

Value represents the state of a settings object, as returned by GetState and accepted by SetState.

boolean (2)oneof value bool: Boolean value
integer (3)oneof value int64: Integer value
real (4)oneof value double: Real (double-precision floating-point) value
string (5)oneof value string: String value
value_list (10)oneof value ValueList: List of values
value_map (11)oneof value ValueMap: Map of values

Value.ValueList

ValueList represents a list of Value objects

lsts (1)repeated Value: The list of values

Value.ValueMap

ValueMap represents a map with string keys and Value values

m (1)repeated MEntry: The map entries

PathInfo

PathInfo represents the location of a settings object in the hierarchy.

root (1)string: The root of the settings tree.
path (2)string: The path to the object from the root.

SchemaMap

SchemaMap represents a named entry in the settings API schema.

name (1)string: The name of the entry.
value (2)Schema: The schema information for this entry.

StringPair

String-String pair.

key (1)string: The name of the entry.
value (2)string: The value for this entry.

Schema

Schema contains the static API description of a settings object, including its type, children, commands, and queries.

type (1)string: Type identifier for the current object (for example, “group” or “named-object”).
children (2)repeated SchemaMap: Children of the current object.
commands (3)repeated SchemaMap: Commands available for the current object.
arguments (4)repeated SchemaMap: Arguments associated with the current command or query object.
object_type (5)Schema: Class template for a named-object instance.
help (6)string: Help text for the current object.
has_allowed_values (7)bool: True if the current object restricts its value to an allowed-values list.
include_child_named_objects (8)bool: True if named-object instances of child objects are also accessible on this object (for example, on boundary_conditions).
list_size (9)int32: Fixed size of the list object; zero for variable-length lists.
user_creatable (10)bool: True if the user can create new instances of this named object.
queries (11)repeated SchemaMap: Queries available for the current object.
return_type (12)string: Return type of the object.
deprecated_version (13)string: Version in which the object was deprecated.
api_exposure_level (14)string: API exposure level of the object.
child_aliases (15)repeated StringPair: Aliases for child objects of the current object.
command_aliases (16)repeated StringPair: Aliases for commands of the current object.
query_aliases (17)repeated StringPair: Aliases for queries of the current object.
arguments_aliases (18)repeated StringPair: Aliases for arguments of the current object.
file_purpose (19)string: Purpose/category specification for file settings.
optional_attrs (20)OptionalAttrs: Optional information for the current object, retrieved based on GetSchemaRequest.optional_attrs.

OptionalAttrs

OptionalAttrs contains optional information for a settings object, as requested in GetSchemaRequest.optional_attrs.

allowed_values (1)repeated string: List of allowed values for the current object.
has_migration_adapter (2)bool: True if the current object has a migration adapter.

GetSchemaRequest

GetSchemaRequest is the request message for GetSchema.

root (1)string: Root path of the settings tree whose schema will be returned.
optional_attrs (2)repeated string: Optional attributes to include in the returned schema. Valid values correspond to the field names of the OptionalAttrs message (e.g., “allowed_values”, “has_migration_adapter”).

GetSchemaResponse

GetSchemaResponse is the response message for GetSchema.

info (1)Schema: The API schema for the requested settings tree root.

GetStateRequest

GetStateRequest is the request message for GetState.

path_info (1)PathInfo: The path to the variable whose state to retrieve.

GetStateResponse

GetStateResponse is the response message for GetState.

value (1)Value: The state of the requested variable.

SetStateRequest

SetStateRequest is the request message for SetState.

path_info (1)PathInfo: The path to the variable to set.
value (2)Value: The new state to set.

SetStateResponse

SetStateResponse is the response message for SetState.

CreateObjectRequest

CreateObjectRequest is the request message for creating a new object

path_info (1)PathInfo: The path where the new object should be created
name (2)string: The name of the new object to create

CreateObjectResponse

CreateObjectResponse is the response message for a create object operation

RenameRequest

RenameRequest is the request message for renaming an object

path_info (1)PathInfo: The path containing the object to rename
old_name (2)string: The current name of the object
new_name (3)string: The new name for the object

RenameResponse

RenameResponse is the response message for a rename object operation

DeleteObjectRequest

DeleteObjectRequest is the request message for deleting an object

path_info (1)PathInfo: The path containing the object to delete
name (2)string: The name of the object to delete

DeleteObjectResponse

DeleteObjectResponse is the response message for a delete object operation

GetObjectNamesRequest

GetObjectNamesRequest is the request message for retrieving object names

path_info (1)PathInfo: The path to retrieve object names from

GetObjectNamesResponse

GetObjectNamesResponse is the response message containing object names

names (1)repeated string: The list of object names at the specified path

GetListSizeRequest

GetListSizeRequest is the request message for retrieving the size of a list object

path_info (1)PathInfo: The path to the list object

GetListSizeResponse

GetListSizeResponse is the response message containing the list size

size (1)int32: The number of elements in the list

ResizeListObjectRequest

ResizeListObjectRequest is the request message for resizing a list object

path_info (1)PathInfo: The path to the list object to resize
size (2)int32: The new size for the list

ResizeListObjectResponse

ResizeListObjectResponse is the response message for a resize list object operation

ExecuteCommandRequest

ExecuteCommandRequest is the request message for executing a command

path_info (1)PathInfo: The path to the object on which to execute the command
command (2)string: The name of the command to execute
args (3)Value: Arguments to pass to the command

ExecuteCommandResponse

ExecuteCommandResponse is the response message containing command execution results

reply (1)Value: The return value from the executed command

ExecuteQueryRequest

ExecuteQueryRequest is the request message for executing a query

path_info (1)PathInfo: The path to the object on which to execute the query
query (2)string: The name of the query to execute
args (3)Value: Arguments to pass to the query

ExecuteQueryResponse

ExecuteQueryResponse is the response message containing query execution results

reply (1)Value: The return value from the executed query

GetAttrsRequest

GetAttrsRequest is the request message for retrieving attributes

path_info (1)PathInfo: The path to the object to retrieve attributes from
attrs (2)repeated string: The list of attribute names to retrieve
recursive (3)bool: If true, retrieves attributes recursively from child objects.

AttrInfoMap

AttrInfoMap represents a named entry in attribute information maps

name (1)string: The name of the child object
value (2)GetAttrsResponse: The attribute information for this child object

GetAttrsResponse

GetAttrsResponse is the response message containing attribute values

values (1)Value: The attribute values for the requested object
group_children (2)repeated AttrInfoMap: Attribute information for child objects (when recursive is true)

IsWildcardRequest

IsWildcardRequest is the request message for IsWildcard.

input (1)string: The string to test.

IsWildcardResponse

IsWildcardResponse is the response message for IsWildcard.

is_wildcard (1)bool: True if the input string is treated as a wildcard by the solver.