xref: /libCEED/examples/fluids/src/velocity_gradient_projection.c (revision d68a66c4667a4dc19397db12012e87e45bb921c9)
1 // Copyright (c) 2017-2023, Lawrence Livermore National Security, LLC and other CEED contributors.
2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3 //
4 // SPDX-License-Identifier: BSD-2-Clause
5 //
6 // This file is part of CEED:  http://github.com/ceed
7 /// @file
8 /// Functions for setting up and projecting the velocity gradient
9 
10 #include "../qfunctions/velocity_gradient_projection.h"
11 
12 #include <petscdmplex.h>
13 
14 #include "../navierstokes.h"
15 
16 PetscErrorCode VelocityGradientProjectionCreateDM(NodalProjectionData grad_velo_proj, User user, PetscInt degree) {
17   PetscSection section;
18 
19   PetscFunctionBeginUser;
20   grad_velo_proj->num_comp = 9;  // 9 velocity gradient
21 
22   PetscCall(DMClone(user->dm, &grad_velo_proj->dm));
23   PetscCall(PetscObjectSetName((PetscObject)grad_velo_proj->dm, "Velocity Gradient Projection"));
24 
25   PetscCall(
26       DMSetupByOrder_FEM(PETSC_TRUE, PETSC_TRUE, user->app_ctx->degree, 1, user->app_ctx->q_extra, 1, &grad_velo_proj->num_comp, grad_velo_proj->dm));
27 
28   PetscCall(DMGetLocalSection(grad_velo_proj->dm, &section));
29   PetscCall(PetscSectionSetFieldName(section, 0, ""));
30   PetscCall(PetscSectionSetComponentName(section, 0, 0, "VelocityGradientXX"));
31   PetscCall(PetscSectionSetComponentName(section, 0, 1, "VelocityGradientXY"));
32   PetscCall(PetscSectionSetComponentName(section, 0, 2, "VelocityGradientXZ"));
33   PetscCall(PetscSectionSetComponentName(section, 0, 3, "VelocityGradientYX"));
34   PetscCall(PetscSectionSetComponentName(section, 0, 4, "VelocityGradientYY"));
35   PetscCall(PetscSectionSetComponentName(section, 0, 5, "VelocityGradientYZ"));
36   PetscCall(PetscSectionSetComponentName(section, 0, 6, "VelocityGradientZX"));
37   PetscCall(PetscSectionSetComponentName(section, 0, 7, "VelocityGradientZY"));
38   PetscCall(PetscSectionSetComponentName(section, 0, 8, "VelocityGradientZZ"));
39 
40   PetscFunctionReturn(PETSC_SUCCESS);
41 };
42 
43 PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem) {
44   OperatorApplyContext mass_matop_ctx;
45   CeedOperator         op_rhs_assemble, op_mass;
46   CeedQFunction        qf_rhs_assemble, qf_mass;
47   CeedBasis            basis_grad_velo;
48   CeedElemRestriction  elem_restr_grad_velo;
49   PetscInt             dim;
50   CeedInt              num_comp_x, num_comp_q, q_data_size;
51 
52   PetscFunctionBeginUser;
53   PetscCall(PetscNew(&user->grad_velo_proj));
54   NodalProjectionData grad_velo_proj = user->grad_velo_proj;
55 
56   PetscCall(VelocityGradientProjectionCreateDM(grad_velo_proj, user, user->app_ctx->degree));
57 
58   // -- Get Pre-requisite things
59   PetscCall(DMGetDimension(grad_velo_proj->dm, &dim));
60   PetscCallCeed(ceed, CeedBasisGetNumComponents(ceed_data->basis_x, &num_comp_x));
61   PetscCallCeed(ceed, CeedBasisGetNumComponents(ceed_data->basis_q, &num_comp_q));
62   PetscCallCeed(ceed, CeedElemRestrictionGetNumComponents(ceed_data->elem_restr_qd_i, &q_data_size));
63   PetscCall(GetRestrictionForDomain(ceed, grad_velo_proj->dm, 0, 0, 0, 0, -1, 0, &elem_restr_grad_velo, NULL, NULL));
64 
65   PetscCall(CreateBasisFromPlex(ceed, grad_velo_proj->dm, 0, 0, 0, 0, &basis_grad_velo));
66 
67   // -- Build RHS operator
68   switch (user->phys->state_var) {
69     case STATEVAR_PRIMITIVE:
70       PetscCallCeed(
71           ceed, CeedQFunctionCreateInterior(ceed, 1, VelocityGradientProjectionRHS_Prim, VelocityGradientProjectionRHS_Prim_loc, &qf_rhs_assemble));
72       break;
73     case STATEVAR_CONSERVATIVE:
74       PetscCallCeed(ceed, CeedQFunctionCreateInterior(ceed, 1, VelocityGradientProjectionRHS_Conserv, VelocityGradientProjectionRHS_Conserv_loc,
75                                                       &qf_rhs_assemble));
76       break;
77     default:
78       SETERRQ(PetscObjectComm((PetscObject)user->dm), PETSC_ERR_SUP, "No velocity gradient projection QFunction for chosen state variable");
79   }
80 
81   PetscCallCeed(ceed, CeedQFunctionSetContext(qf_rhs_assemble, problem->apply_vol_ifunction.qfunction_context));
82   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_rhs_assemble, "q", num_comp_q, CEED_EVAL_INTERP));
83   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_rhs_assemble, "Grad_q", num_comp_q * dim, CEED_EVAL_GRAD));
84   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_rhs_assemble, "qdata", q_data_size, CEED_EVAL_NONE));
85   PetscCallCeed(ceed, CeedQFunctionAddInput(qf_rhs_assemble, "x", num_comp_x, CEED_EVAL_INTERP));
86   PetscCallCeed(ceed, CeedQFunctionAddOutput(qf_rhs_assemble, "velocity gradient", grad_velo_proj->num_comp, CEED_EVAL_INTERP));
87 
88   PetscCallCeed(ceed, CeedOperatorCreate(ceed, qf_rhs_assemble, NULL, NULL, &op_rhs_assemble));
89   PetscCallCeed(ceed, CeedOperatorSetField(op_rhs_assemble, "q", ceed_data->elem_restr_q, ceed_data->basis_q, CEED_VECTOR_ACTIVE));
90   PetscCallCeed(ceed, CeedOperatorSetField(op_rhs_assemble, "Grad_q", ceed_data->elem_restr_q, ceed_data->basis_q, CEED_VECTOR_ACTIVE));
91   PetscCallCeed(ceed, CeedOperatorSetField(op_rhs_assemble, "qdata", ceed_data->elem_restr_qd_i, CEED_BASIS_COLLOCATED, ceed_data->q_data));
92   PetscCallCeed(ceed, CeedOperatorSetField(op_rhs_assemble, "x", ceed_data->elem_restr_x, ceed_data->basis_x, ceed_data->x_coord));
93   PetscCallCeed(ceed, CeedOperatorSetField(op_rhs_assemble, "velocity gradient", elem_restr_grad_velo, basis_grad_velo, CEED_VECTOR_ACTIVE));
94 
95   PetscCall(OperatorApplyContextCreate(user->dm, grad_velo_proj->dm, ceed, op_rhs_assemble, NULL, NULL, NULL, NULL, &grad_velo_proj->l2_rhs_ctx));
96 
97   // -- Build Mass operator
98   PetscCall(CreateMassQFunction(ceed, grad_velo_proj->num_comp, q_data_size, &qf_mass));
99   PetscCallCeed(ceed, CeedOperatorCreate(ceed, qf_mass, NULL, NULL, &op_mass));
100   PetscCallCeed(ceed, CeedOperatorSetField(op_mass, "u", elem_restr_grad_velo, basis_grad_velo, CEED_VECTOR_ACTIVE));
101   PetscCallCeed(ceed, CeedOperatorSetField(op_mass, "qdata", ceed_data->elem_restr_qd_i, CEED_BASIS_COLLOCATED, ceed_data->q_data));
102   PetscCallCeed(ceed, CeedOperatorSetField(op_mass, "v", elem_restr_grad_velo, basis_grad_velo, CEED_VECTOR_ACTIVE));
103 
104   {  // -- Setup KSP for L^2 projection with lumped mass operator
105     Mat      mat_mass;
106     MPI_Comm comm = PetscObjectComm((PetscObject)grad_velo_proj->dm);
107 
108     PetscCall(OperatorApplyContextCreate(grad_velo_proj->dm, grad_velo_proj->dm, ceed, op_mass, NULL, NULL, NULL, NULL, &mass_matop_ctx));
109     PetscCall(CreateMatShell_Ceed(mass_matop_ctx, &mat_mass));
110 
111     PetscCall(KSPCreate(comm, &grad_velo_proj->ksp));
112     PetscCall(KSPSetOptionsPrefix(grad_velo_proj->ksp, "velocity_gradient_projection_"));
113     {
114       PC pc;
115       PetscCall(KSPGetPC(grad_velo_proj->ksp, &pc));
116       PetscCall(PCSetType(pc, PCJACOBI));
117       PetscCall(PCJacobiSetType(pc, PC_JACOBI_ROWSUM));
118       PetscCall(KSPSetType(grad_velo_proj->ksp, KSPPREONLY));
119       // TODO Not sure if the option below are necessary
120       PetscCall(KSPSetConvergenceTest(grad_velo_proj->ksp, KSPConvergedSkip, NULL, NULL));
121     }
122     PetscCall(KSPSetOperators(grad_velo_proj->ksp, mat_mass, mat_mass));
123     PetscCall(KSPSetFromOptions(grad_velo_proj->ksp));
124   }
125 
126   PetscCallCeed(ceed, CeedBasisDestroy(&basis_grad_velo));
127   PetscCallCeed(ceed, CeedElemRestrictionDestroy(&elem_restr_grad_velo));
128   PetscCallCeed(ceed, CeedQFunctionDestroy(&qf_rhs_assemble));
129   PetscCallCeed(ceed, CeedQFunctionDestroy(&qf_mass));
130   PetscCallCeed(ceed, CeedOperatorDestroy(&op_rhs_assemble));
131   PetscCallCeed(ceed, CeedOperatorDestroy(&op_mass));
132   PetscFunctionReturn(PETSC_SUCCESS);
133 }
134 
135 PetscErrorCode VelocityGradientProjectionApply(User user, Vec Q_loc, Vec VelocityGradient) {
136   NodalProjectionData  grad_velo_proj = user->grad_velo_proj;
137   OperatorApplyContext l2_rhs_ctx     = grad_velo_proj->l2_rhs_ctx;
138 
139   PetscFunctionBeginUser;
140   PetscCall(ApplyCeedOperatorLocalToGlobal(Q_loc, VelocityGradient, l2_rhs_ctx));
141 
142   PetscCall(KSPSolve(grad_velo_proj->ksp, VelocityGradient, VelocityGradient));
143 
144   PetscFunctionReturn(PETSC_SUCCESS);
145 }
146