Ifpack move parameters and options to xml file #400

dharinib98 · 2025-02-19T13:56:02Z

Description and Context

Ifpack parameters have been moved to an xml file like other preconditioners. Input parameters related to Ifpack have bene removed from the code. Further steps include moving it to the back end based on Stratimikos.

Related Issues and Merge Requests

Part of #365

mayrmt · 2025-02-19T14:48:29Z

@dharinib98, this branch needs to be rebased to resolve merge conflicts.

mayrmt

The changes to the input files change the preconditioner for some tests, since the new xml file always use zero overlap and a fill level of 0, while some tests have used different settings. I don't say, that you have to change this. I just want to create awareness for this change.

What are the plans to actually dis-allow the old way of configuring Ifpack preconditioners>

mayrmt · 2025-02-19T14:48:59Z

src/core/linear_solver/src/method/4C_linear_solver_method_linalg.cpp

+  /*ifpacklist.set("fact: level-of-fill", inparams.get<int>("IFPACKGFILL"));
  ifpacklist.set("partitioner: overlap", inparams.get<int>("IFPACKOVERLAP"));
  ifpacklist.set("schwarz: combine mode",
      inparams.get<std::string>("IFPACKCOMBINE"));    // can be "Zero", "Add", "Insert"
  ifpacklist.set("schwarz: reordering type", "rcm");  // "rcm" or "metis" or "amd"
+  */


Suggested change

/*ifpacklist.set("fact: level-of-fill", inparams.get<int>("IFPACKGFILL"));

ifpacklist.set("partitioner: overlap", inparams.get<int>("IFPACKOVERLAP"));

ifpacklist.set("schwarz: combine mode",

inparams.get<std::string>("IFPACKCOMBINE")); // can be "Zero", "Add", "Insert"

ifpacklist.set("schwarz: reordering type", "rcm"); // "rcm" or "metis" or "amd"

*/

mayrmt · 2025-02-19T14:49:19Z

src/core/linear_solver/src/method/4C_linear_solver_method_linalg.cpp

  ifpacklist.set("partitioner: overlap", inparams.get<int>("IFPACKOVERLAP"));
  ifpacklist.set("schwarz: combine mode",
      inparams.get<std::string>("IFPACKCOMBINE"));    // can be "Zero", "Add", "Insert"
  ifpacklist.set("schwarz: reordering type", "rcm");  // "rcm" or "metis" or "amd"
+  */
+
+  std::string xmlfile = inparams.get<std::string>("IFPACK_XML_FILE");


Suggested change

std::string xmlfile = inparams.get<std::string>("IFPACK_XML_FILE");

const std::string xmlfile = inparams.get<std::string>("IFPACK_XML_FILE");

... and also at other places throughout this PR.

mayrmt · 2025-02-19T14:51:00Z

tests/input_files/beam3r_line2_backweuler_browndyn_largesys.dat

+IFPACK_XML_FILE                 xml/ifpack.xml
 IFPACKCOMBINE          Zero


Suggested change

IFPACK_XML_FILE xml/ifpack.xml

IFPACKCOMBINE Zero

IFPACK_XML_FILE xml/ifpack.xml

IFPACKCOMBINE Zero

Yet another reason to use yaml for input files :)

yes, this is also the case with overlap values, not all files use a value of 0. Based on the number of tests that fail, we can think about a solution by maybe adding another xml file for the higher gfill values

We can have one or two default xml files in the central xml file collection. If individual tests require a specialized preconditioned, then we can put the xml file just next to the input file.

mayrmt · 2025-02-19T15:06:46Z

tests/input_files/beam3r_line2_backweuler_browndyn_largesys.dat

@@ -61,8 +61,7 @@ AZTOL                  1.0E-3
 AZCONV                 AZ_r0
 AZITER                 1000
 AZSUB                  50
-IFPACKGFILL            1
-IFPACKOVERLAP          1
+IFPACK_XML_FILE                 xml/ifpack.xml


This places the xml file into the top level directory of all xml files for solvers/preconditioners. There is an existing folder structure. @maxfirmbach, should we sort it into the folder structure? If yes, where? Into a new directory?

@dharinib98 @mayrmt We need to figure out a place, not sure where it fits best, in theory we could just create a folder called preconditioner and put all preconditioner related .xml files there with an updated naming scheme. So xml/preconditioner/ifpack.xml would work for me right now.

maxfirmbach

I have one major point I would like to change. Currently AZPREC is called ILU, which I would like to switch to Ifpack to be consistent with all other AZPREC package calls e.g. MueLu and Teko. This will for sure change again soon, but for now we are not limited to ILU by using the .xml file as one could also use ILUT or even just a Jacobi method.

maxfirmbach · 2025-02-19T17:17:17Z

tests/input_files/beam3r_line2_backweuler_browndyn_largesys.dat

@@ -61,8 +61,7 @@ AZTOL                  1.0E-3
 AZCONV                 AZ_r0
 AZITER                 1000
 AZSUB                  50
-IFPACKGFILL            1
-IFPACKOVERLAP          1
+IFPACK_XML_FILE                 xml/ifpack.xml


@dharinib98 @mayrmt We need to figure out a place, not sure where it fits best, in theory we could just create a folder called preconditioner and put all preconditioner related .xml files there with an updated naming scheme. So xml/preconditioner/ifpack.xml would work for me right now.

maxfirmbach · 2025-02-19T17:26:32Z

The changes to the input files change the preconditioner for some tests, since the new xml file always use zero overlap and a fill level of 0, while some tests have used different settings. I don't say, that you have to change this. I just want to create awareness for this change.

