Connect to the pinned local PLAXIS endpoint.

Disconnect the current PLAXIS worker session.

Get state for the pinned PLAXIS role.

List available attributes on a PLAXIS object path.

Inspect a PLAXIS object or property.

Return common project metadata and units.

Return a compact model-phase summary.

Return a compact material summary.

List the model objects of one kind, with the path to pass back.

Each object carries path (the exact string every reference parameter accepts), its identification, and a short geometry or material summary -- enough to pick the object you mean without probing members one at a time.

Report whether the model can be calculated, and what is stopping it.

Read-only. Returns mesh status and element counts, the phase table with each phase's marked-for-calculation flag, and any features with no material assigned. blocking lists what would stop a calculate; unknown lists the checks that could not be evaluated on this endpoint, so an empty blocking is never mistaken for a clean bill of health.

Set a writable PLAXIS property using a dotted path.

For a material reference such as Plate_1.Material use assign_material instead -- PLAXIS needs a real object there, and no string spelling of the material's name works through this tool. Setting Identification renames the object, which changes the path every later call must use.

Call an explicitly named PLAXIS method with literal positional arguments.

Every argument must be a scalar literal (number, string, boolean, or null) -- there is no way to pass a reference to another PLAXIS object or phase through this tool. A string argument is sent to PLAXIS as a quoted text literal, not as a reference, so it cannot stand in for an object or phase parameter even when it names one. Use this only for methods whose PLAXIS command reference shows purely literal parameters; prefer list_objects, model_state, and the first-class tools over probing with dump.

Create a new PLAXIS project.

Open a PLAXIS project.

An absolute path is used as given; a relative path (a bare filename) resolves against the working directory, so "model.p2dx" opens the project in the directory the session was started in. The result reports the resolved absolute path.

Close the active PLAXIS project.

Recover the current PLAXIS project.

Save the active project, optionally to a new path.

Omit filename to save the open project in place. An absolute filename is used as given; a relative one (a bare "model.p2dx") saves into the working directory the session was started in, not PLAXIS's own directory. The result reports the resolved absolute path.

Create a new phase relative to an existing one.

PLAXIS always has an InitialPhase; the first real phase is typically created with reference_phase="InitialPhase".

Make an existing phase the current phase for further edits.

Activate one or more objects in one or more phases.

Deactivate one or more objects in one or more phases.

Calculate phases.

Omit phases to calculate every phase currently marked for calculation; provide phases to calculate exactly those phases regardless of their marked-for-calculation state.

Open a calculated phase in the PLAXIS Output application.

This is the only route from a calculated Input model to the Output endpoint's results: Output reads whatever its application has open, and the Output role deliberately has no open_project. Call this for a phase whose status is "calculated", then read results through the Output server.

Set a property of an object for one specific phase only.

This is PLAXIS's phase-scoped setproperties form, distinct from set_property, which changes a property without phase scoping.

Switch the PLAXIS Input working mode.

force_new_intersection is only meaningful for mode "mesh", "water", or "stages"; it is rejected for "soil" or "structures".

Generate the mesh, optionally with a relative element size factor.

enhanced_refinement requires relative_element_size to also be given.

Create one or more points at [x, y] coordinates.

Create a line, or a polyline through 3 or more vertices.

Each vertex is either an [x, y] coordinate or the path of an existing point. Only the vertex-list form of the line command is implemented; the angle/relative/vector sub-command form is not.

Create a polygon from 3 or more vertices.

Each vertex is either an [x, y] coordinate or the path of an existing point. Only the vertex-list form is implemented; the polycurve-based form is not.

Add a borehole at the given x-coordinate.

Add a soil layer with the given height.

Create a material set.

Omit properties to create a placeholder material that cannot be used to calculate until edited; provide a property/value map (matching PLAXIS's own property names, e.g. "SoilModel", "gammaUnsat") to create a usable material in one call. Property names are checked against the names PLAXIS 2D V22 exposes for that kind and are case-sensitive.

"Identification" renames the material: after create_material(kind="soil", properties={"Identification": "SZ"}), the object's path is "SZ", and that is what every later call -- assign_material included -- must use.

Assign a material to one or more features.

Add a structural element feature to one or more existing lines.

Only the add-to-existing-line form is implemented; creating a new line inline, or element-specific extra overloads, are not. Create the line first with create_line.