xref: /libCEED/examples/fluids/navierstokes.h (revision 844b3d4a9d080d8495201f6d410dac36f007295a)
13d8e8822SJeremy L Thompson // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
23d8e8822SJeremy L Thompson // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
377841947SLeila Ghaffari //
43d8e8822SJeremy L Thompson // SPDX-License-Identifier: BSD-2-Clause
577841947SLeila Ghaffari //
63d8e8822SJeremy L Thompson // This file is part of CEED:  http://github.com/ceed
777841947SLeila Ghaffari 
8b7c563b6SJeremy L Thompson #ifndef libceed_fluids_examples_navier_stokes_h
9b7c563b6SJeremy L Thompson #define libceed_fluids_examples_navier_stokes_h
1077841947SLeila Ghaffari 
1177841947SLeila Ghaffari #include <ceed.h>
1277841947SLeila Ghaffari #include <petscts.h>
1377841947SLeila Ghaffari #include <stdbool.h>
142b730f8bSJeremy L Thompson 
154021610dSJames Wright #include "./include/petsc_ops.h"
1697baf651SJames Wright #include "qfunctions/newtonian_types.h"
172b730f8bSJeremy L Thompson #include "qfunctions/stabilization_types.h"
1877841947SLeila Ghaffari 
19d31f425aSJeremy L Thompson #if PETSC_VERSION_LT(3, 20, 0)
20d31f425aSJeremy L Thompson #error "PETSc v3.20 or later is required"
2177841947SLeila Ghaffari #endif
2277841947SLeila Ghaffari 
2349a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0)
2449a40c8aSKenneth E. Jansen #define DMSetCoordinateDisc(a, b, c) DMProjectCoordinates(a, b)
2549a40c8aSKenneth E. Jansen #endif
2649a40c8aSKenneth E. Jansen 
27d9d458caSJames Wright #define PetscCallCeed(ceed, ...)                                    \
28a424bcd0SJames Wright   do {                                                              \
29d9d458caSJames Wright     int ierr = __VA_ARGS__;                                         \
30a424bcd0SJames Wright     if (ierr != CEED_ERROR_SUCCESS) {                               \
31a424bcd0SJames Wright       const char *error_message;                                    \
32a424bcd0SJames Wright       CeedGetErrorMessage(ceed, &error_message);                    \
33a424bcd0SJames Wright       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "%s", error_message); \
34a424bcd0SJames Wright     }                                                               \
35a424bcd0SJames Wright   } while (0)
36a424bcd0SJames Wright 
3777841947SLeila Ghaffari // -----------------------------------------------------------------------------
3877841947SLeila Ghaffari // Enums
3977841947SLeila Ghaffari // -----------------------------------------------------------------------------
4077841947SLeila Ghaffari // Translate PetscMemType to CeedMemType
412b730f8bSJeremy L Thompson static inline CeedMemType MemTypeP2C(PetscMemType mem_type) { return PetscMemTypeDevice(mem_type) ? CEED_MEM_DEVICE : CEED_MEM_HOST; }
4277841947SLeila Ghaffari 
4377841947SLeila Ghaffari // Euler - test cases
4477841947SLeila Ghaffari typedef enum {
45bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
4677841947SLeila Ghaffari   EULER_TEST_1                 = 1,
4777841947SLeila Ghaffari   EULER_TEST_2                 = 2,
4877841947SLeila Ghaffari   EULER_TEST_3                 = 3,
4977841947SLeila Ghaffari   EULER_TEST_4                 = 4,
5032f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
5177841947SLeila Ghaffari } EulerTestType;
522b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
532b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
5477841947SLeila Ghaffari 
55700ae941SJames Wright // Advection - Wind types
56700ae941SJames Wright static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
57700ae941SJames Wright 
587b77ddfdSJames Wright // Advection - Initial Condition Types
597b77ddfdSJames Wright static const char *const AdvectionICTypes[] = {"sphere", "cylinder", "cosine_hill", "skew", "AdvectionICType", "ADVECTIONIC_", NULL};
60700ae941SJames Wright 
61700ae941SJames Wright // Advection - Bubble Continuity Types
6293639ffbSJames Wright static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "cosine", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
63700ae941SJames Wright 
6477841947SLeila Ghaffari // Stabilization methods
652b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
6677841947SLeila Ghaffari 
6751b00d91SJames Wright // Test mode type
688fb33541SJames Wright typedef enum {
698fb33541SJames Wright   TESTTYPE_NONE           = 0,
708fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
718fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
72970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
738fb33541SJames Wright } TestType;
74970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
758fb33541SJames Wright 
762526956eSJames Wright // Subgrid-Stress mode type
7719ffbc25SJames Wright typedef enum {
7819ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
7919ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
8019ffbc25SJames Wright } SGSModelType;
8119ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
8219ffbc25SJames Wright 
832526956eSJames Wright // Mesh transformation type
842526956eSJames Wright typedef enum {
852526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
862526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
872526956eSJames Wright } MeshTransformType;
882526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
892526956eSJames Wright 
90bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
91bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
92bd882c8aSJames Wright 
9377841947SLeila Ghaffari // -----------------------------------------------------------------------------
9475d1798cSJames Wright // Log Events
9575d1798cSJames Wright // -----------------------------------------------------------------------------
9675d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorApply;
9775d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
9875d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
9975d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
100*844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Init;
101*844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Meta;
102*844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Train;
103*844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_TrainDataCompute;
10475d1798cSJames Wright PetscErrorCode       RegisterLogEvents();
10575d1798cSJames Wright 
10675d1798cSJames Wright // -----------------------------------------------------------------------------
10777841947SLeila Ghaffari // Structs
10877841947SLeila Ghaffari // -----------------------------------------------------------------------------
10977841947SLeila Ghaffari // Structs declarations
11077841947SLeila Ghaffari typedef struct AppCtx_private   *AppCtx;
11177841947SLeila Ghaffari typedef struct CeedData_private *CeedData;
11277841947SLeila Ghaffari typedef struct User_private     *User;
11377841947SLeila Ghaffari typedef struct Units_private    *Units;
11477841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC;
11577841947SLeila Ghaffari typedef struct Physics_private  *Physics;
11677841947SLeila Ghaffari 
11777841947SLeila Ghaffari // Application context from user command line options
11877841947SLeila Ghaffari struct AppCtx_private {
11977841947SLeila Ghaffari   // libCEED arguments
12077841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
12177841947SLeila Ghaffari   PetscInt degree;
12277841947SLeila Ghaffari   PetscInt q_extra;
123544be873SJed Brown   // Solver arguments
124544be873SJed Brown   MatType   amat_type;
125544be873SJed Brown   PetscBool pmat_pbdiagonal;
12677841947SLeila Ghaffari   // Post-processing arguments
12737cbb16aSJed Brown   PetscInt  checkpoint_interval;
12877841947SLeila Ghaffari   PetscInt  viz_refine;
12977841947SLeila Ghaffari   PetscInt  cont_steps;
1304de8550aSJed Brown   PetscReal cont_time;
13169293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
13269293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
13377841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
13469293791SJames Wright   PetscBool add_stepnum2bin;
13537cbb16aSJed Brown   PetscBool checkpoint_vtk;
13677841947SLeila Ghaffari   // Problem type arguments
13777841947SLeila Ghaffari   PetscFunctionList problems;
13877841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
13977841947SLeila Ghaffari   // Test mode arguments
1408fb33541SJames Wright   TestType    test_type;
14177841947SLeila Ghaffari   PetscScalar test_tol;
142b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
143b7d66439SJames Wright   // Turbulent spanwise statistics
144b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
145b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
146b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
147b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
148b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
149ca69d878SAdeleke O. Bankole   // Wall forces
150ca69d878SAdeleke O. Bankole   struct {
151ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
152ca69d878SAdeleke O. Bankole     PetscInt         *walls;
153ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
154ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
155ca69d878SAdeleke O. Bankole     PetscBool         header_written;
156ca69d878SAdeleke O. Bankole   } wall_forces;
15719ffbc25SJames Wright   // Subgrid Stress Model
15819ffbc25SJames Wright   SGSModelType sgs_model_type;
15928134cfaSJames Wright   PetscBool    sgs_train_enable;
1604e9802d1SJames Wright   // Differential Filtering
1614e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1622526956eSJames Wright   MeshTransformType mesh_transform_type;
16377841947SLeila Ghaffari };
16477841947SLeila Ghaffari 
16577841947SLeila Ghaffari // libCEED data struct
16677841947SLeila Ghaffari struct CeedData_private {
16777841947SLeila Ghaffari   CeedVector           x_coord, q_data;
1682b730f8bSJeremy L Thompson   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
16977841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1705263e9c6SJames Wright   CeedOperator         op_setup_vol;
1715263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
172d310b3d3SAdeleke O. Bankole   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,
173d310b3d3SAdeleke O. Bankole       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian;
17477841947SLeila Ghaffari };
17577841947SLeila Ghaffari 
17651ee423eSJames Wright typedef struct {
17751ee423eSJames Wright   DM                    dm;
1781737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
179ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
18051ee423eSJames Wright   PetscInt              num_comp_stats;
181ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
182a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
183a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
184b7d66439SJames Wright   PetscBool             do_mms_test;
1854021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
186495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
187cbef7084SJames Wright } SpanStatsData;
18851ee423eSJames Wright 
189999ff5c7SJames Wright typedef struct {
190999ff5c7SJames Wright   DM                   dm;
191999ff5c7SJames Wright   PetscInt             num_comp;
192999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
193999ff5c7SJames Wright   KSP                  ksp;
194999ff5c7SJames Wright } *NodalProjectionData;
195999ff5c7SJames Wright 
1969a17443dSJames Wright typedef struct {
1979a17443dSJames Wright   DM                   dm_sgs;
1989a17443dSJames Wright   PetscInt             num_comp_sgs;
199be34b3b7SJames Wright   OperatorApplyContext op_nodal_evaluation_ctx, op_sgs_apply_ctx;
2009a17443dSJames Wright   CeedVector           sgs_nodal_ceed;
201cbef7084SJames Wright } *SgsDDData;
2029a17443dSJames Wright 
2034e9802d1SJames Wright typedef struct {
204ee3b213aSJames Wright   DM                   dm_dd_training;
205ee3b213aSJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval;
206ee3b213aSJames Wright   OperatorApplyContext op_training_data_calc_ctx;
207ee3b213aSJames Wright   NodalProjectionData  filtered_grad_velo_proj;
208ee3b213aSJames Wright   size_t               training_data_array_dims[2];
209ee3b213aSJames Wright   PetscBool            overwrite_training_data;
210ee3b213aSJames Wright } *SGS_DD_TrainingData;
211ee3b213aSJames Wright 
212ee3b213aSJames Wright typedef struct {
2134e9802d1SJames Wright   DM                   dm_filter;
21481530087SJames Wright   PetscInt             num_filtered_fields;
21581530087SJames Wright   CeedInt             *num_field_components;
216051427eeSJames Wright   PetscInt             field_prim_state, field_velo_prod;
2174e9802d1SJames Wright   OperatorApplyContext op_rhs_ctx;
2184e9802d1SJames Wright   KSP                  ksp;
2192029a677SJames Wright   PetscBool            do_mms_test;
2204e9802d1SJames Wright } *DiffFilterData;
2214e9802d1SJames Wright 
2228146534cSJames Wright typedef struct {
2238146534cSJames Wright   void    *client;
2248146534cSJames Wright   char     rank_id_name[16];
2258146534cSJames Wright   PetscInt collocated_database_num_ranks;
2268146534cSJames Wright } *SmartSimData;
2278146534cSJames Wright 
22877841947SLeila Ghaffari // PETSc user data
22977841947SLeila Ghaffari struct User_private {
23077841947SLeila Ghaffari   MPI_Comm             comm;
23177841947SLeila Ghaffari   DM                   dm;
23277841947SLeila Ghaffari   DM                   dm_viz;
23377841947SLeila Ghaffari   Mat                  interp_viz;
23477841947SLeila Ghaffari   Ceed                 ceed;
23577841947SLeila Ghaffari   Units                units;
236186595e6SJames Wright   Vec                  M_inv, Q_loc, Q_dot_loc;
23777841947SLeila Ghaffari   Physics              phys;
23877841947SLeila Ghaffari   AppCtx               app_ctx;
2392b730f8bSJeremy L Thompson   CeedVector           q_ceed, q_dot_ceed, g_ceed, coo_values_amat, coo_values_pmat, x_ceed;
2409ad5e8e4SJames Wright   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction, op_ijacobian;
2419ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
242e334ad8fSJed Brown   bool                 matrices_set_up;
24315637395SJames Wright   CeedScalar           time_bc_set;
244cbef7084SJames Wright   SpanStatsData        spanstats;
245999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
246cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2474e9802d1SJames Wright   DiffFilterData       diff_filter;
2488146534cSJames Wright   SmartSimData         smartsim;
249ee3b213aSJames Wright   SGS_DD_TrainingData  sgs_dd_train;
25077841947SLeila Ghaffari };
25177841947SLeila Ghaffari 
25277841947SLeila Ghaffari // Units
25377841947SLeila Ghaffari struct Units_private {
25477841947SLeila Ghaffari   // fundamental units
25577841947SLeila Ghaffari   PetscScalar meter;
25677841947SLeila Ghaffari   PetscScalar kilogram;
25777841947SLeila Ghaffari   PetscScalar second;
25877841947SLeila Ghaffari   PetscScalar Kelvin;
25977841947SLeila Ghaffari   // derived units
26077841947SLeila Ghaffari   PetscScalar Pascal;
26177841947SLeila Ghaffari   PetscScalar J_per_kg_K;
26277841947SLeila Ghaffari   PetscScalar m_per_squared_s;
26377841947SLeila Ghaffari   PetscScalar W_per_m_K;
26477841947SLeila Ghaffari   PetscScalar Joule;
26577841947SLeila Ghaffari };
26677841947SLeila Ghaffari 
26777841947SLeila Ghaffari // Boundary conditions
26877841947SLeila Ghaffari struct SimpleBC_private {
2692fe7aee7SLeila Ghaffari   PetscInt num_wall,  // Number of faces with wall BCs
2702fe7aee7SLeila Ghaffari       wall_comps[5],  // An array of constrained component numbers
2712fe7aee7SLeila Ghaffari       num_comps,
2722fe7aee7SLeila Ghaffari       num_slip[3],  // Number of faces with slip BCs
2732b730f8bSJeremy L Thompson       num_inflow, num_outflow, num_freestream;
274f4ca79c2SJames Wright   PetscInt  walls[16], slips[3][16], inflows[16], outflows[16], freestreams[16];
27577841947SLeila Ghaffari   PetscBool user_bc;
27677841947SLeila Ghaffari };
27777841947SLeila Ghaffari 
27877841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
27977841947SLeila Ghaffari struct Physics_private {
28077841947SLeila Ghaffari   PetscBool             implicit;
28197baf651SJames Wright   StateVariable         state_var;
28211436a05SJames Wright   CeedContextFieldLabel solution_time_label;
283cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
28488626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
285841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
286e334ad8fSJed Brown   CeedContextFieldLabel ijacobian_time_shift_label;
28777841947SLeila Ghaffari };
28877841947SLeila Ghaffari 
28991e5af17SJed Brown typedef struct {
29091e5af17SJed Brown   CeedQFunctionUser    qfunction;
29191e5af17SJed Brown   const char          *qfunction_loc;
292841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
29391e5af17SJed Brown } ProblemQFunctionSpec;
29491e5af17SJed Brown 
29577841947SLeila Ghaffari // Problem specific data
296841e4c73SJed Brown typedef struct ProblemData_private ProblemData;
297841e4c73SJed Brown struct ProblemData_private {
298e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
2991864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
3002b730f8bSJeremy L Thompson   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
3012b730f8bSJeremy L Thompson       apply_freestream, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian;
30277841947SLeila Ghaffari   bool      non_zero_time;
303752a08a7SJames Wright   PetscBool bc_from_ics, use_strong_bc_ceed, uses_newtonian;
304367c849eSJames Wright   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
305841e4c73SJed Brown };
30677841947SLeila Ghaffari 
307841e4c73SJed Brown extern int FreeContextPetsc(void *);
308841e4c73SJed Brown 
30977841947SLeila Ghaffari // -----------------------------------------------------------------------------
31077841947SLeila Ghaffari // Set up problems
31177841947SLeila Ghaffari // -----------------------------------------------------------------------------
31277841947SLeila Ghaffari // Set up function for each problem
31314712a6bSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
314530ad8c4SKenneth E. Jansen extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31546de7363SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31646de7363SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31746de7363SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31846de7363SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31946de7363SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32046de7363SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32146de7363SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32246de7363SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32377841947SLeila Ghaffari 
32477841947SLeila Ghaffari // Print function for each problem
325367c849eSJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
32677841947SLeila Ghaffari 
327367c849eSJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
32877841947SLeila Ghaffari 
329367c849eSJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
330019b7682STimothy Aiken 
331367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
33277841947SLeila Ghaffari 
333367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
33477841947SLeila Ghaffari 
3352e31f396SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
3362e31f396SJames Wright 
33777841947SLeila Ghaffari // -----------------------------------------------------------------------------
33877841947SLeila Ghaffari // libCEED functions
33977841947SLeila Ghaffari // -----------------------------------------------------------------------------
34077841947SLeila Ghaffari // Utility function to create local CEED restriction
341431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
342431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
34377841947SLeila Ghaffari 
344bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
345bb85d312SJames Wright                                                CeedElemRestriction *restriction);
346bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
347bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
348bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
349bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
350bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
351bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
35277841947SLeila Ghaffari 
3530814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3540814d5a7SKenneth E. Jansen 
35577841947SLeila Ghaffari // Utility function to create CEED Composite Operator for the entire domain
3562b730f8bSJeremy L Thompson PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
3572b730f8bSJeremy L Thompson                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
3582b730f8bSJeremy L Thompson                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
35977841947SLeila Ghaffari 
3602b730f8bSJeremy L Thompson PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
36177841947SLeila Ghaffari 
36277841947SLeila Ghaffari // -----------------------------------------------------------------------------
36377841947SLeila Ghaffari // Time-stepping functions
36477841947SLeila Ghaffari // -----------------------------------------------------------------------------
36577841947SLeila Ghaffari // Compute mass matrix for explicit scheme
3662b730f8bSJeremy L Thompson PetscErrorCode ComputeLumpedMassMatrix(Ceed ceed, DM dm, CeedData ceed_data, Vec M);
36777841947SLeila Ghaffari 
36877841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
36977841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
37077841947SLeila Ghaffari 
37177841947SLeila Ghaffari // Implicit time-stepper function setup
3722b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
37377841947SLeila Ghaffari 
37477841947SLeila Ghaffari // User provided TS Monitor
3752b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
37677841947SLeila Ghaffari 
37777841947SLeila Ghaffari // TS: Create, setup, and solve
3782b730f8bSJeremy L Thompson PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
37977841947SLeila Ghaffari 
380a0b9a424SJames Wright // Update Boundary Values when time has changed
381a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
382a0b9a424SJames Wright 
38377841947SLeila Ghaffari // -----------------------------------------------------------------------------
38477841947SLeila Ghaffari // Setup DM
38577841947SLeila Ghaffari // -----------------------------------------------------------------------------
3861864f1c2SLeila Ghaffari // Create mesh
3872b730f8bSJeremy L Thompson PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
38877841947SLeila Ghaffari 
38977841947SLeila Ghaffari // Set up DM
3900814d5a7SKenneth E. Jansen PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
391d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
39285df0564SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
393d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
394d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
39585df0564SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
39677841947SLeila Ghaffari 
39777841947SLeila Ghaffari // Refine DM for high-order viz
3982b730f8bSJeremy L Thompson PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
39977841947SLeila Ghaffari 
40077841947SLeila Ghaffari // -----------------------------------------------------------------------------
40177841947SLeila Ghaffari // Process command line options
40277841947SLeila Ghaffari // -----------------------------------------------------------------------------
40377841947SLeila Ghaffari // Register problems to be available on the command line
40477841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
40577841947SLeila Ghaffari 
40677841947SLeila Ghaffari // Process general command line options
4072b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
40877841947SLeila Ghaffari 
40977841947SLeila Ghaffari // -----------------------------------------------------------------------------
41077841947SLeila Ghaffari // Miscellaneous utility functions
41177841947SLeila Ghaffari // -----------------------------------------------------------------------------
4122b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
41377841947SLeila Ghaffari 
4143c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4152b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
41677841947SLeila Ghaffari 
41777841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4183c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
41977841947SLeila Ghaffari 
42077841947SLeila Ghaffari // Get error for problems with exact solutions
4213c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
42277841947SLeila Ghaffari 
42377841947SLeila Ghaffari // Post-processing
4243c9e7ad1SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
42577841947SLeila Ghaffari 
42677841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
42777841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
42877841947SLeila Ghaffari 
42977841947SLeila Ghaffari // Record boundary values from initial condition
4303c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
43177841947SLeila Ghaffari 
4324de8550aSJed Brown // Versioning token for binary checkpoints
4330de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4340de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4350de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4364de8550aSJed Brown 
437ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
438ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
439ef080ff9SJames Wright 
440999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
441999ff5c7SJames Wright 
442cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4438b892a05SJames Wright                                  FILE **fp);
4448b892a05SJames Wright 
445cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4468b892a05SJames Wright 
447cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4484cc9442bSJames Wright 
449457e73b2SJames Wright PetscErrorCode IntArrayC2P(PetscInt num_entries, CeedInt **array_ceed, PetscInt **array_petsc);
450457e73b2SJames Wright PetscErrorCode IntArrayP2C(PetscInt num_entries, PetscInt **array_petsc, CeedInt **array_ceed);
451457e73b2SJames Wright 
4528b892a05SJames Wright // -----------------------------------------------------------------------------
4538b892a05SJames Wright // Turbulence Statistics Collection Functions
4548b892a05SJames Wright // -----------------------------------------------------------------------------
4558b892a05SJames Wright 
456f5452247SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
457f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
458f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
459fd170fd0SJames Wright 
46077841947SLeila Ghaffari // -----------------------------------------------------------------------------
4614cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4624cc9442bSJames Wright // -----------------------------------------------------------------------------
4634cc9442bSJames Wright 
464cbef7084SJames Wright PetscErrorCode SgsDDModelSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
465cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
466cbef7084SJames Wright PetscErrorCode SgsDDModelApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
4677618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem, StateVariable state_var_input,
4687618d7b7SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
4697618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
470052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
471052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
472900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
473900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4744cc9442bSJames Wright 
4754cc9442bSJames Wright // -----------------------------------------------------------------------------
476dada6cc0SJames Wright // Boundary Condition Related Functions
477dada6cc0SJames Wright // -----------------------------------------------------------------------------
478dada6cc0SJames Wright 
479dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
48066170c20SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
481b7c563b6SJeremy L Thompson 
482d310b3d3SAdeleke O. Bankole PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4838a94a473SJed Brown PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4842b730f8bSJeremy L Thompson 
4854e9802d1SJames Wright // -----------------------------------------------------------------------------
4864e9802d1SJames Wright // Differential Filtering Functions
4874e9802d1SJames Wright // -----------------------------------------------------------------------------
4884e9802d1SJames Wright 
4894e9802d1SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
4904e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
4914e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4924e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
493cbef7084SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
4944e9802d1SJames Wright 
4958146534cSJames Wright // -----------------------------------------------------------------------------
4968146534cSJames Wright // SGS Data-Driven Training via SmartSim
4978146534cSJames Wright // -----------------------------------------------------------------------------
4988146534cSJames Wright PetscErrorCode SmartSimSetup(User user);
499b306c3f1SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
500ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
501ee3b213aSJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
5021a7db67cSJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
503ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
5048146534cSJames Wright 
505b7c563b6SJeremy L Thompson #endif  // libceed_fluids_examples_navier_stokes_h
506