refactor: Remove getDataContext duplication #3895

arng40 · 2025-10-31T16:08:26Z

Remove all getDataContext() / getWrapperDataContext() / getName() written directly in the error message strings (getDataContext() << “: blabla”).
Add missing DataContexts when they are not present in the error DataContext parameters (GEOS_ERROR*, GEOS_ASSERT*, GEOS_WARNING*, GEOS_THROW*)

…file

…necessary

… link between GEOS_THROW_CTX_IF and LVARRAY_THROW_IF_TEST( EXP, MSG, TYPE )

… in try/catch statements Problem: Retrieves everything that was thrown, so not just the message.

…/catch in main)": remove useless try/catch

…y spaces. The previous condition checked whether an argument was present and whether the option was immediately followed by a value like -test"value", which excluded valid cases like -test "value" et -test "value".

…t is expected.

…-dataContext

scripts/ci_build_and_test_in_container.sh

src/coreComponents/physicsSolvers/LinearSolverParameters.cpp

src/coreComponents/physicsSolvers/NonlinearSolverParameters.cpp

src/coreComponents/physicsSolvers/LinearSolverParameters.cpp

src/coreComponents/physicsSolvers/PhysicsSolverBase.cpp

src/coreComponents/physicsSolvers/surfaceGeneration/SurfaceGenerator.cpp

src/coreComponents/fieldSpecification/EquilibriumInitialCondition.cpp

MelReyCG · 2025-12-17T14:30:47Z

src/coreComponents/fieldSpecification/PerfectlyMatchedLayer.cpp

 {
  GEOS_THROW_IF( (m_xMax[0]<m_xMin[0] || m_xMax[1]<m_xMin[1] || m_xMax[2]<m_xMin[2]),
-                 getCatalogName() << " " << getDataContext() << " "
+                 getCatalogName() << " "


Suggested change

getCatalogName() << " "

There are still more below.

src/coreComponents/fieldSpecification/TractionBoundaryCondition.cpp

MelReyCG · 2025-12-17T14:33:14Z

src/coreComponents/fileIO/Outputs/SiloOutput.cpp

+                 GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",
+                           catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),


Suggested change

GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",

catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),

GEOS_FMT( "The flag `{}` is different from zero, but `{}` is empty, which is inconsistent",

onlyPlotSpecifiedFieldNamesString, fieldNamesString ),

There are still data contexts in messages below, rather than in the macro parameters

MelReyCG · 2025-12-17T14:33:46Z

src/coreComponents/fileIO/Outputs/VTKOutput.cpp

+                 GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",
+                           catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),


Suggested change

GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",

catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),

GEOS_FMT( "the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",

onlyPlotSpecifiedFieldNamesString, fieldNamesString ),

&↓∞

There are still data contexts in messages below, rather than in the macro parameters
There are still catalog name too

MelReyCG · 2025-12-17T14:40:29Z

@arng40 requested a lot of unmeaningful catalog-name / prefixes deletion as:

they do not adds up useful info,
some of the prefixes should not be shown to the user (internal type names),
if we want to generalize this, we should implement that in the DataContext class, to keep track of the input file type.

…-dataContext

MelReyCG · 2025-12-30T13:18:09Z

src/coreComponents/fieldSpecification/EquilibriumInitialCondition.cpp

+                   "Mismatch between the size of " <<
                   viewKeyStruct::componentNamesString() <<
                   " and " << viewKeyStruct::componentFractionVsElevationTableNamesString(),
                   InputError );


Forgotten data context here?

MelReyCG · 2025-12-30T13:27:52Z

