Parses and stores command-line arguments for deltaFlow. More...

#include <Argparse.H>

Public Member Functions
	ArgumentParser (int argc, char *argv[])
	Constructor: parses command-line arguments.

	~ArgumentParser ()=default
	Destructor (default).

	ArgumentParser (const ArgumentParser &)=delete

ArgumentParser &	operator= (const ArgumentParser &)=delete

	ArgumentParser (const ArgumentParser &&)=delete

ArgumentParser &	operator= (ArgumentParser &&)=delete

std::string	getInputFile () const noexcept
	Get the input CDF file path.

std::string	getJobName () const noexcept
	Get the job name.

double	getTolerance () const noexcept
	Get the convergence tolerance ($$ \epsilon $$).

int	getMaxIterations () const noexcept
	Get the maximum number of iterations ($$ N_{max} $$).

double	getRelaxationCoefficient () const noexcept
	Get the relaxation coefficient ($$ \omega $$).

SolverType	getSolverType () const noexcept
	Get the solver type.

InputFormat	getInputFormat () const noexcept
	Get the input file format.

PowerFlowOptions	getOptions () const noexcept
	Get all parsed options as a plain data struct (ISP).

Private Member Functions
void	parse_args (int argc, char *argv[])
	Parse the provided arguments.

void	help () const noexcept
	Print help message to stdout.

Private Attributes
std::string	inputFile
	Path to input CDF file.

std::string	jobName
	Job name (defaults to input filename)

double	tolerance = 1E-8
	Convergence tolerance ($$ \epsilon $$)

int	maxIterations = 1024
	Maximum number of iterations ($$ N_{max} $$)

double	relaxation = 1.0
	Relaxation coefficient ($$ \omega $$)

SolverType	method
	Solver type.

InputFormat	format
	Input file format.

Detailed Description

Parses and stores command-line arguments for deltaFlow.

The ArgumentParser extracts command-line arguments related to the input CDF file, job name, solver selection, convergence tolerance ($$ \epsilon $$), maximum iterations ($$ N_{max} $$), and relaxation coefficient ($$ \omega $$).

Definition at line 64 of file Argparse.H.

Constructor & Destructor Documentation

◆ ArgumentParser() [1/3]

ArgumentParser::ArgumentParser	(	int	argc,
		char *	argv[]
	)

Constructor: parses command-line arguments.

Parameters

argc	Argument count.
argv	Argument vector.

Definition at line 37 of file Argparse.C.

                                                     {
    parse_args(argc, argv);
}

References parse_args().

Here is the call graph for this function:

◆ ~ArgumentParser()

ArgumentParser::~ArgumentParser ( )

default

Destructor (default).

◆ ArgumentParser() [2/3]

ArgumentParser::ArgumentParser ( const ArgumentParser & )

delete

◆ ArgumentParser() [3/3]

ArgumentParser::ArgumentParser ( const ArgumentParser && )

delete

Member Function Documentation

◆ getInputFile()

std::string ArgumentParser::getInputFile ( ) const

noexcept

Get the input CDF file path.

Returns: File path as std::string.

Definition at line 131 of file Argparse.C.

                                                      {
    return this->inputFile;
}

References inputFile.

◆ getInputFormat()

InputFormat ArgumentParser::getInputFormat ( ) const

noexcept

Get the input file format.

Returns: InputFormat enum (IEEE or PSSE).

Definition at line 155 of file Argparse.C.

                                                          {
    return this->format;
}

References format.

◆ getJobName()

std::string ArgumentParser::getJobName ( ) const

noexcept

Get the job name.

Returns: Job name as std::string.

Definition at line 135 of file Argparse.C.

                                                    {
    return this->jobName;
}

References jobName.

◆ getMaxIterations()

int ArgumentParser::getMaxIterations ( ) const

noexcept

Get the maximum number of iterations ($$ N_{max} $$).

Returns: Maximum iterations as int.

Definition at line 143 of file Argparse.C.

                                                    {
    return this->maxIterations;
}

References maxIterations.

◆ getOptions()

PowerFlowOptions ArgumentParser::getOptions ( ) const

