ansys / ansys/pyfluent

Add examples for usage of meshing.datamodel.meshing

Open
#2,185 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
497
Forks
77
Avg merge
22h 37m
Merged PRs (30d)
45

Description

### Description of the modifications

Package `meshing.datamodel.meshing` contains functions that appear to be equivalent to meshing workflow, but without annoying boilerplate like `addChildAndUpdate()`, `Arguments = {}`, `Execute()`. A more detailed look shows that while these functions do not reflect 1-1 actions that can be done in workflows both in code and in GUI (some arguments are often in different functions), they do seem to work. It would be nice to have this more programmatic-oriented API for users that want more complex and less script-like, write-once-use-forever code.

I cannot migrate our code to these functions as of now yet, because their existence is not mentioned anywhere else in the docs, and there isn't a single example how to use them to reliably and ensure full compatibility with GUI workflow.

### Useful links and references

https://fluent.docs.pyansys.com/version/stable/api/meshing/datamodel/meshing/index.html#

Contributor guide

Open the contributing guide

Research direction

Start with the meshing.datamodel.meshing API documentation at the linked Fluent docs page and inspect the available functions and their current usage. Add examples showing how the programmatic API can reproduce meshing workflows reliably and remain compatible with GUI workflows; done means the package is documented with usable examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.