doc/html/testTeuchosTestForTermination_8cpp_source.html

 // @HEADER

 // *****************************************************************************

 //                    Teuchos: Common Tools Package

 //

 // Copyright 2004 NTESS and the Teuchos contributors.

 // SPDX-License-Identifier: BSD-3-Clause

 // *****************************************************************************

 // @HEADER


 #include "Teuchos_CommandLineProcessor.hpp"

 #include "Teuchos_GlobalMPISession.hpp"

 #include "Teuchos_TestForException.hpp"


 int main(int argc, char* argv[])

 {


   using Teuchos::GlobalMPISession;

   GlobalMPISession mpiSession(&argc,&argv);


   Teuchos::CommandLineProcessor clp;

   int terminate_on_procid = 0;

   clp.setOption("terminate-on-procid", &terminate_on_procid);

   (void)clp.parse(argc, argv);


   TEUCHOS_TEST_FOR_TERMINATION(

     GlobalMPISession::getRank() == terminate_on_procid,

     "Bingo, we are terminating on procid == "

     "terminate_on_procid = "<<GlobalMPISession::getRank()<<"!"

     );


   return 1; // Will never be called!


 }

Teuchos::GlobalMPISession
Initialize, finalize, and query the global MPI session.
Definition: Teuchos_GlobalMPISession.hpp:81

Teuchos::CommandLineProcessor::setOption
void setOption(const char option_true[], const char option_false[], bool *option_val, const char documentation[]=NULL)
Set a boolean option.
Definition: Teuchos_CommandLineProcessor.cpp:102

Teuchos::CommandLineProcessor::parse
EParseCommandLineReturn parse(int argc, char *argv[], std::ostream *errout=&std::cerr) const
Parse a command line.
Definition: Teuchos_CommandLineProcessor.cpp:248

main
int main(int argc, char *argv[])
Definition: core/example/CommandLineProcessor/cxx_main.cpp:21

Teuchos_GlobalMPISession.hpp
A MPI utilities class, providing methods for initializing, finalizing, and querying the global MPI se...

Teuchos_CommandLineProcessor.hpp
Basic command line parser for input from (argc,argv[])

TEUCHOS_TEST_FOR_TERMINATION
#define TEUCHOS_TEST_FOR_TERMINATION(terminate_test, msg)
This macro is to be used instead of TEUCHOS_TEST_FOR_EXCEPTION() to report an error in situations whe...
Definition: Teuchos_TestForException.hpp:357

Teuchos_TestForException.hpp
Standard test and throw macros.

Teuchos::CommandLineProcessor
Class that helps parse command line input arguments from (argc,argv[]) and set options.
Definition: Teuchos_CommandLineProcessor.hpp:44