Argparse.H

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Saud Zahir
 *
 * This file is part of deltaFlow.
 *
 * deltaFlow is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * deltaFlow is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with deltaFlow.  If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef ARGPARSE_H
#define ARGPARSE_H
 
#include <string>
 
struct PowerFlowOptions;
 
enum class SolverType {
    GaussSeidel,    
    NewtonRaphson   
};
 
enum class InputFormat {
  IEEE,   
  PSSE    
};
 
class ArgumentParser final {
    public:
        ArgumentParser(int argc, char* argv[]);
 
        ~ArgumentParser() = default;
 
        // Deleted copy/move semantics
        ArgumentParser(const ArgumentParser&) = delete;
        ArgumentParser& operator=(const ArgumentParser&) = delete;
        ArgumentParser(const ArgumentParser&&) = delete;
        ArgumentParser& operator=(ArgumentParser&&) = delete;
 
        std::string getInputFile() const noexcept;
 
        std::string getJobName() const noexcept;
 
        double getTolerance() const noexcept;
 
        int getMaxIterations() const noexcept;
 
        double getRelaxationCoefficient() const noexcept;
 
        SolverType getSolverType() const noexcept;
 
        InputFormat getInputFormat() const noexcept;
 
        PowerFlowOptions getOptions() const noexcept;
 
    private:
        std::string inputFile;        
        std::string jobName;          
        double tolerance = 1E-8;      
        int maxIterations = 1024;     
        double relaxation = 1.0;      
        SolverType method;                
        InputFormat format;                
 
        void parse_args(int argc, char* argv[]);
 
        void help() const noexcept;
 
};
 
#endif