#include <deal.II/base/exceptions.h>
#include <prismspf/core/types.h>
#include <prismspf/config.h>

Include dependency graph for exceptions.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	AssertThrowDebug(cond, exc)

Functions
	DeclException1 (FeatureNotImplemented, std::string,<< "The following feature has yet to be implemented in PRISMS-PF:\n "<< arg1<< "\nCheck the issues section of PRISMS-PF's github to see if this feature is under " "development. Additionally, please considering provided a patch to PRISMS-PF if you " "feel that feature is worthwhile for yourself and others.")

	DeclExceptionMsg (UnreachableCode, "This code should not have been reached.")

	DeclException2 (DependencyNotFound, Types::Index, std::string,<< "Attempted access of the variable with index "<< arg1<< " and dependency type "<< arg2<< " that was not marked as needed. Please check CustomAttributeLoader.")

Macro Definition Documentation

◆ AssertThrowDebug

#define AssertThrowDebug	(		cond,
			exc )

Macro for assertion that is only called in DEBUG mode. This is used to throw a catchable exception with zero overhead in RELEASE mode. dealii Assert will call abort(), which is not useful to us.

Function Documentation

◆ DeclException1()

DeclException1	(	FeatureNotImplemented	,
		std::string	,
		<< "The following feature has yet to be implemented in PRISMS-PF:\n "<< arg1<< "\nCheck the issues section of PRISMS-PF's github to see if this feature is under " "development.	Additionally,
		please considering provided a patch to PRISMS-PF if you " "feel that feature is worthwhile for yourself and others."	)

Exception for parts of the library that have yet to be implemented yet. The argument is used to provide additional context for the feature that has yet to be implemented.

◆ DeclException2()

DeclException2	(	DependencyNotFound	,
		Types::Index	,
		std::string	,
		<< "Attempted access of the variable with index "<< arg1<< " and dependency type "<< arg2<< " that was not marked as needed. Please check CustomAttributeLoader."	)

Exception for a user trying to access a variable in from VariableContainer that has not been specified as a dependency.

◆ DeclExceptionMsg()

DeclExceptionMsg	(	UnreachableCode	,
		"This code should not have been reached."	)

Exception for when we have reached part of the code that should not have been reached. This is common in switch statements and conditional chains.