xref: /libCEED/examples/fluids/navierstokes.h (revision 78da6f49bd4f317104176ab77799905fab1a7277)
1 // Copyright (c) 2017-2022, 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 
8 #ifndef libceed_fluids_examples_navier_stokes_h
9 #define libceed_fluids_examples_navier_stokes_h
10 
11 #include <ceed-utils.h>
12 #include <ceed.h>
13 #include <mat-ceed.h>
14 #include <petscts.h>
15 #include <stdbool.h>
16 
17 #include "./include/petsc_ops.h"
18 #include "qfunctions/newtonian_types.h"
19 #include "qfunctions/stabilization_types.h"
20 
21 #if PETSC_VERSION_LT(3, 20, 0)
22 #error "PETSc v3.20 or later is required"
23 #endif
24 
25 #if PETSC_VERSION_LT(3, 21, 0)
26 #define DMSetCoordinateDisc(a, b, c) DMProjectCoordinates(a, b)
27 #endif
28 
29 // -----------------------------------------------------------------------------
30 // Enums
31 // -----------------------------------------------------------------------------
32 
33 // Euler - test cases
34 typedef enum {
35   EULER_TEST_ISENTROPIC_VORTEX = 0,
36   EULER_TEST_1                 = 1,
37   EULER_TEST_2                 = 2,
38   EULER_TEST_3                 = 3,
39   EULER_TEST_4                 = 4,
40   EULER_TEST_5                 = 5,
41 } EulerTestType;
42 static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
43                                              "EulerTestType",     "EULER_TEST_", NULL};
44 
45 // Advection - Wind types
46 static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
47 
48 // Advection - Initial Condition Types
49 static const char *const AdvectionICTypes[] = {"sphere", "cylinder", "cosine_hill", "skew", "AdvectionICType", "ADVECTIONIC_", NULL};
50 
51 // Advection - Bubble Continuity Types
52 static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "cosine", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
53 
54 // Stabilization methods
55 static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
56 
57 // Stabilization tau constants
58 static const char *const StabilizationTauTypes[] = {"Ctau", "AdvDiff_Shakib", "AdvDiff_Shakib_P", "StabilizationTauType", "STAB_TAU_", NULL};
59 
60 // Test mode type
61 typedef enum {
62   TESTTYPE_NONE           = 0,
63   TESTTYPE_SOLVER         = 1,
64   TESTTYPE_TURB_SPANSTATS = 2,
65   TESTTYPE_DIFF_FILTER    = 3,
66 } TestType;
67 static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
68 
69 // Subgrid-Stress mode type
70 typedef enum {
71   SGS_MODEL_NONE        = 0,
72   SGS_MODEL_DATA_DRIVEN = 1,
73 } SGSModelType;
74 static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
75 
76 // Mesh transformation type
77 typedef enum {
78   MESH_TRANSFORM_NONE      = 0,
79   MESH_TRANSFORM_PLATEMESH = 1,
80 } MeshTransformType;
81 static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
82 
83 static const char *const DifferentialFilterDampingFunctions[] = {
84     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
85 
86 // -----------------------------------------------------------------------------
87 // Log Events
88 // -----------------------------------------------------------------------------
89 extern PetscLogEvent FLUIDS_CeedOperatorApply;
90 extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
91 extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
92 extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
93 extern PetscLogEvent FLUIDS_SmartRedis_Init;
94 extern PetscLogEvent FLUIDS_SmartRedis_Meta;
95 extern PetscLogEvent FLUIDS_SmartRedis_Train;
96 extern PetscLogEvent FLUIDS_TrainDataCompute;
97 extern PetscLogEvent FLUIDS_DifferentialFilter;
98 extern PetscLogEvent FLUIDS_VelocityGradientProjection;
99 PetscErrorCode       RegisterLogEvents();
100 
101 // -----------------------------------------------------------------------------
102 // Structs
103 // -----------------------------------------------------------------------------
104 // Structs declarations
105 typedef struct AppCtx_private   *AppCtx;
106 typedef struct CeedData_private *CeedData;
107 typedef struct User_private     *User;
108 typedef struct Units_private    *Units;
109 typedef struct SimpleBC_private *SimpleBC;
110 typedef struct Physics_private  *Physics;
111 
112 // Application context from user command line options
113 struct AppCtx_private {
114   // libCEED arguments
115   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
116   PetscInt degree;
117   PetscInt q_extra;
118   // Solver arguments
119   MatType amat_type;
120   // Post-processing arguments
121   PetscInt  checkpoint_interval;
122   PetscInt  viz_refine;
123   PetscInt  cont_steps;
124   PetscReal cont_time;
125   char      cont_file[PETSC_MAX_PATH_LEN];
126   char      cont_time_file[PETSC_MAX_PATH_LEN];
127   char      output_dir[PETSC_MAX_PATH_LEN];
128   PetscBool add_stepnum2bin;
129   PetscBool checkpoint_vtk;
130   // Problem type arguments
131   PetscFunctionList problems;
132   char              problem_name[PETSC_MAX_PATH_LEN];
133   // Test mode arguments
134   TestType    test_type;
135   PetscScalar test_tol;
136   char        test_file_path[PETSC_MAX_PATH_LEN];
137   // Turbulent spanwise statistics
138   PetscBool         turb_spanstats_enable;
139   PetscInt          turb_spanstats_collect_interval;
140   PetscInt          turb_spanstats_viewer_interval;
141   PetscViewer       turb_spanstats_viewer;
142   PetscViewerFormat turb_spanstats_viewer_format;
143   // Wall forces
144   struct {
145     PetscInt          num_wall;
146     PetscInt         *walls;
147     PetscViewer       viewer;
148     PetscViewerFormat viewer_format;
149     PetscBool         header_written;
150   } wall_forces;
151   // Subgrid Stress Model
152   SGSModelType sgs_model_type;
153   PetscBool    sgs_train_enable;
154   // Differential Filtering
155   PetscBool         diff_filter_monitor;
156   MeshTransformType mesh_transform_type;
157 };
158 
159 // libCEED data struct
160 struct CeedData_private {
161   CeedVector           x_coord, q_data;
162   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
163   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
164   CeedOperator         op_setup_vol;
165   OperatorApplyContext op_ics_ctx;
166   CeedQFunction        qf_setup_vol, qf_ics, qf_rhs_vol, qf_ifunction_vol, qf_setup_sur, qf_apply_inflow, qf_apply_inflow_jacobian, qf_apply_outflow,
167       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian, qf_apply_slip, qf_apply_slip_jacobian;
168 };
169 
170 typedef struct {
171   DM                    dm;
172   PetscSF               sf;  // For communicating child data to parents
173   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
174   PetscInt              num_comp_stats;
175   Vec                   Child_Stats_loc, Parent_Stats_loc;
176   KSP                   ksp;         // For the L^2 projection solve
177   CeedScalar            span_width;  // spanwise width of the child domain
178   PetscBool             do_mms_test;
179   OperatorApplyContext  mms_error_ctx;
180   CeedContextFieldLabel solution_time_label, previous_time_label;
181 } SpanStatsData;
182 
183 typedef struct {
184   DM                   dm;
185   PetscInt             num_comp;
186   OperatorApplyContext l2_rhs_ctx;
187   KSP                  ksp;
188 } *NodalProjectionData;
189 
190 typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
191 typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
192 typedef struct {
193   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
194   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
195   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
196   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
197   SgsDDNodalStressEval      sgs_nodal_eval;
198   SgsDDNodalStressInference sgs_nodal_inference;
199   void                     *sgs_nodal_inference_ctx;
200   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
201 } *SgsDDData;
202 
203 typedef struct {
204   DM                   dm_dd_training;
205   PetscInt             num_comp_dd_inputs, write_data_interval;
206   OperatorApplyContext op_training_data_calc_ctx;
207   NodalProjectionData  filtered_grad_velo_proj;
208   size_t               training_data_array_dims[2];
209   PetscBool            overwrite_training_data;
210 } *SGS_DD_TrainingData;
211 
212 typedef struct {
213   DM                   dm_filter;
214   PetscInt             num_filtered_fields;
215   CeedInt             *num_field_components;
216   PetscInt             field_prim_state, field_velo_prod;
217   OperatorApplyContext op_rhs_ctx;
218   KSP                  ksp;
219   PetscBool            do_mms_test;
220 } *DiffFilterData;
221 
222 typedef struct {
223   void    *client;
224   char     rank_id_name[16];
225   PetscInt collocated_database_num_ranks;
226 } *SmartSimData;
227 
228 // PETSc user data
229 struct User_private {
230   MPI_Comm             comm;
231   DM                   dm;
232   DM                   dm_viz;
233   Mat                  interp_viz;
234   Ceed                 ceed;
235   Units                units;
236   Vec                  Q_loc, Q_dot_loc;
237   Physics              phys;
238   AppCtx               app_ctx;
239   CeedVector           q_ceed, q_dot_ceed, g_ceed, x_ceed;
240   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction;
241   Mat                  mat_ijacobian;
242   KSP                  mass_ksp;
243   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
244   CeedScalar           time_bc_set;
245   SpanStatsData        spanstats;
246   NodalProjectionData  grad_velo_proj;
247   SgsDDData            sgs_dd_data;
248   DiffFilterData       diff_filter;
249   SmartSimData         smartsim;
250   SGS_DD_TrainingData  sgs_dd_train;
251 };
252 
253 // Units
254 struct Units_private {
255   // fundamental units
256   PetscScalar meter;
257   PetscScalar kilogram;
258   PetscScalar second;
259   PetscScalar Kelvin;
260   // derived units
261   PetscScalar Pascal;
262   PetscScalar J_per_kg_K;
263   PetscScalar m_per_squared_s;
264   PetscScalar W_per_m_K;
265   PetscScalar Joule;
266 };
267 
268 // Boundary conditions
269 struct SimpleBC_private {
270   PetscInt num_wall,  // Number of faces with wall BCs
271       wall_comps[5],  // An array of constrained component numbers
272       num_comps,
273       num_symmetry[3],  // Number of faces with symmetry BCs
274       num_inflow, num_outflow, num_freestream, num_slip;
275   PetscInt walls[16], symmetries[3][16], inflows[16], outflows[16], freestreams[16], slips[16];
276 };
277 
278 // Struct that contains all enums and structs used for the physics of all problems
279 struct Physics_private {
280   PetscBool             implicit;
281   StateVariable         state_var;
282   CeedContextFieldLabel solution_time_label;
283   CeedContextFieldLabel stg_solution_time_label;
284   CeedContextFieldLabel timestep_size_label;
285   CeedContextFieldLabel ics_time_label;
286   CeedContextFieldLabel ijacobian_time_shift_label;
287 };
288 
289 typedef struct {
290   CeedQFunctionUser    qfunction;
291   const char          *qfunction_loc;
292   CeedQFunctionContext qfunction_context;
293 } ProblemQFunctionSpec;
294 
295 // Problem specific data
296 typedef struct ProblemData_private ProblemData;
297 struct ProblemData_private {
298   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
299   CeedScalar           dm_scale;
300   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
301       apply_freestream, apply_slip, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian, apply_slip_jacobian;
302   bool      non_zero_time;
303   PetscBool bc_from_ics, use_strong_bc_ceed, uses_newtonian;
304   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
305 };
306 
307 extern int FreeContextPetsc(void *);
308 
309 // -----------------------------------------------------------------------------
310 // Set up problems
311 // -----------------------------------------------------------------------------
312 // Set up function for each problem
313 extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
314 extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
315 extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
316 extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
317 extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
318 extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
319 extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
320 extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
321 extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
322 extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
323 
324 // Print function for each problem
325 extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
326 
327 extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
328 
329 extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
330 
331 extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
332 
333 extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
334 
335 PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
336 
337 // -----------------------------------------------------------------------------
338 // libCEED functions
339 // -----------------------------------------------------------------------------
340 // Utility function to create local CEED restriction
341 PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
342                                          CeedElemRestriction *elem_restr);
343 
344 PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
345                                                CeedElemRestriction *restriction);
346 PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
347                                                          CeedElemRestriction *restriction);
348 PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
349                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
350 PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
351                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
352 
353 PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
354 
355 // Utility function to create CEED Composite Operator for the entire domain
356 PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
357                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
358                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
359 
360 PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
361 
362 // -----------------------------------------------------------------------------
363 // Time-stepping functions
364 // -----------------------------------------------------------------------------
365 // Create KSP to solve the inverse mass operator for explicit time stepping schemes
366 PetscErrorCode CreateKSPMassOperator(User user, CeedData ceed_data);
367 
368 // RHS (Explicit time-stepper) function setup
369 PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
370 
371 // Implicit time-stepper function setup
372 PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
373 
374 // User provided TS Monitor
375 PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
376 
377 // TS: Create, setup, and solve
378 PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
379 
380 // Update Boundary Values when time has changed
381 PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
382 
383 // -----------------------------------------------------------------------------
384 // Setup DM
385 // -----------------------------------------------------------------------------
386 // Create mesh
387 PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
388 
389 // Set up DM
390 PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
391 PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
392                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
393 PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
394 PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
395                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
396 
397 // Refine DM for high-order viz
398 PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
399 
400 // -----------------------------------------------------------------------------
401 // Process command line options
402 // -----------------------------------------------------------------------------
403 // Register problems to be available on the command line
404 PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
405 
406 // Process general command line options
407 PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
408 
409 // -----------------------------------------------------------------------------
410 // Miscellaneous utility functions
411 // -----------------------------------------------------------------------------
412 PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
413 
414 PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
415                                                   Vec grad_FVM);
416 
417 // Compare reference solution values with current test run for CI
418 PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
419 
420 // Get error for problems with exact solutions
421 PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
422 
423 // Post-processing
424 PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
425 
426 // -- Gather initial Q values in case of continuation of simulation
427 PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
428 
429 // Record boundary values from initial condition
430 PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
431 
432 // Versioning token for binary checkpoints
433 extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
434 extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
435 extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
436 
437 // Create appropriate mass qfunction based on number of components N
438 PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
439 
440 PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
441 
442 PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
443                                  FILE **fp);
444 
445 PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
446 
447 PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
448 
449 // -----------------------------------------------------------------------------
450 // Turbulence Statistics Collection Functions
451 // -----------------------------------------------------------------------------
452 
453 PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
454 PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
455 PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
456 
457 // -----------------------------------------------------------------------------
458 // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
459 // -----------------------------------------------------------------------------
460 
461 PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
462 PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
463 PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
464 PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem, StateVariable state_var_input,
465                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
466 PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
467 PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
468                                                         CeedVector *grid_aniso_vector);
469 PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
470                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
471 
472 // -----------------------------------------------------------------------------
473 // Boundary Condition Related Functions
474 // -----------------------------------------------------------------------------
475 
476 // Setup StrongBCs that use QFunctions
477 PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
478 
479 PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
480 PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
481 PetscErrorCode SlipBCSetup(ProblemData *problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
482 
483 // -----------------------------------------------------------------------------
484 // Differential Filtering Functions
485 // -----------------------------------------------------------------------------
486 
487 PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
488 PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
489 PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
490 PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
491 PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
492 
493 // -----------------------------------------------------------------------------
494 // SGS Data-Driven Training via SmartSim
495 // -----------------------------------------------------------------------------
496 PetscErrorCode SmartSimSetup(User user);
497 PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
498 PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
499 PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
500 PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
501 PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
502 
503 #endif  // libceed_fluids_examples_navier_stokes_h
504