src/coreComponents/fieldSpecification/PerfectlyMatchedLayer.cpp

 {
  GEOS_THROW_IF( (m_xMax[0]<m_xMin[0] || m_xMax[1]<m_xMin[1] || m_xMax[2]<m_xMin[2]),
-                 getCatalogName() << " " << getDataContext() << " "
+                 getCatalogName() << " "


There are still more below.

MelReyCG · 2025-12-30T13:33:54Z

src/coreComponents/fileIO/Outputs/SiloOutput.cpp

+                 GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",
+                           catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),


There are still data contexts in messages below, rather than in the macro parameters

MelReyCG · 2025-12-30T13:36:22Z

src/coreComponents/fileIO/Outputs/VTKOutput.cpp

+                 GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",
+                           catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),


There are still data contexts in messages below, rather than in the macro parameters
There are still catalog name too

MelReyCG · 2025-12-30T13:49:11Z

src/coreComponents/mesh/ElementRegionManager.hpp

-                         subRegion.getDataContext() <<
-                         ": Material " << constitutiveRelation.getDataContext() <<
-                         " does not contain " << viewName,
+                         "Material "<< constitutiveRelation.getName() << "does not contain " << viewName,


lacks a space

MelReyCG · 2025-12-30T14:00:56Z

src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp

+      ErrorLogger::global().currentErrorMsg()
+        .addToMsg( errorMsg )
+        .addContextInfo( getDataContext().getContextInfo().setPriority( 1 ) );


MelReyCG · 2025-12-30T14:05:16Z

src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp

-                   "WellControls " << wellControls.getName() <<
-                   " : Injection stream not specified for well " << subRegion.getName(),
-                   InputError );
+                   "Injection stream not specified for well " << subRegion.getName(),


For those 4 messages, should we have "[...] for well sub-region " << subRegion.getName()? To ease readaction, can you give an instance of what is output from one of these messages? (from a real case)

MelReyCG · 2025-12-30T14:14:21Z

src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp

+                 getWrapperDataContext( viewKeyStruct::injectionStreamString() ),
+                 getWrapperDataContext( viewKeyStruct::injectionTemperatureString() ) );


I think the output will be strange with two data contexts here, what about just one getDataContext()

MelReyCG · 2025-12-30T14:15:25Z

src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp

                  (m_targetMassRate <= 0.0 && m_targetMassRateTableName.empty()) &&
                  (m_targetTotalRate <= 0.0 && m_targetTotalRateTableName.empty())),
-                 "WellControls " << getDataContext() << ": You need to specify a phase, mass, or total rate constraint. \n" <<
+                 "You need to specify a phase, mass, or total rate constraint. \n" <<


Doesn't this message lacks some separators?

MelReyCG · 2025-12-30T14:31:44Z

src/coreComponents/physicsSolvers/multiphysics/PoromechanicsSolver.hpp

-                     InputError );
+                     GEOS_FMT( "Region `{}` must be a target region of `{}`",
+                               poromechanicsTargetRegionNames[i], this->flowSolver()->getCatalogName() ),
+                     InputError, this->getDataContext(), this->solidMechanicsSolver()->getDataContext() );


Suggested change

InputError, this->getDataContext(), this->solidMechanicsSolver()->getDataContext() );

InputError, this->getDataContext(), this->flowSolver()->getDataContext() );

amandinehry added 30 commits April 25, 2025 17:05

creation of an object header that logs errors and warnings in a yaml …

c846586

…file

Set up ErrorHandling

f1713fa

traits errors commented (to treat)

4e5250f

Set up test

94b775c

Modification to properly format the yaml so that it can be parsed if …

1cb8aa3

…necessary

Test to add variadic arguments

9d5e16a

draft: retrieve data contexts info

2f7660c

Added additional information in the yaml - not functional missing the…

6036551

… link between GEOS_THROW_CTX_IF and LVARRAY_THROW_IF_TEST( EXP, MSG, TYPE )

First attempt at outputting exceptions

46b4904

Complete: code for outputting errors into yaml

e1aed93

Manage the text contained in the potential exception

bc953be

First attempt: Handling the text contained in the potential exception…

1a434bc

