TIMPI::DataType Class Reference

Encapsulates the MPI_Datatype. More...

#include <data_type.h>

Inheritance diagram for TIMPI::DataType:

Public Member Functions
	DataType ()=default
	DataType (const DataType &other)=default
	DataType (DataType &&other)=default
	DataType (const data_type &type)
	DataType (const DataType &other, unsigned int count)
virtual	~DataType ()=default
DataType &	operator= (const DataType &other)=default
DataType &	operator= (DataType &&other)=default
DataType &	operator= (const data_type &type)
	operator const data_type & () const
	operator data_type & ()
void	commit ()
void	free ()

Static Public Attributes
static const bool	is_fixed_type = true

Protected Attributes
data_type	_datatype

Detailed Description

Encapsulates the MPI_Datatype.

Definition at line 50 of file data_type.h.

Constructor & Destructor Documentation

DataType() [1/5]

TIMPI::DataType::DataType ( )

default

DataType() [2/5]

TIMPI::DataType::DataType ( const DataType &  other )

default

DataType() [3/5]

TIMPI::DataType::DataType ( DataType &&  other )

default

DataType() [4/5]

TIMPI::DataType::DataType ( const data_type &  type )

inline

Definition at line 58 of file data_type.h.

                                    :
    _datatype(type)
  {}

DataType() [5/5]

TIMPI::DataType::DataType ( const DataType &  other, unsigned int  count  )

inline

Definition at line 62 of file data_type.h.

  {
    // FIXME - if we nest an inner type here will we run into bug
    // https://github.com/libMesh/libmesh/issues/631 again?
    timpi_call_mpi(MPI_Type_contiguous(count, other._datatype, &_datatype));
    ignore(other, count); // ifndef TIMPI_HAVE_MPI
    this->commit();
  }

References _datatype, TIMPI::cast_int(), commit(), and TIMPI::ignore().

~DataType()

virtual TIMPI::DataType::~DataType ( )

virtualdefault

Member Function Documentation

commit()

void TIMPI::DataType::commit ( )

inline

Definition at line 91 of file data_type.h.

  {
    timpi_call_mpi
      (MPI_Type_commit (&_datatype));
  }

References _datatype, and TIMPI::cast_int().

Referenced by DataType().

free()

void TIMPI::DataType::free ( )

inline

Definition at line 97 of file data_type.h.

  {
    timpi_call_mpi
      (MPI_Type_free (&_datatype));
  }

References _datatype, and TIMPI::cast_int().

operator const data_type &()

TIMPI::DataType::operator const data_type & ( ) const

inline

Definition at line 79 of file data_type.h.

  { return _datatype; }

References _datatype.

operator data_type &()

TIMPI::DataType::operator data_type & ( )

inline

Definition at line 82 of file data_type.h.

  { return _datatype; }

References _datatype.

operator=() [1/3]

DataType & TIMPI::DataType::operator= ( const data_type &  type )

inline

Definition at line 76 of file data_type.h.

  { _datatype = type; return *this; }

References _datatype.

operator=() [2/3]

DataType & TIMPI::DataType::operator= ( const DataType &  other )

default

operator=() [3/3]

DataType & TIMPI::DataType::operator= ( DataType &&  other )

default

Member Data Documentation

_datatype

data_type TIMPI::DataType::_datatype

protected

Definition at line 105 of file data_type.h.

Referenced by commit(), DataType(), free(), operator const data_type &(), operator data_type &(), operator=(), TIMPI::StandardType< std::array< T, N >, typename std::enable_if< StandardType< T >::is_fixed_type >::type >::StandardType(), TIMPI::StandardType< std::pair< T1, T2 >, typename std::enable_if< StandardType< typename std::remove_const< T1 >::type >::is_fixed_type &&StandardType< T2 >::is_fixed_type >::type >::StandardType(), TIMPI::StandardType< std::tuple< Types... >, typename std::enable_if< CheckAllFixedTypes< Types... >::is_fixed_type >::type >::StandardType(), and TIMPI::StandardType< TIMPI_DEFAULT_SCALAR_TYPE >::StandardType().

is_fixed_type

const bool TIMPI::DataType::is_fixed_type = true

static

Definition at line 56 of file data_type.h.

---

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

• src/parallel/include/timpi/data_type.h