CommandLineArgumentParser.h File Reference

Detailed Description

Declaration of CommandLineArgumentParser.

Copyright

Copyright (c) 2012-2025, OpenGeoSys Community (http://www.opengeosys.org) Distributed under a Modified BSD License. See accompanying file LICENSE.txt or http://www.opengeosys.org/project/license

Definition in file CommandLineArgumentParser.h.

#include <string>
#include <vector>

Include dependency graph for CommandLineArgumentParser.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	CommandLineArguments

Functions
CommandLineArguments	parseCommandLineArguments (int argc, char *argv[], bool const exit_on_exception=true)

Function Documentation

parseCommandLineArguments()

CommandLineArguments parseCommandLineArguments	(	int	argc,
		char *	argv[],
		bool const	exit_on_exception = true )

Definition at line 23 of file CommandLineArgumentParser.cpp.

{
    // Parse CLI arguments.
    TCLAP::CmdLine cmd(
        "OpenGeoSys-6 software."
        "\n"
        "Copyright (c) 2012-2025, OpenGeoSys Community "
        "(https://www.opengeosys.org) "
        "\n"
        "Distributed under a Modified BSD License. "
        "See accompanying file LICENSE.txt or "
        "https://www.opengeosys.org/project/license"
        "\n"
        "version: " +
            GitInfoLib::GitInfo::ogs_version +
            "\n"
            "CMake arguments: " +
            CMakeInfoLib::CMakeInfo::cmake_args,
        ' ',
        GitInfoLib::GitInfo::ogs_version + "\n\n" +
            "CMake arguments: " + CMakeInfoLib::CMakeInfo::cmake_args);
 
    BaseLib::TCLAPOutput tclapOutput;
    cmd.setOutput(&tclapOutput);
    cmd.setExceptionHandling(exit_on_exception);
 
    TCLAP::SwitchArg log_parallel("", "log-parallel",
                                  "enables all MPI ranks to log");
 
#ifndef _WIN32  // TODO: On windows floating point exceptions are not handled
                // currently
    TCLAP::SwitchArg enable_fpe_arg("", "enable-fpe",
                                    "enables floating point exceptions");
#endif  // _WIN32
    TCLAP::SwitchArg unbuffered_cout_arg("", "unbuffered-std-out",
                                         "use unbuffered standard output");
 
    TCLAP::ValueArg<std::string> reference_path_arg(
        "r", "reference",
        "Input. Run output result comparison after successful simulation "
        "comparing to all files in the given path. This requires test "
        "definitions to be present in the project file.",
        false, "", "REF_PATH");
 
    TCLAP::UnlabeledValueArg<std::string> project_arg(
        "project-file",
        "Input (.prj|.xml). Path to the ogs6 project file",
        true,
        "",
        "PROJECT_FILE");
 
    TCLAP::MultiArg<std::string> xml_patch_files_arg(
        "p", "xml-patch",
        "Input (.xml). The xml patch file(s) which is (are) applied (in the "
        "given order) "
        "to the PROJECT_FILE",
        false, "XML_PATCH_FILE");
 
    TCLAP::ValueArg<std::string> outdir_arg(
        "o", "output-directory", "Output. The output directory to write to",
        false, "", "OUTPUT_PATH");
 
    TCLAP::ValueArg<std::string> mesh_dir_arg(
        "m", "mesh-input-directory",
        "Input. The directory where the meshes are read from", false, "",
        "MESH_DIR_PATH");
 
    TCLAP::ValueArg<std::string> script_dir_arg(
        "s", "script-input-directory",
        "Input. The directory where script files (e.g. Python BCs) are read "
        "from",
        false, "", "SCRIPT_DIR_PATH");
 
    TCLAP::SwitchArg write_prj_arg("",
                                   "write-prj",
                                   "Writes processed project file to output "
                                   "path / [prj_base_name]_processed.prj.");
 
    TCLAP::SwitchArg nonfatal_arg("",
                                  "config-warnings-nonfatal",
                                  "warnings from parsing the configuration "
                                  "file will not trigger program abortion");
    cmd.add(reference_path_arg);
    cmd.add(project_arg);
    cmd.add(xml_patch_files_arg);
    cmd.add(outdir_arg);
    cmd.add(mesh_dir_arg);
    cmd.add(script_dir_arg);
    cmd.add(write_prj_arg);
    cmd.add(log_parallel);
    auto log_level_arg = BaseLib::makeLogLevelArg();
    cmd.add(log_level_arg);
    cmd.add(nonfatal_arg);
    cmd.add(unbuffered_cout_arg);
#ifndef _WIN32  // TODO: On windows floating point exceptions are not handled
                // currently
    cmd.add(enable_fpe_arg);
#endif  // _WIN32
 
    cmd.parse(argc, argv);
 
    CommandLineArguments cli_args;
    cli_args.reference_path = reference_path_arg.getValue();
    cli_args.reference_path_is_set = reference_path_arg.isSet();
    cli_args.project = project_arg.getValue();
 
    BaseLib::setProjectDirectory(BaseLib::extractPath(cli_args.project));
 
    cli_args.xml_patch_file_names = xml_patch_files_arg.getValue();
    cli_args.outdir = outdir_arg.getValue();
    cli_args.mesh_dir = mesh_dir_arg.getValue().empty()
                            ? BaseLib::getProjectDirectory()
                            : mesh_dir_arg.getValue();
    cli_args.script_dir = script_dir_arg.getValue().empty()
                              ? BaseLib::getProjectDirectory()
                              : script_dir_arg.getValue();
    cli_args.nonfatal = nonfatal_arg.getValue();
    cli_args.log_parallel = log_parallel.getValue();
    cli_args.log_level = log_level_arg.getValue();
    cli_args.write_prj = write_prj_arg.getValue();
 
    // deactivate buffer for standard output if specified
    if (unbuffered_cout_arg.isSet())
    {
        std::cout.setf(std::ios::unitbuf);
    }
#ifndef _WIN32
    cli_args.enable_fpe_is_set = enable_fpe_arg.isSet();
#endif  // _WIN32
 
    return cli_args;
}

References CommandLineArguments::enable_fpe_is_set, BaseLib::extractPath(), BaseLib::getProjectDirectory(), CommandLineArguments::log_level, CommandLineArguments::log_parallel, BaseLib::makeLogLevelArg(), CommandLineArguments::mesh_dir, CommandLineArguments::nonfatal, GitInfoLib::GitInfo::ogs_version, CommandLineArguments::outdir, CommandLineArguments::project, CommandLineArguments::reference_path, CommandLineArguments::reference_path_is_set, CommandLineArguments::script_dir, BaseLib::setProjectDirectory(), CommandLineArguments::write_prj, and CommandLineArguments::xml_patch_file_names.

Referenced by OGSSimulation::OGSSimulation(), checkCommandLineArguments(), and main().