precice/calculix-adapter

Inconsistent lookup for read/write data in CHT and FSI

Open

#107 opened on Oct 24, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)C (30 forks)auto 404
buggood first issue

Repository metrics

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

Description

For temperature and heat flux, we are checking whether the field name is exactly matched in the config:

https://github.com/precice/calculix-adapter/blob/4496e8f160ec121481653baf44ec032813409ac6/adapter/PreciceInterface.c#L624

For other fields, we are checking whether the field name just starts with this prefix (similar behavior as in the OpenFOAM adapter), sometimes with a trailing -, sometimes without:

https://github.com/precice/calculix-adapter/blob/4496e8f160ec121481653baf44ec032813409ac6/adapter/PreciceInterface.c#L37

https://github.com/precice/calculix-adapter/blob/4496e8f160ec121481653baf44ec032813409ac6/adapter/PreciceInterface.c#L654

Additionally, data names are hard-coded for preCICE:

https://github.com/precice/calculix-adapter/blob/4496e8f160ec121481653baf44ec032813409ac6/adapter/PreciceInterface.c#L628

Finally, this error message is rather confusing:

https://github.com/precice/calculix-adapter/blob/4496e8f160ec121481653baf44ec032813409ac6/adapter/PreciceInterface.c#L662

"Does not exist" made me think that I still needed to specify it somewhere. However, it just means that the adapter does not know how to handle it.

Contributor guide

Research direction
Inspect the code in PreciceInterface.c around the lines mentioned. Compare how field names are matched for different data types (temperature/heat flux vs others). Identify the inconsistency and the hard coded data names. Trace the error message to understand when it is triggered. Determine the intended behavior for CHT (conjugate heat transfer) and FSI (fluid structure interaction) cases. Propose a uniform method for field name matching and improve the error message to be clearer.
Tech stack
c
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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.
Mostly clear
Prerequisites
GitC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70