xref: /libCEED/backends/ref/ceed-ref-operator.c (revision f05116b9f691b43fc3d4afbf561404e33a51ae22) 
1 // Copyright (c) 2017-2018, Lawrence Livermore National Security, LLC.
2 // Produced at the Lawrence Livermore National Laboratory. LLNL-CODE-734707.
3 // All Rights reserved. See files LICENSE and NOTICE for details.
4 //
5 // This file is part of CEED, a collection of benchmarks, miniapps, software
6 // libraries and APIs for efficient high-order finite element and spectral
7 // element discretizations for exascale applications. For more information and
8 // source code availability see http://github.com/ceed.
9 //
10 // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC,
11 // a collaborative effort of two U.S. Department of Energy organizations (Office
12 // of Science and the National Nuclear Security Administration) responsible for
13 // the planning and preparation of a capable exascale ecosystem, including
14 // software, applications, hardware, advanced system engineering and early
15 // testbed platforms, in support of the nation's exascale computing imperative.
16 
17 #include <string.h>
18 #include "ceed-ref.h"
19 
20 static int CeedOperatorDestroy_Ref(CeedOperator op) {
21   int ierr;
22   CeedOperator_Ref *impl;
23   ierr = CeedOperatorGetData(op, (void *)&impl); CeedChk(ierr);
24 
25   for (CeedInt i=0; i<impl->numein+impl->numeout; i++) {
26     ierr = CeedVectorDestroy(&impl->evecs[i]); CeedChk(ierr);
27   }
28   ierr = CeedFree(&impl->evecs); CeedChk(ierr);
29   ierr = CeedFree(&impl->edata); CeedChk(ierr);
30   ierr = CeedFree(&impl->inputstate); CeedChk(ierr);
31 
32   for (CeedInt i=0; i<impl->numein; i++) {
33     ierr = CeedVectorDestroy(&impl->evecsin[i]); CeedChk(ierr);
34     ierr = CeedVectorDestroy(&impl->qvecsin[i]); CeedChk(ierr);
35   }
36   ierr = CeedFree(&impl->evecsin); CeedChk(ierr);
37   ierr = CeedFree(&impl->qvecsin); CeedChk(ierr);
38 
39   for (CeedInt i=0; i<impl->numeout; i++) {
40     ierr = CeedVectorDestroy(&impl->evecsout[i]); CeedChk(ierr);
41     ierr = CeedVectorDestroy(&impl->qvecsout[i]); CeedChk(ierr);
42   }
43   ierr = CeedFree(&impl->evecsout); CeedChk(ierr);
44   ierr = CeedFree(&impl->qvecsout); CeedChk(ierr);
45 
46   ierr = CeedFree(&impl); CeedChk(ierr);
47   return 0;
48 }
49 
50 /*
51   Setup infields or outfields
52  */
53 static int CeedOperatorSetupFields_Ref(CeedQFunction qf, CeedOperator op,
54                                        bool inOrOut,
55                                        CeedVector *fullevecs, CeedVector *evecs,
56                                        CeedVector *qvecs, CeedInt starte,
57                                        CeedInt numfields, CeedInt Q) {
58   CeedInt dim, ierr, ncomp, P;
59   Ceed ceed;
60   ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
61   CeedBasis basis;
62   CeedElemRestriction Erestrict;
63   CeedOperatorField *opfields;
64   CeedQFunctionField *qffields;
65   if (inOrOut) {
66     ierr = CeedOperatorGetFields(op, NULL, &opfields);
67     CeedChk(ierr);
68     ierr = CeedQFunctionGetFields(qf, NULL, &qffields);
69     CeedChk(ierr);
70   } else {
71     ierr = CeedOperatorGetFields(op, &opfields, NULL);
72     CeedChk(ierr);
73     ierr = CeedQFunctionGetFields(qf, &qffields, NULL);
74     CeedChk(ierr);
75   }
76 
77   // Loop over fields
78   for (CeedInt i=0; i<numfields; i++) {
79     CeedEvalMode emode;
80     ierr = CeedQFunctionFieldGetEvalMode(qffields[i], &emode); CeedChk(ierr);
81 
82     if (emode != CEED_EVAL_WEIGHT) {
83       ierr = CeedOperatorFieldGetElemRestriction(opfields[i], &Erestrict);
84       CeedChk(ierr);
85       ierr = CeedElemRestrictionCreateVector(Erestrict, NULL,
86                                              &fullevecs[i+starte]);
87       CeedChk(ierr);
88     }
89 
90     switch(emode) {
91     case CEED_EVAL_NONE:
92       ierr = CeedQFunctionFieldGetNumComponents(qffields[i], &ncomp);
93       CeedChk(ierr);
94       ierr = CeedVectorCreate(ceed, Q*ncomp, &qvecs[i]); CeedChk(ierr);
95       break;
96     case CEED_EVAL_INTERP:
97       ierr = CeedQFunctionFieldGetNumComponents(qffields[i], &ncomp);
98       CeedChk(ierr);
99       ierr = CeedElemRestrictionGetElementSize(Erestrict, &P);
100       CeedChk(ierr);
101       ierr = CeedVectorCreate(ceed, P*ncomp, &evecs[i]); CeedChk(ierr);
102       ierr = CeedVectorCreate(ceed, Q*ncomp, &qvecs[i]); CeedChk(ierr);
103       break;
104     case CEED_EVAL_GRAD:
105       ierr = CeedOperatorFieldGetBasis(opfields[i], &basis); CeedChk(ierr);
106       ierr = CeedQFunctionFieldGetNumComponents(qffields[i], &ncomp);
107       ierr = CeedBasisGetDimension(basis, &dim); CeedChk(ierr);
108       ierr = CeedElemRestrictionGetElementSize(Erestrict, &P);
109       CeedChk(ierr);
110       ierr = CeedVectorCreate(ceed, P*ncomp, &evecs[i]); CeedChk(ierr);
111       ierr = CeedVectorCreate(ceed, Q*ncomp*dim, &qvecs[i]); CeedChk(ierr);
112       break;
113     case CEED_EVAL_WEIGHT: // Only on input fields
114       ierr = CeedOperatorFieldGetBasis(opfields[i], &basis); CeedChk(ierr);
115       ierr = CeedVectorCreate(ceed, Q, &qvecs[i]); CeedChk(ierr);
116       ierr = CeedBasisApply(basis, 1, CEED_NOTRANSPOSE, CEED_EVAL_WEIGHT,
117                             NULL, qvecs[i]); CeedChk(ierr);
118       break;
119     case CEED_EVAL_DIV:
120       break; // Not implimented
121     case CEED_EVAL_CURL:
122       break; // Not implimented
123     }
124   }
125   return 0;
126 }
127 
128 /*
129   CeedOperator needs to connect all the named fields (be they active or passive)
130   to the named inputs and outputs of its CeedQFunction.
131  */
132 static int CeedOperatorSetup_Ref(CeedOperator op) {
133   int ierr;
134   bool setupdone;
135   ierr = CeedOperatorGetSetupStatus(op, &setupdone); CeedChk(ierr);
136   if (setupdone) return 0;
137   Ceed ceed;
138   ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
139   CeedOperator_Ref *impl;
140   ierr = CeedOperatorGetData(op, (void *)&impl); CeedChk(ierr);
141   CeedQFunction qf;
142   ierr = CeedOperatorGetQFunction(op, &qf); CeedChk(ierr);
143   CeedInt Q, numinputfields, numoutputfields;
144   ierr = CeedOperatorGetNumQuadraturePoints(op, &Q); CeedChk(ierr);
145   ierr = CeedQFunctionGetNumArgs(qf, &numinputfields, &numoutputfields);
146   CeedChk(ierr);
147   CeedOperatorField *opinputfields, *opoutputfields;
148   ierr = CeedOperatorGetFields(op, &opinputfields, &opoutputfields);
149   CeedChk(ierr);
150   CeedQFunctionField *qfinputfields, *qfoutputfields;
151   ierr = CeedQFunctionGetFields(qf, &qfinputfields, &qfoutputfields);
152   CeedChk(ierr);
153 
154   // Allocate
155   ierr = CeedCalloc(numinputfields + numoutputfields, &impl->evecs);
156   CeedChk(ierr);
157   ierr = CeedCalloc(numinputfields + numoutputfields, &impl->edata);
158   CeedChk(ierr);
159 
160   ierr = CeedCalloc(16, &impl->inputstate); CeedChk(ierr);
161   ierr = CeedCalloc(16, &impl->evecsin); CeedChk(ierr);
162   ierr = CeedCalloc(16, &impl->evecsout); CeedChk(ierr);
163   ierr = CeedCalloc(16, &impl->qvecsin); CeedChk(ierr);
164   ierr = CeedCalloc(16, &impl->qvecsout); CeedChk(ierr);
165 
166   impl->numein = numinputfields; impl->numeout = numoutputfields;
167 
168   // Set up infield and outfield evecs and qvecs
169   // Infields
170   ierr = CeedOperatorSetupFields_Ref(qf, op, 0, impl->evecs,
171                                      impl->evecsin, impl->qvecsin, 0,
172                                      numinputfields, Q);
173   CeedChk(ierr);
174 
175   // Outfields
176   ierr = CeedOperatorSetupFields_Ref(qf, op, 1, impl->evecs,
177                                      impl->evecsout, impl->qvecsout,
178                                      numinputfields, numoutputfields, Q);
179   CeedChk(ierr);
180 
181   ierr = CeedOperatorSetSetupDone(op); CeedChk(ierr);
182 
183   return 0;
184 }
185 
186 static int CeedOperatorApply_Ref(CeedOperator op, CeedVector invec,
187                                  CeedVector outvec, CeedRequest *request) {
188   int ierr;
189   CeedOperator_Ref *impl;
190   ierr = CeedOperatorGetData(op, (void *)&impl); CeedChk(ierr);
191   CeedQFunction qf;
192   ierr = CeedOperatorGetQFunction(op, &qf); CeedChk(ierr);
193   CeedInt Q, numelements, elemsize, numinputfields, numoutputfields, ncomp;
194   ierr = CeedOperatorGetNumQuadraturePoints(op, &Q); CeedChk(ierr);
195   ierr = CeedOperatorGetNumElements(op, &numelements); CeedChk(ierr);
196   ierr= CeedQFunctionGetNumArgs(qf, &numinputfields, &numoutputfields);
197   CeedChk(ierr);
198   CeedTransposeMode lmode;
199   CeedOperatorField *opinputfields, *opoutputfields;
200   ierr = CeedOperatorGetFields(op, &opinputfields, &opoutputfields);
201   CeedChk(ierr);
202   CeedQFunctionField *qfinputfields, *qfoutputfields;
203   ierr = CeedQFunctionGetFields(qf, &qfinputfields, &qfoutputfields);
204   CeedChk(ierr);
205   CeedEvalMode emode;
206   CeedVector vec;
207   CeedBasis basis;
208   CeedElemRestriction Erestrict;
209   uint64_t state;
210 
211   // Setup
212   ierr = CeedOperatorSetup_Ref(op); CeedChk(ierr);
213 
214   // Input Evecs and Restriction
215   for (CeedInt i=0; i<numinputfields; i++) {
216     ierr = CeedQFunctionFieldGetEvalMode(qfinputfields[i], &emode);
217     CeedChk(ierr);
218     if (emode == CEED_EVAL_WEIGHT) { // Skip
219     } else {
220       // Get input vector
221       ierr = CeedOperatorFieldGetVector(opinputfields[i], &vec); CeedChk(ierr);
222       if (vec == CEED_VECTOR_ACTIVE)
223         vec = invec;
224       // Restrict
225       ierr = CeedVectorGetState(vec, &state); CeedChk(ierr);
226       // Skip restriction if input is unchanged
227       if (state != impl->inputstate[i] || vec == invec) {
228         ierr = CeedOperatorFieldGetElemRestriction(opinputfields[i], &Erestrict);
229         CeedChk(ierr);
230         ierr = CeedOperatorFieldGetLMode(opinputfields[i], &lmode); CeedChk(ierr);
231         ierr = CeedElemRestrictionApply(Erestrict, CEED_NOTRANSPOSE,
232                                         lmode, vec, impl->evecs[i],
233                                         request); CeedChk(ierr);
234         impl->inputstate[i] = state;
235       }
236       // Get evec
237       ierr = CeedVectorGetArrayRead(impl->evecs[i], CEED_MEM_HOST,
238                                     (const CeedScalar **) &impl->edata[i]);
239       CeedChk(ierr);
240     }
241   }
242 
243   // Output Evecs
244   for (CeedInt i=0; i<numoutputfields; i++) {
245     ierr = CeedVectorGetArray(impl->evecs[i+impl->numein], CEED_MEM_HOST,
246                               &impl->edata[i + numinputfields]); CeedChk(ierr);
247   }
248 
249   // Loop through elements
250   for (CeedInt e=0; e<numelements; e++) {
251     // Input basis apply if needed
252     for (CeedInt i=0; i<numinputfields; i++) {
253       // Get elemsize, emode, ncomp
254       ierr = CeedOperatorFieldGetElemRestriction(opinputfields[i], &Erestrict);
255       CeedChk(ierr);
256       ierr = CeedElemRestrictionGetElementSize(Erestrict, &elemsize);
257       CeedChk(ierr);
258       ierr = CeedQFunctionFieldGetEvalMode(qfinputfields[i], &emode);
259       CeedChk(ierr);
260       ierr = CeedQFunctionFieldGetNumComponents(qfinputfields[i], &ncomp);
261       CeedChk(ierr);
262       // Basis action
263       switch(emode) {
264       case CEED_EVAL_NONE:
265         ierr = CeedVectorSetArray(impl->qvecsin[i], CEED_MEM_HOST,
266                                   CEED_USE_POINTER,
267                                   &impl->edata[i][e*Q*ncomp]); CeedChk(ierr);
268         break;
269       case CEED_EVAL_INTERP:
270         ierr = CeedOperatorFieldGetBasis(opinputfields[i], &basis); CeedChk(ierr);
271         ierr = CeedVectorSetArray(impl->evecsin[i], CEED_MEM_HOST,
272                                   CEED_USE_POINTER,
273                                   &impl->edata[i][e*elemsize*ncomp]);
274         CeedChk(ierr);
275         ierr = CeedBasisApply(basis, 1, CEED_NOTRANSPOSE,
276                               CEED_EVAL_INTERP, impl->evecsin[i],
277                               impl->qvecsin[i]); CeedChk(ierr);
278         break;
279       case CEED_EVAL_GRAD:
280         ierr = CeedOperatorFieldGetBasis(opinputfields[i], &basis); CeedChk(ierr);
281         ierr = CeedVectorSetArray(impl->evecsin[i], CEED_MEM_HOST,
282                                   CEED_USE_POINTER,
283                                   &impl->edata[i][e*elemsize*ncomp]);
284         CeedChk(ierr);
285         ierr = CeedBasisApply(basis, 1, CEED_NOTRANSPOSE,
286                               CEED_EVAL_GRAD, impl->evecsin[i],
287                               impl->qvecsin[i]); CeedChk(ierr);
288         break;
289       case CEED_EVAL_WEIGHT:
290         break;  // No action
291       case CEED_EVAL_DIV:
292         break; // Not implimented
293       case CEED_EVAL_CURL:
294         break; // Not implimented
295       }
296     }
297     // Output pointers
298     for (CeedInt i=0; i<numoutputfields; i++) {
299       ierr = CeedQFunctionFieldGetEvalMode(qfoutputfields[i], &emode);
300       CeedChk(ierr);
301       if (emode == CEED_EVAL_NONE) {
302         ierr = CeedQFunctionFieldGetNumComponents(qfoutputfields[i], &ncomp);
303         CeedChk(ierr);
304         ierr = CeedVectorSetArray(impl->qvecsout[i], CEED_MEM_HOST,
305                                   CEED_USE_POINTER,
306                                   &impl->edata[i + numinputfields][e*Q*ncomp]);
307         CeedChk(ierr);
308       }
309     }
310     // Q function
311     ierr = CeedQFunctionApply(qf, Q, impl->qvecsin, impl->qvecsout); CeedChk(ierr);
312 
313     // Output basis apply if needed
314     for (CeedInt i=0; i<numoutputfields; i++) {
315       // Get elemsize, emode, ncomp
316       ierr = CeedOperatorFieldGetElemRestriction(opoutputfields[i], &Erestrict);
317       CeedChk(ierr);
318       ierr = CeedElemRestrictionGetElementSize(Erestrict, &elemsize);
319       CeedChk(ierr);
320       ierr = CeedQFunctionFieldGetEvalMode(qfoutputfields[i], &emode);
321       CeedChk(ierr);
322       ierr = CeedQFunctionFieldGetNumComponents(qfoutputfields[i], &ncomp);
323       CeedChk(ierr);
324       // Basis action
325       switch(emode) {
326       case CEED_EVAL_NONE:
327         break; // No action
328       case CEED_EVAL_INTERP:
329         ierr = CeedOperatorFieldGetBasis(opoutputfields[i], &basis);
330         CeedChk(ierr);
331         ierr = CeedVectorSetArray(impl->evecsout[i], CEED_MEM_HOST,
332                                   CEED_USE_POINTER,
333                                   &impl->edata[i + numinputfields][e*elemsize*ncomp]);
334         ierr = CeedBasisApply(basis, 1, CEED_TRANSPOSE,
335                               CEED_EVAL_INTERP, impl->qvecsout[i],
336                               impl->evecsout[i]); CeedChk(ierr);
337         break;
338       case CEED_EVAL_GRAD:
339         ierr = CeedOperatorFieldGetBasis(opoutputfields[i], &basis);
340         CeedChk(ierr);
341         ierr = CeedVectorSetArray(impl->evecsout[i], CEED_MEM_HOST,
342                                   CEED_USE_POINTER,
343                                   &impl->edata[i + numinputfields][e*elemsize*ncomp]);
344         ierr = CeedBasisApply(basis, 1, CEED_TRANSPOSE,
345                               CEED_EVAL_GRAD, impl->qvecsout[i],
346                               impl->evecsout[i]); CeedChk(ierr);
347         break;
348       case CEED_EVAL_WEIGHT: {
349         Ceed ceed;
350         ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
351         return CeedError(ceed, 1,
352                          "CEED_EVAL_WEIGHT cannot be an output evaluation mode");
353         break; // Should not occur
354       }
355       case CEED_EVAL_DIV:
356         break; // Not implimented
357       case CEED_EVAL_CURL:
358         break; // Not implimented
359       }
360     }
361   }
362 
363   // Zero lvecs
364   for (CeedInt i=0; i<numoutputfields; i++) {
365     ierr = CeedOperatorFieldGetVector(opoutputfields[i], &vec); CeedChk(ierr);
366     if (vec == CEED_VECTOR_ACTIVE) {
367       if (!impl->add) {
368         vec = outvec;
369         ierr = CeedVectorSetValue(vec, 0.0); CeedChk(ierr);
370       }
371     } else {
372       ierr = CeedVectorSetValue(vec, 0.0); CeedChk(ierr);
373     }
374   }
375   impl->add = false;
376 
377   // Output restriction
378   for (CeedInt i=0; i<numoutputfields; i++) {
379     // Restore evec
380     ierr = CeedVectorRestoreArray(impl->evecs[i+impl->numein],
381                                   &impl->edata[i + numinputfields]);
382     CeedChk(ierr);
383     // Get output vector
384     ierr = CeedOperatorFieldGetVector(opoutputfields[i], &vec); CeedChk(ierr);
385     // Active
386     if (vec == CEED_VECTOR_ACTIVE)
387       vec = outvec;
388     // Restrict
389     ierr = CeedOperatorFieldGetElemRestriction(opoutputfields[i], &Erestrict);
390     CeedChk(ierr);
391     ierr = CeedOperatorFieldGetLMode(opoutputfields[i], &lmode); CeedChk(ierr);
392     ierr = CeedElemRestrictionApply(Erestrict, CEED_TRANSPOSE,
393                                     lmode, impl->evecs[i+impl->numein], vec,
394                                     request); CeedChk(ierr);
395   }
396 
397   // Restore input arrays
398   for (CeedInt i=0; i<numinputfields; i++) {
399     ierr = CeedQFunctionFieldGetEvalMode(qfinputfields[i], &emode);
400     CeedChk(ierr);
401     if (emode == CEED_EVAL_WEIGHT) { // Skip
402     } else {
403       ierr = CeedVectorRestoreArrayRead(impl->evecs[i],
404                                         (const CeedScalar **) &impl->edata[i]);
405       CeedChk(ierr);
406     }
407   }
408 
409   return 0;
410 }
411 
412 static int CeedCompositeOperatorApply_Ref(CeedOperator op, CeedVector invec,
413     CeedVector outvec,
414     CeedRequest *request) {
415   int ierr;
416   CeedInt numsub;
417   CeedOperator_Ref *impl;
418   CeedOperator *suboperators;
419   ierr = CeedOperatorGetNumSub(op, &numsub); CeedChk(ierr);
420   ierr = CeedOperatorGetSubList(op, &suboperators); CeedChk(ierr);
421 
422   // Overwrite outvec with first output
423   ierr = CeedOperatorApply(suboperators[0], invec, outvec, request);
424   CeedChk(ierr);
425   // Add to outvec with subsequent outputs
426   for (CeedInt i=1; i<numsub; i++) {
427     ierr = CeedOperatorGetData(suboperators[i], (void *)&impl);
428     impl->add = true;
429     ierr = CeedOperatorApply(suboperators[i], invec, outvec, request);
430     CeedChk(ierr);
431   }
432 
433   return 0;
434 }
435 
436 int CeedOperatorCreate_Ref(CeedOperator op) {
437   int ierr;
438   Ceed ceed;
439   ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
440   CeedOperator_Ref *impl;
441 
442   ierr = CeedCalloc(1, &impl); CeedChk(ierr);
443   impl->add = false;
444   ierr = CeedOperatorSetData(op, (void *)&impl);
445 
446   ierr = CeedSetBackendFunction(ceed, "Operator", op, "Apply",
447                                 CeedOperatorApply_Ref); CeedChk(ierr);
448   ierr = CeedSetBackendFunction(ceed, "Operator", op, "Destroy",
449                                 CeedOperatorDestroy_Ref); CeedChk(ierr);
450   return 0;
451 }
452 
453 int CeedCompositeOperatorCreate_Ref(CeedOperator op) {
454   int ierr;
455   Ceed ceed;
456   ierr = CeedOperatorGetCeed(op, &ceed); CeedChk(ierr);
457 
458   ierr = CeedSetBackendFunction(ceed, "Operator", op, "Apply",
459                                 CeedCompositeOperatorApply_Ref); CeedChk(ierr);
460   return 0;
461 }
462