Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jun 2, 2025

Description

Adding INVOPT command.

Issue linked

Close #3976

Checklist

Summary by Sourcery

New Features:

  • Add invopt method to toggle inverse solving for static analysis load steps

@germa89 germa89 requested a review from a team as a code owner June 2, 2025 10:59
@germa89 germa89 self-assigned this Jun 2, 2025
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 2, 2025

Reviewer's Guide

This pull request introduces the INVOPT command wrapper to the AnalysisOptions class, enabling users to toggle inverse solving on a per‐load‐step basis. The implementation adds a new method following existing patterns, includes parameter validation via docstring, and leverages the generic run() interface. Corresponding unit tests and documentation updates ensure coverage and reflect the new feature.

Sequence Diagram for INVOPT Command Execution

sequenceDiagram
    actor User
    User->>AnalysisOptions: invopt(option="ON")
    AnalysisOptions->>MAPDL: run("INVOPT,ON")
    MAPDL-->>AnalysisOptions: ExecutionResult
    AnalysisOptions-->>User: ExecutionResult
Loading

Updated Class Diagram for AnalysisOptions

classDiagram
    class AnalysisOptions {
        +invopt(option: string) : object
    }
Loading

File-Level Changes

Change Details Files
Added invopt method to wrap the INVOPT APDL command
  • Defined invopt signature with option parameter
  • Wrote detailed docstring (Parameters, Notes, APDL Command)
  • Implemented return self.run(f"INVOPT,{option}", **kwargs)
src/ansys/mapdl/core/_commands/solution/analysis_options.py
Expanded unit tests to cover INVOPT functionality
  • Added tests for enabling (ON) and disabling (OFF) inverse solving
  • Asserted correct command string is sent to run()
  • Ensured behavior matches default forward solving case
tests/test_solution_commands.py
Updated documentation to include INVOPT command
  • Added INVOPT section to analysis options reference
  • Documented usage examples and notes linking to Structural Analysis Guide
docs/source/commands/analysis_options.rst

Assessment against linked issues

Issue Objective Addressed Explanation
#3976 Provide a direct API/function in PyMAPDL to execute the invopt, on MAPDL command, enabling or disabling inverse solving for the current load step.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@germa89 germa89 requested a review from vnamdeo June 2, 2025 10:59
@github-actions github-actions bot added the new feature Request or proposal for a new feature label Jun 2, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @germa89 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.25%. Comparing base (628dde1) to head (4974d36).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3979      +/-   ##
==========================================
- Coverage   88.26%   88.25%   -0.02%     
==========================================
  Files         187      187              
  Lines       14941    14943       +2     
==========================================
  Hits        13188    13188              
- Misses       1753     1755       +2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89
Copy link
Collaborator Author

germa89 commented Jun 2, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) June 2, 2025 15:01
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89 germa89 merged commit 5d50979 into main Jun 2, 2025
85 of 86 checks passed
@germa89 germa89 deleted the feat/adding-invopt-command branch June 2, 2025 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new feature Request or proposal for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PyMAPDL lacks a direct API/function for executing the "invopt, on" mapdl command (Turn on Inverse Solving)

3 participants