xref: /petsc/src/sys/objects/ptype.c (revision fbfcfee5110779e3d6a9465ca0a2e0f9a1a6e5e3)
1 
2 /*
3      Provides utility routines for manipulating any type of PETSc object.
4 */
5 #include <petscsys.h>  /*I   "petscsys.h"    I*/
6 
7 /*@C
8      PetscDataTypeToMPIDataType - Converts the PETSc name of a datatype to its MPI name.
9 
10    Not collective
11 
12     Input Parameter:
13 .     ptype - the PETSc datatype name (for example PETSC_DOUBLE)
14 
15     Output Parameter:
16 .     mtype - the MPI datatype (for example MPI_DOUBLE, ...)
17 
18     Level: advanced
19 
20 .seealso: PetscDataType, PetscMPIDataTypeToPetscDataType()
21 @*/
22 PetscErrorCode  PetscDataTypeToMPIDataType(PetscDataType ptype,MPI_Datatype *mtype)
23 {
24   PetscFunctionBegin;
25   if (ptype == PETSC_INT)              *mtype = MPIU_INT;
26   else if (ptype == PETSC_DOUBLE)      *mtype = MPI_DOUBLE;
27 #if defined(PETSC_USE_COMPLEX)
28 #if defined(PETSC_USE_REAL_SINGLE)
29   else if (ptype == PETSC_COMPLEX)     *mtype = MPIU_C_COMPLEX;
30 #elif defined(PETSC_USE_REAL___FLOAT128)
31   else if (ptype == PETSC_COMPLEX)     *mtype = MPIU___COMPLEX128;
32 #else
33   else if (ptype == PETSC_COMPLEX)     *mtype = MPIU_C_DOUBLE_COMPLEX;
34 #endif
35 #endif
36   else if (ptype == PETSC_LONG)        *mtype = MPI_LONG;
37   else if (ptype == PETSC_SHORT)       *mtype = MPI_SHORT;
38   else if (ptype == PETSC_ENUM)        *mtype = MPI_INT;
39   else if (ptype == PETSC_BOOL)        *mtype = MPI_INT;
40   else if (ptype == PETSC_FLOAT)       *mtype = MPI_FLOAT;
41   else if (ptype == PETSC_CHAR)        *mtype = MPI_CHAR;
42   else if (ptype == PETSC_BIT_LOGICAL) *mtype = MPI_BYTE;
43 #if defined(PETSC_USE_REAL___FLOAT128)
44   else if (ptype == PETSC___FLOAT128)  *mtype = MPIU___FLOAT128;
45 #endif
46   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown PETSc datatype");
47   PetscFunctionReturn(0);
48 }
49 
50 /*@C
51      PetscMPIDataTypeToPetscDataType Finds the PETSc name of a datatype from its MPI name
52 
53    Not collective
54 
55     Input Parameter:
56 .     mtype - the MPI datatype (for example MPI_DOUBLE, ...)
57 
58     Output Parameter:
59 .     ptype - the PETSc datatype name (for example PETSC_DOUBLE)
60 
61     Level: advanced
62 
63 .seealso: PetscDataType, PetscMPIDataTypeToPetscDataType()
64 @*/
65 PetscErrorCode  PetscMPIDataTypeToPetscDataType(MPI_Datatype mtype,PetscDataType *ptype)
66 {
67   PetscFunctionBegin;
68   if (mtype == MPIU_INT)             *ptype = PETSC_INT;
69   else if (mtype == MPI_INT)         *ptype = PETSC_INT;
70   else if (mtype == MPI_DOUBLE)      *ptype = PETSC_DOUBLE;
71 #if defined(PETSC_USE_COMPLEX)
72 #if defined(PETSC_USE_REAL_SINGLE)
73   else if (mtype == MPIU_C_COMPLEX)  *ptype = PETSC_COMPLEX;
74 #elif defined(PETSC_USE_REAL___FLOAT128)
75   else if (mtype == MPIU___COMPLEX128) *ptype = PETSC_COMPLEX;
76 #else
77   else if (mtype == MPIU_C_DOUBLE_COMPLEX) *ptype = PETSC_COMPLEX;
78 #endif
79 #endif
80   else if (mtype == MPI_LONG)        *ptype = PETSC_LONG;
81   else if (mtype == MPI_SHORT)       *ptype = PETSC_SHORT;
82   else if (mtype == MPI_FLOAT)       *ptype = PETSC_FLOAT;
83   else if (mtype == MPI_CHAR)        *ptype = PETSC_CHAR;
84 #if defined(PETSC_USE_REAL___FLOAT128)
85   else if (mtype == MPIU___FLOAT128) *ptype = PETSC___FLOAT128;
86 #endif
87   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unhandled MPI datatype");
88   PetscFunctionReturn(0);
89 }
90 
91 typedef enum {PETSC_INT_SIZE         = sizeof(PetscInt),
92               PETSC_DOUBLE_SIZE      = sizeof(double),
93               PETSC_COMPLEX_SIZE     = sizeof(PetscScalar),
94               PETSC_LONG_SIZE        = sizeof(long),
95               PETSC_SHORT_SIZE       = sizeof(short),
96               PETSC_FLOAT_SIZE       = sizeof(float),
97               PETSC_CHAR_SIZE        = sizeof(char),
98               PETSC_BIT_LOGICAL_SIZE = sizeof(char),
99               PETSC_ENUM_SIZE        = sizeof(PetscBool),
100               PETSC_BOOL_SIZE        = sizeof(PetscBool),
101               PETSC___FLOAT128_SIZE  = sizeof(long double)
102              } PetscDataTypeSize;
103 
104 /*@C
105      PetscDataTypeGetSize - Gets the size (in bytes) of a PETSc datatype
106 
107    Not collective
108 
109     Input Parameter:
110 .     ptype - the PETSc datatype name (for example PETSC_DOUBLE)
111 
112     Output Parameter:
113 .     size - the size in bytes (for example the size of PETSC_DOUBLE is 8)
114 
115     Level: advanced
116 
117 .seealso: PetscDataType, PetscDataTypeToMPIDataType()
118 @*/
119 PetscErrorCode  PetscDataTypeGetSize(PetscDataType ptype,size_t *size)
120 {
121   PetscFunctionBegin;
122   if ((int) ptype < 0) {
123     *size = -(int) ptype;
124     PetscFunctionReturn(0);
125   }
126 
127   if (ptype == PETSC_INT)              *size = PETSC_INT_SIZE;
128   else if (ptype == PETSC_DOUBLE)      *size = PETSC_DOUBLE_SIZE;
129 #if defined(PETSC_USE_COMPLEX)
130   else if (ptype == PETSC_COMPLEX)     *size = PETSC_COMPLEX_SIZE;
131 #endif
132   else if (ptype == PETSC_LONG)        *size = PETSC_LONG_SIZE;
133   else if (ptype == PETSC_SHORT)       *size = PETSC_SHORT_SIZE;
134   else if (ptype == PETSC_FLOAT)       *size = PETSC_FLOAT_SIZE;
135   else if (ptype == PETSC_CHAR)        *size = PETSC_CHAR_SIZE;
136   else if (ptype == PETSC_ENUM)        *size = PETSC_ENUM_SIZE;
137   else if (ptype == PETSC_BIT_LOGICAL) *size = PETSC_BIT_LOGICAL_SIZE;
138   else if (ptype == PETSC_BOOL)        *size = PETSC_BOOL_SIZE;
139   else if (ptype == PETSC___FLOAT128)  *size = PETSC___FLOAT128_SIZE;
140   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown PETSc datatype");
141   PetscFunctionReturn(0);
142 }
143 
144 /*@
145      PetscDataTypeFromString - Gets the enum value of a PETSc datatype represented as a string
146 
147    Not collective
148 
149     Input Parameter:
150 .     name - the PETSc datatype name (for example, DOUBLE or real or Scalar)
151 
152     Output Parameter:
153 +    ptype - the enum value
154 -    found - the string matches one of the data types
155 
156     Level: advanced
157 
158 .seealso: PetscDataType, PetscDataTypeToMPIDataType(), PetscDataTypeGetSize()
159 @*/
160 PetscErrorCode  PetscDataTypeFromString(const char*name, PetscDataType *ptype,PetscBool *found)
161 {
162   PetscErrorCode ierr;
163 
164   PetscFunctionBegin;
165   ierr = PetscEnumFind(PetscDataTypes,name,(PetscEnum*)ptype,found);CHKERRQ(ierr);
166   if (!*found) {
167     char formatted[16];
168 
169     ierr = PetscStrncpy(formatted,name,16);CHKERRQ(ierr);
170     ierr = PetscStrtolower(formatted);CHKERRQ(ierr);
171     ierr = PetscStrcmp(formatted,"scalar",found);CHKERRQ(ierr);
172     if (*found) {
173       *ptype = PETSC_SCALAR;
174     } else {
175       ierr = PetscStrcmp(formatted,"real",found);CHKERRQ(ierr);
176       if (*found) {
177         *ptype = PETSC_REAL;
178       }
179     }
180   }
181   PetscFunctionReturn(0);
182 }
183