precice/calculix-adapter

Split the adapter config file to one file per participant

Open

#3 opened on Feb 9, 2018

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C (30 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

For the OpenFOAM adapter we decided to have one adapter configuration file per participant, as shown here. This was done so that we don't need to modify the solver to accept an extra command-line argument (we want to keep the solvers intact).

If there is no problem with the current setup, I propose that we also change the CalculiX adapter to look for one YAML file per participant, instead of accessing a common file for all the participants. We already discussed this with @uekerman.

(as the links may break in the future, they refer to the precice-adapter-config.yml and config.yml of the heat exchanger tutorial for OpenFOAM and CalculiX)

Contributor guide

Research direction
Investigate the current YAML configuration loading in the CalculiX adapter, then compare with the per participant config approach in the linked OpenFOAM tutorial to identify how to split the config into separate files.
Tech stack
c
Domain
backend
Issue type
Feature
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
GitCYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70