precice / precice/code_aster-adapter
Rename and move adapter.py
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 16
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
The main adapter file is currently cht/adapter.py. We should:
- Rename the adapter to something that points to preCICE, for example
precice.py. - Move it to the main directory, unless we have any good reason not to. An important design decision would be if we:
- implement FSI in the same file as CHT (preferably, if simple)
- split CHT and FSI in a similar way as in the OpenFOAM adapter (preferably, if complex)
- provide completely different adapters for CHT and FSI
- Update the documentation respectively.
@uekerman what do you think about the name? Is there a good reason to keep this directory structure?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing cht/adapter.py and the current documentation to understand how the adapter is organized. Resolve whether CHT and FSI should share a file, be split like the OpenFOAM adapter, or use separate adapters; done means the chosen structure is renamed, moved as appropriate, and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100