xref: /libCEED/examples/solids/elasticity.h (revision 9e9355a0fdff482bf45ceba04fa716f883a6e057)
1 // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at
2 // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
3 // 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 #ifndef setup_h
18 #define setup_h
19 
20 #include <stdbool.h>
21 #include <string.h>
22 
23 #include <petsc.h>
24 #include <petscdmplex.h>
25 #include <petscksp.h>
26 #include <petscfe.h>
27 
28 #include <ceed.h>
29 
30 #ifndef PHYSICS_STRUCT
31 #define PHYSICS_STRUCT
32 typedef struct Physics_private *Physics;
33 struct Physics_private {
34   CeedScalar   nu;      // Poisson's ratio
35   CeedScalar   E;       // Young's Modulus
36 };
37 #endif
38 
39 // -----------------------------------------------------------------------------
40 // Command Line Options
41 // -----------------------------------------------------------------------------
42 // Problem options
43 typedef enum {
44   ELAS_LIN = 0, ELAS_HYPER_SS = 1, ELAS_HYPER_FS = 2
45 } problemType;
46 static const char *const problemTypes[] = {"linElas",
47                                            "hyperSS",
48                                            "hyperFS",
49                                            "problemType","ELAS_",0
50                                           };
51 static const char *const problemTypesForDisp[] = {"Linear elasticity",
52                                                   "Hyper elasticity small strain",
53                                                   "Hyper elasticity finite strain"
54                                                  };
55 
56 // Forcing function options
57 typedef enum {
58   FORCE_NONE = 0, FORCE_CONST = 1, FORCE_MMS = 2
59 } forcingType;
60 static const char *const forcingTypes[] = {"none",
61                                            "constant",
62                                            "mms",
63                                            "forcingType","FORCE_",0
64                                           };
65 static const char *const forcingTypesForDisp[] = {"None",
66                                                   "Constant",
67                                                   "Manufactured solution"
68                                                  };
69 
70 // Multigrid options
71 typedef enum {
72   MULTIGRID_LOGARITHMIC = 0, MULTIGRID_UNIFORM = 1, MULTIGRID_NONE = 2
73 } multigridType;
74 static const char *const multigridTypes [] = {"logarithmic",
75                                               "uniform",
76                                               "none",
77                                               "multigridType","MULTIGRID",0
78                                              };
79 static const char *const multigridTypesForDisp[] = {"P-multigrid, logarithmic coarsening",
80                                                     "P-multigrind, uniform coarsening",
81                                                     "No multigrid"
82                                                    };
83 
84 typedef PetscErrorCode BCFunc(PetscInt, PetscReal, const PetscReal *, PetscInt,
85                               PetscScalar *, void *);
86 // Note: These variables should be updated if additional boundary conditions
87 //         are added to boundary.c.
88 BCFunc BCMMS, BCZero, BCClamp;
89 
90 // -----------------------------------------------------------------------------
91 // Structs
92 // -----------------------------------------------------------------------------
93 // Units
94 typedef struct Units_private *Units;
95 struct Units_private {
96   // Fundamental units
97   PetscScalar meter;
98   PetscScalar kilogram;
99   PetscScalar second;
100   // Derived unit
101   PetscScalar Pascal;
102 };
103 
104 // Application context from user command line options
105 typedef struct AppCtx_private *AppCtx;
106 struct AppCtx_private {
107   char          ceedResource[PETSC_MAX_PATH_LEN];     // libCEED backend
108   char          ceedResourceFine[PETSC_MAX_PATH_LEN]; // libCEED for fine grid
109   char          meshFile[PETSC_MAX_PATH_LEN];         // exodusII mesh file
110   PetscBool     testMode;
111   PetscBool     viewSoln;
112   PetscBool     viewFinalSoln;
113   problemType   problemChoice;
114   forcingType   forcingChoice;
115   multigridType multigridChoice;
116   PetscInt      degree;
117   PetscInt      qextra;
118   PetscInt      numLevels;
119   PetscInt      *levelDegrees;
120   PetscInt      numIncrements;                        // Number of steps
121   PetscInt      bcClampFaces[16];
122   PetscInt      bcClampCount;
123   PetscScalar   bcClampMax[16][7];
124   PetscScalar   forcingVector[3];
125 };
126 
127 // Problem specific data
128 typedef struct {
129   CeedInt           qdatasize;
130   CeedQFunctionUser setupgeo, apply, jacob, energy;
131   const char        *setupgeofname, *applyfname, *jacobfname, *energyfname;
132   CeedQuadMode      qmode;
133 } problemData;
134 
135 // Data specific to each problem option
136 extern problemData problemOptions[3];
137 
138 // Forcing function data
139 typedef struct {
140   CeedQFunctionUser setupforcing;
141   const char        *setupforcingfname;
142 } forcingData;
143 
144 extern forcingData forcingOptions[3];
145 
146 // Data for PETSc Matshell
147 typedef struct UserMult_private *UserMult;
148 struct UserMult_private {
149   MPI_Comm     comm;
150   DM           dm;
151   Vec          Xloc, Yloc;
152   CeedVector   Xceed, Yceed;
153   CeedOperator op;
154   Ceed         ceed;
155   PetscScalar  loadIncrement;
156 };
157 
158 // Data for Jacobian setup routine
159 typedef struct FormJacobCtx_private *FormJacobCtx;
160 struct FormJacobCtx_private {
161   UserMult     *jacobCtx;
162   PetscInt     numLevels;
163   SNES         snesCoarse;
164   Mat          *jacobMat, jacobMatCoarse;
165   Vec          Ucoarse;
166 };
167 
168 // Data for PETSc Prolongation/Restriction Matshell
169 typedef struct UserMultProlongRestr_private *UserMultProlongRestr;
170 struct UserMultProlongRestr_private {
171   MPI_Comm     comm;
172   DM           dmC, dmF;
173   Vec          locVecC, locVecF, multVec;
174   CeedVector   ceedVecC, ceedVecF;
175   CeedOperator opProlong, opRestrict;
176   Ceed         ceed;
177 };
178 
179 // libCEED data struct for level
180 typedef struct CeedData_private *CeedData;
181 struct CeedData_private {
182   Ceed                ceed;
183   CeedBasis           basisx, basisu, basisCtoF, basisEnergy;
184   CeedElemRestriction Erestrictx, Erestrictu, Erestrictqdi,
185                       ErestrictGradui, ErestrictEnergy;
186   CeedQFunction       qfApply, qfJacob, qfEnergy;
187   CeedOperator        opApply, opJacob, opRestrict, opProlong, opEnergy;
188   CeedVector          qdata, gradu, xceed, yceed, truesoln, energy;
189 };
190 
191 // -----------------------------------------------------------------------------
192 // Process command line options
193 // -----------------------------------------------------------------------------
194 // Process general command line options
195 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx appCtx);
196 
197 // Process physics options
198 PetscErrorCode ProcessPhysics(MPI_Comm comm, Physics phys, Units units);
199 
200 // -----------------------------------------------------------------------------
201 // Setup DM
202 // -----------------------------------------------------------------------------
203 PetscErrorCode CreateBCLabel(DM dm, const char name[]);
204 
205 // Create FE by degree
206 PetscErrorCode PetscFECreateByDegree(DM dm, PetscInt dim, PetscInt Nc,
207                                      PetscBool isSimplex, const char prefix[],
208                                      PetscInt order, PetscFE *fem);
209 
210 // Read mesh and distribute DM in parallel
211 PetscErrorCode CreateDistributedDM(MPI_Comm comm, AppCtx appCtx, DM *dm);
212 
213 // Setup DM with FE space of appropriate degree
214 PetscErrorCode SetupDMByDegree(DM dm, AppCtx appCtx, PetscInt order,
215                                PetscInt ncompu);
216 
217 // -----------------------------------------------------------------------------
218 // libCEED Functions
219 // -----------------------------------------------------------------------------
220 // Destroy libCEED objects
221 PetscErrorCode CeedDataDestroy(CeedInt level, CeedData data);
222 
223 // Get libCEED restriction data from DMPlex
224 PetscErrorCode CreateRestrictionPlex(Ceed ceed, CeedInt P, CeedInt ncomp,
225                                      CeedElemRestriction *Erestrict, DM dm);
226 
227 // Set up libCEED for a given degree
228 PetscErrorCode SetupLibceedFineLevel(DM dm, Ceed ceed, AppCtx appCtx,
229                                      Physics phys, CeedData *data,
230                                      PetscInt fineLevel, PetscInt ncompu,
231                                      PetscInt Ugsz, PetscInt Ulocsz,
232                                      CeedVector forceCeed,
233                                      CeedQFunction qfRestrict,
234                                      CeedQFunction qfProlong);
235 
236 // Set up libCEED for a given degree
237 PetscErrorCode SetupLibceedLevel(DM dm, Ceed ceed, AppCtx appCtx, Physics phys,
238                                  CeedData *data, PetscInt level,
239                                  PetscInt ncompu, PetscInt Ugsz,
240                                  PetscInt Ulocsz, CeedVector forceCeed,
241                                  CeedQFunction qfRestrict,
242                                  CeedQFunction qfProlong);
243 
244 // Setup context data for Jacobian evaluation
245 PetscErrorCode SetupJacobianCtx(MPI_Comm comm, AppCtx appCtx, DM dm, Vec V,
246                                 Vec Vloc, CeedData ceedData, Ceed ceed,
247                                 UserMult jacobianCtx);
248 
249 // Setup context data for prolongation and restriction operators
250 PetscErrorCode SetupProlongRestrictCtx(MPI_Comm comm, DM dmC, DM dmF, Vec VF,
251                                        Vec VlocC, Vec VlocF, CeedData ceedDataC,
252                                        CeedData ceedDataF, Ceed ceed,
253                                        UserMultProlongRestr prolongRestrCtx);
254 
255 // -----------------------------------------------------------------------------
256 // Jacobian setup
257 // -----------------------------------------------------------------------------
258 PetscErrorCode FormJacobian(SNES snes, Vec U, Mat J, Mat Jpre, void *ctx);
259 
260 // -----------------------------------------------------------------------------
261 // SNES Monitor
262 // -----------------------------------------------------------------------------
263 PetscErrorCode ViewSolution(MPI_Comm comm, Vec U, PetscInt increment,
264                             PetscScalar loadIncrement);
265 
266 // -----------------------------------------------------------------------------
267 // libCEED Operators for MatShell
268 // -----------------------------------------------------------------------------
269 // This function uses libCEED to compute the local action of an operator
270 PetscErrorCode ApplyLocalCeedOp(Vec X, Vec Y, UserMult user);
271 
272 // This function uses libCEED to compute the non-linear residual
273 PetscErrorCode FormResidual_Ceed(SNES snes, Vec X, Vec Y, void *ctx);
274 
275 // This function uses libCEED to apply the Jacobian for assembly via a SNES
276 PetscErrorCode ApplyJacobianCoarse_Ceed(SNES snes, Vec X, Vec Y, void *ctx);
277 
278 // This function uses libCEED to compute the action of the Jacobian
279 PetscErrorCode ApplyJacobian_Ceed(Mat A, Vec X, Vec Y);
280 
281 // This function uses libCEED to compute the action of the prolongation operator
282 PetscErrorCode Prolong_Ceed(Mat A, Vec X, Vec Y);
283 
284 // This function uses libCEED to compute the action of the restriction operator
285 PetscErrorCode Restrict_Ceed(Mat A, Vec X, Vec Y);
286 
287 // This function returns the computed diagonal of the operator
288 PetscErrorCode GetDiag_Ceed(Mat A, Vec D);
289 
290 // This function calculates the strain energy in the final solution
291 PetscErrorCode ComputeStrainEnergy(UserMult user, CeedOperator opEnergy, Vec X,
292                                    CeedVector energyLoc, PetscReal *energy);
293 
294 // -----------------------------------------------------------------------------
295 // Boundary Functions
296 // -----------------------------------------------------------------------------
297 // Note: If additional boundary conditions are added, an update is needed in
298 //         elasticity.h for the boundaryOptions variable.
299 
300 // BCMMS - boundary function
301 // Values on all points of the mesh is set based on given solution below
302 // for u[0], u[1], u[2]
303 PetscErrorCode BCMMS(PetscInt dim, PetscReal loadIncrement,
304                      const PetscReal coords[], PetscInt ncompu,
305                      PetscScalar *u, void *ctx);
306 
307 // BCClamp - fix boundary values with affine transformation at fraction of load
308 //   increment
309 PetscErrorCode BCClamp(PetscInt dim, PetscReal loadIncrement,
310                        const PetscReal coords[], PetscInt ncompu,
311                        PetscScalar *u, void *ctx);
312 
313 #endif //setup_h
314