noexcept

Get all parsed options as a plain data struct (ISP).

Lets consumers that only need the parsed values (e.g. PowerFlowApplication) depend on a small data type instead of the full ArgumentParser interface.

Returns: PowerFlowOptions populated from the parsed arguments.

Definition at line 159 of file Argparse.C.

                                                           {
    PowerFlowOptions opts;
    opts.inputFile = this->inputFile;
    opts.jobName = this->jobName;
    opts.tolerance = this->tolerance;
    opts.maxIterations = this->maxIterations;
    opts.relaxation = this->relaxation;
    opts.solverType = this->method;
    opts.inputFormat = this->format;
    return opts;
}

References format, inputFile, PowerFlowOptions::inputFile, PowerFlowOptions::inputFormat, jobName, PowerFlowOptions::jobName, maxIterations, PowerFlowOptions::maxIterations, method, relaxation, PowerFlowOptions::relaxation, PowerFlowOptions::solverType, tolerance, and PowerFlowOptions::tolerance.

Here is the caller graph for this function:

◆ getRelaxationCoefficient()

double ArgumentParser::getRelaxationCoefficient ( ) const

noexcept

Get the relaxation coefficient ($$ \omega $$).

Returns: Relaxation coefficient as double.

Definition at line 147 of file Argparse.C.

                                                               {
    return this->relaxation;
}

References relaxation.

◆ getSolverType()

SolverType ArgumentParser::getSolverType ( ) const

noexcept

Get the solver type.

Returns: Solver enum (GaussSeidel or NewtonRaphson).

Definition at line 151 of file Argparse.C.

                                                        {
    return this->method;
}

References method.

◆ getTolerance()

double ArgumentParser::getTolerance ( ) const

noexcept

Get the convergence tolerance ($$ \epsilon $$).

Returns: Tolerance as double.

Definition at line 139 of file Argparse.C.

                                                   {
    return this->tolerance;
}

References tolerance.

◆ help()

void ArgumentParser::help ( ) const

privatenoexcept

Print help message to stdout.

Definition at line 171 of file Argparse.C.

                                         {
    LOG_MESSAGE(R"(
Usage:
  deltaFlow [OPTIONS] <input-file> <solver>
 
Required:
  <input-file>                 Path to input file (.cdf, .txt or .raw)
  <solver>                     Solver method: GAUSS | NEWTON
 
Options:
  -j, --job <name>             Job name
  -t, --tolerance <value>      Convergence tolerance (default: 1E-8)
  -m, --max-iterations <int>   Maximum number of iterations (default: 1024)
  -h, --help                   Display help message
  -v, --version                Show program version and exit
 
Solvers:
  GAUSS                Gauss-Seidel Method
    -r, --relaxation <value>  Relaxation coefficient (default: 1.0)
 
  NEWTON               Newton-Raphson Method
)");
}

References LOG_MESSAGE.

Here is the caller graph for this function:

◆ operator=() [1/2]

ArgumentParser & ArgumentParser::operator= ( ArgumentParser && )

delete

◆ operator=() [2/2]

ArgumentParser & ArgumentParser::operator= ( const ArgumentParser & )

delete

◆ parse_args()

void ArgumentParser::parse_args	(	int	argc,
		char *	argv[]
	)

private

Parse the provided arguments.

Parameters

argc	Argument count.
argv	Argument vector.

