preCICE v3.1.2
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
precice::utils::MPIResult Struct Reference

#include <MPIResult.hpp>

Public Member Functions

 MPIResult ()=default
 
 MPIResult (const MPIResult &other)=default
 
 MPIResult (int res)
 
MPIResultoperator= (MPIResult other)
 
 operator bool () const
 
std::string message () const
 

Public Attributes

int code
 

Detailed Description

Utility class to simplify use of MPI return codes

Provides implicit conversion to bool and message printing.

Definition at line 18 of file MPIResult.hpp.

Constructor & Destructor Documentation

◆ MPIResult() [1/3]

precice::utils::MPIResult::MPIResult ( )
default

◆ MPIResult() [2/3]

precice::utils::MPIResult::MPIResult ( const MPIResult & other)
default

◆ MPIResult() [3/3]

precice::utils::MPIResult::MPIResult ( int res)
inline

Definition at line 25 of file MPIResult.hpp.

Member Function Documentation

◆ message()

std::string precice::utils::MPIResult::message ( ) const
inline

Definition at line 39 of file MPIResult.hpp.

Here is the call graph for this function:

◆ operator bool()

precice::utils::MPIResult::operator bool ( ) const
inline

Definition at line 34 of file MPIResult.hpp.

◆ operator=()

MPIResult & precice::utils::MPIResult::operator= ( MPIResult other)
inline

Definition at line 28 of file MPIResult.hpp.

Member Data Documentation

◆ code

int precice::utils::MPIResult::code

Definition at line 19 of file MPIResult.hpp.


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