exceptions.h File Reference

#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:

Go to the source code of this file.

Functions
template<typename Condition , typename Exception >
PRISMS_PF_BEGIN_NAMESPACE constexpr void	AssertThrowDebug (const Condition &, const Exception &)
	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.")

Function Documentation

AssertThrowDebug()

template<typename Condition , typename Exception >

PRISMS_PF_BEGIN_NAMESPACE constexpr void AssertThrowDebug ( const Condition &  , const Exception &    )

constexpr

Function for deal.II AssertThrow that is only valid in DEBUG mode. This is used to throw and error that can be caught by catch2 while not bloating code in release mode.

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.