New location logic by orlandoisepic · Pull Request #15 · precice/case-generate

orlandoisepic · 2026-08-16T14:15:49Z

New location logic

This implements the requested changes in #7 and #14 (that have first been proposed in precice/preeco-orga#70).

This means that the topology now uses the tags
from-location-name and to-location-name instead of from-patch and to-patch, respectively.
The new tags
from-location-type and to-location-type are introduced and can currently take the values surface and volume.
These tags are only relevant for the adapter-config.
The precice-config generation is left completely unchanged by this PR.

These changes also affect the generated adapter-config: its entry "location" is now filled out according to the specified location type of the exchanges and patch-names are now used exactly as specified in the topology.

Implementation Details

Unfortunately, there were a lot of changes to be made to the NodeCreator :(

Old methods _patch_preprocessing() and _initialize_meshes_and_patches() have been reworked into _initialize_locations() and now _initialize_meshes(). Both methods are now relatively modular and simpler than before.
- The locations are now initialized directly as nodes. They hold references to all meshes that use/interact with them (before, they were assigned to exactly one mesh).
- The meshes are now initialized for each participant, for each participant they interact with, for each of "extensive"/"intensive", for each of "surface"/"volume". This means that there will be even more meshes now 🤯 However, in the average topology case, nothing will change actually.
LocationNode (previously PatchNode) is now used consistently throughout the entire project. No more storing and manipulating locations (patches) as strings.
The method get_mesh_patch_map() has been renamed to get_mesh_location_map() and now uses the new LocationNode objects.
Other methods that need to use meshes now also use the new location-type as the meshes key and were thus updated.

The TopologyReader has also improved:

Its check_topology() method now checks against more edge cases and preprocesses it more.
- If a location (former patch) has a location-type specified only once, it will be used whenever the location is mentioned. This means that it is not necessary to type "...-location-type" in every exchange.
- It is not allowed to create a location with both "surface" and "volume" type.

The adapter config now uses the LocationNode object to create the entries.

Create a new enum for location-type and update old references to "patch"

update documentation of topology

Added info about changed topology tags

Extend preprocessing to guard against multiple location-types for the same location and actually implement the check for "unique-exchanges", which the docstring said the method does, but never actually did.

Change all references from "patch" to "location" and added a few comments for clarity.

Consistently use LocationType as entry and not str

Update the `LocationNode` class to suit new needs.

New location logic! This changed mainly the old `_patch_preprocessing()` (now `_initialize_locations()`) and `_initialize_meshes_and_patches()` (now `_initialize_meshes()`). Patch names are not modified in the topology anymore, thus appear in the adapter-config as they were specified. This allows a much cleaner method and removed a lot of unnecessary logic. The patches (now LocationNode) are now mainly used as their object and hold references to all meshes that use/interact with them. Meshes are now split based on type (extensive vs. intensive) and location (surface vs. volume). This includes some logic, although it is implemented in a smarter way than before. The method that passes the location info to the adapter-configs has been modified to include the new LocationNode as well. The new location_type is used as a key in the `mesh_map` which is used in a few other methods; other than that, no changes. This makes the current design a bit lighter and more modular.

Use the renamed method of NodeCreator

Use the new LocationNode object and actually adhere to the precice-adapter-schema 🫣

Fix the uniqueness check to include location-names

Remove check for duplicate exchanges. I think this may require some more adjustements and should thus be moved to a different PR

Update test to new topology format

Fix comparison logic

This updates and optimizes the mesh-creation logic. Before, if two participants exchanged intensive and extensive data, always two meshes were used per participant. Now, if the exchanges are in different direction, i.e., extensive in one direction, intensive in the other, the same mesh is used by each participant.

it now uses _ instead of -

Update to avoid weird bug

Change it back. Apparently it was correct all along

Mesh split logic

uekerman

Had a quick look (only):

Is there any example with volume coupling already? If not, could be good to add one to also check the "type".
Probably beyond this PR: We should eventually check all names for consistency with the adapter schema, things like using "-name" or not
to-location-name -> to-location-names and turn into list (same for "from")

orlandoisepic · 2026-08-20T04:31:44Z

Is there any example with volume coupling already? If not, could be good to add one to also check the "type".

I added an example plus a test

Probably beyond this PR: We should eventually check all names for consistency with the adapter schema, things like using "-name" or not

I agree. Dropping the "-name" would certainly make writing the topology easier and be more consistent with the adapter config.

to-location-name -> to-location-names and turn into list (same for "from")

I will work on it

uekerman · 2026-08-21T10:00:07Z

Dropping the "-name" would certainly make writing the topology easier

agree

and be more consistent with the adapter config.

don't agree :)

Could you please open a separate issue (eventually) where we could collect and compare names?

update to new adapter-config

Change `from-/to-location-name` → `from-/to-location-names` (note the 's' at the end).

Updaet to allow lists in `from-/to-location-names`. The preprocessing method is now redundant.

Move the preprocessing and validation logic to a new class.

New validation and preprocessing logic.

Update to new reader and processing.

This scenario is not correct anymore. Now it is supposed to cause an error. This error is already checked in "preprocessing/exchange_loop"

Update the description for new tags

orlandoisepic · 2026-08-29T10:02:42Z

The requested feature

to-location-name -> to-location-names and turn into list (same for "from")

is implemented in #18 and can be merged into this PR.

Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com>

Location lists

orlandoisepic added 12 commits August 15, 2026 16:25

Update topology-schema.json

f2a541f

Update topology_reader.py

8c9d626

Update helper.py

95c6ab7

Create a new enum for location-type and update old references to "patch"

Update README.md

4cb19b0

update documentation of topology

Update README.md

17fd60d

Added info about changed topology tags

Update topology_reader.py

27329e9

Extend preprocessing to guard against multiple location-types for the same location and actually implement the check for "unique-exchanges", which the docstring said the method does, but never actually did.

Update node_creator.py

e3fb97b

Change all references from "patch" to "location" and added a few comments for clarity.

Update topology_reader.py

f3effc1

Consistently use LocationType as entry and not str

Update helper.py

b16492f

Update the `LocationNode` class to suit new needs.

Update cli.py

6fd52ca

Use the renamed method of NodeCreator

Update adapter_config_creator.py

aba6db7

Use the new LocationNode object and actually adhere to the precice-adapter-schema 🫣

This was linked to issues Aug 16, 2026

Change topology patches tag #7

Open

Simplify location (patch) → mesh generation logic #14

Open

orlandoisepic added the breaking change A change will break backwards compatibilty label Aug 16, 2026

orlandoisepic mentioned this pull request Aug 17, 2026

Preprocessing of topology #6

Open

orlandoisepic added 12 commits August 17, 2026 07:00

Update topology_reader.py

49384e7

Fix the uniqueness check to include location-names

update tag -patch → -location-name

11e118f

Update tag -patch → -location-name

37a4ca0

Update topology_reader.py

a2b68d5

Remove check for duplicate exchanges. I think this may require some more adjustements and should thus be moved to a different PR

Update test_node_generation.py

626fc46

Update test to new topology format

Update topology_reader.py

6d1d5b2

Fix comparison logic

rename directory

bf0db7c

it now uses _ instead of -

Create test case for mesh split

a766e61

Update node_creator.py

2fe2cbf

Update to avoid weird bug

Update precice-config.xml

dd9338f

Change it back. Apparently it was correct all along

Merge pull request #16 from precice/mesh-split-logic

ac6e081

Mesh split logic

orlandoisepic marked this pull request as ready for review August 17, 2026 13:11

uekerman reviewed Aug 19, 2026

View reviewed changes

orlandoisepic added 2 commits August 20, 2026 06:09

Add example for volume coupling

1b50196

Add test for location-type

f90e526

orlandoisepic mentioned this pull request Aug 20, 2026

Update schema for consistent names precice/preeco-orga#76

Merged

orlandoisepic marked this pull request as draft August 21, 2026 04:11

orlandoisepic added 11 commits August 22, 2026 15:11

Update adapter_config_creator.py

2216914

update to new adapter-config

Update test_location_type.py

e0533ab

Update topology-schema.json

7dd3acb

Change `from-/to-location-name` → `from-/to-location-names` (note the 's' at the end).

Update node_creator.py

7c41a66

Updaet to allow lists in `from-/to-location-names`. The preprocessing method is now redundant.

Update topology_reader.py

e72d0d6

Move the preprocessing and validation logic to a new class.

Create topology_processor.py

11e33d9

New validation and preprocessing logic.

Update cli.py

88011e7

Update to new reader and processing.

Test for location-lists

f8c632b

Remove redundant test

5ca9fd4

This scenario is not correct anymore. Now it is supposed to cause an error. This error is already checked in "preprocessing/exchange_loop"

Update location-lists

e9fdaf3

Update README.md

74d8f91

Update the description for new tags

orlandoisepic and others added 3 commits September 1, 2026 05:57

Update precicecasegenerate/schemas/README.md

ab6818f

Co-authored-by: Benjamin Uekermann <benjamin.uekermann@gmail.com>

Update README.md

3cf76ef

Merge pull request #18 from precice/location-lists

a493852

Location lists

Navigation Menu

Uh oh!

Uh oh!

New location logic - #15

New location logic #15
orlandoisepic wants to merge 40 commits into
mainfrom
develop

orlandoisepic commented Aug 16, 2026 •

edited

Loading

Uh oh!

uekerman left a comment

Uh oh!

orlandoisepic commented Aug 20, 2026

Uh oh!

uekerman commented Aug 21, 2026

Uh oh!

orlandoisepic commented Aug 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

orlandoisepic commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New location logic

Implementation Details

Uh oh!

uekerman left a comment

Choose a reason for hiding this comment

Uh oh!

orlandoisepic commented Aug 20, 2026

Uh oh!

uekerman commented Aug 21, 2026

Uh oh!

orlandoisepic commented Aug 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

orlandoisepic commented Aug 16, 2026 •

edited

Loading