Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 1.31 KB

MPI_Type_free.3.rst

File metadata and controls

72 lines (44 loc) · 1.31 KB
Raw

MPI_Type_free

:ref:`MPI_Type_free` - Frees a data type.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Type_free(MPI_Datatype *datatype)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_FREE(DATATYPE, IERROR)
     INTEGER DATATYPE, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Type_free(datatype, ierror)
     TYPE(MPI_Datatype), INTENT(INOUT) :: datatype
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT/OUTPUT PARAMETER

  • datatype: Datatype that is freed (handle).

OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

DESCRIPTION

Marks the datatype object associated with datatype for de-allocation and sets datatype to MPI_DATATYPE_NULL. Any communication that is currently using this datatype will complete normally. Derived datatypes that were defined from the freed datatype are not affected.

Freeing a datatype does not affect any other datatype that was built from the freed datatype. The system behaves as if input datatype arguments to derived datatype constructors are passed by value.

ERRORS