[Mapping] Add checks at init in TopologicalMapping by hugtalbot · Pull Request #3339 · sofa-framework/sofa

hugtalbot · 2022-09-27T07:02:45Z

Adding check on pointers and type of input/output topology (mostly input) before using them in TopologicalMapping

By submitting this pull request, I acknowledge that
I have read, understand, and agree SOFA Developer Certificate of Origin (DCO).

Reviewers will merge this pull-request only if

it builds with SUCCESS for all platforms on the CI.
it does not generate new warnings.
it does not generate new unit test failures.
it does not generate new scene test failures.
it does not break API compatibility.
it is more than 1 week old (or has fast-merge label).

hugtalbot · 2022-09-27T07:03:14Z

Further to our discussion @epernod @ScheiklP

hugtalbot · 2022-09-27T07:03:35Z

[ci-build][with-all-tests]

alxbilger

Thanks for making this PR. It will improve the UX for sure.

However, I see a lot of duplicated code. I consider it as a technical debt. To discuss if we temporary merge your changes, or think bigger ;)

hugtalbot · 2022-09-28T14:39:55Z

I am open to think bigger, or merge it and then factorize

hugtalbot · 2022-09-29T12:19:12Z

Reviews taken into account 👍 @alxbilger

epernod

I think there is already some checks in TopologyMapping parse method. Checking fromModel and toModel.
Might be the good timing to unify it.
Also it is not possible to put the same message in a single method inside TopologyMapping which is called by the different components.
Using toModel.GetClassName, toModel.getName() etc... ?
Which part of the check is not generic?

epernod

several changes are not compatible with the current api of the topology and some tests are already present in TopologicalMapping create and canCreate methods.

@hugtalbot if you agree I will push a new proposal directly in this PR.

epernod · 2022-10-20T21:47:10Z

+    if (!fromModel)
+    {
+        // If the input topology link isn't set by the user, the TopologicalMapping::create method tries to find it.
+        // If it is null at this point, it means no input mesh topology could be found.
+        msg_error() << "No input mesh topology found. Consider setting the '" << fromModel.getName() << "' data attribute.";
+        modelsOk = false;
+    }


2 remarks regarding this check:

This case is never possible because fromModel is already checked in the mother class TopologicalMapping in the canCreate method. If input and output don't link to valid BaseMeshTopology, the mapping is not create (canCreate return false)

Hopefully this case is never possible because if fromModel is null, printing error message with fromModel.getName() will crash 😄

epernod · 2022-10-20T21:52:16Z