What are the plans to actually dis-allow the old way of configuring Ifpack preconditioners>

@mayrmt We will use the provided .xml file for now and see how many tests fail. From that point on we slowly work towards passing all tests with a minimal set of configs.

sebproell · 2025-02-20T09:55:31Z

src/inpar/4C_inpar_solver.cpp

+      Core::Utils::string_parameter(
+          "IFPACK_XML_FILE", "none", "xml file defining any IFPACK options", &list);


We can read files in a better way (so that relative paths are correctly resolved). See e.g. https://github.com/4C-multiphysics/4C/blob/main/src/inpar/4C_inpar_solver.cpp#L104-L108

mayrmt · 2025-02-20T12:09:52Z

src/core/linear_solver/src/preconditioner/4C_linear_solver_preconditioner_ifpack.cpp

-    // get the type of ifpack preconditioner from solver parameter list
-    std::string prectype = solverlist_.get("Preconditioner Type", "ILU");
-    const int overlap = ifpacklist_.get("IFPACKOVERLAP", 0);
+    std::string xmlFileName = ifpacklist_.get<std::string>("IFPACK_XML_FILE");


Suggested change

std::string xmlFileName = ifpacklist_.get<std::string>("IFPACK_XML_FILE");

const std::string xmlFileName = ifpacklist_.get<std::string>("IFPACK_XML_FILE");

mayrmt · 2025-02-20T12:11:52Z

src/core/linear_solver/src/preconditioner/4C_linear_solver_preconditioner_ifpack.cpp

+    auto prectype = ifpack_params.get<std::string>("Preconditioner type");
+    auto overlap = ifpack_params.get<int>("Overlap");


Const qualifiers?

Suggested change

auto prectype = ifpack_params.get<std::string>("Preconditioner type");

auto overlap = ifpack_params.get<int>("Overlap");

const std::string prectype = ifpack_params.get<std::string>("Preconditioner type");

const int overlap = ifpack_params.get<int>("Overlap");

dharinib98 self-assigned this Feb 19, 2025

dharinib98 changed the title ~~1361 ifpack move parameters and options to xml file~~ [Draft]1361 ifpack move parameters and options to xml file Feb 19, 2025

sebproell marked this pull request as draft February 19, 2025 14:13

sebproell changed the title ~~[Draft]1361 ifpack move parameters and options to xml file~~ Ifpack move parameters and options to xml file Feb 19, 2025

mayrmt requested a review from maxfirmbach February 19, 2025 14:37

mayrmt reviewed Feb 19, 2025

View reviewed changes

maxfirmbach reviewed Feb 19, 2025

View reviewed changes

maxfirmbach added status: under review Issues undergoing review during a pull request type: enhancement A new feature or enhancement to be implemented team: solvers labels Feb 19, 2025

dharinib98 added 5 commits February 20, 2025 10:42

Add Ifpack xml file

571d2dd

Add xml file for ifpack

ad77c44

Add parameter list

2764b4f

Refactor gfilloverlap parameter in tests

d4ca631

Refactor all testcases

0cdbd4a

dharinib98 force-pushed the 1361-ifpack-move-parameters-and-options-to-xml-file branch from eab2e0e to 0cdbd4a Compare February 20, 2025 09:48

sebproell reviewed Feb 20, 2025

View reviewed changes

dharinib98 added 2 commits February 20, 2025 11:23

Minor Changes

aae3c1e

Move xml file location

0a76006

mayrmt reviewed Feb 20, 2025

View reviewed changes

Const qualifiers

a60306e

ischeider mentioned this pull request Feb 26, 2025

Update documentation,analysis guide->linearsolvers #443

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ifpack move parameters and options to xml file #400

Ifpack move parameters and options to xml file #400

dharinib98 commented Feb 19, 2025 •

edited

Loading

mayrmt commented Feb 19, 2025

mayrmt left a comment

mayrmt Feb 19, 2025

mayrmt Feb 19, 2025

mayrmt Feb 19, 2025

sebproell Feb 19, 2025

dharinib98 Feb 19, 2025

mayrmt Feb 19, 2025

mayrmt Feb 19, 2025

maxfirmbach Feb 19, 2025

maxfirmbach left a comment

maxfirmbach Feb 19, 2025

maxfirmbach commented Feb 19, 2025

sebproell Feb 20, 2025

mayrmt Feb 20, 2025

mayrmt Feb 20, 2025

	std::string xmlfile = inparams.get<std::string>("IFPACK_XML_FILE");
	const std::string xmlfile = inparams.get<std::string>("IFPACK_XML_FILE");

		Core::Utils::string_parameter(
		"IFPACK_XML_FILE", "none", "xml file defining any IFPACK options", &list);

	std::string xmlFileName = ifpacklist_.get<std::string>("IFPACK_XML_FILE");
	const std::string xmlFileName = ifpacklist_.get<std::string>("IFPACK_XML_FILE");

		auto prectype = ifpack_params.get<std::string>("Preconditioner type");
		auto overlap = ifpack_params.get<int>("Overlap");

Ifpack move parameters and options to xml file #400

Are you sure you want to change the base?

Ifpack move parameters and options to xml file #400

Conversation

dharinib98 commented Feb 19, 2025 • edited Loading

Description and Context

Related Issues and Merge Requests

mayrmt commented Feb 19, 2025

mayrmt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxfirmbach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxfirmbach commented Feb 19, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dharinib98 commented Feb 19, 2025 •

edited

Loading