xref: /libCEED/examples/fluids/navierstokes.h (revision 91c97f41bd25cf2fbada21392acdb50722cb486e)
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>
12*91c97f41SJames Wright #include <mat-ceed.h>
1377841947SLeila Ghaffari #include <petscts.h>
1477841947SLeila Ghaffari #include <stdbool.h>
152b730f8bSJeremy L Thompson 
164021610dSJames Wright #include "./include/petsc_ops.h"
1797baf651SJames Wright #include "qfunctions/newtonian_types.h"
182b730f8bSJeremy L Thompson #include "qfunctions/stabilization_types.h"
1977841947SLeila Ghaffari 
20d31f425aSJeremy L Thompson #if PETSC_VERSION_LT(3, 20, 0)
21d31f425aSJeremy L Thompson #error "PETSc v3.20 or later is required"
2277841947SLeila Ghaffari #endif
2377841947SLeila Ghaffari 
2449a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0)
2549a40c8aSKenneth E. Jansen #define DMSetCoordinateDisc(a, b, c) DMProjectCoordinates(a, b)
2649a40c8aSKenneth E. Jansen #endif
2749a40c8aSKenneth E. Jansen 
28d9d458caSJames Wright #define PetscCallCeed(ceed, ...)                                    \
29a424bcd0SJames Wright   do {                                                              \
30d9d458caSJames Wright     int ierr = __VA_ARGS__;                                         \
31a424bcd0SJames Wright     if (ierr != CEED_ERROR_SUCCESS) {                               \
32a424bcd0SJames Wright       const char *error_message;                                    \
33a424bcd0SJames Wright       CeedGetErrorMessage(ceed, &error_message);                    \
34a424bcd0SJames Wright       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "%s", error_message); \
35a424bcd0SJames Wright     }                                                               \
36a424bcd0SJames Wright   } while (0)
37a424bcd0SJames Wright 
3877841947SLeila Ghaffari // -----------------------------------------------------------------------------
3977841947SLeila Ghaffari // Enums
4077841947SLeila Ghaffari // -----------------------------------------------------------------------------
4177841947SLeila Ghaffari // Translate PetscMemType to CeedMemType
422b730f8bSJeremy L Thompson static inline CeedMemType MemTypeP2C(PetscMemType mem_type) { return PetscMemTypeDevice(mem_type) ? CEED_MEM_DEVICE : CEED_MEM_HOST; }
4377841947SLeila Ghaffari 
4477841947SLeila Ghaffari // Euler - test cases
4577841947SLeila Ghaffari typedef enum {
46bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
4777841947SLeila Ghaffari   EULER_TEST_1                 = 1,
4877841947SLeila Ghaffari   EULER_TEST_2                 = 2,
4977841947SLeila Ghaffari   EULER_TEST_3                 = 3,
5077841947SLeila Ghaffari   EULER_TEST_4                 = 4,
5132f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
5277841947SLeila Ghaffari } EulerTestType;
532b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
542b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
5577841947SLeila Ghaffari 
56700ae941SJames Wright // Advection - Wind types
57700ae941SJames Wright static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
58700ae941SJames Wright 
597b77ddfdSJames Wright // Advection - Initial Condition Types
607b77ddfdSJames Wright static const char *const AdvectionICTypes[] = {"sphere", "cylinder", "cosine_hill", "skew", "AdvectionICType", "ADVECTIONIC_", NULL};
61700ae941SJames Wright 
62700ae941SJames Wright // Advection - Bubble Continuity Types
6393639ffbSJames Wright static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "cosine", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
64700ae941SJames Wright 
6577841947SLeila Ghaffari // Stabilization methods
662b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
6777841947SLeila Ghaffari 
6851b00d91SJames Wright // Test mode type
698fb33541SJames Wright typedef enum {
708fb33541SJames Wright   TESTTYPE_NONE           = 0,
718fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
728fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
73970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
748fb33541SJames Wright } TestType;
75970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
768fb33541SJames Wright 
772526956eSJames Wright // Subgrid-Stress mode type
7819ffbc25SJames Wright typedef enum {
7919ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
8019ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
8119ffbc25SJames Wright } SGSModelType;
8219ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
8319ffbc25SJames Wright 
842526956eSJames Wright // Mesh transformation type
852526956eSJames Wright typedef enum {
862526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
872526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
882526956eSJames Wright } MeshTransformType;
892526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
902526956eSJames Wright 
91bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
92bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
93bd882c8aSJames Wright 
9477841947SLeila Ghaffari // -----------------------------------------------------------------------------
9575d1798cSJames Wright // Log Events
9675d1798cSJames Wright // -----------------------------------------------------------------------------
9775d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorApply;
9875d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
9975d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
10075d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
101844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Init;
102844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Meta;
103844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Train;
104844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_TrainDataCompute;
1053737f832SJames Wright extern PetscLogEvent FLUIDS_DifferentialFilter;
1063737f832SJames Wright extern PetscLogEvent FLUIDS_VelocityGradientProjection;
10775d1798cSJames Wright PetscErrorCode       RegisterLogEvents();
10875d1798cSJames Wright 
10975d1798cSJames Wright // -----------------------------------------------------------------------------
11077841947SLeila Ghaffari // Structs
11177841947SLeila Ghaffari // -----------------------------------------------------------------------------
11277841947SLeila Ghaffari // Structs declarations
11377841947SLeila Ghaffari typedef struct AppCtx_private   *AppCtx;
11477841947SLeila Ghaffari typedef struct CeedData_private *CeedData;
11577841947SLeila Ghaffari typedef struct User_private     *User;
11677841947SLeila Ghaffari typedef struct Units_private    *Units;
11777841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC;
11877841947SLeila Ghaffari typedef struct Physics_private  *Physics;
11977841947SLeila Ghaffari 
12077841947SLeila Ghaffari // Application context from user command line options
12177841947SLeila Ghaffari struct AppCtx_private {
12277841947SLeila Ghaffari   // libCEED arguments
12377841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
12477841947SLeila Ghaffari   PetscInt degree;
12577841947SLeila Ghaffari   PetscInt q_extra;
126544be873SJed Brown   // Solver arguments
127544be873SJed Brown   MatType amat_type;
12877841947SLeila Ghaffari   // Post-processing arguments
12937cbb16aSJed Brown   PetscInt  checkpoint_interval;
13077841947SLeila Ghaffari   PetscInt  viz_refine;
13177841947SLeila Ghaffari   PetscInt  cont_steps;
1324de8550aSJed Brown   PetscReal cont_time;
13369293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
13469293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
13577841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
13669293791SJames Wright   PetscBool add_stepnum2bin;
13737cbb16aSJed Brown   PetscBool checkpoint_vtk;
13877841947SLeila Ghaffari   // Problem type arguments
13977841947SLeila Ghaffari   PetscFunctionList problems;
14077841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
14177841947SLeila Ghaffari   // Test mode arguments
1428fb33541SJames Wright   TestType    test_type;
14377841947SLeila Ghaffari   PetscScalar test_tol;
144b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
145b7d66439SJames Wright   // Turbulent spanwise statistics
146b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
147b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
148b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
149b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
150b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
151ca69d878SAdeleke O. Bankole   // Wall forces
152ca69d878SAdeleke O. Bankole   struct {
153ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
154ca69d878SAdeleke O. Bankole     PetscInt         *walls;
155ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
156ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
157ca69d878SAdeleke O. Bankole     PetscBool         header_written;
158ca69d878SAdeleke O. Bankole   } wall_forces;
15919ffbc25SJames Wright   // Subgrid Stress Model
16019ffbc25SJames Wright   SGSModelType sgs_model_type;
16128134cfaSJames Wright   PetscBool    sgs_train_enable;
1624e9802d1SJames Wright   // Differential Filtering
1634e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1642526956eSJames Wright   MeshTransformType mesh_transform_type;
16577841947SLeila Ghaffari };
16677841947SLeila Ghaffari 
16777841947SLeila Ghaffari // libCEED data struct
16877841947SLeila Ghaffari struct CeedData_private {
16977841947SLeila Ghaffari   CeedVector           x_coord, q_data;
1702b730f8bSJeremy L Thompson   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
17177841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1725263e9c6SJames Wright   CeedOperator         op_setup_vol;
1735263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
174d310b3d3SAdeleke 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,
1759f844368SJames Wright       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian, qf_apply_slip, qf_apply_slip_jacobian;
17677841947SLeila Ghaffari };
17777841947SLeila Ghaffari 
17851ee423eSJames Wright typedef struct {
17951ee423eSJames Wright   DM                    dm;
1801737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
181ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
18251ee423eSJames Wright   PetscInt              num_comp_stats;
183ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
184a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
185a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
186b7d66439SJames Wright   PetscBool             do_mms_test;
1874021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
188495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
189cbef7084SJames Wright } SpanStatsData;
19051ee423eSJames Wright 
191999ff5c7SJames Wright typedef struct {
192999ff5c7SJames Wright   DM                   dm;
193999ff5c7SJames Wright   PetscInt             num_comp;
194999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
195999ff5c7SJames Wright   KSP                  ksp;
196999ff5c7SJames Wright } *NodalProjectionData;
197999ff5c7SJames Wright 
1986b3fb9aeSJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
1991250e899SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
2009a17443dSJames Wright typedef struct {
2011250e899SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
2029a17443dSJames Wright   PetscInt                  num_comp_sgs;
2031250e899SJames Wright   CeedInt                   num_comp_inputs, num_comp_outputs;
2041250e899SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
2051250e899SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
2066b3fb9aeSJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
2071250e899SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
2081250e899SJames Wright   void                     *sgs_nodal_inference_ctx;
2091250e899SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
210cbef7084SJames Wright } *SgsDDData;
2119a17443dSJames Wright 
2124e9802d1SJames Wright typedef struct {
213ee3b213aSJames Wright   DM                   dm_dd_training;
214ee3b213aSJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval;
215ee3b213aSJames Wright   OperatorApplyContext op_training_data_calc_ctx;
216ee3b213aSJames Wright   NodalProjectionData  filtered_grad_velo_proj;
217ee3b213aSJames Wright   size_t               training_data_array_dims[2];
218ee3b213aSJames Wright   PetscBool            overwrite_training_data;
219ee3b213aSJames Wright } *SGS_DD_TrainingData;
220ee3b213aSJames Wright 
221ee3b213aSJames Wright typedef struct {
2224e9802d1SJames Wright   DM                   dm_filter;
22381530087SJames Wright   PetscInt             num_filtered_fields;
22481530087SJames Wright   CeedInt             *num_field_components;
225051427eeSJames Wright   PetscInt             field_prim_state, field_velo_prod;
2264e9802d1SJames Wright   OperatorApplyContext op_rhs_ctx;
2274e9802d1SJames Wright   KSP                  ksp;
2282029a677SJames Wright   PetscBool            do_mms_test;
2294e9802d1SJames Wright } *DiffFilterData;
2304e9802d1SJames Wright 
2318146534cSJames Wright typedef struct {
2328146534cSJames Wright   void    *client;
2338146534cSJames Wright   char     rank_id_name[16];
2348146534cSJames Wright   PetscInt collocated_database_num_ranks;
2358146534cSJames Wright } *SmartSimData;
2368146534cSJames Wright 
23777841947SLeila Ghaffari // PETSc user data
23877841947SLeila Ghaffari struct User_private {
23977841947SLeila Ghaffari   MPI_Comm             comm;
24077841947SLeila Ghaffari   DM                   dm;
24177841947SLeila Ghaffari   DM                   dm_viz;
24277841947SLeila Ghaffari   Mat                  interp_viz;
24377841947SLeila Ghaffari   Ceed                 ceed;
24477841947SLeila Ghaffari   Units                units;
24504292f7dSJames Wright   Vec                  Q_loc, Q_dot_loc;
24677841947SLeila Ghaffari   Physics              phys;
24777841947SLeila Ghaffari   AppCtx               app_ctx;
248*91c97f41SJames Wright   CeedVector           q_ceed, q_dot_ceed, g_ceed, x_ceed;
249*91c97f41SJames Wright   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction;
250*91c97f41SJames Wright   Mat                  mat_ijacobian;
25104292f7dSJames Wright   KSP                  mass_ksp;
2529ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
25315637395SJames Wright   CeedScalar           time_bc_set;
254cbef7084SJames Wright   SpanStatsData        spanstats;
255999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
256cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2574e9802d1SJames Wright   DiffFilterData       diff_filter;
2588146534cSJames Wright   SmartSimData         smartsim;
259ee3b213aSJames Wright   SGS_DD_TrainingData  sgs_dd_train;
26077841947SLeila Ghaffari };
26177841947SLeila Ghaffari 
26277841947SLeila Ghaffari // Units
26377841947SLeila Ghaffari struct Units_private {
26477841947SLeila Ghaffari   // fundamental units
26577841947SLeila Ghaffari   PetscScalar meter;
26677841947SLeila Ghaffari   PetscScalar kilogram;
26777841947SLeila Ghaffari   PetscScalar second;
26877841947SLeila Ghaffari   PetscScalar Kelvin;
26977841947SLeila Ghaffari   // derived units
27077841947SLeila Ghaffari   PetscScalar Pascal;
27177841947SLeila Ghaffari   PetscScalar J_per_kg_K;
27277841947SLeila Ghaffari   PetscScalar m_per_squared_s;
27377841947SLeila Ghaffari   PetscScalar W_per_m_K;
27477841947SLeila Ghaffari   PetscScalar Joule;
27577841947SLeila Ghaffari };
27677841947SLeila Ghaffari 
27777841947SLeila Ghaffari // Boundary conditions
27877841947SLeila Ghaffari struct SimpleBC_private {
2792fe7aee7SLeila Ghaffari   PetscInt num_wall,  // Number of faces with wall BCs
2802fe7aee7SLeila Ghaffari       wall_comps[5],  // An array of constrained component numbers
2812fe7aee7SLeila Ghaffari       num_comps,
2827c5bba50SJames Wright       num_symmetry[3],  // Number of faces with symmetry BCs
2839f844368SJames Wright       num_inflow, num_outflow, num_freestream, num_slip;
2849f844368SJames Wright   PetscInt walls[16], symmetries[3][16], inflows[16], outflows[16], freestreams[16], slips[16];
28577841947SLeila Ghaffari };
28677841947SLeila Ghaffari 
28777841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
28877841947SLeila Ghaffari struct Physics_private {
28977841947SLeila Ghaffari   PetscBool             implicit;
29097baf651SJames Wright   StateVariable         state_var;
29111436a05SJames Wright   CeedContextFieldLabel solution_time_label;
292cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
29388626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
294841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
295e334ad8fSJed Brown   CeedContextFieldLabel ijacobian_time_shift_label;
29677841947SLeila Ghaffari };
29777841947SLeila Ghaffari 
29891e5af17SJed Brown typedef struct {
29991e5af17SJed Brown   CeedQFunctionUser    qfunction;
30091e5af17SJed Brown   const char          *qfunction_loc;
301841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
30291e5af17SJed Brown } ProblemQFunctionSpec;
30391e5af17SJed Brown 
30477841947SLeila Ghaffari // Problem specific data
305841e4c73SJed Brown typedef struct ProblemData_private ProblemData;
306841e4c73SJed Brown struct ProblemData_private {
307e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
3081864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
3092b730f8bSJeremy L Thompson   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
3109f844368SJames Wright       apply_freestream, apply_slip, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian, apply_slip_jacobian;
31177841947SLeila Ghaffari   bool      non_zero_time;
312752a08a7SJames Wright   PetscBool bc_from_ics, use_strong_bc_ceed, uses_newtonian;
313367c849eSJames Wright   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
314841e4c73SJed Brown };
31577841947SLeila Ghaffari 
316841e4c73SJed Brown extern int FreeContextPetsc(void *);
317841e4c73SJed Brown 
31877841947SLeila Ghaffari // -----------------------------------------------------------------------------
31977841947SLeila Ghaffari // Set up problems
32077841947SLeila Ghaffari // -----------------------------------------------------------------------------
32177841947SLeila Ghaffari // Set up function for each problem
32214712a6bSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
323530ad8c4SKenneth E. Jansen extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32446de7363SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32546de7363SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32646de7363SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32746de7363SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32846de7363SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32946de7363SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
33046de7363SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
33146de7363SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
33277841947SLeila Ghaffari 
33377841947SLeila Ghaffari // Print function for each problem
334367c849eSJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
33577841947SLeila Ghaffari 
336367c849eSJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
33777841947SLeila Ghaffari 
338367c849eSJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
339019b7682STimothy Aiken 
340367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
34177841947SLeila Ghaffari 
342367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
34377841947SLeila Ghaffari 
3442e31f396SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
3452e31f396SJames Wright 
34677841947SLeila Ghaffari // -----------------------------------------------------------------------------
34777841947SLeila Ghaffari // libCEED functions
34877841947SLeila Ghaffari // -----------------------------------------------------------------------------
34977841947SLeila Ghaffari // Utility function to create local CEED restriction
350431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
351431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
35277841947SLeila Ghaffari 
353bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
354bb85d312SJames Wright                                                CeedElemRestriction *restriction);
355bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
356bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
357bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
358bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
359bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
360bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
36177841947SLeila Ghaffari 
3620814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3630814d5a7SKenneth E. Jansen 
36477841947SLeila Ghaffari // Utility function to create CEED Composite Operator for the entire domain
3652b730f8bSJeremy L Thompson PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
3662b730f8bSJeremy L Thompson                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
3672b730f8bSJeremy L Thompson                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
36877841947SLeila Ghaffari 
3692b730f8bSJeremy L Thompson PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
37077841947SLeila Ghaffari 
37177841947SLeila Ghaffari // -----------------------------------------------------------------------------
37277841947SLeila Ghaffari // Time-stepping functions
37377841947SLeila Ghaffari // -----------------------------------------------------------------------------
37404292f7dSJames Wright // Create KSP to solve the inverse mass operator for explicit time stepping schemes
375dfcf44b0SJames Wright PetscErrorCode CreateKSPMassOperator(User user, CeedData ceed_data);
37677841947SLeila Ghaffari 
37777841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
37877841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
37977841947SLeila Ghaffari 
38077841947SLeila Ghaffari // Implicit time-stepper function setup
3812b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
38277841947SLeila Ghaffari 
38377841947SLeila Ghaffari // User provided TS Monitor
3842b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
38577841947SLeila Ghaffari 
38677841947SLeila Ghaffari // TS: Create, setup, and solve
3872b730f8bSJeremy L Thompson PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
38877841947SLeila Ghaffari 
389a0b9a424SJames Wright // Update Boundary Values when time has changed
390a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
391a0b9a424SJames Wright 
39277841947SLeila Ghaffari // -----------------------------------------------------------------------------
39377841947SLeila Ghaffari // Setup DM
39477841947SLeila Ghaffari // -----------------------------------------------------------------------------
3951864f1c2SLeila Ghaffari // Create mesh
3962b730f8bSJeremy L Thompson PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
39777841947SLeila Ghaffari 
39877841947SLeila Ghaffari // Set up DM
3990814d5a7SKenneth E. Jansen PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
400d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
40185df0564SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
402d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
403d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
40485df0564SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
40577841947SLeila Ghaffari 
40677841947SLeila Ghaffari // Refine DM for high-order viz
4072b730f8bSJeremy L Thompson PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
40877841947SLeila Ghaffari 
40977841947SLeila Ghaffari // -----------------------------------------------------------------------------
41077841947SLeila Ghaffari // Process command line options
41177841947SLeila Ghaffari // -----------------------------------------------------------------------------
41277841947SLeila Ghaffari // Register problems to be available on the command line
41377841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
41477841947SLeila Ghaffari 
41577841947SLeila Ghaffari // Process general command line options
4162b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
41777841947SLeila Ghaffari 
41877841947SLeila Ghaffari // -----------------------------------------------------------------------------
41977841947SLeila Ghaffari // Miscellaneous utility functions
42077841947SLeila Ghaffari // -----------------------------------------------------------------------------
4212b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
42277841947SLeila Ghaffari 
4233c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4242b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
42577841947SLeila Ghaffari 
42677841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4273c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
42877841947SLeila Ghaffari 
42977841947SLeila Ghaffari // Get error for problems with exact solutions
4303c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
43177841947SLeila Ghaffari 
43277841947SLeila Ghaffari // Post-processing
4333c9e7ad1SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
43477841947SLeila Ghaffari 
43577841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
43677841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
43777841947SLeila Ghaffari 
43877841947SLeila Ghaffari // Record boundary values from initial condition
4393c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
44077841947SLeila Ghaffari 
4414de8550aSJed Brown // Versioning token for binary checkpoints
4420de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4430de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4440de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4454de8550aSJed Brown 
446ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
447ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
448ef080ff9SJames Wright 
449999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
450999ff5c7SJames Wright 
451cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4528b892a05SJames Wright                                  FILE **fp);
4538b892a05SJames Wright 
454cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4558b892a05SJames Wright 
456cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4574cc9442bSJames Wright 
458457e73b2SJames Wright PetscErrorCode IntArrayC2P(PetscInt num_entries, CeedInt **array_ceed, PetscInt **array_petsc);
459457e73b2SJames Wright PetscErrorCode IntArrayP2C(PetscInt num_entries, PetscInt **array_petsc, CeedInt **array_ceed);
460457e73b2SJames Wright 
4618b892a05SJames Wright // -----------------------------------------------------------------------------
4628b892a05SJames Wright // Turbulence Statistics Collection Functions
4638b892a05SJames Wright // -----------------------------------------------------------------------------
4648b892a05SJames Wright 
465f5452247SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
466f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
467f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
468fd170fd0SJames Wright 
46977841947SLeila Ghaffari // -----------------------------------------------------------------------------
4704cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4714cc9442bSJames Wright // -----------------------------------------------------------------------------
4724cc9442bSJames Wright 
4738f5ab23bSJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
474cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
4758f5ab23bSJames Wright PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
4767618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem, StateVariable state_var_input,
4777618d7b7SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
4787618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
479052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
480052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
481900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
482900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4834cc9442bSJames Wright 
4844cc9442bSJames Wright // -----------------------------------------------------------------------------
485dada6cc0SJames Wright // Boundary Condition Related Functions
486dada6cc0SJames Wright // -----------------------------------------------------------------------------
487dada6cc0SJames Wright 
488dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
48966170c20SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
490b7c563b6SJeremy L Thompson 
491d310b3d3SAdeleke O. Bankole PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4928a94a473SJed Brown PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4939f844368SJames Wright PetscErrorCode SlipBCSetup(ProblemData *problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
4942b730f8bSJeremy L Thompson 
4954e9802d1SJames Wright // -----------------------------------------------------------------------------
4964e9802d1SJames Wright // Differential Filtering Functions
4974e9802d1SJames Wright // -----------------------------------------------------------------------------
4984e9802d1SJames Wright 
4994e9802d1SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
5004e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
5014e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
5024e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
503cbef7084SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
5044e9802d1SJames Wright 
5058146534cSJames Wright // -----------------------------------------------------------------------------
5068146534cSJames Wright // SGS Data-Driven Training via SmartSim
5078146534cSJames Wright // -----------------------------------------------------------------------------
5088146534cSJames Wright PetscErrorCode SmartSimSetup(User user);
509b306c3f1SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
510ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
511ee3b213aSJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
5121a7db67cSJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
513ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
5148146534cSJames Wright 
515b7c563b6SJeremy L Thompson #endif  // libceed_fluids_examples_navier_stokes_h
516