Add more context to errors - mesh/ files #2450

MelReyCG · 2023-05-16T08:28:16Z

This PR uses the features added the PR #2404 to add more context to the errors messages of classes in src/coreComponents/mesh files.
In particular, this PR aims to add the lines of the XML elements from which an error message comes from.

See issue and attached files describing error message changes: #2320

- Added SourceContext to know where Groups/Wrappers has been declared - Added a test for the node & attribute line infos

…y/2320-xml-errors-feedback" - using getSourceContext() instead of getPath()

…ack-3' into feature/rey/error-xml-line-2-errors-impacting

- also renaming FileContext to DataFileContext

- code refactoring + doc edit

+ virtual destructors

…l-line-mesh

…xml-line-2

+ get type name by using catalogName() method

src/coreComponents/mesh/generators/InternalWellGenerator.cpp

TotoGaz

I'll move this out of the merge queue because there are some pending questions.

TotoGaz · 2023-09-20T00:51:28Z

src/coreComponents/mesh/CellElementRegion.cpp

@@ -24,7 +24,7 @@ CellElementRegion::CellElementRegion( string const & name, Group * const parent
  ElementRegionBase( name, parent )
 {
  registerWrapper( viewKeyStruct::sourceCellBlockNamesString(), &m_cellBlockNames ).
-    setInputFlag( InputFlags::OPTIONAL );
+    setInputFlag( InputFlags::REQUIRED );


This will change the rst file. And maybe will require a rebaseline.

MelReyCG · 2023-09-21T12:36:43Z

What really matters is

GEOS/src/uncrustify.cfg

Line 1585 in 7f0065a

code_width = 200 # unsigned number

@TotoGaz Just to clarify, are you talking about string values or about every code lines? Is their an exception for string values?
Do you want me to remove unnecessary line returns ?

…xml-line-mesh

rrsettgast · 2023-10-11T03:48:59Z

What really matters is

GEOS/src/uncrustify.cfg

Line 1585 in 7f0065a

code_width = 200 # unsigned number

@TotoGaz Just to clarify, are you talking about string values or about every code lines? Is their an exception for string values? Do you want me to remove unnecessary line returns ?

There is no hard limit. We were trying to stay under 100 characters, but that even seems low now. I was purposefully lenient. 120 is probably more realistic as a goal. Of course sometimes it makes sense to go longer, so it is allowed. It is at your discretion.

paveltomin · 2023-10-12T19:11:15Z

@MelReyCG clean up and move back into merge queue?

rrsettgast · 2023-10-26T05:13:08Z

@TotoGaz is this good to go in?

MelReyCG · 2023-10-27T08:21:21Z

@sframba ran the integrated tests on it (thanks!), and 5 tests failed:

acoustic_vti_smoke_0{1,8}
particleRepartition
dfgMovingGrid
singleParticle

The first two are potentially failing due to another PR, and we don't think that the three last failed because of this PR.

CusiniM · 2023-10-27T19:28:53Z

@sframba ran the integrated tests on it (thanks!), and 5 tests failed:
* acoustic_vti_smoke_0{1,8}

* particleRepartition

* dfgMovingGrid

* singleParticle
The first two are potentially failing due to another PR, and we don't think that the three last failed because of this PR.

this should be fixed in the latest develop

TotoGaz

I'm fine merging this, there are questions that can be answered afterward.

TotoGaz · 2023-11-02T21:42:32Z

src/coreComponents/mesh/ElementType.hpp

@@ -109,6 +109,9 @@ ENUM_STRINGS( ElementType,
              "HendecagonalPrism",
              "Polyhedron" );

+/// String available for mesh errors
+inline auto constexpr generalMeshErrorAdvice = "\nPlease consider checking the validity of your mesh with the `mesh_doctor` GEOS python tools.";


If possible, could you add the URL https://geosx-geosx.readthedocs-hosted.com/en/latest/docs/sphinx/pythonTools/mesh_doctor.html?
Also, could you remove the initial \n?

TotoGaz · 2023-11-02T21:43:41Z

src/coreComponents/mesh/generators/InternalMeshGenerator.cpp

@@ -140,7 +140,7 @@ void InternalMeshGenerator::postProcessInput()
    }
    if( failFlag )
    {
-      GEOS_ERROR( "vertex/element mismatch InternalMeshGenerator::ReadXMLPost()" );
+      GEOS_ERROR( getDataContext() << ": vertex/element mismatch." << generalMeshErrorAdvice );


Suggested change

GEOS_ERROR( getDataContext() << ": vertex/element mismatch." << generalMeshErrorAdvice );

GEOS_ERROR( getDataContext() << ": vertex/element mismatch.\n" << generalMeshErrorAdvice );

Then this would be it?

TotoGaz · 2023-11-02T21:49:31Z

src/coreComponents/mesh/generators/VTKUtilities.cpp

@@ -531,7 +534,7 @@ loadMesh( Path const & filePath,
    case VTKMeshExtension::pvti: return parallelRead( vtkSmartPointer< vtkXMLPImageDataReader >::New() );
    default:
    {
-      GEOS_ERROR( extension << " is not a recognized extension for VTKMesh. Please use .vtk, .vtu, .vtr, .vts, .vti, .pvtu, .pvtr, .pvts or .ptvi." );
+      GEOS_ERROR( extension << " is not a recognized extension for VTKMesh. Please use ." << EnumStrings< VTKMeshExtension >::concat( ", ." ) );


The previous list did not contain vtm, the new list does. Is it intended?

Yes, as it is managed by this switch, I think we should list vtm as a compatible extension.

TotoGaz · 2023-11-02T21:52:24Z

src/coreComponents/mesh/generators/VTKUtilities.cpp

-                             "Make sure partitionRefinement is set to 1 or higher (this may help).",
-                             pointGlobalID ) );
+                   GEOS_FMT( "At least one duplicate point detected (globalID = {}).{}\n"
+                             "Potential fixes :\n- Consider cleaning the dataset in Paraview using 'Clean to grid' filter.\n"


Do we really want to advise the usag of clean to grid? My XP with this tool was not great. @jeannepellerin ?

I asked her, we don't need to recommend that to the user as it is not reliable. I will remove this advice.

MelReyCG and others added 27 commits March 23, 2023 14:17

Adding context to errors when reading wrapper from xml

7601706

added XML hierarchy to the wrapper parsing error

622f8d6

Modified testXmlWrapper so it expect exceptions

a5fb1fe

Changed the regexs so the schema detects more errors

4524704

updating LvArray submodule

c36a052

Adding documentation

081939c

added C++17 string_view comments

a123a15

- Added the ability to know the line of xml nodes & attributes

0b1cd21

- Added SourceContext to know where Groups/Wrappers has been declared - Added a test for the node & attribute line infos

merge branch "feature/rey/error-xml-line-2" with PR branch "bugfix/re…

7a7331f

…y/2320-xml-errors-feedback" - using getSourceContext() instead of getPath()

Merge remote-tracking branch 'origin/bugfix/rey/2320-xml-errors-feedb…

d56087e

…ack-3' into feature/rey/error-xml-line-2-errors-impacting

Indentation, code style, naming

fb418c8

Renaming SourceContext to DataContext

e995b0c

- also renaming FileContext to DataFileContext

comment update in Logger.hpp

7b793c9

- Added xml line to messages from PR 2341 & 2357

e1af0c6

- code refactoring + doc edit

Added getWrapperDataContext()

3e95803

uncrustify + documentation corrections

cbfa507

added compatibility with GEOS_FMT

c69a98d

+ virtual destructors

Added more context in various mesh/ error messages

552ae0c

Adapted getGroupByPath test with new error message

703d88b

error message improvements + bugfixes + removed unused header

7a7e053

Group::printDataHierarchy : wrapper type fix + layout

9445618

Merge branch 'feature/rey/error-xml-line-2' into feature/rey/error-xm…

e289be9

…l-line-mesh

perforation error message improvement

10fef50

made "cellBlocks" attribute a required one

197ae38

Error messages slight improvements + uncrustify

e644d86

Merge branch 'develop' into feature/rey/error-xml-line-2

f25415e

Merge remote-tracking branch 'origin/develop' into feature/rey/error-…

8f26f6d

…xml-line-2

MelReyCG mentioned this pull request May 16, 2023

Add Group & Wrapper source XML line in errors #2404

Merged

Merge remote-tracking branch 'origin/develop' into feature/rey/error-…

7d08ddc

…xml-line-2

MelReyCG mentioned this pull request May 16, 2023

Add more context to errors - other files #2449

Merged

MelReyCG added 6 commits September 15, 2023 10:27

merge mistake fix

b3ffe3a

GroupContext::toString(): showing file-name instead of file-path

c85cc91

Show InternalWell name instead of region name

fa57ee3

+ get type name by using catalogName() method

InternalWell error message refactoring

642d444

error message factorization

37103ea

compilation fixes

5dc1dbf

TotoGaz approved these changes Sep 19, 2023

View reviewed changes

src/coreComponents/mesh/generators/InternalWellGenerator.cpp Show resolved Hide resolved

TotoGaz requested changes Sep 20, 2023

View reviewed changes

MelReyCG mentioned this pull request Sep 22, 2023

[EPIC] Improve feedback to user on XML errors #2320

Open

9 tasks

Merge remote-tracking branch 'origin/develop' into feature/rey/error-…

0620854

…xml-line-mesh

rrsettgast and others added 4 commits October 23, 2023 18:48

Merge branch 'develop' into feature/rey/error-xml-line-mesh

1ef175c

A few more message edits

6652854

compil fix + doc

b97246a

Merge branch 'develop' into feature/rey/error-xml-line-mesh

61949b6

rrsettgast added the ci: run CUDA builds Allows to triggers (costly) CUDA jobs label Oct 26, 2023

Merge branch 'develop' into feature/rey/error-xml-line-mesh

80670af

Merge branch 'develop' into feature/rey/error-xml-line-mesh

6728e89

paveltomin requested a review from TotoGaz November 2, 2023 21:19

TotoGaz approved these changes Nov 2, 2023

View reviewed changes

TotoGaz merged commit c7add46 into develop Nov 2, 2023
18 checks passed

TotoGaz deleted the feature/rey/error-xml-line-mesh branch November 2, 2023 21:55

MelReyCG mentioned this pull request Nov 22, 2023

A few mesh messages edit #2844

Merged

ouassimkh pushed a commit that referenced this pull request Feb 16, 2024

Add more context to errors - mesh/ files (#2450)

9005a00

paveltomin mentioned this pull request Feb 27, 2024

Error at mesh loading in serial with same mesh loaded in parallel #2262

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more context to errors - mesh/ files #2450

Add more context to errors - mesh/ files #2450

MelReyCG commented May 16, 2023 •

edited

Loading

TotoGaz left a comment

TotoGaz Sep 20, 2023

MelReyCG commented Sep 21, 2023 •

edited

Loading

rrsettgast commented Oct 11, 2023

paveltomin commented Oct 12, 2023

rrsettgast commented Oct 26, 2023

MelReyCG commented Oct 27, 2023 •

edited

Loading

CusiniM commented Oct 27, 2023

TotoGaz left a comment

TotoGaz Nov 2, 2023

TotoGaz Nov 2, 2023

TotoGaz Nov 2, 2023

MelReyCG Nov 13, 2023

TotoGaz Nov 2, 2023

MelReyCG Nov 13, 2023

	GEOS_ERROR( getDataContext() << ": vertex/element mismatch." << generalMeshErrorAdvice );
	GEOS_ERROR( getDataContext() << ": vertex/element mismatch.\n" << generalMeshErrorAdvice );

Add more context to errors - mesh/ files #2450

Add more context to errors - mesh/ files #2450

Conversation

MelReyCG commented May 16, 2023 • edited Loading

TotoGaz left a comment

Choose a reason for hiding this comment

TotoGaz Sep 20, 2023

Choose a reason for hiding this comment

MelReyCG commented Sep 21, 2023 • edited Loading

rrsettgast commented Oct 11, 2023

paveltomin commented Oct 12, 2023

rrsettgast commented Oct 26, 2023

MelReyCG commented Oct 27, 2023 • edited Loading

CusiniM commented Oct 27, 2023

TotoGaz left a comment

Choose a reason for hiding this comment

TotoGaz Nov 2, 2023

Choose a reason for hiding this comment

TotoGaz Nov 2, 2023

Choose a reason for hiding this comment

TotoGaz Nov 2, 2023

Choose a reason for hiding this comment

MelReyCG Nov 13, 2023

Choose a reason for hiding this comment

TotoGaz Nov 2, 2023

Choose a reason for hiding this comment

MelReyCG Nov 13, 2023

Choose a reason for hiding this comment

MelReyCG commented May 16, 2023 •

edited

Loading

MelReyCG commented Sep 21, 2023 •

edited

Loading

MelReyCG commented Oct 27, 2023 •

edited

Loading