nimble::CommandLineConfiguration Class Reference

#include <nimble_cli.h>

Classes
struct	impl

Public Member Functions
	CommandLineConfiguration (int argc, char **argv)
	CommandLineConfiguration (const CommandLineConfiguration &)=delete
	CommandLineConfiguration (CommandLineConfiguration &&) noexcept
virtual	~CommandLineConfiguration ()
CommandLineConfiguration &	operator= (const CommandLineConfiguration &)=delete
CommandLineConfiguration &	operator= (CommandLineConfiguration &&) noexcept
virtual void	ConfigureCommandLineArguments ()
int	ParseAndGetErrorCode ()
bool	UseTpetra () const noexcept
bool	UseVT () const noexcept
bool	UseUQ () const noexcept
const std::string &	InputFilename () const noexcept
int &	ArgC () noexcept
char **&	ArgV () noexcept

Constructor & Destructor Documentation

CommandLineConfiguration() [1/3]

nimble::CommandLineConfiguration::CommandLineConfiguration	(	int	argc,
		char **	argv )

  : impl_{std::make_unique< impl >()}
{
  impl_->argc_ = argc;
  impl_->argv_ = argv;
}

CommandLineConfiguration() [2/3]

nimble::CommandLineConfiguration::CommandLineConfiguration ( const CommandLineConfiguration & )

delete

CommandLineConfiguration() [3/3]

nimble::CommandLineConfiguration::CommandLineConfiguration ( CommandLineConfiguration && )

defaultnoexcept

~CommandLineConfiguration()

nimble::CommandLineConfiguration::~CommandLineConfiguration ( )

virtualdefault

Member Function Documentation

ArgC()

int & nimble::CommandLineConfiguration::ArgC ( )

noexcept

{
  return impl_->argc_;
}

ArgV()

char **& nimble::CommandLineConfiguration::ArgV ( )

noexcept

{
  return impl_->argv_;
}

ConfigureCommandLineArguments()

void nimble::CommandLineConfiguration::ConfigureCommandLineArguments ( )

virtual

                                                        {
  impl_->cli_app_.allow_extras();
 
 
  auto* tpetra_opt = impl_->cli_app_.add_flag("--use_tpetra", impl_->use_tpetra_, "Use TPetra solvers")
                         ->check([](const std::string&) -> std::string {
#ifdef NIMBLE_HAVE_TRILINOS
                           return {};  // Empty string on success
#else
                           return "NimbleSM was not built with Trilinos support";
#endif
                         });
 
  impl_->cli_app_.add_flag("--use_vt", impl_->use_vt_, "Use DARMA/vt for asynchronous distributed contact tasking")
          ->check([](const std::string&) -> std::string {
#ifdef NIMBLE_HAVE_VT
            return {};  // Empty string on success
#else
            return "NimbleSM was not built with DARMA/vt support";
#endif
          });
 
  impl_->cli_app_.add_flag("--use_uq", impl_->use_vt_, "Use UQ capability")->check([](const std::string&) -> std::string {
#ifdef NIMBLE_HAVE_UQ
    return {};  // Empty string on success
#else
    return "NimbleSM was not built with UQ support";
#endif
  });
 
  impl_->cli_app_.add_option( "INPUT_FILE", impl_->input_filename_)->required()->check(CLI::ExistingFile);
}

InputFilename()

const std::string & nimble::CommandLineConfiguration::InputFilename ( ) const

noexcept

{
  return impl_->input_filename_;
}

operator=() [1/2]

CommandLineConfiguration & nimble::CommandLineConfiguration::operator= ( CommandLineConfiguration && )

defaultnoexcept

operator=() [2/2]

CommandLineConfiguration & nimble::CommandLineConfiguration::operator= ( const CommandLineConfiguration & )

delete

ParseAndGetErrorCode()

int nimble::CommandLineConfiguration::ParseAndGetErrorCode

(

)

                                               {
  try {
    impl_->cli_app_.parse(impl_->argc_, impl_->argv_);
  } catch (const CLI::ParseError& e) {
    return impl_->cli_app_.exit(e);
  }
 
  return 0;
}

UseTpetra()

bool nimble::CommandLineConfiguration::UseTpetra ( ) const

noexcept

{
  return impl_->use_tpetra_;
}

UseUQ()

bool nimble::CommandLineConfiguration::UseUQ ( ) const

noexcept

{
  return impl_->use_uq_;
}

UseVT()

bool nimble::CommandLineConfiguration::UseVT ( ) const

noexcept

{
  return impl_->use_vt_;
}

---

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

• src/nimble_cli.h
• src/nimble_cli.cc