#include <oomph_definitions.h>

Inheritance diagram for oomph::OomphLibError:

Public Member Functions
	OomphLibError (const std::string &error_description, const std::string &function_name, const char *location)

Public Member Functions inherited from oomph::OomphLibException
void	disable_error_message ()

Static Public Member Functions
static void	set_stream_pt (std::ostream *const &stream_pt)

static void	set_output_width (const unsigned &output_width)

Static Private Attributes
static std::ostream *	Stream_pt = &std::cerr
	Output stream that is used to write the errors. More...

static unsigned	Output_width = 70
	Width in characters of the output report. More...

Additional Inherited Members
Protected Member Functions inherited from oomph::OomphLibException
	OomphLibException (const std::string &error_description, const std::string &function_name, const char *location, const std::string &exception_type, std::ostream &exception_stream, const unsigned &output_width, bool list_trace_back)

	~OomphLibException () throw ()
	The destructor cannot throw an exception (C++ STL standard) More...

Protected Attributes inherited from oomph::OomphLibException
std::ostream *	Exception_stream_pt
	Exception stream to which we write message in destructor. More...

std::stringstream *	Exception_stringstream_pt
	String stream that records the error message. More...

bool	Suppress_error_message

Detailed Description

An OomphLibError object which should be thrown when an run-time error is encountered. The error stream and stream width can be specified. The default is cerr with a width of 70 characters.

Constructor & Destructor Documentation

◆ OomphLibError()

oomph::OomphLibError::OomphLibError	(	const std::string &	error_description,
		const std::string &	function_name,
		const char *	location
	)

inline

Constructor requires the error description and the function in which the error occured and the location provided by the OOMPH_EXCEPTION_LOCATION macro

       : OomphLibException(error_description,
                           function_name,
                           location,
                           "ERROR",
                           *Stream_pt,
                           Output_width,
                           true)
     {
     }

Member Function Documentation

◆ set_output_width()

static void oomph::OomphLibError::set_output_width ( const unsigned & output_width )

inlinestatic

Static member function used to specify the width (in characters) of the error stream

     {
       Output_width = output_width;
     }

◆ set_stream_pt()

static void oomph::OomphLibError::set_stream_pt ( std::ostream *const & stream_pt )

inlinestatic

Static member function used to specify the error stream, which must be passed as a pointer because streams cannot be copied.

     {
       Stream_pt = stream_pt;
     }

References GlobalParameters::Stream_pt.

Referenced by main().

Member Data Documentation

◆ Output_width

unsigned oomph::OomphLibError::Output_width = 70

staticprivate

Width in characters of the output report.

Default output width for OomphLibErrors (70)

◆ Stream_pt

std::ostream * oomph::OomphLibError::Stream_pt = &std::cerr

staticprivate

Output stream that is used to write the errors.

Default output stream for OomphLibErorrs (cerr)

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

Public Member Functions

Static Public Member Functions

Static Private Attributes

Additional Inherited Members