svMultiPhysics
Loading...
Searching...
No Matches
Public Member Functions | List of all members
svmp::FE::SingularMappingException Class Reference

Element geometric mapping is singular or inverted. More...

#include <FEException.h>

Inheritance diagram for svmp::FE::SingularMappingException:
[legend]

Public Member Functions

 SingularMappingException (const std::string &message, double jacobian_det=0.0)
 Construct with a message and the offending Jacobian determinant.
 
double jacobian_det () const noexcept
 Jacobian determinant at the failure point.
 
- Public Member Functions inherited from svmp::FE::FEException
 FEException (const std::string &message, StatusCode status=StatusCode::Unknown)
 Construct with a message and optional status code.
 
StatusCode status () const noexcept
 Status code classifying the failure.
 
- Public Member Functions inherited from svmp::ExceptionBase
const char * what () const noexcept override
 
StatusCode status_code () const noexcept
 
const std::string & message () const noexcept
 
const ExceptionContext & context () const noexcept
 
void add_context (const std::string &context)
 
void set_source_location (const SourceLocation &location)
 Record the originating source location and refresh what().
 

Additional Inherited Members

- Protected Member Functions inherited from svmp::ExceptionBase
 ExceptionBase (std::string message, StatusCode status, std::string_view subsystem_label, const char *file="", int line=0, const char *function="")
 
void rebuild_what ()
 
- Protected Attributes inherited from svmp::ExceptionBase
std::string message_
 
ExceptionContext context_
 
std::string_view subsystem_label_
 
std::string what_
 

Detailed Description

Element geometric mapping is singular or inverted.

Records the offending Jacobian determinant so error reports can show the degeneracy.

Constructor & Destructor Documentation

◆ SingularMappingException()

svmp::FE::SingularMappingException::SingularMappingException ( const std::string &  message,
double  jacobian_det = 0.0 
)
inline

Construct with a message and the offending Jacobian determinant.

Parameters
messageHuman-readable error description.
jacobian_detJacobian determinant at the failure point; appended to the message.

Member Function Documentation

◆ jacobian_det()

double svmp::FE::SingularMappingException::jacobian_det ( ) const
inlinenoexcept

Jacobian determinant at the failure point.

Returns
The determinant recorded at construction.

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