Naming of software, package and repository

[BenjaminRodenberg]

We want to use the following names for this project:

• The name of the software is "FEniCS-preCICE Adapter", since this is a name that tells both preCICE and FEniCS users/developers what the software does.
• The name of this repository is precice/fenics-adapter, since this is consistent with the other adapters and represents the perspective of a preCICE developer.
• The name of the package is fenicsprecice, since this repesents the perspective of a FEniCS user import fenicsprecice.

This comes with a few todos:

• Documentation (README.md)
• Related Provide package via PyPI #75
• Update setup.py
• Change import fenicsadapter to import fenicsprecice in corresponding tutorials (e.g. https://github.com/precice/tutorials/blob/master/HT/partitioned-heat/fenics-fenics/heat.py#L30)

[MakisH]

I see a trend towards "solver-preCICE Adapter" names lately. Just in case this did not already pop up and to document why our adapters are currently named as e.g. "OpenFOAM adapter for preCICE":

• The adapter adapts OpenFOAM, not preCICE, so OpenFOAM adapter.
• The adapter does everything to make OpenFOAM compatible with preCICE, so for preCICE. One could also say of preCICE (part of the "ecosystem").

I understand that in the case of FEniCS this is maybe a bit less natural, as we also write the solver. But then I am not sure I understand the "-preCICE" part. I guess the problem lies in the "adapter" part of the term in this case, where "example" could be more descriptive (but probably also incomplete).

Also, small question: what is the motivation behind the uppercase "A" in "Adapter"? We currently don't use this form anywhere else.

[BenjaminRodenberg]

@MakisH Thanks for the input!

We came across this issue while writing the paper for the FEniCS(-preCICE) adapter. When thinking about the title we revisited the actual name of the software. Currently we are only writing "FEniCS Adapter". However, this does not really tell a lot about what the adapter is actually doing from the perspective of somebody who is not from within the "preCICE bubble". Therefore, we decided to extend the name of the software to "FEniCS-preCICE Adapter".

The "-preCICE" part represents (from my point of view) the for preCICE in "FEniCS adapter for preCICE".

Regarding the small question: I think the uppercase "A" currently has no real reason. "FEniCS-preCICE adapter" is also fine.

[BenjaminRodenberg]

@uekerman @IshaanDesai: We did not really discuss the name "FEniCS adapter for preCICE" yet. Did we?

[MakisH]

If the issue is people understanding what this is about, then:

• In the paper, explaining once what this actually is should be enough. A title such as "FEniCS adapter for preCICE" should be enough.
• As a "software name" (if we see this as one "package"), I don't see where "adapter" is needed. Better something as simple as "FEniCS-preCICE". In any case, the term "adapter" is something mostly we are using in this context, so it does not add much information.

[uekerman]

I think it's time to properly discuss this 😁
I also had it on the agenda for Wednesday.

Historically, we used all kinds of different names 🙈

• 2016 paper: "preCICE adapter"
• 2017 paper: "preCICE adapter for solver"
• Thesis Makis: "solver adapter for preCICE"
• Diss Benjamin: "preCICE adapter of/for solver"
• Thesis Alex R: "coupling adapter integrated into solver"
• Diss Bernhard: "adapter combining the preCICE and the COMSOL API", "preCICE adapter"

The adapter adapts OpenFOAM, not preCICE, so OpenFOAM adapter.
The adapter does everything to make OpenFOAM compatible with preCICE, so for preCICE. One could also say of preCICE (part of the "ecosystem").

I guess those points you could also turn around. I think it's just our preCICE viewpoint.
"The adapter adapts preCICE to be usable by OpenFOAM. The adapter does everything to make preCICE compatible with OpenFOAM".
That could be the perspective of an OpenFOAM user hearing the first time about preCICE and its adapter, right?

"Solver-preCICE adapter" would be a symmetric name, suggestion by @ajaust. An adapter between the solver and preCICE. Adapting both ways.

Also, small question: what is the motivation behind the uppercase "A" in "Adapter"? We currently don't use this form anywhere else.

Motivation was to make it a proper name.

[MakisH]

I guess those points you could also turn around. I think it's just our preCICE viewpoint.

I think that from a software perspective it is clear: an adapter modifies the solver code, which needs to be recompiled (or directly the runtime execution steps). preCICE itself does not even know that this ever happened.

Note that here I assume "adapter = someone that adapts something". Not generically something that goes in between and converts "stuff" from A to B and B to A (unclear what "stuff" is + this is what preCICE is mainly doing).

"The adapter adapts preCICE to be usable by OpenFOAM. The adapter does everything to make preCICE compatible with OpenFOAM".
That could be the perspective of an OpenFOAM user hearing the first time about preCICE and its adapter, right?

This sounds wrong to me, due to the "preCICE (code) is not being modified" argument.

"Solver-preCICE adapter" would be a symmetric name, suggestion by @ajaust. An adapter between the solver and preCICE. Adapting both ways.

What is it adapting?

Motivation was to make it a proper name.

I am not sure if this will help solve some problem or if we will end up with both forms being used interchangeably.

[uekerman]

Note that here I assume "adapter = someone that adapts something". Not generically something that goes in between and converts "stuff" from A to B and B to A (unclear what "stuff" is + this is what preCICE is mainly doing).

Maybe that's the important point. For me, adapter was always the thing in between. Sth like this. 😄
And "adapting" is what it does = converting data structures, converting coupling logic, etc.

Besides the best choice (if there is a best choice), I think it's time to come up with a consistent naming scheme.

In my opinion, it would be good to have a naming scheme that works for both the software name and the "code name" / "package name".

Paper title: "Software name: Coupling FEniCS to other Simulation Software"

import packagename

The repository names are good. Here, it is ok to take our viewpoint.

[IshaanDesai]

Taking into consideration what preCICE does, FEniCS adapter for preCICE does not seem correct to me, because we provide an adapter to couple FEniCS using preCICE and not for preCICE. Using for might confuse a new reader into thinking that preCICE is another solver.
A long description would be "Adapter to coupling FEniCS using preCICE". My suggestions would be:

• Repository name: precice/fenics-adapter keeping it the same as it is now because anyone who reaches the adapter repository is going to reach it via the preCICE project.
• Code name / package name: precice + module / plug-in. I think here we can totally avoid the solver name because the user is already going to be setting up the case in the solver environment.
• Software name: preCICE Adapter for FEniCS. I would stress on the capital "A" as we are naming a software, it is the title.

[ajaust]

I like the new name fenicsprecice for the package.

For now I would stick with the term "adapt/adapter". Who adapts what for who depends a lot on the software used, perspective taken etc. We could have a long discussion about that some other time/place. :-D

Nevertheless, i like the suggestion of @MakisH to drop the term "adapter" when suitable and just use the name of the package or something similar. That should avoid confusion. Thus, I also like @uekerman's new title suggestion.

As already mentioned I suggested something like "Solver-preCICE adapter" as consistent naming scheme that is somewhat vague what is actually adapted, but reflects the name of the solver it is intended to be used with and points to preCICE. I assumed that "pointing" to preCICE might be needed for users who would be completely new and just stumble over the paper or package description.

[uekerman]

Thanks for the opinions 👍 More are very welcome!

Quick remark: if possible we could avoid prepositions in the software's name. Makes it shorter and easier to recognize as a stand-alone name.

[MakisH]

For the software name (not a machine-readable name), I would then suggest something like:
preCICE::FEniCS, preCICE::OpenFOAM, etc. (no strong feelings for the separator, maybe a simple - would be more versatile).

• It is short
• It can be generalized to all of our adapters
• It avoids the preCICE-only and confusing "adapter" term
• Having preCICE first:
  • We make a nice list of related software
  • A FEniCS user knows that she is already using FEniCS and knows that she wants to add preCICE, so this is the first thing she thinks of.
  • It is clear that this software belongs to the "preCICE ecosystem". I see the :: as a "namespace".
  • Emphasizes the "preCICE" part, offering more recognition to the core software.

Since we need a "generally recognizable" software name, let's simply drop the "adapter" part there (and only there): it is anyway a term only we are using in this way and it is already confusing. I think both my view ("adapts the code") and @uekerman's view ("adapts data structures") have cases that don't perfectly fit.

@IshaanDesai:

Taking into consideration what preCICE does, FEniCS adapter for preCICE does not seem correct to me, because we provide an adapter to couple FEniCS using preCICE and not for preCICE.

Fair point, but I would argue that we change the verb in this sentence: couple X using Y vs adapt X for Y. I read it as prepare FEniCS for preCICE.

I agree with your repository and package name suggestions / argumentation.

Software name: preCICE Adapter for FEniCS. I would stress on the capital "A" as we are naming a software, it is the title.

This is mostly a style-related discussion. There are names with lowercase letters, for example "preCICE", "deal.II", etc. But indeed, not a very common pattern. Maybe a useful example for your approach would be "LibreOffice Writer", "LibreOffice Impress" etc.

Related curse in all this discussion: if we use "preCICE" first, it will often be automatically be converted to PreCICE.