libMesh::MacroFunctions Namespace Reference

Functions
void	here (const char *file, int line, const char *date, const char *time, std::ostream &os=libMesh::err)
void	stop (const char *file, int line, const char *date, const char *time)
void	report_error (const char *file, int line, const char *date, const char *time, std::ostream &os=libMesh::err)

Variables
Threads::spin_mutex	report_error_spin_mtx

Function Documentation

here()

void libMesh::MacroFunctions::here	(	const char *	file,
		int	line,
		const char *	date,
		const char *	time,
		std::ostream &	os = libMesh::err
	)

Definition at line 47 of file libmesh_common.C.

{
  os << "[" << static_cast<std::size_t>(libMesh::global_processor_id()) << "] "
     << file
     << ", line " << line
     << ", compiled " << date
     << " at " << time
     << std::endl;
}

References libMesh::global_processor_id().

Referenced by report_error(), and stop().

report_error()

void libMesh::MacroFunctions::report_error	(	const char *	file,
		int	line,
		const char *	date,
		const char *	time,
		std::ostream &	os = libMesh::err
	)

Definition at line 77 of file libmesh_common.C.

{
  // Avoid a race condition on that static bool
  Threads::spin_mutex::scoped_lock lock(report_error_spin_mtx);
 
  // It is possible to have an error *inside* report_error; e.g. from
  // print_trace.  We don't want to infinitely recurse.
  static bool reporting_error = false;
  if (reporting_error)
    {
      // I heard you like error reporting, so we put an error report
      // in report_error() so you can report errors from the report.
      os << "libMesh encountered an error while attempting to report_error." << std::endl;
      return;
    }
  reporting_error = true;
 
  libMesh::MacroFunctions::here(file, line, date, time, os);
 
  if (libMesh::global_n_processors() == 1 ||
      libMesh::on_command_line("--print-trace"))
    libMesh::print_trace(os);
  else
    libMesh::write_traceout();
 
  reporting_error = false;
}

References libMesh::global_n_processors(), here(), libMesh::on_command_line(), libMesh::print_trace(), report_error_spin_mtx, and libMesh::write_traceout().

stop()

void libMesh::MacroFunctions::stop	(	const char *	file,
		int	line,
		const char *	date,
		const char *	time
	)

Definition at line 59 of file libmesh_common.C.

{
  if (libMesh::global_n_processors() == 1)
    {
      libMesh::MacroFunctions::here(file, line, date, time);
#if defined(LIBMESH_HAVE_CSIGNAL) && defined(SIGSTOP)
      libMesh::out << "Stopping process " << getpid() << "..." << std::endl;
      std::raise(SIGSTOP);
      libMesh::out << "Continuing process " << getpid() << "..." << std::endl;
#else
      libMesh::out << "WARNING:  libmesh_stop() does not work; no operating system support." << std::endl;
#endif
    }
}

References libMesh::global_n_processors(), here(), and libMesh::out.

Variable Documentation

report_error_spin_mtx

Threads::spin_mutex libMesh::MacroFunctions::report_error_spin_mtx

Definition at line 75 of file libmesh_common.C.

Referenced by report_error().