SettingsSchema

class ansys.fluent.mcp.solve.catalog.schema.SettingsSchema(raw: dict[str, Any], *, source: str = '')

Indexed view over the static settings schema.

Indexing is built once at construction. Resolution is O(depth) over the snake_case path components, with kebab and snake spellings accepted interchangeably.

Overview

Methods

resolve	Resolve a snake_case (or kebab-case) dotted path.
lookup_command	Resolve a command call path like solution.run_calculation.iterate.

Properties

source	Return the source associated with the catalog node.
node_count	Return the number of nodes in the catalog tree.

Import detail

from ansys.fluent.mcp.solve.catalog.schema import SettingsSchema

Property detail

property SettingsSchema.source: str

Return the source associated with the catalog node.

Returns:

str

String value produced by the helper.

property SettingsSchema.node_count: int

Return the number of nodes in the catalog tree.

Returns:

int

Configured integer limit used by the helper.

Method detail

SettingsSchema.resolve(path: str) → SettingsNode | None

Resolve a snake_case (or kebab-case) dotted path.

Bracketed member selectors (...wall["w1"]) are stripped and the schema descends through the NamedObject’s element envelope automatically — so resolve("setup.boundary_conditions.wall.thermal") returns the element-level node for wall thermal, not the container.

Dot-form member keys are also supported: solution.controls.under_relaxation.pressure resolves to the under_relaxation member envelope (Fluent rejects new keys here at runtime, but the schema can’t know which keys the user has created — so we accept any token after a NamedObject as a member-key access).

Parameters:

pathstr

Fluent object path or file-system path to inspect.

Returns:

SettingsNode | None

Collection containing the operation results.

SettingsSchema.lookup_command(path: str) → CommandSpec | None

Resolve a command call path like solution.run_calculation.iterate.

Splits the trailing segment as the command name and looks it up on the parent node’s commands (then queries as a fallback).

Parameters:

pathstr

Fluent object path or file-system path to inspect.

Returns:

CommandSpec | None

Result produced by the function.