docs: Example on lid driven cavity [skip tests]#4848
Open
MohammedAnsys wants to merge 17 commits intomainfrom
Open
docs: Example on lid driven cavity [skip tests]#4848MohammedAnsys wants to merge 17 commits intomainfrom
MohammedAnsys wants to merge 17 commits intomainfrom
Conversation
MohammedAnsys
requested review from
hpohekar,
mayankansys and
prmukherj
as code owners
github-actions
bot
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive lid-driven cavity flow example to demonstrate a fundamental CFD benchmark problem in PyFluent. The example simulates 2D laminar flow in a water-filled square cavity with a moving top wall.
Changes:
- Implements a complete lid-driven cavity simulation with setup, solving, and post-processing
- Adds the new example to the documentation build configuration
- Includes the example in the weekly CI workflow for automated execution testing
Reviewed changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| examples/00-fluent/lid_driven_cavity.py | Complete example implementation demonstrating lid-driven cavity CFD simulation with velocity analysis |
| doc/source/conf.py | Updates filename pattern to include the new lid_driven_cavity example in documentation generation |
| .github/workflows/execute-examples-weekly.yml | Adds execution step for the new example in the weekly CI workflow |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| """.. _lid_driven_cavity_simulation: | ||
|
|
||
| Lid Driven Flow in a Cavity |
Collaborator
There was a problem hiding this comment.
Briefly perusing PyAnsys docs, I note that headings are in a mixture of Title Case and Sentence case. E.g.:
- PyFluent doc is all sentence case
- PyFluent examples have a mixture
- PyMAPDL doc has a mixture
- PyMAPDL examples are all in title case
According to https://dev.docs.pyansys.com/content-writing/rst-files-writers/rst-format-rules.html, sentence case is the chosen PyAnsys documentation format. AFAICS, there are general PyAnsys consistency issues around this.
## Context The range was too broader. ## Change Summary The range is removed. ## Rationale Compatible version only allowed. ## Impact pyproject.toml is updated. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
## Context The 'meshing_workflow' and the updated meshing interface was not rendered correctly in the api reference. ## Change Summary 1. 'meshing_workflow' was explicitly handled in api doc generation. 2. Minor improvements on other meshing docs. ## Impact User facing meshing docs rendered in a user readable format. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
## Change Summary Currently PIM doesn't support dimension=2. This fixes support for that --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Harshal Pohekar <106588300+hpohekar@users.noreply.github.com> Co-authored-by: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Update CHANGELOG for v0.38.dev3 and remove .md files in doc/changelog.d. > [!CAUTION] > Do not merge this pull request until the release has been successfully made.
Update CHANGELOG for v0.38.dev4 and remove .md files in doc/changelog.d. > [!CAUTION] > Do not merge this pull request until the release has been successfully made. --------- Co-authored-by: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com>
Bump version to v0.38.dev5 --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
This pull request focuses on dependency management improvements and minor documentation updates. The main changes include refining how dependencies are handled by Dependabot, updating the version constraint for an optional dependency. Dependency management improvements: * Updated `.github/dependabot.yml` to ignore updates for several main and optional dependencies, preventing Dependabot from creating PRs for these packages. This helps control which dependencies are automatically updated. * Relaxed the version constraint for the `h5py` package in the `reader` optional dependency, allowing any version greater than or equal to 3.15.1 instead of requiring exactly 3.15.1 in `pyproject.toml`. ## Context Dependabot was creating update PRs for dependencies that do not need automatic updates, adding unnecessary noise. Some optional dependencies were also pinned to exact versions, which limited flexibility and caused avoidable constraints. ## Change Summary Updated the Dependabot configuration to ignore selected dependencies and reduce unwanted PRs. Relaxed version constraints for optional dependencies by allowing minimum versions instead of exact pins, and updated documentation to reflect these changes. ## Impact What parts of the system or workflows are affected? This pull request primarily updates dependency management and documentation. The most significant changes include refining the dependencies handled by Dependabot, relaxing version constraints for optional dependencies, and updating documentation. Dependency management improvements: * Updated `.github/dependabot.yml` to ignore updates for a list of specified dependencies, preventing Dependabot from creating PRs for these packages. * Relaxed version constraints for optional dependencies in `pyproject.toml`, changing pinned versions to minimum version requirements for `h5py`, `ipywidgets`, and `panel`. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Updated the ``CONTRIBUTORS.md`` file with the latest contributors. --- This pull request was created by a bot. If you have any questions, please ping the PyAnsys Core team for assistance. To ping the team write a comment in this issue with the following mention: `@ansys/pyansys-core`. If you want this repository to be excluded from this automated maintenance process, please let us know by [filling in the opt-out request form](https://github.com/ansys-internal/pyansys-maintenance-automation/issues/new?labels=&projects=&template=opt-out.yml&title=Request+to+opt-out+from+automated+maintenance+for+ansys%2Fpyfluent). --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> Co-authored-by: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com>
## Context Insecure options are for internal testing only. ## Change Summary Insecure options replaced with MTLS options. ## Rationale MTLS options work on all platforms. ## Impact File transfer service workflow. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
…ce_terms" (#4874) In examples: pyfluent.EXAMPLES_PATH -> pyfluent.config.examples_path In seetings-api docs: source_terms -> sources.terms --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Disable the label-syncer job as that seems to be deleting custom labels from GitHub. I think the the automatic labeler should still work without the pre-sync step. @jorgepiloto @RobPasMue Please let us know if there will be any issue with this change. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
…s [skip tests] (#4880) ## Context As observed in #4159 the computed hash of the codegen source before and after the codegen step in CI are different. This is most likely due to generation of .pyc files and \_\_pycache__ folder as the pyfluent module is loaded during codegen. As the hash is changed, the github caching mechanism doesn't work for the codegen step. Ideally, if the codegen source is not changed between two successive git push, the codegen step should not be run again. ## Change Summary The fix is based on the assumption that the cache invalidation is due to generation of Python bytecode files within the codegen folder. The env var `PYTHONDONTWRITEBYTECODE=1` is set which should avoid generation of these files. ## Rationale This fixes the most probable issue. We'll observe if the CI behaviour is improved after this fix. ## Impact The CI is expected to run faster as the codegen step won't be re-run with every push. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
## Context Several tests were skipped using `@pytest.mark.skip`, but the skip reasons were inconsistent and often unclear. Many reasons only described symptoms (for example, “works locally but fails on CI”) without stating whether the root cause was known, partially understood, or unknown. Similar situations were described using different wording across the test suite, making maintenance and investigation harder. ## Change Summary - Introduced a small set of canonical skip reason string literals in `conftest.py`. - Replaced ad-hoc skip reason strings in test files with these shared constants. - Updated existing skipped tests to use the standardized reasons. ## Impact - Test code only: no impact on runtime or production behavior. - Improves readability, searchability, and maintainability of skipped tests. - Makes it easier to audit and clean up skipped tests in the future. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
…m/ansys/pyfluent into docs/example_on_lid_driven_cavity
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The PyFluent examples collection lacked a lid-driven cavity flow example, which is one of the most fundamental and widely recognized benchmark problems in CFD.
Change Summary
A complete, example demonstrating: 2D laminar flow simulation in a water-filled cavity, Moving top wall driving recirculating flow
Post-processing: velocity vectors, centerline profiles, and vortex analysis
Rationale
lid driven cavity was choosen because of universally recognized problem, simple geometry, rich in physics
Impact
Adds a fundamental CFD benchmark to the fluent examples directory
The example tries to follow the provided guidelines with #4378 and uses the new API implementation.
Thanks.