Skip to content

Use enum for SystemSolver preconditioner side #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
verma-divyanshu-git wants to merge 1 commit into
base: verma/enum_change
Choose a base branch
from
Open

Use enum for SystemSolver preconditioner side #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions examples/sysGmres.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ static int sysGmres(int argc, char* argv[]);
static void processInputs(std::string& method,
std::string& gs,
std::string& sketch,
std::string& flexible,
std::string& side);
std::string& flexible);

/// Main function selects example to be run
int main(int argc, char* argv[])
Expand Down Expand Up @@ -166,10 +165,27 @@ int sysGmres(int argc, char* argv[])
opt = options.getParamFromKey("-x");
std::string flexible = opt ? (*opt).second : "yes";

opt = options.getParamFromKey("-p");
std::string side = opt ? (*opt).second : "right";
opt = options.getParamFromKey("-p");
Preconditioner::Side preconditioner_side = Preconditioner::RIGHT;
if (opt)
{
if (opt->second == "left")
{
preconditioner_side = Preconditioner::LEFT;
}
else if (opt->second == "right")
{
preconditioner_side = Preconditioner::RIGHT;
}
else
{
std::cout << "Preconditioning side '" << opt->second
<< "' not recognized. Use 'left' or 'right'.\n";
return 1;
}
}

processInputs(method, gs, sketch, flexible, side);
processInputs(method, gs, sketch, flexible);

