xref: /petsc/src/sys/classes/viewer/impls/adios/adios.c (revision 8a976931b7a83f81d213503b5760e45917bb0380)
1 #include <petsc/private/viewerimpl.h>    /*I   "petscsys.h"   I*/
2 #include <adios.h>
3 
4 int64_t Petsc_adios_group;
5 
6 #include <petsc/private/vieweradiosimpl.h>
7 
8 static PetscErrorCode PetscViewerSetFromOptions_ADIOS(PetscOptionItems *PetscOptionsObject,PetscViewer v)
9 {
10   PetscErrorCode ierr;
11 
12   PetscFunctionBegin;
13   ierr = PetscOptionsHead(PetscOptionsObject,"ADIOS PetscViewer Options");CHKERRQ(ierr);
14   ierr = PetscOptionsTail();CHKERRQ(ierr);
15   PetscFunctionReturn(0);
16 }
17 
18 static PetscErrorCode PetscViewerFileClose_ADIOS(PetscViewer viewer)
19 {
20   PetscViewer_ADIOS *adios = (PetscViewer_ADIOS*)viewer->data;
21   PetscErrorCode    ierr;
22 
23   PetscFunctionBegin;
24   ierr = adios_close(adios->adios_handle);CHKERRQ(ierr);
25   ierr = PetscFree(adios->filename);CHKERRQ(ierr);
26   PetscFunctionReturn(0);
27 }
28 
29 PetscErrorCode PetscViewerDestroy_ADIOS(PetscViewer viewer)
30 {
31   PetscViewer_ADIOS *adios = (PetscViewer_ADIOS*) viewer->data;
32   PetscErrorCode    ierr;
33 
34   PetscFunctionBegin;
35   ierr = PetscViewerFileClose_ADIOS(viewer);CHKERRQ(ierr);
36   ierr = PetscFree(adios);CHKERRQ(ierr);
37   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetName_C",NULL);CHKERRQ(ierr);
38   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileGetName_C",NULL);CHKERRQ(ierr);
39   ierr = PetscObjectComposeFunction((PetscObject)viewer,"PetscViewerFileSetMode_C",NULL);CHKERRQ(ierr);
40   PetscFunctionReturn(0);
41 }
42 
43 PetscErrorCode  PetscViewerFileSetMode_ADIOS(PetscViewer viewer, PetscFileMode type)
44 {
45   PetscViewer_ADIOS *adios = (PetscViewer_ADIOS*) viewer->data;
46 
47   PetscFunctionBegin;
48   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 1);
49   adios->btype = type;
50   PetscFunctionReturn(0);
51 }
52 
53 PetscErrorCode  PetscViewerFileSetName_ADIOS(PetscViewer viewer, const char name[])
54 {
55   PetscViewer_ADIOS *adios = (PetscViewer_ADIOS*) viewer->data;
56   PetscErrorCode    ierr;
57 
58   PetscFunctionBegin;
59   if (adios->filename) {ierr = PetscFree(adios->filename);CHKERRQ(ierr);}
60   ierr = PetscStrallocpy(name, &adios->filename);CHKERRQ(ierr);
61   /* Create or open the file collectively */
62   switch (adios->btype) {
63   case FILE_MODE_READ:
64     adios_open(&adios->adios_handle,"PETSc",adios->filename,"r",PetscObjectComm((PetscObject)viewer));
65     break;
66   case FILE_MODE_APPEND:
67     break;
68   case FILE_MODE_WRITE:
69     adios_open(&adios->adios_handle,"PETSc",adios->filename,"w",PetscObjectComm((PetscObject)viewer));
70     break;
71   default:
72     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ORDER, "Must call PetscViewerFileSetMode() before PetscViewerFileSetName()");
73   }
74   PetscFunctionReturn(0);
75 }
76 
77 static PetscErrorCode PetscViewerFileGetName_ADIOS(PetscViewer viewer,const char **name)
78 {
79   PetscViewer_ADIOS *vadios = (PetscViewer_ADIOS*)viewer->data;
80 
81   PetscFunctionBegin;
82   *name = vadios->filename;
83   PetscFunctionReturn(0);
84 }
85 
86 /*MC
87    PETSCVIEWERADIOS - A viewer that writes to an ADIOS file
88 
89 
90 .seealso:  PetscViewerADIOSOpen(), PetscViewerStringSPrintf(), PetscViewerSocketOpen(), PetscViewerDrawOpen(), PETSCVIEWERSOCKET,
91            PetscViewerCreate(), PetscViewerASCIIOpen(), PetscViewerBinaryOpen(), PETSCVIEWERBINARY, PETSCVIEWERDRAW, PETSCVIEWERSTRING,
92            PetscViewerMatlabOpen(), VecView(), DMView(), PetscViewerMatlabPutArray(), PETSCVIEWERASCII, PETSCVIEWERMATLAB,
93            PetscViewerFileSetName(), PetscViewerFileSetMode(), PetscViewerFormat, PetscViewerType, PetscViewerSetType()
94 
95   Level: beginner
96 M*/
97 
98 PETSC_EXTERN PetscErrorCode PetscViewerCreate_ADIOS(PetscViewer v)
99 {
100   PetscViewer_ADIOS *adios;
101   PetscErrorCode    ierr;
102 
103   PetscFunctionBegin;
104   ierr = PetscNewLog(v,&adios);CHKERRQ(ierr);
105 
106   v->data                = (void*) adios;
107   v->ops->destroy        = PetscViewerDestroy_ADIOS;
108   v->ops->setfromoptions = PetscViewerSetFromOptions_ADIOS;
109   v->ops->flush          = 0;
110   adios->btype            = (PetscFileMode) -1;
111   adios->filename         = 0;
112   adios->timestep         = -1;
113 
114   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetName_C",PetscViewerFileSetName_ADIOS);CHKERRQ(ierr);
115   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileGetName_C",PetscViewerFileGetName_ADIOS);CHKERRQ(ierr);
116   ierr = PetscObjectComposeFunction((PetscObject)v,"PetscViewerFileSetMode_C",PetscViewerFileSetMode_ADIOS);CHKERRQ(ierr);
117   PetscFunctionReturn(0);
118 }
119 
120 /*@C
121    PetscViewerADIOSOpen - Opens a file for ADIOS input/output.
122 
123    Collective on MPI_Comm
124 
125    Input Parameters:
126 +  comm - MPI communicator
127 .  name - name of file
128 -  type - type of file
129 $    FILE_MODE_WRITE - create new file for binary output
130 $    FILE_MODE_READ - open existing file for binary input
131 $    FILE_MODE_APPEND - open existing file for binary output
132 
133    Output Parameter:
134 .  adiosv - PetscViewer for ADIOS input/output to use with the specified file
135 
136    Level: beginner
137 
138    Note:
139    This PetscViewer should be destroyed with PetscViewerDestroy().
140 
141    Concepts: ADIOS files
142    Concepts: PetscViewerADIOS^creating
143 
144 .seealso: PetscViewerASCIIOpen(), PetscViewerPushFormat(), PetscViewerDestroy(), PetscViewerHDF5Open(),
145           VecView(), MatView(), VecLoad(), PetscViewerSetType(), PetscViewerFileSetMode(), PetscViewerFileSetName()
146           MatLoad(), PetscFileMode, PetscViewer
147 @*/
148 PetscErrorCode  PetscViewerADIOSOpen(MPI_Comm comm, const char name[], PetscFileMode type, PetscViewer *adiosv)
149 {
150   PetscErrorCode ierr;
151 
152   PetscFunctionBegin;
153   ierr = PetscViewerCreate(comm, adiosv);CHKERRQ(ierr);
154   ierr = PetscViewerSetType(*adiosv, PETSCVIEWERADIOS);CHKERRQ(ierr);
155   ierr = PetscViewerFileSetMode(*adiosv, type);CHKERRQ(ierr);
156   ierr = PetscViewerFileSetName(*adiosv, name);CHKERRQ(ierr);
157   PetscFunctionReturn(0);
158 }
159 
160 /*@C
161   PetscDataTypeToADIOSDataType - Converts the PETSc name of a datatype to its ADIOS name.
162 
163   Not collective
164 
165   Input Parameter:
166 . ptype - the PETSc datatype name (for example PETSC_DOUBLE)
167 
168   Output Parameter:
169 . mtype - the MPI datatype (for example MPI_DOUBLE, ...)
170 
171   Level: advanced
172 
173   Developer Notes: These have not been verified
174 
175 .seealso: PetscDataType, PetscADIOSDataTypeToPetscDataType()
176 @*/
177 PetscErrorCode PetscDataTypeToADIOSDataType(PetscDataType ptype, enum ADIOS_DATATYPES *htype)
178 {
179   PetscFunctionBegin;
180   if (ptype == PETSC_INT)
181 #if defined(PETSC_USE_64BIT_INDICES)
182                                        *htype = adios_long;
183 #else
184                                        *htype = adios_integer;
185 #endif
186   else if (ptype == PETSC_ENUM)        *htype = adios_integer;
187   else if (ptype == PETSC_DOUBLE)      *htype = adios_double;
188   else if (ptype == PETSC_LONG)        *htype = adios_long;
189   else if (ptype == PETSC_SHORT)       *htype = adios_short;
190   else if (ptype == PETSC_FLOAT)       *htype = adios_real;
191   else if (ptype == PETSC_CHAR)        *htype = adios_string_array;
192   else if (ptype == PETSC_STRING)      *htype = adios_string;
193   else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Unsupported PETSc datatype");
194   PetscFunctionReturn(0);
195 }
196 
197 /*@C
198   PetscADIOSDataTypeToPetscDataType - Finds the PETSc name of a datatype from its ADIOS name
199 
200   Not collective
201 
202   Input Parameter:
203 . htype - the ADIOS datatype (for example H5T_NATIVE_DOUBLE, ...)
204 
205   Output Parameter:
206 . ptype - the PETSc datatype name (for example PETSC_DOUBLE)
207 
208   Level: advanced
209 
210   Developer Notes: These have not been verified
211 
212 .seealso: PetscDataType, PetscADIOSDataTypeToPetscDataType()
213 @*/
214 PetscErrorCode PetscADIOSDataTypeToPetscDataType(enum ADIOS_DATATYPES htype, PetscDataType *ptype)
215 {
216   PetscFunctionBegin;
217 #if defined(PETSC_USE_64BIT_INDICES)
218   if      (htype == adios_integer)     *ptype = PETSC_ENUM;
219   else if (htype == adios_long)        *ptype = PETSC_INT;
220 #else
221   if      (htype == adios_integer)     *ptype = PETSC_INT;
222 #endif
223   else if (htype == adios_double)      *ptype = PETSC_DOUBLE;
224   else if (htype == adios_long)        *ptype = PETSC_LONG;
225   else if (htype == adios_short)       *ptype = PETSC_SHORT;
226   else if (htype == adios_real)        *ptype = PETSC_FLOAT;
227   else if (htype == adios_string_array) *ptype = PETSC_CHAR;
228   else if (htype == adios_string)       *ptype = PETSC_STRING;
229   else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Unsupported ADIOS datatype");
230   PetscFunctionReturn(0);
231 }
232 
233