precice/openfoam-adapter

Remove the connectivity switch from the configuration, ask preCICE

Open

#198 opened on Sep 20, 2021

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)C++ (115 forks)auto 404
compatibilityenhancementgood first issue

Repository metrics

Stars
 (171 stars)
PR merge metrics
 (PR metrics pending)

Description

preCICE v2.3.0 https://github.com/precice/precice/pull/1080 introduces an API method to ask whether mesh connectivity is required. In the OpenFOAM adapter, we currently ask the user whether this is required, which the user should not need to configure, as it is system-internal information: https://precice.org/adapter-openfoam-config.html#nearest-projection-mapping

We could directly ask preCICE for this and remove the option from the configuration. As it currently defaults to false, maybe we can do it in a backwards-compatible way and deprecate the option for now.

Contributor guide

Research direction
Check preCICE API method to query mesh connectivity requirement, then remove the configuration option and add deprecation warning.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75