Definition at line 41 of file Argparse.C.

                                                      {
    bool methodFound = false;
    bool inputFileFound = false;
 
    for (int i = 1; i < argc; ++i) {
        std::string arg = argv[i];
 
        if ((arg == "--job" || arg == "-j") && i + 1 < argc) {
            this->jobName = argv[++i];
        }
        else if ((arg == "--tolerance" || arg == "-t") && i + 1 < argc) {
            this->tolerance = std::stod(argv[++i]);
        }
        else if ((arg == "--max-iterations" || arg == "-m") && i + 1 < argc) {
            this->maxIterations = std::stoi(argv[++i]);
        }
        else if ((arg == "--relaxation" || arg == "-r") && i + 1 < argc) {
            this->relaxation = std::stod(argv[++i]);
        }
        else if (arg == "--version" || arg == "-v") {
            std::exit(0);
        }
        else if (arg == "--help" || arg == "-h") {
            help();
            std::exit(0);
        }
        else if (!inputFileFound) {
            this->inputFile = arg;
 
            if (Utilities::isCommonDataFormat(arg)) {
                this->format = InputFormat::IEEE;
            }
            else if (Utilities::isRawFormat(arg))
            {
                this->format = InputFormat::PSSE;
            }
            else {
                LOG_MESSAGE("ERROR: Invalid format '{}'", arg);
                help();
                std::exit(1);
            }
 
            inputFileFound = true;
        }
        else if (!methodFound) {
            if (arg == "GAUSS") {
                this->method = SolverType::GaussSeidel;
                methodFound = true;
            }
            else if (arg == "NEWTON") {
                this->method = SolverType::NewtonRaphson;
                methodFound = true;
            }
            else {
                LOG_MESSAGE("ERROR: Invalid method '{}'", arg);
                help();
                std::exit(1);
            }
        }
        else {
            LOG_MESSAGE("ERROR: Unexpected argument '{}'", arg);
            help();
            std::exit(1);
        }
    }
 
    if (!inputFileFound) {
        LOG_MESSAGE("ERROR: Input CDF file (.txt or .cdf) is required.");
        help();
        std::exit(1);
    }
 
    if (!methodFound) {
        LOG_MESSAGE("ERROR: Missing required solver argument (GAUSS or NEWTON).");
        help();
        std::exit(1);
    }
 
    if (jobName.empty()) {
        jobName = std::filesystem::path(inputFile).stem().string();
    }
 
    if (method == SolverType::NewtonRaphson && relaxation != 1.0) {
        LOG_MESSAGE("Warning: Relaxation coefficient ignored for method 'NEWTON'");
    }
 
    LOG_DEBUG("deltaFlow v{}", deltaFlow_VERSION);
    LOG_DEBUG("CMake v{}, GCC v{}", CMake_VERSION, gcc_VERSION);
}

References format, GaussSeidel, help(), IEEE, inputFile, Utilities::isCommonDataFormat(), Utilities::isRawFormat(), jobName, LOG_DEBUG, LOG_MESSAGE, maxIterations, method, NewtonRaphson, PSSE, relaxation, and tolerance.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ format

InputFormat ArgumentParser::format

private

Input file format.

Definition at line 142 of file Argparse.H.

◆ inputFile

std::string ArgumentParser::inputFile

private

Path to input CDF file.

Definition at line 136 of file Argparse.H.

◆ jobName

std::string ArgumentParser::jobName

private

Job name (defaults to input filename)

Definition at line 137 of file Argparse.H.

◆ maxIterations

int ArgumentParser::maxIterations = 1024

private

Maximum number of iterations ($$ N_{max} $$)

Definition at line 139 of file Argparse.H.

◆ method

SolverType ArgumentParser::method

private

Solver type.

Definition at line 141 of file Argparse.H.

◆ relaxation

double ArgumentParser::relaxation = 1.0

private

Relaxation coefficient ($$ \omega $$)

Definition at line 140 of file Argparse.H.

◆ tolerance

double ArgumentParser::tolerance = 1E-8

private

Convergence tolerance ($$ \epsilon $$)

Definition at line 138 of file Argparse.H.

The documentation for this class was generated from the following files:

src/utils/Argparse.H
src/utils/Argparse.C

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ArgumentParser() [1/3]

◆ ~ArgumentParser()

◆ ArgumentParser() [2/3]

◆ ArgumentParser() [3/3]

Member Function Documentation

◆ getInputFile()

◆ getInputFormat()

◆ getJobName()

◆ getMaxIterations()

◆ getOptions()

◆ getRelaxationCoefficient()

◆ getSolverType()

◆ getTolerance()

◆ help()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse_args()

Member Data Documentation

◆ format

◆ inputFile

◆ jobName

◆ maxIterations

◆ method

◆ relaxation

◆ tolerance