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