Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::ParallelConsistencyError Class Reference

#include <gromacs/utility/exceptions.h>

+ Inheritance diagram for gmx::ParallelConsistencyError:
+ Collaboration diagram for gmx::ParallelConsistencyError:

Description

Exception class for use when ensuring that MPI ranks to throw in a coordinated fashion.

Generally all ranks that can throw would need to check for whether an exception has been caught, communicate whether any rank caught, then all throw one of these, with either a string that describes any exception caught on that rank, or a generic string.

Public Member Functions

 ParallelConsistencyError (const ExceptionInitializer &details)
 Creates an exception object with the provided initializer/reason. More...
 
int errorCode () const override
 Returns the error code corresponding to the exception type.
 
- Public Member Functions inherited from gmx::APIError
 APIError (const ExceptionInitializer &details)
 Creates an exception object with the provided initializer/reason. More...
 
- Public Member Functions inherited from gmx::GromacsException
const char * what () const noexceptoverride
 Returns the reason string for the exception. More...
 
template<class InfoType >
const InfoType::value_type * getInfo () const
 Returns the value associated with given ExceptionInfo. More...
 
template<class Tag , typename T >
void setInfo (const ExceptionInfo< Tag, T > &item)
 Associates extra information with the exception. More...
 
void prependContext (const std::string &context)
 Adds context information to this exception. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::GromacsException
 GromacsException (const ExceptionInitializer &details)
 Creates an exception object with the provided initializer/reason. More...
 

Constructor & Destructor Documentation

gmx::ParallelConsistencyError::ParallelConsistencyError ( const ExceptionInitializer details)
inlineexplicit

Creates an exception object with the provided initializer/reason.

Parameters
[in]detailsInitializer for the exception.
Exceptions
std::bad_allocif out of memory.

It is possible to call this constructor either with an explicit ExceptionInitializer object (useful for more complex cases), or a simple string if only a reason string needs to be provided.


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