+        if (!dynamic_cast<container::dynamic::TriangleSetTopologyContainer *>(toModel.get()))
+        {
+            msg_error() << "The input topology '" << toModel.getPath() << "' is not homogeneous with a TriangleSetTopologyContainer. The '" << toModel.getName() << "' data attribute must be linked to a valid component, among the following list of eligible components:" << msgendl
+                                   << sofa::core::ObjectFactory::getInstance()->listClassesDerivedFrom<container::dynamic::TriangleSetTopologyContainer>();


I tested what would be the error message. In this mapping case, it is:
data attribute must be linked to a valid component, among the following list of eligible components: TetrahedronSetTopologyContainer, TriangleSetTopologyContainer

which doesn't work, because putting a TetrahedronSetTopologyContainer as output will result in a strange behavior. Not sure if it will crash or if it will be like a "TopologicalIdentityMapping" 🤔

I suggest to move the checks inside a commun method in TopologicalMapping and just test the topologyType of the containters

epernod · 2022-10-20T21:54:54Z

+    else
+    {
+        // Making sure the input topology includes triangle elements
+        if (fromModel.get()->getNbTriangles() != 0)


This could still be valid if we start from an empty mesh and we add progressively triangles with a mapping on the edges... btw I thought I had a test on that.

epernod · 2022-10-25T23:06:00Z

[ci-build][with-all-tests]

hugtalbot · 2022-10-26T09:08:37Z

New approach proposed in the TopologicalMapping to make the checks on input/output topologies. Some missing implementation and find a solution to get the topological element name from enum class. New review needed

…or messages

epernod · 2022-10-26T10:34:25Z

I moved all changes related to TopologicalMapping into the PR #3428 for better clarity.
Therefor this one depends on this new PR.

…TopologicalMapping.h to test input/output

…ing.h

…calMapping

hugtalbot · 2022-10-28T09:53:36Z

If my last question is answered by @epernod (see here), then good to be merged IMO

hugtalbot · 2022-11-02T08:36:43Z

To be rebased once #3428 is merged, then ready

epernod · 2022-11-02T16:34:20Z

et 💥 !!

hugtalbot · 2022-11-02T18:35:42Z

aw aw aw @epernod !

😁

hugtalbot · 2022-11-02T18:38:41Z

it seems mostly to be the case of a grid linked :

The type of the input topology '@../grid' does not correspond to a valid 'Hexahedron' topology.

epernod · 2022-11-02T21:55:57Z

yes and it is "funny" because I had the same issue in #3368
this is just because Grid inherite from MeshTopology which doesn't define the TopoogyType as Hexahedron

fredroy · 2022-11-04T05:34:30Z

Failing scenes were fixed in #3453 a fortiori, lets merge with master and have a final check

hugtalbot added pr: status to review To notify reviewers to review this pull-request pr: clean Cleaning the code labels Sep 27, 2022

alxbilger reviewed Sep 27, 2022

View reviewed changes

Comment thread ...mponent/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.cpp Outdated

hugtalbot added pr: status wip Development in the pull-request is still in progress and removed pr: status to review To notify reviewers to review this pull-request labels Sep 28, 2022

hugtalbot requested a review from alxbilger September 29, 2022 12:18

hugtalbot added pr: status to review To notify reviewers to review this pull-request and removed pr: status wip Development in the pull-request is still in progress labels Sep 29, 2022

epernod reviewed Sep 29, 2022

View reviewed changes

fredroy added pr: status wip Development in the pull-request is still in progress and removed pr: status to review To notify reviewers to review this pull-request labels Oct 5, 2022

epernod requested changes Oct 20, 2022

View reviewed changes

epernod added pr: status to review To notify reviewers to review this pull-request and removed pr: status wip Development in the pull-request is still in progress labels Oct 25, 2022

hugtalbot commented Oct 26, 2022

View reviewed changes

Comment thread ...mponent/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.cpp Outdated

hugtalbot commented Oct 26, 2022

View reviewed changes

Comment thread ...mponent/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.cpp Outdated

hugtalbot commented Oct 26, 2022

View reviewed changes

Comment thread Sofa/framework/Geometry/src/sofa/geometry/ElementType.h

hugtalbot added pr: status wip Development in the pull-request is still in progress and removed pr: status to review To notify reviewers to review this pull-request labels Oct 26, 2022

epernod added 4 commits October 26, 2022 12:15

[TopologicalMapping] move some implementation into cpp file

4ffec70

[Geometry] Add method to convert elementType into const char* for err…

4ffb541

…or messages

Add method in TopologicalMapping to check the type of element

6ec5480

[Topology] Some more cleaning in TopologicalMapping

2394781

hugtalbot and others added 3 commits October 26, 2022 13:28

Update error message to better guide the user

104cebf

[topology.mapping] Update all topological mapping ot use method from …

4f245b7

…TopologicalMapping.h to test input/output

[topology.mapping] Fix edge2QuadTopologicalMapping types

6030f26

epernod force-pushed the check_topologicalmapping_init branch from 65d06d6 to 6030f26 Compare October 26, 2022 11:31

hugtalbot added 3 commits October 28, 2022 11:38

fix compilation due to removal of getLoc2GlobVec() in TopologicalMapp…

ec04fce

…ing.h

Add warning notifying the requested types from this specific Topologi…

ba0cdb9

…calMapping

remove unused variable

4e92ffa

hugtalbot added pr: status to review To notify reviewers to review this pull-request and removed pr: status wip Development in the pull-request is still in progress labels Oct 28, 2022

Merge branch 'master' into check_topologicalmapping_init

af6af33

hugtalbot mentioned this pull request Nov 2, 2022

findLinkDest() searching in parent nodes #3449

Open

Merge branch 'master' into check_topologicalmapping_init

52aa532

epernod added pr: status wip Development in the pull-request is still in progress and removed pr: status to review To notify reviewers to review this pull-request labels Nov 2, 2022

[MeshTopology FIx missing ElementType attribution at init

84dbf2f

epernod added pr: status to review To notify reviewers to review this pull-request and removed pr: status wip Development in the pull-request is still in progress labels Nov 2, 2022

epernod mentioned this pull request Nov 3, 2022

[Examples] Fix & Clean ProjectToPlaneConstraint and RegularGridTopology_dimension scenes #3453

Merged

Merge branch 'master' into check_topologicalmapping_init

4686a02

fredroy added pr: status ready Approved a pull-request, ready to be squashed and removed pr: status to review To notify reviewers to review this pull-request labels Nov 4, 2022

fredroy merged commit a2105d0 into sofa-framework:master Nov 4, 2022

hugtalbot added this to the v22.12 milestone Dec 5, 2022

Conversation

hugtalbot commented Sep 27, 2022

Uh oh!

hugtalbot commented Sep 27, 2022

Uh oh!

hugtalbot commented Sep 27, 2022

Uh oh!

alxbilger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hugtalbot commented Sep 28, 2022

Uh oh!

hugtalbot commented Sep 29, 2022

Uh oh!

epernod left a comment

Choose a reason for hiding this comment

Uh oh!

epernod left a comment

Choose a reason for hiding this comment

Uh oh!

epernod Oct 20, 2022

Choose a reason for hiding this comment

Uh oh!

epernod Oct 20, 2022

Choose a reason for hiding this comment

Uh oh!

epernod Oct 20, 2022

Choose a reason for hiding this comment

Uh oh!

epernod commented Oct 25, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugtalbot commented Oct 26, 2022

Uh oh!

epernod commented Oct 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugtalbot commented Oct 28, 2022

Uh oh!

hugtalbot commented Nov 2, 2022

Uh oh!

epernod commented Nov 2, 2022

Uh oh!

hugtalbot commented Nov 2, 2022

Uh oh!

hugtalbot commented Nov 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

epernod commented Nov 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fredroy commented Nov 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

epernod commented Oct 26, 2022 •

edited

Loading

hugtalbot commented Nov 2, 2022 •

edited

Loading

epernod commented Nov 2, 2022 •

edited

Loading