UseCaseEnvironment.hpp

/*------------------------------------------------------------------------*/
/*                 Copyright 2010 Sandia Corporation.                     */
/*  Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive   */
/*  license for use of this work by or on behalf of the U.S. Government.  */
/*  Export of this program may require a license from the                 */
/*  United States Government.                                             */
/*------------------------------------------------------------------------*/

#ifndef stk_util_use_cases_UseCaseEnvironement_hpp
#define stk_util_use_cases_UseCaseEnvironement_hpp

#include <stk_util/parallel/Parallel.hpp>
#include <stk_util/parallel/BroadcastArg.hpp>

#include <stk_util/diag/Writer_fwd.hpp>
#include <stk_util/diag/Timer.hpp>

#include <stk_util/environment/OutputLog.hpp>
#include <stk_util/environment/ProgramOptions.hpp>
#include <stk_util/environment/ReportHandler.hpp>
#include <stk_util/environment/RuntimeWarning.hpp>
#include <stk_util/environment/RuntimeDoomed.hpp>

#include <iosfwd>

namespace use_case {

enum LogMask {
  LOG_ALWAYS    = stk_classic::LOG_ALWAYS,
  LOG_TRACE   = stk_classic::LOG_TRACE,
  LOG_TRACE_STATS = stk_classic::LOG_TRACE_STATS,
  LOG_TRACE_SUB_CALLS = stk_classic::LOG_TRACE_SUB_CALLS,
  LOG_MEMBERS   = stk_classic::LOG_MEMBERS,

  LOG_SEARCH            = 0x0000010,
  LOG_TRANSFER          = 0x0000020,
  LOG_TIMER             = 0x0000040
};

enum message_type {
  MSG_WARNING = stk_classic::MSG_WARNING,
  MSG_FATAL = stk_classic::MSG_DOOMED,
  MSG_INFORMATION,
  MSG_EXCEPTION,
  MSG_PARALLEL_EXCEPTION
};


enum message_throttle_type {
  MSG_APPLICATION = stk_classic::MSG_APPLICATION,
  MSG_TIME_STEP
};

enum TimerSetMask {
  TIMER_MESH    = 0x00000001,   
  TIMER_MESH_IO   = 0x00000002,   
  TIMER_SEARCH    = 0x00000004,   
  TIMER_TRANSFER  = 0x00000008,   
  TIMER_ALL   = 0xFFFFFFFF,   

  TIMER_FORCE   = 0x00000000    
};

std::ostream &out();                
std::ostream &dout();               
std::ostream &pout();               
std::ostream &tout();               

std::ostream &dwout();              

stk_classic::diag::Writer &dw();

stk_classic::diag::TimerSet &timerSet();

stk_classic::diag::Timer &timer();

void my_report_handler(const char *message, int type);

bool print_status(stk_classic::ParallelMachine comm, bool success);

struct UseCaseEnvironment
{
  // Will initialize a comm
  UseCaseEnvironment(int *argc, char ***argv);

  // Assumes already-initialized comm
  UseCaseEnvironment(int *argc, char ***argv, stk_classic::ParallelMachine comm);

  // shared constructor implementation; do not call directly
  void initialize(int* argc, char ***argv);

  ~UseCaseEnvironment();

  const stk_classic::ParallelMachine    m_comm;
  std::string                   m_workingDirectory;
  bool                          m_need_to_finalize;
};

} // namespace use_case

#endif // stk_util_use_cases_UseCaseEnvironement_hpp