Skip to content

Conversation

clatapie
Copy link
Contributor

Description

This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.

This PR focus on the first part of the solution submodule integration.

You can check the mapdl-cmd-conv documentation to have a look at the output of each methods.

Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.

Issue linked

This PR is meant to be merged within the feat/main_solu branch. The latter will gather all the parts of the submodule prior to be merged to the main branch.

Checklist

@clatapie clatapie self-assigned this Oct 17, 2025
@clatapie clatapie requested a review from a team as a code owner October 17, 2025 15:01
@clatapie clatapie changed the base branch from main to feat/main_solu October 17, 2025 15:01
@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Oct 17, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds new additive manufacturing and 2D→3D analysis command wrappers, introduces internal/underscore-prefixed solution submodules, and replaces/renames several existing solution mixins while removing multi‑field solver related modules. Key changes include restructuring SolutionCommands inheritance, renaming MasterDOF to MasterDof with expanded docstrings, and adding new parameters (meshflag, omgsqrdkey) to existing command wrappers.

  • Reworks SolutionCommands composition: drops multiple multi_field_solver and miscellaneous_loads mixins; adds additive manufacturing, 2D→3D, status, gap, and nonlinear options modules.
  • Renames/updates classes and command wrappers (MasterDOF → MasterDof; gap_conditions → _gap_conditions; NonLinearOptions capitalization change) and extends method signatures (F adds meshflag; KBC adds omgsqrdkey).
  • Introduces new feature modules for additive manufacturing (am*) and 2D→3D mapping.

Reviewed Changes

Copilot reviewed 37 out of 40 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
src/ansys/mapdl/core/commands.py Alters SolutionCommands inheritance list; removes multi-field solver/misc loads, adds new internal and AM/2D→3D/status modules (API surface change).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_time_controls.py Removed (multi-field time control commands no longer mixed in).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_load_transfer.py Removed (load transfer commands removed from public mixin).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_interface_mapping.py Removed (interface mapping commands dropped).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_global_controls.py Removed (global multi-field controls removed).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_definition_commands.py Removed (definition commands removed).
src/ansys/mapdl/core/_commands/solution/multi_field_solver_convergence_controls.py Removed (convergence controls removed).
src/ansys/mapdl/core/_commands/solution/miscellaneous_loads.py Removed (miscellaneous loads mixin removed).
src/ansys/mapdl/core/_commands/solution/gap_conditions.py Removed (replaced by underscore-prefixed implementation).
src/ansys/mapdl/core/_commands/solution/master_dof.py Renames class MasterDOF→MasterDof; expands docstrings; adds support argument; adjusts command strings.
src/ansys/mapdl/core/_commands/solution/load_step_options.py Adds typing, extended docstrings; KBC gains second parameter omgsqrdkey.
src/ansys/mapdl/core/_commands/solution/fe_forces.py Adds meshflag parameter to F; modifies command string; updates docstring; potential command format impact.
src/ansys/mapdl/core/_commands/solution/birth_and_death.py Removes typing imports; updates docstrings; minor refactor.
src/ansys/mapdl/core/_commands/solution/analysis_2d_to_3d.py New file providing MAP2DTO3D wrapper.
src/ansys/mapdl/core/_commands/solution/additive_manufacturing.py New additive manufacturing command wrappers (am*).
src/ansys/mapdl/core/_commands/solution/_status.py Adds Status mixin with GAP status topic.
src/ansys/mapdl/core/_commands/solution/_nonlinear_options.py Adds NonlinearOptions with CRPLIM wrapper.
src/ansys/mapdl/core/_commands/solution/_gap_conditions.py New underscore-prefixed gap conditions implementation replacing prior one.

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@clatapie
Copy link
Contributor Author

This PR is ready for review @germa89!

@germa89 germa89 added the deploy pr docs Deploy pull request documentation label Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy pr docs Deploy pull request documentation documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants