File: PetscDataType.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (52 lines) | stat: -rw-r--r-- 4,658 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscDataType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscDataType</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/Sys/PetscDataType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscDataType"><H1>PetscDataType</H1></A>
Used for handling different basic data types. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef enum {<A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_DATATYPE_UNKNOWN</A> = 0,
              <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_DOUBLE</A> = 1, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_COMPLEX</A> = 2, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_LONG</A> = 3, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_SHORT</A> = 4, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_FLOAT</A> = 5,
              <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_CHAR</A> = 6, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_BIT_LOGICAL</A> = 7, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_ENUM</A> = 8, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_BOOL</A> = 9, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC___FLOAT128</A> = 10,
              <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_OBJECT</A> = 11, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_FUNCTION</A> = 12, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_STRING</A> = 13, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC___FP16</A> = 14, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_STRUCT</A> = 15,
              <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_INT</A> = 16, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_INT64</A> = 17} <A HREF="../Sys/PetscDataType.html#PetscDataType">PetscDataType</A>;
</PRE>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Use of this should be avoided if one can directly use MPI_Datatype instead.
<P>
<A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_INT</A> is the datatype for a <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>, regardless of whether it is 4 or 8 bytes.
PETSC_REAL, <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_COMPLEX</A> and PETSC_SCALAR are the datatypes for <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A>, <A HREF="../Sys/PetscComplex.html#PetscComplex">PetscComplex</A> and <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A>, regardless of their sizes.
<P>
<H3><FONT COLOR="#CC3333">Developer comment</FONT></H3>
It would be nice if we could always just use MPI Datatypes, why can we not?
<P>
If you change any values in PetscDatatype make sure you update their usage in
share/petsc/matlab/PetscBagRead.m and share/petsc/matlab/@PetscOpenSocket/read/write.m
<P>
TODO: Add PETSC_INT32 and remove use of improper <A HREF="../Sys/PetscDataType.html#PetscDataType">PETSC_ENUM</A>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Sys/PetscBinaryRead.html#PetscBinaryRead">PetscBinaryRead</A>(), <A HREF="../Sys/PetscBinaryWrite.html#PetscBinaryWrite">PetscBinaryWrite</A>(), <A HREF="../Sys/PetscDataTypeToMPIDataType.html#PetscDataTypeToMPIDataType">PetscDataTypeToMPIDataType</A>(),
<BR><A HREF="../Sys/PetscDataTypeGetSize.html#PetscDataTypeGetSize">PetscDataTypeGetSize</A>()
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../include/petscsystypes.h.html#PetscDataType">include/petscsystypes.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/sys/tutorials/ex5.c.html">src/sys/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex6.c.html">src/vec/vec/tutorials/ex6.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex6f.F90.html">src/vec/vec/tutorials/ex6f.F90.html</A><BR>
<A HREF="../../../src/dm/tutorials/ex20.c.html">src/dm/tutorials/ex20.c.html</A><BR>
<A HREF="../../../src/dm/tutorials/swarm_ex3.c.html">src/dm/tutorials/swarm_ex3.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>