xref: /libCEED/examples/fluids/navierstokes.h (revision bb85d3120cc857fb1b4b3ced9fdf3c98ac05c9b5)
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 
19db3e7f92SJames Wright #if PETSC_VERSION_LT(3, 19, 0)
20db3e7f92SJames Wright #error "PETSc v3.19 or later is required"
2177841947SLeila Ghaffari #endif
2277841947SLeila Ghaffari 
23a424bcd0SJames Wright #define PetscCeedChk(ceed, ierr)                                    \
24a424bcd0SJames Wright   do {                                                              \
25a424bcd0SJames Wright     if (ierr != CEED_ERROR_SUCCESS) {                               \
26a424bcd0SJames Wright       const char *error_message;                                    \
27a424bcd0SJames Wright       CeedGetErrorMessage(ceed, &error_message);                    \
28a424bcd0SJames Wright       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "%s", error_message); \
29a424bcd0SJames Wright     }                                                               \
30a424bcd0SJames Wright   } while (0)
31a424bcd0SJames Wright 
32a424bcd0SJames Wright #define PetscCallCeed(ceed, ...) \
33a424bcd0SJames Wright   do {                           \
34a424bcd0SJames Wright     int ierr_q_ = __VA_ARGS__;   \
35a424bcd0SJames Wright     PetscCeedChk(ceed, ierr_q_); \
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 // Advection - Wind Options
4577841947SLeila Ghaffari typedef enum {
4677841947SLeila Ghaffari   WIND_ROTATION    = 0,
4777841947SLeila Ghaffari   WIND_TRANSLATION = 1,
4877841947SLeila Ghaffari } WindType;
492b730f8bSJeremy L Thompson static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
5077841947SLeila Ghaffari 
5177841947SLeila Ghaffari // Advection - Bubble Types
5277841947SLeila Ghaffari typedef enum {
5377841947SLeila Ghaffari   BUBBLE_SPHERE   = 0,  // dim=3
5477841947SLeila Ghaffari   BUBBLE_CYLINDER = 1,  // dim=2
5577841947SLeila Ghaffari } BubbleType;
562b730f8bSJeremy L Thompson static const char *const BubbleTypes[] = {"sphere", "cylinder", "BubbleType", "BUBBLE_", NULL};
5777841947SLeila Ghaffari 
5877841947SLeila Ghaffari // Advection - Bubble Continuity Types
5977841947SLeila Ghaffari typedef enum {
6077841947SLeila Ghaffari   BUBBLE_CONTINUITY_SMOOTH     = 0,  // Original continuous, smooth shape
6177841947SLeila Ghaffari   BUBBLE_CONTINUITY_BACK_SHARP = 1,  // Discontinuous, sharp back half shape
6277841947SLeila Ghaffari   BUBBLE_CONTINUITY_THICK      = 2,  // Define a finite thickness
6377841947SLeila Ghaffari } BubbleContinuityType;
642b730f8bSJeremy L Thompson static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
6577841947SLeila Ghaffari 
6677841947SLeila Ghaffari // Euler - test cases
6777841947SLeila Ghaffari typedef enum {
68bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
6977841947SLeila Ghaffari   EULER_TEST_1                 = 1,
7077841947SLeila Ghaffari   EULER_TEST_2                 = 2,
7177841947SLeila Ghaffari   EULER_TEST_3                 = 3,
7277841947SLeila Ghaffari   EULER_TEST_4                 = 4,
7332f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
7477841947SLeila Ghaffari } EulerTestType;
752b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
762b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
7777841947SLeila Ghaffari 
7877841947SLeila Ghaffari // Stabilization methods
792b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
8077841947SLeila Ghaffari 
8151b00d91SJames Wright // Test mode type
828fb33541SJames Wright typedef enum {
838fb33541SJames Wright   TESTTYPE_NONE           = 0,
848fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
858fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
86970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
878fb33541SJames Wright } TestType;
88970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
898fb33541SJames Wright 
902526956eSJames Wright // Subgrid-Stress mode type
9119ffbc25SJames Wright typedef enum {
9219ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
9319ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
9419ffbc25SJames Wright } SGSModelType;
9519ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
9619ffbc25SJames Wright 
972526956eSJames Wright // Mesh transformation type
982526956eSJames Wright typedef enum {
992526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
1002526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
1012526956eSJames Wright } MeshTransformType;
1022526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
1032526956eSJames Wright 
104bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
105bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
106bd882c8aSJames Wright 
10777841947SLeila Ghaffari // -----------------------------------------------------------------------------
10875d1798cSJames Wright // Log Events
10975d1798cSJames Wright // -----------------------------------------------------------------------------
11075d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorApply;
11175d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
11275d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
11375d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
11475d1798cSJames Wright PetscErrorCode       RegisterLogEvents();
11575d1798cSJames Wright 
11675d1798cSJames Wright // -----------------------------------------------------------------------------
11777841947SLeila Ghaffari // Structs
11877841947SLeila Ghaffari // -----------------------------------------------------------------------------
11977841947SLeila Ghaffari // Structs declarations
12077841947SLeila Ghaffari typedef struct AppCtx_private   *AppCtx;
12177841947SLeila Ghaffari typedef struct CeedData_private *CeedData;
12277841947SLeila Ghaffari typedef struct User_private     *User;
12377841947SLeila Ghaffari typedef struct Units_private    *Units;
12477841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC;
12577841947SLeila Ghaffari typedef struct Physics_private  *Physics;
12677841947SLeila Ghaffari 
12777841947SLeila Ghaffari // Application context from user command line options
12877841947SLeila Ghaffari struct AppCtx_private {
12977841947SLeila Ghaffari   // libCEED arguments
13077841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
13177841947SLeila Ghaffari   PetscInt degree;
13277841947SLeila Ghaffari   PetscInt q_extra;
133544be873SJed Brown   // Solver arguments
134544be873SJed Brown   MatType   amat_type;
135544be873SJed Brown   PetscBool pmat_pbdiagonal;
13677841947SLeila Ghaffari   // Post-processing arguments
13737cbb16aSJed Brown   PetscInt  checkpoint_interval;
13877841947SLeila Ghaffari   PetscInt  viz_refine;
13977841947SLeila Ghaffari   PetscInt  cont_steps;
1404de8550aSJed Brown   PetscReal cont_time;
14169293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
14269293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
14377841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
14469293791SJames Wright   PetscBool add_stepnum2bin;
14537cbb16aSJed Brown   PetscBool checkpoint_vtk;
14677841947SLeila Ghaffari   // Problem type arguments
14777841947SLeila Ghaffari   PetscFunctionList problems;
14877841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
14977841947SLeila Ghaffari   // Test mode arguments
1508fb33541SJames Wright   TestType    test_type;
15177841947SLeila Ghaffari   PetscScalar test_tol;
152b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
153b7d66439SJames Wright   // Turbulent spanwise statistics
154b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
155b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
156b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
157b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
158b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
159ca69d878SAdeleke O. Bankole   // Wall forces
160ca69d878SAdeleke O. Bankole   struct {
161ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
162ca69d878SAdeleke O. Bankole     PetscInt         *walls;
163ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
164ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
165ca69d878SAdeleke O. Bankole     PetscBool         header_written;
166ca69d878SAdeleke O. Bankole   } wall_forces;
16719ffbc25SJames Wright   // Subgrid Stress Model
16819ffbc25SJames Wright   SGSModelType sgs_model_type;
1694e9802d1SJames Wright   // Differential Filtering
1704e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1712526956eSJames Wright   MeshTransformType mesh_transform_type;
17277841947SLeila Ghaffari };
17377841947SLeila Ghaffari 
17477841947SLeila Ghaffari // libCEED data struct
17577841947SLeila Ghaffari struct CeedData_private {
17677841947SLeila Ghaffari   CeedVector           x_coord, q_data;
1772b730f8bSJeremy L Thompson   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
17877841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1795263e9c6SJames Wright   CeedOperator         op_setup_vol;
1805263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
181d310b3d3SAdeleke 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,
182d310b3d3SAdeleke O. Bankole       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian;
18377841947SLeila Ghaffari };
18477841947SLeila Ghaffari 
18551ee423eSJames Wright typedef struct {
18651ee423eSJames Wright   DM                    dm;
1871737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
188ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
18951ee423eSJames Wright   PetscInt              num_comp_stats;
190ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
191a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
192a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
193b7d66439SJames Wright   PetscBool             do_mms_test;
1944021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
195495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
196cbef7084SJames Wright } SpanStatsData;
19751ee423eSJames Wright 
198999ff5c7SJames Wright typedef struct {
199999ff5c7SJames Wright   DM                   dm;
200999ff5c7SJames Wright   PetscInt             num_comp;
201999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
202999ff5c7SJames Wright   KSP                  ksp;
203999ff5c7SJames Wright } *NodalProjectionData;
204999ff5c7SJames Wright 
2059a17443dSJames Wright typedef struct {
2069a17443dSJames Wright   DM                   dm_sgs;
2079a17443dSJames Wright   PetscInt             num_comp_sgs;
208be34b3b7SJames Wright   OperatorApplyContext op_nodal_evaluation_ctx, op_sgs_apply_ctx;
2099a17443dSJames Wright   CeedVector           sgs_nodal_ceed;
210cbef7084SJames Wright } *SgsDDData;
2119a17443dSJames Wright 
2124e9802d1SJames Wright typedef struct {
2134e9802d1SJames Wright   DM                   dm_filter;
21481530087SJames Wright   PetscInt             num_filtered_fields;
21581530087SJames Wright   CeedInt             *num_field_components;
2164e9802d1SJames Wright   OperatorApplyContext op_rhs_ctx;
2174e9802d1SJames Wright   KSP                  ksp;
2182029a677SJames Wright   PetscBool            do_mms_test;
2194e9802d1SJames Wright } *DiffFilterData;
2204e9802d1SJames Wright 
22177841947SLeila Ghaffari // PETSc user data
22277841947SLeila Ghaffari struct User_private {
22377841947SLeila Ghaffari   MPI_Comm             comm;
22477841947SLeila Ghaffari   DM                   dm;
22577841947SLeila Ghaffari   DM                   dm_viz;
22677841947SLeila Ghaffari   Mat                  interp_viz;
22777841947SLeila Ghaffari   Ceed                 ceed;
22877841947SLeila Ghaffari   Units                units;
229186595e6SJames Wright   Vec                  M_inv, Q_loc, Q_dot_loc;
23077841947SLeila Ghaffari   Physics              phys;
23177841947SLeila Ghaffari   AppCtx               app_ctx;
2322b730f8bSJeremy L Thompson   CeedVector           q_ceed, q_dot_ceed, g_ceed, coo_values_amat, coo_values_pmat, x_ceed;
2339ad5e8e4SJames Wright   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction, op_ijacobian;
2349ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
235e334ad8fSJed Brown   bool                 matrices_set_up;
23615637395SJames Wright   CeedScalar           time_bc_set;
237cbef7084SJames Wright   SpanStatsData        spanstats;
238999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
239cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2404e9802d1SJames Wright   DiffFilterData       diff_filter;
24177841947SLeila Ghaffari };
24277841947SLeila Ghaffari 
24377841947SLeila Ghaffari // Units
24477841947SLeila Ghaffari struct Units_private {
24577841947SLeila Ghaffari   // fundamental units
24677841947SLeila Ghaffari   PetscScalar meter;
24777841947SLeila Ghaffari   PetscScalar kilogram;
24877841947SLeila Ghaffari   PetscScalar second;
24977841947SLeila Ghaffari   PetscScalar Kelvin;
25077841947SLeila Ghaffari   // derived units
25177841947SLeila Ghaffari   PetscScalar Pascal;
25277841947SLeila Ghaffari   PetscScalar J_per_kg_K;
25377841947SLeila Ghaffari   PetscScalar m_per_squared_s;
25477841947SLeila Ghaffari   PetscScalar W_per_m_K;
25577841947SLeila Ghaffari   PetscScalar Joule;
25677841947SLeila Ghaffari };
25777841947SLeila Ghaffari 
25877841947SLeila Ghaffari // Boundary conditions
25977841947SLeila Ghaffari struct SimpleBC_private {
2602fe7aee7SLeila Ghaffari   PetscInt num_wall,  // Number of faces with wall BCs
2612fe7aee7SLeila Ghaffari       wall_comps[5],  // An array of constrained component numbers
2622fe7aee7SLeila Ghaffari       num_comps,
2632fe7aee7SLeila Ghaffari       num_slip[3],  // Number of faces with slip BCs
2642b730f8bSJeremy L Thompson       num_inflow, num_outflow, num_freestream;
265f4ca79c2SJames Wright   PetscInt  walls[16], slips[3][16], inflows[16], outflows[16], freestreams[16];
26677841947SLeila Ghaffari   PetscBool user_bc;
26777841947SLeila Ghaffari };
26877841947SLeila Ghaffari 
26977841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
27077841947SLeila Ghaffari struct Physics_private {
27177841947SLeila Ghaffari   WindType              wind_type;
27277841947SLeila Ghaffari   BubbleType            bubble_type;
27377841947SLeila Ghaffari   BubbleContinuityType  bubble_continuity_type;
27477841947SLeila Ghaffari   EulerTestType         euler_test;
27577841947SLeila Ghaffari   StabilizationType     stab;
27677841947SLeila Ghaffari   PetscBool             implicit;
27797baf651SJames Wright   StateVariable         state_var;
27877841947SLeila Ghaffari   PetscBool             has_curr_time;
27977841947SLeila Ghaffari   PetscBool             has_neumann;
28011436a05SJames Wright   CeedContextFieldLabel solution_time_label;
281cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
28288626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
283841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
284e334ad8fSJed Brown   CeedContextFieldLabel ijacobian_time_shift_label;
28577841947SLeila Ghaffari };
28677841947SLeila Ghaffari 
28791e5af17SJed Brown typedef struct {
28891e5af17SJed Brown   CeedQFunctionUser    qfunction;
28991e5af17SJed Brown   const char          *qfunction_loc;
290841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
29191e5af17SJed Brown } ProblemQFunctionSpec;
29291e5af17SJed Brown 
29377841947SLeila Ghaffari // Problem specific data
294841e4c73SJed Brown typedef struct ProblemData_private ProblemData;
295841e4c73SJed Brown struct ProblemData_private {
296e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
2971864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
2982b730f8bSJeremy L Thompson   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
2992b730f8bSJeremy L Thompson       apply_freestream, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian;
30077841947SLeila Ghaffari   bool      non_zero_time;
3013722cd23SJames Wright   PetscBool bc_from_ics, use_strong_bc_ceed;
302367c849eSJames Wright   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
303841e4c73SJed Brown };
30477841947SLeila Ghaffari 
305841e4c73SJed Brown extern int FreeContextPetsc(void *);
306841e4c73SJed Brown 
30777841947SLeila Ghaffari // -----------------------------------------------------------------------------
30877841947SLeila Ghaffari // Set up problems
30977841947SLeila Ghaffari // -----------------------------------------------------------------------------
31077841947SLeila Ghaffari // Set up function for each problem
31114712a6bSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
312530ad8c4SKenneth E. Jansen extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31346de7363SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31446de7363SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31546de7363SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31646de7363SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31746de7363SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31846de7363SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31946de7363SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32046de7363SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32177841947SLeila Ghaffari 
32277841947SLeila Ghaffari // Print function for each problem
323367c849eSJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
32477841947SLeila Ghaffari 
325367c849eSJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
32677841947SLeila Ghaffari 
327367c849eSJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
328019b7682STimothy Aiken 
329367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
33077841947SLeila Ghaffari 
331367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
33277841947SLeila Ghaffari 
3332e31f396SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
3342e31f396SJames Wright 
33577841947SLeila Ghaffari // -----------------------------------------------------------------------------
33677841947SLeila Ghaffari // libCEED functions
33777841947SLeila Ghaffari // -----------------------------------------------------------------------------
33877841947SLeila Ghaffari // Utility function to create local CEED restriction
339431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
340431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
34177841947SLeila Ghaffari 
342*bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
343*bb85d312SJames Wright                                                CeedElemRestriction *restriction);
344*bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
345*bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
346*bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
347*bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
348*bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
349*bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
35077841947SLeila Ghaffari 
3510814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3520814d5a7SKenneth E. Jansen 
35377841947SLeila Ghaffari // Utility function to create CEED Composite Operator for the entire domain
3542b730f8bSJeremy L Thompson PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
3552b730f8bSJeremy L Thompson                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
3562b730f8bSJeremy L Thompson                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
35777841947SLeila Ghaffari 
3582b730f8bSJeremy L Thompson PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
35977841947SLeila Ghaffari 
36077841947SLeila Ghaffari // -----------------------------------------------------------------------------
36177841947SLeila Ghaffari // Time-stepping functions
36277841947SLeila Ghaffari // -----------------------------------------------------------------------------
36377841947SLeila Ghaffari // Compute mass matrix for explicit scheme
3642b730f8bSJeremy L Thompson PetscErrorCode ComputeLumpedMassMatrix(Ceed ceed, DM dm, CeedData ceed_data, Vec M);
36577841947SLeila Ghaffari 
36677841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
36777841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
36877841947SLeila Ghaffari 
36977841947SLeila Ghaffari // Implicit time-stepper function setup
3702b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
37177841947SLeila Ghaffari 
37277841947SLeila Ghaffari // User provided TS Monitor
3732b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
37477841947SLeila Ghaffari 
37577841947SLeila Ghaffari // TS: Create, setup, and solve
3762b730f8bSJeremy L Thompson PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
37777841947SLeila Ghaffari 
378a0b9a424SJames Wright // Update Boundary Values when time has changed
379a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
380a0b9a424SJames Wright 
38177841947SLeila Ghaffari // -----------------------------------------------------------------------------
38277841947SLeila Ghaffari // Setup DM
38377841947SLeila Ghaffari // -----------------------------------------------------------------------------
3841864f1c2SLeila Ghaffari // Create mesh
3852b730f8bSJeremy L Thompson PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
38677841947SLeila Ghaffari 
38777841947SLeila Ghaffari // Set up DM
3880814d5a7SKenneth E. Jansen PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
389d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
390d68a66c4SJames Wright                                        CeedInt num_fields, const CeedInt *field_sizes, DM dm);
391d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
392d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
393d68a66c4SJames Wright                                   CeedInt num_fields, const CeedInt *field_sizes, DM dm);
39477841947SLeila Ghaffari 
39577841947SLeila Ghaffari // Refine DM for high-order viz
3962b730f8bSJeremy L Thompson PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
39777841947SLeila Ghaffari 
39877841947SLeila Ghaffari // -----------------------------------------------------------------------------
39977841947SLeila Ghaffari // Process command line options
40077841947SLeila Ghaffari // -----------------------------------------------------------------------------
40177841947SLeila Ghaffari // Register problems to be available on the command line
40277841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
40377841947SLeila Ghaffari 
40477841947SLeila Ghaffari // Process general command line options
4052b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
40677841947SLeila Ghaffari 
40777841947SLeila Ghaffari // -----------------------------------------------------------------------------
40877841947SLeila Ghaffari // Miscellaneous utility functions
40977841947SLeila Ghaffari // -----------------------------------------------------------------------------
4102b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
41177841947SLeila Ghaffari 
4123c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4132b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
41477841947SLeila Ghaffari 
41577841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4163c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
41777841947SLeila Ghaffari 
41877841947SLeila Ghaffari // Get error for problems with exact solutions
4193c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
42077841947SLeila Ghaffari 
42177841947SLeila Ghaffari // Post-processing
4223c9e7ad1SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
42377841947SLeila Ghaffari 
42477841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
42577841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
42677841947SLeila Ghaffari 
42777841947SLeila Ghaffari // Record boundary values from initial condition
4283c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
42977841947SLeila Ghaffari 
4304de8550aSJed Brown // Versioning token for binary checkpoints
4310de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4320de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4330de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4344de8550aSJed Brown 
435ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
436ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
437ef080ff9SJames Wright 
438999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
439999ff5c7SJames Wright 
440cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4418b892a05SJames Wright                                  FILE **fp);
4428b892a05SJames Wright 
443cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4448b892a05SJames Wright 
445cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4464cc9442bSJames Wright 
447457e73b2SJames Wright PetscErrorCode IntArrayC2P(PetscInt num_entries, CeedInt **array_ceed, PetscInt **array_petsc);
448457e73b2SJames Wright PetscErrorCode IntArrayP2C(PetscInt num_entries, PetscInt **array_petsc, CeedInt **array_ceed);
449457e73b2SJames Wright 
4508b892a05SJames Wright // -----------------------------------------------------------------------------
4518b892a05SJames Wright // Turbulence Statistics Collection Functions
4528b892a05SJames Wright // -----------------------------------------------------------------------------
4538b892a05SJames Wright 
454f5452247SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
455f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
456f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
457fd170fd0SJames Wright 
45877841947SLeila Ghaffari // -----------------------------------------------------------------------------
4594cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4604cc9442bSJames Wright // -----------------------------------------------------------------------------
4614cc9442bSJames Wright 
462cbef7084SJames Wright PetscErrorCode SgsDDModelSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
463cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
464cbef7084SJames Wright PetscErrorCode SgsDDModelApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
4653909d146SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
466f84dcd56SJames Wright PetscErrorCode VelocityGradientProjectionApply(User user, Vec Q_loc, Vec VelocityGradient);
467052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
468052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
469900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
470900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4714cc9442bSJames Wright 
4724cc9442bSJames Wright // -----------------------------------------------------------------------------
473dada6cc0SJames Wright // Boundary Condition Related Functions
474dada6cc0SJames Wright // -----------------------------------------------------------------------------
475dada6cc0SJames Wright 
476dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
47766170c20SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
478b7c563b6SJeremy L Thompson 
479d310b3d3SAdeleke O. Bankole PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4808a94a473SJed Brown PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4812b730f8bSJeremy L Thompson 
4824e9802d1SJames Wright // -----------------------------------------------------------------------------
4834e9802d1SJames Wright // Differential Filtering Functions
4844e9802d1SJames Wright // -----------------------------------------------------------------------------
4854e9802d1SJames Wright 
4864e9802d1SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
4874e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
4884e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4894e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
490cbef7084SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
4914e9802d1SJames Wright 
492b7c563b6SJeremy L Thompson #endif  // libceed_fluids_examples_navier_stokes_h
493