… in try/catch statements Problem: Retrieves everything that was thrown, so not just the message.

Complete: yaml output for PVT tables error

acf4d99

YAML error message well formatted

ee58884

Fix duplication error

32a0237

Add variadic parameters to GEOS_THROW_CTX_IF

589270f

Reorganization after operational tests

9b65581

Apply the output error functionality in yaml to all geos errors

b13f0a6

Latest update for exception handling (try/catch in main)

6de2c6a

Add priority to the error message into the yaml file

5830aee

Update of the commit named "latest update for exception handling (try…

2b27c41

…/catch in main)": remove useless try/catch

set priority

86f793e

errors cli modification: add --errors-output

8a8117e

errors cli modification: add --errors-output

2c0f5aa

Replace original macros

eb2f691

Correction: replace original macros

7b5f293

Reacting with the command line option -e / --errors-output

670ddfa

Add the rank on which the error is catch for error and warning outputs

d08a30f

Unit test to check if the contents of the yaml file match exactly wha…

5a6c1a0

…t is expected.

arng40 requested a review from corbett5 as a code owner November 5, 2025 10:56

arng40 changed the title ~~Remove getDataContext duplication~~ refactor: Remove getDataContext duplication Nov 5, 2025

arng40 added ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI flag: no rebaseline Does not require rebaseline labels Nov 5, 2025

arng40 and others added 6 commits November 12, 2025 10:43

fix test & uncrustidy

9addc80

Merge remote-tracking branch 'origin/develop' into feat/dudes/display…

d60f75a

…-dataContext

Merge branch 'develop' into feat/dudes/display-dataContext

1b4f141

Merge remote-tracking branch 'origin/develop' into feat/dudes/display…

9a6d5d7

…-dataContext

fix error

a58f6c9

xsd

49d9930

arng40 requested a review from herve-gross as a code owner December 3, 2025 15:02

arng40 and others added 5 commits December 3, 2025 16:19

2nd pass

5dafc09

2nd pass

02c2a23

Merge branch 'develop' into feat/dudes/display-dataContext

d35793c

Merge branch 'develop' into feat/dudes/display-dataContext

39d078d

Merge branch 'develop' into feat/dudes/display-dataContext

df759b1

MelReyCG approved these changes Dec 17, 2025

View reviewed changes

scripts/ci_build_and_test_in_container.sh Outdated Show resolved Hide resolved

MelReyCG requested changes Dec 17, 2025

View reviewed changes

arng40 and others added 9 commits December 18, 2025 17:11

another pass

e994ab1

log output fix

8f85f7e

Another pass on all files

ff90325

fix dataContext

d94e0d7

fix tests

37100ff

Merge branch 'develop' into feat/dudes/display-dataContext

f40029f

another pass on datacontext

025ac97

Merge remote-tracking branch 'origin/develop' into feat/dudes/display…

2a02eda

…-dataContext

uncrustfy

1587ac0

MelReyCG requested changes Dec 30, 2025

View reviewed changes

		GEOS_FMT( "{} : the flag `{}` is different from zero, but `{}` is empty, which is inconsistent",
		catalogName(), onlyPlotSpecifiedFieldNamesString, fieldNamesString ),

		getWrapperDataContext( viewKeyStruct::injectionStreamString() ),
		getWrapperDataContext( viewKeyStruct::injectionTemperatureString() ) );

	InputError, this->getDataContext(), this->solidMechanicsSolver()->getDataContext() );
	InputError, this->getDataContext(), this->flowSolver()->getDataContext() );

refactor: Remove getDataContext duplication #3895

Are you sure you want to change the base?

refactor: Remove getDataContext duplication #3895

Uh oh!

Conversation

arng40 commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MelReyCG commented Dec 17, 2025

Uh oh!

MelReyCG Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

arng40 commented Oct 31, 2025 •

edited

Loading

MelReyCG Dec 30, 2025 •

edited

Loading