std::cout << "Matrix file: " << matrix_pathname << "\n"
<< "RHS file: " << rhs_pathname << "\n";
Expand Down Expand Up @@ -255,7 +271,7 @@ int sysGmres(int argc, char* argv[])
// Set up the preconditioner
if (return_code == 0)
{
status = solver.preconditionerSetup(side);
status = solver.preconditionerSetup(preconditioner_side);
std::cout << "solver.preconditionerSetup returned status: " << status << "\n";
if (status != 0)
{
Expand Down Expand Up @@ -289,7 +305,10 @@ int sysGmres(int argc, char* argv[])
return return_code;
}

void processInputs(std::string& method, std::string& gs, std::string& sketch, std::string& flexible, std::string& side)
void processInputs(std::string& method,
std::string& gs,
std::string& sketch,
std::string& flexible)
{
if (method == "randgmres")
{
Expand Down Expand Up @@ -322,10 +341,4 @@ void processInputs(std::string& method, std::string& gs, std::string& sketch, st
std::cout << "Setting flexible to the default (yes).\n\n";
flexible = "yes";
}

if ((side != "left") && (side != "right"))
{
std::cout << "Preconditioning side " << side << " not recognized.\n";
std::cout << "Setting preconditioning side to the default (right).\n\n";
}
}
20 changes: 2 additions & 18 deletions resolve/SystemSolver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ namespace ReSolve
*
* @return int 0 if successful, 1 if it fails
*/
int SystemSolver::preconditionerSetup(std::string side)
int SystemSolver::preconditionerSetup(Preconditioner::Side side)
{
int status = 0;

Expand All @@ -614,23 +614,7 @@ namespace ReSolve
return status;
}

Preconditioner::Side prec_side;
if (side == "left")
{
prec_side = Preconditioner::LEFT;
}
else if (side == "right")
{
prec_side = Preconditioner::RIGHT;
}
else
{
out::error() << "Preconditioning side '" << side
<< "' not recognized. Use 'left' or 'right'.\n";
return 1;
}

status += preconditioner_->setSide(prec_side);
status += preconditioner_->setSide(side);
status += preconditioner_->setup(A_);

if (memspace_ != "cpu")
Expand Down
2 changes: 1 addition & 1 deletion resolve/SystemSolver.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace ReSolve
int factorize(); // numeric part
int refactorize();
int refactorizationSetup();
int preconditionerSetup(std::string side);
int preconditionerSetup(Preconditioner::Side side);

@pelesh pelesh Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that we want to expose internal enum in SystemSolver API. The SystemSolver class is a wrapper for Re::Solve solvers and it is intended to simplify user interaction with the rest of the library. It takes string inputs as these are read from the command line interface.

I agree that it would be better to avoid string arguments in the SystemSolver class but that would then require expanding parser to select correct enumeration entries based on the CLI inputs. Should we decide to go that route, we should make appropriate changes to all string inputs, not only preconditioner type, to make the code consistent.

int resetPreconditioner(matrix_type* A);
int solve(vector_type* rhs, vector_type* x); // for direct and iterative
int refine(vector_type* rhs, vector_type* x); // for iterative refinement
Expand Down
6 changes: 6 additions & 0 deletions tests/functionality/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,12 @@ add_test(NAME sys_gmres_mgspm_test
COMMAND $<TARGET_FILE:sys_rand_gmres_test.exe> "-x" "no" "-i" "fgmres"
"-g" "mgs_pm"
)
add_test(NAME sys_gmres_invalid_preconditioner_side_test
COMMAND $<TARGET_FILE:sys_rand_gmres_test.exe> "-p" "bogus"
)
set_tests_properties(
sys_gmres_invalid_preconditioner_side_test PROPERTIES WILL_FAIL TRUE
)

# Left-preconditioned Krylov solvers tests (GMRES)
add_test(NAME sys_rand_count_gmres_left_cgs2_test
Expand Down
43 changes: 27 additions & 16 deletions tests/functionality/testSysGmres.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
#include <resolve/matrix/Csr.hpp>
#include <resolve/matrix/MatrixHandler.hpp>
#include <resolve/matrix/io.hpp>
#include <resolve/utilities/logger/Logger.hpp>
#include <resolve/utilities/params/CliOptions.hpp>
#include <resolve/vector/Vector.hpp>
#include <resolve/vector/VectorHandler.hpp>
Expand All @@ -42,7 +43,7 @@ template <class workspace_type>
static int test(int argc, char* argv[]);

/// Checks if inputs are valid, otherwise sets defaults
static void processInputs(std::string& method, std::string& gs, std::string& sketch, std::string& side);
static void processInputs(std::string& method, std::string& gs, std::string& sketch);

/// Creates string with test description
static std::string headerInfo(const std::string& method,
Expand Down Expand Up @@ -103,10 +104,27 @@ int test(int argc, char* argv[])
opt = options.getParamFromKey("-x");
std::string flexible = opt ? (*opt).second : "yes";

opt = options.getParamFromKey("-p");
std::string side = opt ? (*opt).second : "right";
opt = options.getParamFromKey("-p");
ReSolve::Preconditioner::Side preconditioner_side = ReSolve::Preconditioner::RIGHT;
if (opt)
{
if (opt->second == "left")
{
preconditioner_side = ReSolve::Preconditioner::LEFT;
}
else if (opt->second == "right")
{
preconditioner_side = ReSolve::Preconditioner::RIGHT;
}
else
{
std::cout << "Preconditioning side '" << opt->second
<< "' not recognized. Use 'left' or 'right'.\n";
return 1;
}
}

processInputs(method, gs, sketch, side);
processInputs(method, gs, sketch);

// Create workspace and initialize its handles.
workspace_type workspace;
Expand Down Expand Up @@ -169,7 +187,7 @@ int test(int argc, char* argv[])
solver.getIterativeSolver().setCliParam("restart", "200");

// Set preconditioner (default in this case ILU0)
status = solver.preconditionerSetup(side);
status = solver.preconditionerSetup(preconditioner_side);
error_sum += status;

// Solve system
Expand Down Expand Up @@ -206,7 +224,7 @@ int test(int argc, char* argv[])
bad_guess_solver.getIterativeSolver().setCliParam("flexible", flexible);
bad_guess_solver.getIterativeSolver().setCliParam("restart", "200");

status = bad_guess_solver.preconditionerSetup(side);
status = bad_guess_solver.preconditionerSetup(preconditioner_side);
error_sum += status;

const real_type bad_guess_rnorm = bad_guess_solver.getResidualNorm(vec_rhs, &bad_guess_x);
Expand Down Expand Up @@ -235,7 +253,7 @@ int test(int argc, char* argv[])
}
else
{
Log::misc << "Expect a warning on the next line for the bad initial guess test." << std::endl;
ReSolve::io::Logger::misc() << "Expect a warning on the next line for the bad initial guess test." << std::endl;
}

// Use a scaled converged solution as a nonzero initial guess.
Expand All @@ -262,7 +280,7 @@ int test(int argc, char* argv[])
accepted_guess_solver.getIterativeSolver().setCliParam("flexible", flexible);
accepted_guess_solver.getIterativeSolver().setCliParam("restart", "200");

status = accepted_guess_solver.preconditionerSetup(side);
status = accepted_guess_solver.preconditionerSetup(preconditioner_side);
error_sum += status;

const real_type initial_guess_rnorm = accepted_guess_solver.getResidualNorm(vec_rhs, &vec_x_guess);
Expand Down Expand Up @@ -311,7 +329,7 @@ int test(int argc, char* argv[])
// Definitions of helper functions
//

void processInputs(std::string& method, std::string& gs, std::string& sketch, std::string& side)
void processInputs(std::string& method, std::string& gs, std::string& sketch)
{
if (method == "randgmres")
{
Expand All @@ -337,13 +355,6 @@ void processInputs(std::string& method, std::string& gs, std::string& sketch, st
std::cout << "Setting orthogonalization to the default (CGS2).\n\n";
gs = "cgs2";
}

if ((side != "left") && (side != "right"))
{
std::cout << "Preconditioning side " << side << " not recognized.\n";
std::cout << "Setting preconditioning side to the default (right).\n\n";
side = "right";
}
}

std::string headerInfo(const std::string& method,
Expand Down