Cantera  4.0.0a2
Loading...
Searching...
No Matches
TimeStepError Class Reference

Error thrown when time stepping cannot proceed and the steady-state solver should be given a chance to recover by other means. More...

#include <SteadyStateSystem.h>

Inheritance diagram for TimeStepError:
[legend]

Detailed Description

Error thrown when time stepping cannot proceed and the steady-state solver should be given a chance to recover by other means.

Definition at line 22 of file SteadyStateSystem.h.

Public Member Functions

template<typename... Args>
 TimeStepError (const string &func, const string &msg, const Args &... args)
 
string getClass () const override
 Method overridden by derived classes to indicate their type.
 
- Public Member Functions inherited from CanteraError
template<typename... Args>
 CanteraError (const string &procedure, const string &msg, const Args &... args)
 Normal Constructor for the CanteraError base class.
 
virtual ~CanteraError () throw ()
 Destructor for base class does nothing.
 
const char * what () const override throw ()
 Get a description of the error.
 
virtual string getMessage () const
 Method overridden by derived classes to format the error message.
 
virtual string getMethod () const
 Get the name of the method that threw the exception.
 
virtual string getClass () const
 Method overridden by derived classes to indicate their type.
 

Additional Inherited Members

- Static Public Member Functions inherited from CanteraError
static void setStackTraceDepth (int depth)
 Set the number of stack frames to include when a CanteraError is displayed.
 
- Protected Member Functions inherited from CanteraError
 CanteraError ()
 Protected default constructor discourages throwing errors containing no information.
 
 CanteraError (const string &procedure)
 Constructor used by derived classes that override getMessage()
 
- Protected Attributes inherited from CanteraError
string procedure_
 The name of the procedure where the exception occurred.
 
string formattedMessage_
 Formatted message returned by what()
 

Constructor & Destructor Documentation

◆ TimeStepError()

template<typename... Args>
TimeStepError ( const string &  func,
const string &  msg,
const Args &...  args 
)
inline

Definition at line 26 of file SteadyStateSystem.h.

Member Function Documentation

◆ getClass()

string getClass ( ) const
inlineoverridevirtual

Method overridden by derived classes to indicate their type.

Reimplemented from CanteraError.

Definition at line 29 of file SteadyStateSystem.h.


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