xref: /libCEED/examples/fluids/navierstokes.h (revision 49a40c8a2d720db341b0b117b89656b473cbebfb)
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 
23*49a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0)
24*49a40c8aSKenneth E. Jansen #define DMSetCoordinateDisc(a, b, c) DMProjectCoordinates(a, b)
25*49a40c8aSKenneth E. Jansen #endif
26*49a40c8aSKenneth E. Jansen 
27a424bcd0SJames Wright #define PetscCeedChk(ceed, ierr)                                    \
28a424bcd0SJames Wright   do {                                                              \
29a424bcd0SJames Wright     if (ierr != CEED_ERROR_SUCCESS) {                               \
30a424bcd0SJames Wright       const char *error_message;                                    \
31a424bcd0SJames Wright       CeedGetErrorMessage(ceed, &error_message);                    \
32a424bcd0SJames Wright       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_LIB, "%s", error_message); \
33a424bcd0SJames Wright     }                                                               \
34a424bcd0SJames Wright   } while (0)
35a424bcd0SJames Wright 
36a424bcd0SJames Wright #define PetscCallCeed(ceed, ...) \
37a424bcd0SJames Wright   do {                           \
38a424bcd0SJames Wright     int ierr_q_ = __VA_ARGS__;   \
39a424bcd0SJames Wright     PetscCeedChk(ceed, ierr_q_); \
40a424bcd0SJames Wright   } while (0)
41a424bcd0SJames Wright 
4277841947SLeila Ghaffari // -----------------------------------------------------------------------------
4377841947SLeila Ghaffari // Enums
4477841947SLeila Ghaffari // -----------------------------------------------------------------------------
4577841947SLeila Ghaffari // Translate PetscMemType to CeedMemType
462b730f8bSJeremy L Thompson static inline CeedMemType MemTypeP2C(PetscMemType mem_type) { return PetscMemTypeDevice(mem_type) ? CEED_MEM_DEVICE : CEED_MEM_HOST; }
4777841947SLeila Ghaffari 
4877841947SLeila Ghaffari // Advection - Wind Options
4977841947SLeila Ghaffari typedef enum {
5077841947SLeila Ghaffari   WIND_ROTATION    = 0,
5177841947SLeila Ghaffari   WIND_TRANSLATION = 1,
5277841947SLeila Ghaffari } WindType;
532b730f8bSJeremy L Thompson static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
5477841947SLeila Ghaffari 
5577841947SLeila Ghaffari // Advection - Bubble Types
5677841947SLeila Ghaffari typedef enum {
5777841947SLeila Ghaffari   BUBBLE_SPHERE   = 0,  // dim=3
5877841947SLeila Ghaffari   BUBBLE_CYLINDER = 1,  // dim=2
5977841947SLeila Ghaffari } BubbleType;
602b730f8bSJeremy L Thompson static const char *const BubbleTypes[] = {"sphere", "cylinder", "BubbleType", "BUBBLE_", NULL};
6177841947SLeila Ghaffari 
6277841947SLeila Ghaffari // Advection - Bubble Continuity Types
6377841947SLeila Ghaffari typedef enum {
6477841947SLeila Ghaffari   BUBBLE_CONTINUITY_SMOOTH     = 0,  // Original continuous, smooth shape
6577841947SLeila Ghaffari   BUBBLE_CONTINUITY_BACK_SHARP = 1,  // Discontinuous, sharp back half shape
6677841947SLeila Ghaffari   BUBBLE_CONTINUITY_THICK      = 2,  // Define a finite thickness
6777841947SLeila Ghaffari } BubbleContinuityType;
682b730f8bSJeremy L Thompson static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
6977841947SLeila Ghaffari 
7077841947SLeila Ghaffari // Euler - test cases
7177841947SLeila Ghaffari typedef enum {
72bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
7377841947SLeila Ghaffari   EULER_TEST_1                 = 1,
7477841947SLeila Ghaffari   EULER_TEST_2                 = 2,
7577841947SLeila Ghaffari   EULER_TEST_3                 = 3,
7677841947SLeila Ghaffari   EULER_TEST_4                 = 4,
7732f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
7877841947SLeila Ghaffari } EulerTestType;
792b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
802b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
8177841947SLeila Ghaffari 
8277841947SLeila Ghaffari // Stabilization methods
832b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
8477841947SLeila Ghaffari 
8551b00d91SJames Wright // Test mode type
868fb33541SJames Wright typedef enum {
878fb33541SJames Wright   TESTTYPE_NONE           = 0,
888fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
898fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
90970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
918fb33541SJames Wright } TestType;
92970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
938fb33541SJames Wright 
942526956eSJames Wright // Subgrid-Stress mode type
9519ffbc25SJames Wright typedef enum {
9619ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
9719ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
9819ffbc25SJames Wright } SGSModelType;
9919ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
10019ffbc25SJames Wright 
1012526956eSJames Wright // Mesh transformation type
1022526956eSJames Wright typedef enum {
1032526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
1042526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
1052526956eSJames Wright } MeshTransformType;
1062526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
1072526956eSJames Wright 
108bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
109bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
110bd882c8aSJames Wright 
11177841947SLeila Ghaffari // -----------------------------------------------------------------------------
11275d1798cSJames Wright // Log Events
11375d1798cSJames Wright // -----------------------------------------------------------------------------
11475d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorApply;
11575d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
11675d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
11775d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
11875d1798cSJames Wright PetscErrorCode       RegisterLogEvents();
11975d1798cSJames Wright 
12075d1798cSJames Wright // -----------------------------------------------------------------------------
12177841947SLeila Ghaffari // Structs
12277841947SLeila Ghaffari // -----------------------------------------------------------------------------
12377841947SLeila Ghaffari // Structs declarations
12477841947SLeila Ghaffari typedef struct AppCtx_private   *AppCtx;
12577841947SLeila Ghaffari typedef struct CeedData_private *CeedData;
12677841947SLeila Ghaffari typedef struct User_private     *User;
12777841947SLeila Ghaffari typedef struct Units_private    *Units;
12877841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC;
12977841947SLeila Ghaffari typedef struct Physics_private  *Physics;
13077841947SLeila Ghaffari 
13177841947SLeila Ghaffari // Application context from user command line options
13277841947SLeila Ghaffari struct AppCtx_private {
13377841947SLeila Ghaffari   // libCEED arguments
13477841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
13577841947SLeila Ghaffari   PetscInt degree;
13677841947SLeila Ghaffari   PetscInt q_extra;
137544be873SJed Brown   // Solver arguments
138544be873SJed Brown   MatType   amat_type;
139544be873SJed Brown   PetscBool pmat_pbdiagonal;
14077841947SLeila Ghaffari   // Post-processing arguments
14137cbb16aSJed Brown   PetscInt  checkpoint_interval;
14277841947SLeila Ghaffari   PetscInt  viz_refine;
14377841947SLeila Ghaffari   PetscInt  cont_steps;
1444de8550aSJed Brown   PetscReal cont_time;
14569293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
14669293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
14777841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
14869293791SJames Wright   PetscBool add_stepnum2bin;
14937cbb16aSJed Brown   PetscBool checkpoint_vtk;
15077841947SLeila Ghaffari   // Problem type arguments
15177841947SLeila Ghaffari   PetscFunctionList problems;
15277841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
15377841947SLeila Ghaffari   // Test mode arguments
1548fb33541SJames Wright   TestType    test_type;
15577841947SLeila Ghaffari   PetscScalar test_tol;
156b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
157b7d66439SJames Wright   // Turbulent spanwise statistics
158b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
159b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
160b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
161b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
162b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
163ca69d878SAdeleke O. Bankole   // Wall forces
164ca69d878SAdeleke O. Bankole   struct {
165ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
166ca69d878SAdeleke O. Bankole     PetscInt         *walls;
167ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
168ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
169ca69d878SAdeleke O. Bankole     PetscBool         header_written;
170ca69d878SAdeleke O. Bankole   } wall_forces;
17119ffbc25SJames Wright   // Subgrid Stress Model
17219ffbc25SJames Wright   SGSModelType sgs_model_type;
1734e9802d1SJames Wright   // Differential Filtering
1744e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1752526956eSJames Wright   MeshTransformType mesh_transform_type;
17677841947SLeila Ghaffari };
17777841947SLeila Ghaffari 
17877841947SLeila Ghaffari // libCEED data struct
17977841947SLeila Ghaffari struct CeedData_private {
18077841947SLeila Ghaffari   CeedVector           x_coord, q_data;
1812b730f8bSJeremy L Thompson   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
18277841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1835263e9c6SJames Wright   CeedOperator         op_setup_vol;
1845263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
185d310b3d3SAdeleke 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,
186d310b3d3SAdeleke O. Bankole       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian;
18777841947SLeila Ghaffari };
18877841947SLeila Ghaffari 
18951ee423eSJames Wright typedef struct {
19051ee423eSJames Wright   DM                    dm;
1911737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
192ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
19351ee423eSJames Wright   PetscInt              num_comp_stats;
194ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
195a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
196a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
197b7d66439SJames Wright   PetscBool             do_mms_test;
1984021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
199495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
200cbef7084SJames Wright } SpanStatsData;
20151ee423eSJames Wright 
202999ff5c7SJames Wright typedef struct {
203999ff5c7SJames Wright   DM                   dm;
204999ff5c7SJames Wright   PetscInt             num_comp;
205999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
206999ff5c7SJames Wright   KSP                  ksp;
207999ff5c7SJames Wright } *NodalProjectionData;
208999ff5c7SJames Wright 
2099a17443dSJames Wright typedef struct {
2109a17443dSJames Wright   DM                   dm_sgs;
2119a17443dSJames Wright   PetscInt             num_comp_sgs;
212be34b3b7SJames Wright   OperatorApplyContext op_nodal_evaluation_ctx, op_sgs_apply_ctx;
2139a17443dSJames Wright   CeedVector           sgs_nodal_ceed;
214cbef7084SJames Wright } *SgsDDData;
2159a17443dSJames Wright 
2164e9802d1SJames Wright typedef struct {
2174e9802d1SJames Wright   DM                   dm_filter;
21881530087SJames Wright   PetscInt             num_filtered_fields;
21981530087SJames Wright   CeedInt             *num_field_components;
2204e9802d1SJames Wright   OperatorApplyContext op_rhs_ctx;
2214e9802d1SJames Wright   KSP                  ksp;
2222029a677SJames Wright   PetscBool            do_mms_test;
2234e9802d1SJames Wright } *DiffFilterData;
2244e9802d1SJames Wright 
22577841947SLeila Ghaffari // PETSc user data
22677841947SLeila Ghaffari struct User_private {
22777841947SLeila Ghaffari   MPI_Comm             comm;
22877841947SLeila Ghaffari   DM                   dm;
22977841947SLeila Ghaffari   DM                   dm_viz;
23077841947SLeila Ghaffari   Mat                  interp_viz;
23177841947SLeila Ghaffari   Ceed                 ceed;
23277841947SLeila Ghaffari   Units                units;
233186595e6SJames Wright   Vec                  M_inv, Q_loc, Q_dot_loc;
23477841947SLeila Ghaffari   Physics              phys;
23577841947SLeila Ghaffari   AppCtx               app_ctx;
2362b730f8bSJeremy L Thompson   CeedVector           q_ceed, q_dot_ceed, g_ceed, coo_values_amat, coo_values_pmat, x_ceed;
2379ad5e8e4SJames Wright   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction, op_ijacobian;
2389ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
239e334ad8fSJed Brown   bool                 matrices_set_up;
24015637395SJames Wright   CeedScalar           time_bc_set;
241cbef7084SJames Wright   SpanStatsData        spanstats;
242999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
243cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2444e9802d1SJames Wright   DiffFilterData       diff_filter;
24577841947SLeila Ghaffari };
24677841947SLeila Ghaffari 
24777841947SLeila Ghaffari // Units
24877841947SLeila Ghaffari struct Units_private {
24977841947SLeila Ghaffari   // fundamental units
25077841947SLeila Ghaffari   PetscScalar meter;
25177841947SLeila Ghaffari   PetscScalar kilogram;
25277841947SLeila Ghaffari   PetscScalar second;
25377841947SLeila Ghaffari   PetscScalar Kelvin;
25477841947SLeila Ghaffari   // derived units
25577841947SLeila Ghaffari   PetscScalar Pascal;
25677841947SLeila Ghaffari   PetscScalar J_per_kg_K;
25777841947SLeila Ghaffari   PetscScalar m_per_squared_s;
25877841947SLeila Ghaffari   PetscScalar W_per_m_K;
25977841947SLeila Ghaffari   PetscScalar Joule;
26077841947SLeila Ghaffari };
26177841947SLeila Ghaffari 
26277841947SLeila Ghaffari // Boundary conditions
26377841947SLeila Ghaffari struct SimpleBC_private {
2642fe7aee7SLeila Ghaffari   PetscInt num_wall,  // Number of faces with wall BCs
2652fe7aee7SLeila Ghaffari       wall_comps[5],  // An array of constrained component numbers
2662fe7aee7SLeila Ghaffari       num_comps,
2672fe7aee7SLeila Ghaffari       num_slip[3],  // Number of faces with slip BCs
2682b730f8bSJeremy L Thompson       num_inflow, num_outflow, num_freestream;
269f4ca79c2SJames Wright   PetscInt  walls[16], slips[3][16], inflows[16], outflows[16], freestreams[16];
27077841947SLeila Ghaffari   PetscBool user_bc;
27177841947SLeila Ghaffari };
27277841947SLeila Ghaffari 
27377841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
27477841947SLeila Ghaffari struct Physics_private {
27577841947SLeila Ghaffari   WindType              wind_type;
27677841947SLeila Ghaffari   BubbleType            bubble_type;
27777841947SLeila Ghaffari   BubbleContinuityType  bubble_continuity_type;
27877841947SLeila Ghaffari   EulerTestType         euler_test;
27977841947SLeila Ghaffari   StabilizationType     stab;
28077841947SLeila Ghaffari   PetscBool             implicit;
28197baf651SJames Wright   StateVariable         state_var;
28277841947SLeila Ghaffari   PetscBool             has_curr_time;
28377841947SLeila Ghaffari   PetscBool             has_neumann;
28411436a05SJames Wright   CeedContextFieldLabel solution_time_label;
285cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
28688626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
287841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
288e334ad8fSJed Brown   CeedContextFieldLabel ijacobian_time_shift_label;
28977841947SLeila Ghaffari };
29077841947SLeila Ghaffari 
29191e5af17SJed Brown typedef struct {
29291e5af17SJed Brown   CeedQFunctionUser    qfunction;
29391e5af17SJed Brown   const char          *qfunction_loc;
294841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
29591e5af17SJed Brown } ProblemQFunctionSpec;
29691e5af17SJed Brown 
29777841947SLeila Ghaffari // Problem specific data
298841e4c73SJed Brown typedef struct ProblemData_private ProblemData;
299841e4c73SJed Brown struct ProblemData_private {
300e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
3011864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
3022b730f8bSJeremy L Thompson   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
3032b730f8bSJeremy L Thompson       apply_freestream, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian;
30477841947SLeila Ghaffari   bool      non_zero_time;
3053722cd23SJames Wright   PetscBool bc_from_ics, use_strong_bc_ceed;
306367c849eSJames Wright   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
307841e4c73SJed Brown };
30877841947SLeila Ghaffari 
309841e4c73SJed Brown extern int FreeContextPetsc(void *);
310841e4c73SJed Brown 
31177841947SLeila Ghaffari // -----------------------------------------------------------------------------
31277841947SLeila Ghaffari // Set up problems
31377841947SLeila Ghaffari // -----------------------------------------------------------------------------
31477841947SLeila Ghaffari // Set up function for each problem
31514712a6bSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
316530ad8c4SKenneth E. Jansen extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31746de7363SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31846de7363SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31946de7363SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32046de7363SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32146de7363SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32246de7363SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32346de7363SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32446de7363SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
32577841947SLeila Ghaffari 
32677841947SLeila Ghaffari // Print function for each problem
327367c849eSJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
32877841947SLeila Ghaffari 
329367c849eSJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
33077841947SLeila Ghaffari 
331367c849eSJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
332019b7682STimothy Aiken 
333367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
33477841947SLeila Ghaffari 
335367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
33677841947SLeila Ghaffari 
3372e31f396SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
3382e31f396SJames Wright 
33977841947SLeila Ghaffari // -----------------------------------------------------------------------------
34077841947SLeila Ghaffari // libCEED functions
34177841947SLeila Ghaffari // -----------------------------------------------------------------------------
34277841947SLeila Ghaffari // Utility function to create local CEED restriction
343431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
344431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
34577841947SLeila Ghaffari 
346bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
347bb85d312SJames Wright                                                CeedElemRestriction *restriction);
348bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
349bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
350bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
351bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
352bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
353bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
35477841947SLeila Ghaffari 
3550814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3560814d5a7SKenneth E. Jansen 
35777841947SLeila Ghaffari // Utility function to create CEED Composite Operator for the entire domain
3582b730f8bSJeremy L Thompson PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
3592b730f8bSJeremy L Thompson                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
3602b730f8bSJeremy L Thompson                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
36177841947SLeila Ghaffari 
3622b730f8bSJeremy L Thompson PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
36377841947SLeila Ghaffari 
36477841947SLeila Ghaffari // -----------------------------------------------------------------------------
36577841947SLeila Ghaffari // Time-stepping functions
36677841947SLeila Ghaffari // -----------------------------------------------------------------------------
36777841947SLeila Ghaffari // Compute mass matrix for explicit scheme
3682b730f8bSJeremy L Thompson PetscErrorCode ComputeLumpedMassMatrix(Ceed ceed, DM dm, CeedData ceed_data, Vec M);
36977841947SLeila Ghaffari 
37077841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
37177841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
37277841947SLeila Ghaffari 
37377841947SLeila Ghaffari // Implicit time-stepper function setup
3742b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
37577841947SLeila Ghaffari 
37677841947SLeila Ghaffari // User provided TS Monitor
3772b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
37877841947SLeila Ghaffari 
37977841947SLeila Ghaffari // TS: Create, setup, and solve
3802b730f8bSJeremy L Thompson PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
38177841947SLeila Ghaffari 
382a0b9a424SJames Wright // Update Boundary Values when time has changed
383a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
384a0b9a424SJames Wright 
38577841947SLeila Ghaffari // -----------------------------------------------------------------------------
38677841947SLeila Ghaffari // Setup DM
38777841947SLeila Ghaffari // -----------------------------------------------------------------------------
3881864f1c2SLeila Ghaffari // Create mesh
3892b730f8bSJeremy L Thompson PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
39077841947SLeila Ghaffari 
39177841947SLeila Ghaffari // Set up DM
3920814d5a7SKenneth E. Jansen PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
393d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
39485df0564SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
395d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
396d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
39785df0564SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
39877841947SLeila Ghaffari 
39977841947SLeila Ghaffari // Refine DM for high-order viz
4002b730f8bSJeremy L Thompson PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
40177841947SLeila Ghaffari 
40277841947SLeila Ghaffari // -----------------------------------------------------------------------------
40377841947SLeila Ghaffari // Process command line options
40477841947SLeila Ghaffari // -----------------------------------------------------------------------------
40577841947SLeila Ghaffari // Register problems to be available on the command line
40677841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
40777841947SLeila Ghaffari 
40877841947SLeila Ghaffari // Process general command line options
4092b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
41077841947SLeila Ghaffari 
41177841947SLeila Ghaffari // -----------------------------------------------------------------------------
41277841947SLeila Ghaffari // Miscellaneous utility functions
41377841947SLeila Ghaffari // -----------------------------------------------------------------------------
4142b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
41577841947SLeila Ghaffari 
4163c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4172b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
41877841947SLeila Ghaffari 
41977841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4203c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
42177841947SLeila Ghaffari 
42277841947SLeila Ghaffari // Get error for problems with exact solutions
4233c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
42477841947SLeila Ghaffari 
42577841947SLeila Ghaffari // Post-processing
4263c9e7ad1SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
42777841947SLeila Ghaffari 
42877841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
42977841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
43077841947SLeila Ghaffari 
43177841947SLeila Ghaffari // Record boundary values from initial condition
4323c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
43377841947SLeila Ghaffari 
4344de8550aSJed Brown // Versioning token for binary checkpoints
4350de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4360de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4370de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4384de8550aSJed Brown 
439ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
440ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
441ef080ff9SJames Wright 
442999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
443999ff5c7SJames Wright 
444cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4458b892a05SJames Wright                                  FILE **fp);
4468b892a05SJames Wright 
447cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4488b892a05SJames Wright 
449cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4504cc9442bSJames Wright 
451457e73b2SJames Wright PetscErrorCode IntArrayC2P(PetscInt num_entries, CeedInt **array_ceed, PetscInt **array_petsc);
452457e73b2SJames Wright PetscErrorCode IntArrayP2C(PetscInt num_entries, PetscInt **array_petsc, CeedInt **array_ceed);
453457e73b2SJames Wright 
4548b892a05SJames Wright // -----------------------------------------------------------------------------
4558b892a05SJames Wright // Turbulence Statistics Collection Functions
4568b892a05SJames Wright // -----------------------------------------------------------------------------
4578b892a05SJames Wright 
458f5452247SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
459f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
460f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
461fd170fd0SJames Wright 
46277841947SLeila Ghaffari // -----------------------------------------------------------------------------
4634cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4644cc9442bSJames Wright // -----------------------------------------------------------------------------
4654cc9442bSJames Wright 
466cbef7084SJames Wright PetscErrorCode SgsDDModelSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
467cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
468cbef7084SJames Wright PetscErrorCode SgsDDModelApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
4693909d146SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
470f84dcd56SJames Wright PetscErrorCode VelocityGradientProjectionApply(User user, Vec Q_loc, Vec VelocityGradient);
471052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
472052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
473900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
474900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4754cc9442bSJames Wright 
4764cc9442bSJames Wright // -----------------------------------------------------------------------------
477dada6cc0SJames Wright // Boundary Condition Related Functions
478dada6cc0SJames Wright // -----------------------------------------------------------------------------
479dada6cc0SJames Wright 
480dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
48166170c20SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
482b7c563b6SJeremy L Thompson 
483d310b3d3SAdeleke O. Bankole PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4848a94a473SJed Brown PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4852b730f8bSJeremy L Thompson 
4864e9802d1SJames Wright // -----------------------------------------------------------------------------
4874e9802d1SJames Wright // Differential Filtering Functions
4884e9802d1SJames Wright // -----------------------------------------------------------------------------
4894e9802d1SJames Wright 
4904e9802d1SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
4914e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
4924e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4934e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
494cbef7084SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
4954e9802d1SJames Wright 
496b7c563b6SJeremy L Thompson #endif  // libceed_fluids_examples_navier_stokes_h
497