xref: /libCEED/examples/fluids/navierstokes.h (revision b4e9a8f894a0481205b699a80d40c97cb033c4b2)
15aed82e4SJeremy L Thompson // Copyright (c) 2017-2024, 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
724a65d3dSJeremy L Thompson #pragma once
877841947SLeila Ghaffari 
9d0593705SJames Wright #include <ceed-utils.h>
1077841947SLeila Ghaffari #include <ceed.h>
1191c97f41SJames Wright #include <mat-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 
1949a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0)
20fd9d666bSJames Wright #error "PETSc v3.21 or later is required"
2149a40c8aSKenneth E. Jansen #endif
2249a40c8aSKenneth E. Jansen 
2377841947SLeila Ghaffari // -----------------------------------------------------------------------------
2477841947SLeila Ghaffari // Enums
2577841947SLeila Ghaffari // -----------------------------------------------------------------------------
2677841947SLeila Ghaffari 
2777841947SLeila Ghaffari // Euler - test cases
2877841947SLeila Ghaffari typedef enum {
29bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
3077841947SLeila Ghaffari   EULER_TEST_1                 = 1,
3177841947SLeila Ghaffari   EULER_TEST_2                 = 2,
3277841947SLeila Ghaffari   EULER_TEST_3                 = 3,
3377841947SLeila Ghaffari   EULER_TEST_4                 = 4,
3432f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
3577841947SLeila Ghaffari } EulerTestType;
362b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
372b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
3877841947SLeila Ghaffari 
39700ae941SJames Wright // Advection - Wind types
40700ae941SJames Wright static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
41700ae941SJames Wright 
427b77ddfdSJames Wright // Advection - Initial Condition Types
437b77ddfdSJames Wright static const char *const AdvectionICTypes[] = {"sphere", "cylinder", "cosine_hill", "skew", "AdvectionICType", "ADVECTIONIC_", NULL};
44700ae941SJames Wright 
45700ae941SJames Wright // Advection - Bubble Continuity Types
4693639ffbSJames Wright static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "cosine", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
47700ae941SJames Wright 
4877841947SLeila Ghaffari // Stabilization methods
492b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
5077841947SLeila Ghaffari 
51b18328c4SJames Wright // Stabilization tau constants
52b18328c4SJames Wright static const char *const StabilizationTauTypes[] = {"Ctau", "AdvDiff_Shakib", "AdvDiff_Shakib_P", "StabilizationTauType", "STAB_TAU_", NULL};
53b18328c4SJames Wright 
5451b00d91SJames Wright // Test mode type
558fb33541SJames Wright typedef enum {
568fb33541SJames Wright   TESTTYPE_NONE           = 0,
578fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
588fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
59970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
608fb33541SJames Wright } TestType;
61970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
628fb33541SJames Wright 
632526956eSJames Wright // Subgrid-Stress mode type
6419ffbc25SJames Wright typedef enum {
6519ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
6619ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
6719ffbc25SJames Wright } SGSModelType;
6819ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
6919ffbc25SJames Wright 
702526956eSJames Wright // Mesh transformation type
712526956eSJames Wright typedef enum {
722526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
732526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
742526956eSJames Wright } MeshTransformType;
752526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
762526956eSJames Wright 
77bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
78bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
79bd882c8aSJames Wright 
8077841947SLeila Ghaffari // -----------------------------------------------------------------------------
8175d1798cSJames Wright // Log Events
8275d1798cSJames Wright // -----------------------------------------------------------------------------
8375d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorApply;
8475d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemble;
8575d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssembleDiagonal;
8675d1798cSJames Wright extern PetscLogEvent FLUIDS_CeedOperatorAssemblePointBlockDiagonal;
87844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Init;
88844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Meta;
89844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_SmartRedis_Train;
90844b3d4aSRiccardo Balin extern PetscLogEvent FLUIDS_TrainDataCompute;
913737f832SJames Wright extern PetscLogEvent FLUIDS_DifferentialFilter;
923737f832SJames Wright extern PetscLogEvent FLUIDS_VelocityGradientProjection;
9375d1798cSJames Wright PetscErrorCode       RegisterLogEvents();
9475d1798cSJames Wright 
9575d1798cSJames Wright // -----------------------------------------------------------------------------
9677841947SLeila Ghaffari // Structs
9777841947SLeila Ghaffari // -----------------------------------------------------------------------------
9877841947SLeila Ghaffari // Structs declarations
9977841947SLeila Ghaffari typedef struct AppCtx_private   *AppCtx;
10077841947SLeila Ghaffari typedef struct CeedData_private *CeedData;
10177841947SLeila Ghaffari typedef struct User_private     *User;
10277841947SLeila Ghaffari typedef struct Units_private    *Units;
10377841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC;
10477841947SLeila Ghaffari typedef struct Physics_private  *Physics;
10577841947SLeila Ghaffari 
10677841947SLeila Ghaffari // Application context from user command line options
10777841947SLeila Ghaffari struct AppCtx_private {
10877841947SLeila Ghaffari   // libCEED arguments
10977841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
11077841947SLeila Ghaffari   PetscInt degree;
11177841947SLeila Ghaffari   PetscInt q_extra;
112544be873SJed Brown   // Solver arguments
113544be873SJed Brown   MatType amat_type;
11477841947SLeila Ghaffari   // Post-processing arguments
11537cbb16aSJed Brown   PetscInt  checkpoint_interval;
11677841947SLeila Ghaffari   PetscInt  viz_refine;
11777841947SLeila Ghaffari   PetscInt  cont_steps;
1184de8550aSJed Brown   PetscReal cont_time;
11969293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
12069293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
12177841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
12269293791SJames Wright   PetscBool add_stepnum2bin;
12337cbb16aSJed Brown   PetscBool checkpoint_vtk;
12477841947SLeila Ghaffari   // Problem type arguments
12577841947SLeila Ghaffari   PetscFunctionList problems;
12677841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
12777841947SLeila Ghaffari   // Test mode arguments
1288fb33541SJames Wright   TestType    test_type;
12977841947SLeila Ghaffari   PetscScalar test_tol;
130b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
131b7d66439SJames Wright   // Turbulent spanwise statistics
132b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
133b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
134b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
135b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
136b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
137ca69d878SAdeleke O. Bankole   // Wall forces
138ca69d878SAdeleke O. Bankole   struct {
139ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
140ca69d878SAdeleke O. Bankole     PetscInt         *walls;
141ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
142ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
143ca69d878SAdeleke O. Bankole     PetscBool         header_written;
144ca69d878SAdeleke O. Bankole   } wall_forces;
14519ffbc25SJames Wright   // Subgrid Stress Model
14619ffbc25SJames Wright   SGSModelType sgs_model_type;
14728134cfaSJames Wright   PetscBool    sgs_train_enable;
1484e9802d1SJames Wright   // Differential Filtering
1494e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1502526956eSJames Wright   MeshTransformType mesh_transform_type;
15177841947SLeila Ghaffari };
15277841947SLeila Ghaffari 
15377841947SLeila Ghaffari // libCEED data struct
15477841947SLeila Ghaffari struct CeedData_private {
15577841947SLeila Ghaffari   CeedVector           x_coord, q_data;
1562b730f8bSJeremy L Thompson   CeedBasis            basis_x, basis_xc, basis_q, basis_x_sur, basis_q_sur, basis_xc_sur;
15777841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1585263e9c6SJames Wright   CeedOperator         op_setup_vol;
1595263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
160d310b3d3SAdeleke 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,
1619f844368SJames Wright       qf_apply_outflow_jacobian, qf_apply_freestream, qf_apply_freestream_jacobian, qf_apply_slip, qf_apply_slip_jacobian;
16277841947SLeila Ghaffari };
16377841947SLeila Ghaffari 
16451ee423eSJames Wright typedef struct {
16551ee423eSJames Wright   DM                    dm;
1661737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
167ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
16851ee423eSJames Wright   PetscInt              num_comp_stats;
169ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
170a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
171a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
172b7d66439SJames Wright   PetscBool             do_mms_test;
1734021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
174495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
175cbef7084SJames Wright } SpanStatsData;
17651ee423eSJames Wright 
177999ff5c7SJames Wright typedef struct {
178999ff5c7SJames Wright   DM                   dm;
179999ff5c7SJames Wright   PetscInt             num_comp;
180999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
181999ff5c7SJames Wright   KSP                  ksp;
182999ff5c7SJames Wright } *NodalProjectionData;
183999ff5c7SJames Wright 
1846b3fb9aeSJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
1851250e899SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
1869a17443dSJames Wright typedef struct {
1871250e899SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
1885f5d6789SAlex Lindsay   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
1891250e899SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
1901250e899SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
1916b3fb9aeSJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
1921250e899SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
1931250e899SJames Wright   void                     *sgs_nodal_inference_ctx;
1941250e899SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
195cbef7084SJames Wright } *SgsDDData;
1969a17443dSJames Wright 
1974e9802d1SJames Wright typedef struct {
198ee3b213aSJames Wright   DM                   dm_dd_training;
199ee3b213aSJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval;
200ee3b213aSJames Wright   OperatorApplyContext op_training_data_calc_ctx;
201ee3b213aSJames Wright   NodalProjectionData  filtered_grad_velo_proj;
202ee3b213aSJames Wright   size_t               training_data_array_dims[2];
203ee3b213aSJames Wright   PetscBool            overwrite_training_data;
204ee3b213aSJames Wright } *SGS_DD_TrainingData;
205ee3b213aSJames Wright 
206ee3b213aSJames Wright typedef struct {
2074e9802d1SJames Wright   DM                   dm_filter;
20881530087SJames Wright   PetscInt             num_filtered_fields;
20981530087SJames Wright   CeedInt             *num_field_components;
210051427eeSJames Wright   PetscInt             field_prim_state, field_velo_prod;
2114e9802d1SJames Wright   OperatorApplyContext op_rhs_ctx;
2124e9802d1SJames Wright   KSP                  ksp;
2132029a677SJames Wright   PetscBool            do_mms_test;
2144e9802d1SJames Wright } *DiffFilterData;
2154e9802d1SJames Wright 
2168146534cSJames Wright typedef struct {
2178146534cSJames Wright   void    *client;
2188146534cSJames Wright   char     rank_id_name[16];
2198146534cSJames Wright   PetscInt collocated_database_num_ranks;
2208146534cSJames Wright } *SmartSimData;
2218146534cSJames Wright 
22277841947SLeila Ghaffari // PETSc user data
22377841947SLeila Ghaffari struct User_private {
22477841947SLeila Ghaffari   MPI_Comm             comm;
22577841947SLeila Ghaffari   DM                   dm;
22677841947SLeila Ghaffari   DM                   dm_viz;
22777841947SLeila Ghaffari   Mat                  interp_viz;
22877841947SLeila Ghaffari   Ceed                 ceed;
22977841947SLeila Ghaffari   Units                units;
23004292f7dSJames Wright   Vec                  Q_loc, Q_dot_loc;
23177841947SLeila Ghaffari   Physics              phys;
23277841947SLeila Ghaffari   AppCtx               app_ctx;
23391c97f41SJames Wright   CeedVector           q_ceed, q_dot_ceed, g_ceed, x_ceed;
23491c97f41SJames Wright   CeedOperator         op_rhs_vol, op_ifunction_vol, op_ifunction;
23591c97f41SJames Wright   Mat                  mat_ijacobian;
23604292f7dSJames Wright   KSP                  mass_ksp;
2379ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
23815637395SJames Wright   CeedScalar           time_bc_set;
239cbef7084SJames Wright   SpanStatsData        spanstats;
240999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
241cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2424e9802d1SJames Wright   DiffFilterData       diff_filter;
2438146534cSJames Wright   SmartSimData         smartsim;
244ee3b213aSJames Wright   SGS_DD_TrainingData  sgs_dd_train;
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,
2677c5bba50SJames Wright       num_symmetry[3],  // Number of faces with symmetry BCs
2689f844368SJames Wright       num_inflow, num_outflow, num_freestream, num_slip;
2699f844368SJames Wright   PetscInt walls[16], symmetries[3][16], inflows[16], outflows[16], freestreams[16], slips[16];
27077841947SLeila Ghaffari };
27177841947SLeila Ghaffari 
27277841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
27377841947SLeila Ghaffari struct Physics_private {
27477841947SLeila Ghaffari   PetscBool             implicit;
27597baf651SJames Wright   StateVariable         state_var;
27611436a05SJames Wright   CeedContextFieldLabel solution_time_label;
277cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
27888626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
279841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
280e334ad8fSJed Brown   CeedContextFieldLabel ijacobian_time_shift_label;
28177841947SLeila Ghaffari };
28277841947SLeila Ghaffari 
28391e5af17SJed Brown typedef struct {
28491e5af17SJed Brown   CeedQFunctionUser    qfunction;
28591e5af17SJed Brown   const char          *qfunction_loc;
286841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
28791e5af17SJed Brown } ProblemQFunctionSpec;
28891e5af17SJed Brown 
28977841947SLeila Ghaffari // Problem specific data
290841e4c73SJed Brown typedef struct ProblemData_private ProblemData;
291841e4c73SJed Brown struct ProblemData_private {
292e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
2931864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
2942b730f8bSJeremy L Thompson   ProblemQFunctionSpec setup_vol, setup_sur, ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow,
2959f844368SJames Wright       apply_freestream, apply_slip, apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian, apply_slip_jacobian;
29677841947SLeila Ghaffari   bool      non_zero_time;
297752a08a7SJames Wright   PetscBool bc_from_ics, use_strong_bc_ceed, uses_newtonian;
298367c849eSJames Wright   PetscErrorCode (*print_info)(User, ProblemData *, AppCtx);
299*b4e9a8f8SJames Wright   PetscErrorCode (*create_mass_operator)(User, CeedOperator *);
300841e4c73SJed Brown };
30177841947SLeila Ghaffari 
302841e4c73SJed Brown extern int FreeContextPetsc(void *);
303841e4c73SJed Brown 
30477841947SLeila Ghaffari // -----------------------------------------------------------------------------
30577841947SLeila Ghaffari // Set up problems
30677841947SLeila Ghaffari // -----------------------------------------------------------------------------
30777841947SLeila Ghaffari // Set up function for each problem
30814712a6bSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
309530ad8c4SKenneth E. Jansen extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31046de7363SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31146de7363SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31246de7363SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31346de7363SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31446de7363SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31546de7363SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31646de7363SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31746de7363SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData *problem, DM dm, void *ctx, SimpleBC bc);
31877841947SLeila Ghaffari 
31977841947SLeila Ghaffari // Print function for each problem
320367c849eSJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData *problem, AppCtx app_ctx);
32177841947SLeila Ghaffari 
322367c849eSJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData *problem, AppCtx app_ctx);
32377841947SLeila Ghaffari 
324367c849eSJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData *problem, AppCtx app_ctx);
325019b7682STimothy Aiken 
326367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData *problem, AppCtx app_ctx);
32777841947SLeila Ghaffari 
328367c849eSJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData *problem, AppCtx app_ctx);
32977841947SLeila Ghaffari 
3302e31f396SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData *problem, MPI_Comm comm);
3312e31f396SJames Wright 
33277841947SLeila Ghaffari // -----------------------------------------------------------------------------
33377841947SLeila Ghaffari // libCEED functions
33477841947SLeila Ghaffari // -----------------------------------------------------------------------------
33577841947SLeila Ghaffari // Utility function to create local CEED restriction
336431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
337431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
33877841947SLeila Ghaffari 
339bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
340bb85d312SJames Wright                                                CeedElemRestriction *restriction);
341bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
342bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
343bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
344bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
345bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
346bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
34777841947SLeila Ghaffari 
3480814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3490814d5a7SKenneth E. Jansen 
35077841947SLeila Ghaffari // Utility function to create CEED Composite Operator for the entire domain
3512b730f8bSJeremy L Thompson PetscErrorCode CreateOperatorForDomain(Ceed ceed, DM dm, SimpleBC bc, CeedData ceed_data, Physics phys, CeedOperator op_apply_vol,
3522b730f8bSJeremy L Thompson                                        CeedOperator op_apply_ijacobian_vol, CeedInt height, CeedInt P_sur, CeedInt Q_sur, CeedInt q_data_size_sur,
3532b730f8bSJeremy L Thompson                                        CeedInt jac_data_size_sur, CeedOperator *op_apply, CeedOperator *op_apply_ijacobian);
35477841947SLeila Ghaffari 
3552b730f8bSJeremy L Thompson PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData *problem, SimpleBC bc);
35677841947SLeila Ghaffari 
35777841947SLeila Ghaffari // -----------------------------------------------------------------------------
35877841947SLeila Ghaffari // Time-stepping functions
35977841947SLeila Ghaffari // -----------------------------------------------------------------------------
36077841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
36177841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
36277841947SLeila Ghaffari 
36377841947SLeila Ghaffari // Implicit time-stepper function setup
3642b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
36577841947SLeila Ghaffari 
36677841947SLeila Ghaffari // User provided TS Monitor
3672b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
36877841947SLeila Ghaffari 
36977841947SLeila Ghaffari // TS: Create, setup, and solve
3702b730f8bSJeremy L Thompson PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, Vec *Q, PetscScalar *f_time, TS *ts);
37177841947SLeila Ghaffari 
372a0b9a424SJames Wright // Update Boundary Values when time has changed
373a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
374a0b9a424SJames Wright 
37577841947SLeila Ghaffari // -----------------------------------------------------------------------------
37677841947SLeila Ghaffari // Setup DM
37777841947SLeila Ghaffari // -----------------------------------------------------------------------------
3781864f1c2SLeila Ghaffari // Create mesh
3792b730f8bSJeremy L Thompson PetscErrorCode CreateDM(MPI_Comm comm, ProblemData *problem, MatType, VecType, DM *dm);
38077841947SLeila Ghaffari 
38177841947SLeila Ghaffari // Set up DM
3820814d5a7SKenneth E. Jansen PetscErrorCode SetUpDM(DM dm, ProblemData *problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
383d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
38485df0564SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
385d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
386d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
38785df0564SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
38877841947SLeila Ghaffari 
38977841947SLeila Ghaffari // Refine DM for high-order viz
3902b730f8bSJeremy L Thompson PetscErrorCode VizRefineDM(DM dm, User user, ProblemData *problem, SimpleBC bc, Physics phys);
39177841947SLeila Ghaffari 
39277841947SLeila Ghaffari // -----------------------------------------------------------------------------
39377841947SLeila Ghaffari // Process command line options
39477841947SLeila Ghaffari // -----------------------------------------------------------------------------
39577841947SLeila Ghaffari // Register problems to be available on the command line
39677841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
39777841947SLeila Ghaffari 
39877841947SLeila Ghaffari // Process general command line options
3992b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
40077841947SLeila Ghaffari 
40177841947SLeila Ghaffari // -----------------------------------------------------------------------------
40277841947SLeila Ghaffari // Miscellaneous utility functions
40377841947SLeila Ghaffari // -----------------------------------------------------------------------------
4043a10b0eeSJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
4053a10b0eeSJames Wright                                       PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity,
4063a10b0eeSJames Wright                                       CeedVector *inv_multiplicity);
4072b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
40877841947SLeila Ghaffari 
4093c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4102b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
41177841947SLeila Ghaffari 
41277841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4133c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
41477841947SLeila Ghaffari 
41577841947SLeila Ghaffari // Get error for problems with exact solutions
4163c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
41777841947SLeila Ghaffari 
41877841947SLeila Ghaffari // Post-processing
4193c9e7ad1SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData *problem, User user, Vec Q, PetscScalar final_time);
42077841947SLeila Ghaffari 
42177841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
42277841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
42377841947SLeila Ghaffari 
42477841947SLeila Ghaffari // Record boundary values from initial condition
4253c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
42677841947SLeila Ghaffari 
4274de8550aSJed Brown // Versioning token for binary checkpoints
4280de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4290de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4300de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4314de8550aSJed Brown 
432ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
433ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
434ef080ff9SJames Wright 
435999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
436999ff5c7SJames Wright 
437cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4388b892a05SJames Wright                                  FILE **fp);
4398b892a05SJames Wright 
440cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4418b892a05SJames Wright 
442cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4434cc9442bSJames Wright 
4448b892a05SJames Wright // -----------------------------------------------------------------------------
4458b892a05SJames Wright // Turbulence Statistics Collection Functions
4468b892a05SJames Wright // -----------------------------------------------------------------------------
4478b892a05SJames Wright 
448f5452247SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
449f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
450f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
451fd170fd0SJames Wright 
45277841947SLeila Ghaffari // -----------------------------------------------------------------------------
4534cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4544cc9442bSJames Wright // -----------------------------------------------------------------------------
4554cc9442bSJames Wright 
4568f5ab23bSJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
457cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
4588f5ab23bSJames Wright PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
4597618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem, StateVariable state_var_input,
4607618d7b7SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
4617618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
462052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
463052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
464900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
465900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4664cc9442bSJames Wright 
4674cc9442bSJames Wright // -----------------------------------------------------------------------------
468dada6cc0SJames Wright // Boundary Condition Related Functions
469dada6cc0SJames Wright // -----------------------------------------------------------------------------
470dada6cc0SJames Wright 
471dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
47266170c20SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData *problem, SimpleBC bc);
473b7c563b6SJeremy L Thompson 
474d310b3d3SAdeleke O. Bankole PetscErrorCode FreestreamBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4758a94a473SJed Brown PetscErrorCode OutflowBCSetup(ProblemData *problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
4769f844368SJames Wright PetscErrorCode SlipBCSetup(ProblemData *problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
4772b730f8bSJeremy L Thompson 
4784e9802d1SJames Wright // -----------------------------------------------------------------------------
4794e9802d1SJames Wright // Differential Filtering Functions
4804e9802d1SJames Wright // -----------------------------------------------------------------------------
4814e9802d1SJames Wright 
4824e9802d1SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
4834e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
4844e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4854e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
486cbef7084SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData *problem);
4874e9802d1SJames Wright 
4888146534cSJames Wright // -----------------------------------------------------------------------------
4898146534cSJames Wright // SGS Data-Driven Training via SmartSim
4908146534cSJames Wright // -----------------------------------------------------------------------------
4918146534cSJames Wright PetscErrorCode SmartSimSetup(User user);
492b306c3f1SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
493ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData *problem);
494ee3b213aSJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
4951a7db67cSJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
496ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
497