Skip to content

Conversation

@pyansys-ci-bot
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot commented Jun 23, 2025

This PR is a mirror pull request created from fix: Added missing kwargs to the dmpoption command. to allow the code to access PyMAPDL CICD secrets.

Check the original PR made by @mbbatukan for more details.

Closes #4027

Original pull request

fix: Added missing kwargs to the dmpoption command.

Description

Please provide a brief description of the changes made in this pull request.
Added missing kwargs to the dmpoption command.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.
It is a very minor fix. Please see the changes and refer to the documentation: https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v242/en/ans_cmd/Hlp_C_DMPOPTION.html

Summary by Sourcery

Add missing distributed memory file options to the DMPOPTION command

Bug Fixes:

  • Include rescombfreq and deleopt keyword arguments in the dmpoption function signature and propagate them to the APDL command string

Documentation:

  • Extend the dmpoption docstring to document the new rescombfreq and deleopt parameters

@pyansys-ci-bot pyansys-ci-bot requested a review from a team as a code owner June 23, 2025 08:59
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 23, 2025

Reviewer's Guide

This PR adds two new keyword arguments, rescombfreq and deleopt, to the dmpoption method to enable configuring result-combination frequency and local file deletion, updates the docstring with descriptions for these options, and adjusts the command string to include the new parameters.

Class diagram for updated dmpoption method signature

classDiagram
    class SolutionAnalysisOptions {
        +dmpoption(filetype="", combine="", rescombfreq="", deleopt="", **kwargs)
    }
Loading

Flow diagram for DMPOPTION command construction with new parameters

flowchart TD
    A[Call dmpoption method] --> B[Build DMPOPTION command string]
    B --> C{Include parameters}
    C -->|filetype| D1[Add filetype]
    C -->|combine| D2[Add combine]
    C -->|rescombfreq| D3[Add rescombfreq]
    C -->|deleopt| D4[Add deleopt]
    D1 & D2 & D3 & D4 --> E[Run command with constructed string]
Loading

File-Level Changes

Change Details Files
Extend dmpoption signature and command construction to support rescombfreq and deleopt
  • Add rescombfreq and deleopt parameters to method signature
  • Update command string to append rescombfreq and deleopt values
src/ansys/mapdl/core/_commands/solution/analysis_options.py
Update dmpoption docstring to describe the new options
  • Add description block for rescombfreq frequency settings
  • Add description block for deleopt file-deletion options
src/ansys/mapdl/core/_commands/solution/analysis_options.py

Assessment against linked issues

Issue Objective Addressed Explanation
#4027 Add rescombfreq and deleopt parameters to the dmpoption command.
#4027 Update the dmpoption docstring to describe the new rescombfreq and deleopt options.

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

@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

@codecov
Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.12%. Comparing base (53ad87c) to head (c2f588a).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4030      +/-   ##
==========================================
+ Coverage   89.05%   89.12%   +0.07%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
+ Hits        13331    13342      +11     
+ Misses       1639     1628      -11     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 changed the title migrated (PR 4027): fix: Added missing kwargs to the dmpoption command. fix (migrated PR 4027): Added missing kwargs to the dmpoption command. Jun 23, 2025
@github-actions github-actions bot added the bug Issue, problem or error in PyMAPDL label Jun 23, 2025
@germa89 germa89 changed the title fix (migrated PR 4027): Added missing kwargs to the dmpoption command. fix: (migrated PR 4027): Added missing kwargs to the dmpoption command. Jun 23, 2025
@germa89 germa89 self-assigned this Jun 23, 2025
@germa89 germa89 enabled auto-merge (squash) June 25, 2025 10:49
@germa89
Copy link
Collaborator

germa89 commented Jun 25, 2025

Close #4027

@germa89 germa89 merged commit 352757f into main Jun 25, 2025
83 of 84 checks passed
@germa89 germa89 deleted the migration/pr-4027 branch June 25, 2025 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issue, problem or error in PyMAPDL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants