xref: /libCEED/examples/solids/elasticity.h (revision 9d0076196e8007111c70cfd35fb6663d10de6039)
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   problemType   problemChoice;
113   forcingType   forcingChoice;
114   multigridType multigridChoice;
115   PetscInt      degree;
116   PetscInt      numLevels;
117   PetscInt      *levelDegrees;
118   PetscInt      numIncrements;                        // Number of steps
119   PetscInt      bcClampFaces[16];
120   PetscInt      bcClampCount;
121   PetscScalar   bcClampMax[16][7];
122   PetscScalar   forcingVector[3];
123 };
124 
125 // Problem specific data
126 typedef struct {
127   CeedInt           qdatasize;
128   CeedQFunctionUser setupgeo, apply, jacob, energy;
129   const char        *setupgeofname, *applyfname, *jacobfname, *energyfname;
130   CeedQuadMode      qmode;
131 } problemData;
132 
133 // Data specific to each problem option
134 problemData problemOptions[3];
135 
136 // Forcing function data
137 typedef struct {
138   CeedQFunctionUser setupforcing;
139   const char        *setupforcingfname;
140 } forcingData;
141 
142 forcingData forcingOptions[3];
143 
144 // Data for PETSc Matshell
145 typedef struct UserMult_private *UserMult;
146 struct UserMult_private {
147   MPI_Comm     comm;
148   DM           dm;
149   Vec          Xloc, Yloc;
150   CeedVector   Xceed, Yceed;
151   CeedOperator op;
152   Ceed         ceed;
153   PetscScalar  loadIncrement;
154 };
155 
156 // Data for Jacobian setup routine
157 typedef struct FormJacobCtx_private *FormJacobCtx;
158 struct FormJacobCtx_private {
159   UserMult     *jacobCtx;
160   PetscInt     numLevels;
161   SNES         snesCoarse;
162   Mat          *jacobMat, jacobMatCoarse;
163   Vec          Ucoarse;
164 };
165 
166 // Data for PETSc Prolongation/Restriction Matshell
167 typedef struct UserMultProlongRestr_private *UserMultProlongRestr;
168 struct UserMultProlongRestr_private {
169   MPI_Comm     comm;
170   DM           dmC, dmF;
171   Vec          locVecC, locVecF, multVec;
172   CeedVector   ceedVecC, ceedVecF;
173   CeedOperator opProlong, opRestrict;
174   Ceed         ceed;
175 };
176 
177 // libCEED data struct for level
178 typedef struct CeedData_private *CeedData;
179 struct CeedData_private {
180   Ceed                ceed;
181   CeedBasis           basisx, basisu, basisCtoF, basisEnergy;
182   CeedElemRestriction Erestrictx, Erestrictu, Erestrictqdi,
183                       ErestrictGradui, ErestrictEnergy;
184   CeedQFunction       qfApply, qfJacob, qfEnergy;
185   CeedOperator        opApply, opJacob, opRestrict, opProlong, opEnergy;
186   CeedVector          qdata, gradu, xceed, yceed, truesoln, energy;
187 };
188 
189 // -----------------------------------------------------------------------------
190 // Process command line options
191 // -----------------------------------------------------------------------------
192 // Process general command line options
193 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx appCtx);
194 
195 // Process physics options
196 PetscErrorCode ProcessPhysics(MPI_Comm comm, Physics phys, Units units);
197 
198 // -----------------------------------------------------------------------------
199 // Setup DM
200 // -----------------------------------------------------------------------------
201 PetscErrorCode CreateBCLabel(DM dm, const char name[]);
202 
203 // Create FE by degree
204 PetscErrorCode PetscFECreateByDegree(DM dm, PetscInt dim, PetscInt Nc,
205                                      PetscBool isSimplex, const char prefix[],
206                                      PetscInt order, PetscFE *fem);
207 
208 // Read mesh and distribute DM in parallel
209 PetscErrorCode CreateDistributedDM(MPI_Comm comm, AppCtx appCtx, DM *dm);
210 
211 // Setup DM with FE space of appropriate degree
212 PetscErrorCode SetupDMByDegree(DM dm, AppCtx appCtx, PetscInt order,
213                                PetscInt ncompu);
214 
215 // -----------------------------------------------------------------------------
216 // libCEED Functions
217 // -----------------------------------------------------------------------------
218 // Destroy libCEED objects
219 PetscErrorCode CeedDataDestroy(CeedInt level, CeedData data);
220 
221 // Get libCEED restriction data from DMPlex
222 PetscErrorCode CreateRestrictionPlex(Ceed ceed, CeedInterlaceMode imode,
223                                      CeedInt P, CeedInt ncomp,
224                                      CeedElemRestriction *Erestrict, DM dm);
225 
226 // Set up libCEED for a given degree
227 PetscErrorCode SetupLibceedFineLevel(DM dm, Ceed ceed, AppCtx appCtx,
228                                      Physics phys, CeedData *data,
229                                      PetscInt fineLevel, PetscInt ncompu,
230                                      PetscInt Ugsz, PetscInt Ulocsz,
231                                      CeedVector forceCeed,
232                                      CeedQFunction qfRestrict,
233                                      CeedQFunction qfProlong);
234 
235 // Set up libCEED for a given degree
236 PetscErrorCode SetupLibceedLevel(DM dm, Ceed ceed, AppCtx appCtx, Physics phys,
237                                  CeedData *data, PetscInt level,
238                                  PetscInt ncompu, PetscInt Ugsz,
239                                  PetscInt Ulocsz, CeedVector forceCeed,
240                                  CeedQFunction qfRestrict,
241                                  CeedQFunction qfProlong);
242 
243 // Setup context data for Jacobian evaluation
244 PetscErrorCode SetupJacobianCtx(MPI_Comm comm, AppCtx appCtx, DM dm, Vec V,
245                                 Vec Vloc, CeedData ceedData, Ceed ceed,
246                                 UserMult jacobianCtx);
247 
248 // Setup context data for prolongation and restriction operators
249 PetscErrorCode SetupProlongRestrictCtx(MPI_Comm comm, DM dmC, DM dmF, Vec VF,
250                                        Vec VlocC, Vec VlocF, CeedData ceedDataC,
251                                        CeedData ceedDataF, Ceed ceed,
252                                        UserMultProlongRestr prolongRestrCtx);
253 
254 // -----------------------------------------------------------------------------
255 // Jacobian setup
256 // -----------------------------------------------------------------------------
257 PetscErrorCode FormJacobian(SNES snes, Vec U, Mat J, Mat Jpre, void *ctx);
258 
259 // -----------------------------------------------------------------------------
260 // SNES Monitor
261 // -----------------------------------------------------------------------------
262 PetscErrorCode ViewSolution(MPI_Comm comm, Vec U, PetscInt increment,
263                             PetscScalar loadIncrement);
264 
265 // -----------------------------------------------------------------------------
266 // libCEED Operators for MatShell
267 // -----------------------------------------------------------------------------
268 // This function uses libCEED to compute the local action of an operator
269 PetscErrorCode ApplyLocalCeedOp(Vec X, Vec Y, UserMult user);
270 
271 // This function uses libCEED to compute the non-linear residual
272 PetscErrorCode FormResidual_Ceed(SNES snes, Vec X, Vec Y, void *ctx);
273 
274 // This function uses libCEED to apply the Jacobian for assembly via a SNES
275 PetscErrorCode ApplyJacobianCoarse_Ceed(SNES snes, Vec X, Vec Y, void *ctx);
276 
277 // This function uses libCEED to compute the action of the Jacobian
278 PetscErrorCode ApplyJacobian_Ceed(Mat A, Vec X, Vec Y);
279 
280 // This function uses libCEED to compute the action of the prolongation operator
281 PetscErrorCode Prolong_Ceed(Mat A, Vec X, Vec Y);
282 
283 // This function uses libCEED to compute the action of the restriction operator
284 PetscErrorCode Restrict_Ceed(Mat A, Vec X, Vec Y);
285 
286 // This function returns the computed diagonal of the operator
287 PetscErrorCode GetDiag_Ceed(Mat A, Vec D);
288 
289 // This function calculates the strain energy in the final solution
290 PetscErrorCode ComputeStrainEnergy(UserMult user, CeedOperator opEnergy, Vec X,
291                                    CeedVector energyLoc, PetscReal *energy);
292 
293 // -----------------------------------------------------------------------------
294 // Boundary Functions
295 // -----------------------------------------------------------------------------
296 // Note: If additional boundary conditions are added, an update is needed in
297 //         elasticity.h for the boundaryOptions variable.
298 
299 // BCMMS - boundary function
300 // Values on all points of the mesh is set based on given solution below
301 // for u[0], u[1], u[2]
302 PetscErrorCode BCMMS(PetscInt dim, PetscReal loadIncrement,
303                      const PetscReal coords[], PetscInt ncompu,
304                      PetscScalar *u, void *ctx);
305 
306 // BCClamp - fix boundary values with affine transformation at fraction of load
307 //   increment
308 PetscErrorCode BCClamp(PetscInt dim, PetscReal loadIncrement,
309                        const PetscReal coords[], PetscInt ncompu,
310                        PetscScalar *u, void *ctx);
311 
312 #endif //setup_h
313