xref: /honee/include/navierstokes.h (revision f978755d57fb6574cfe1ff974b5424124ae3c75e)
1ae2b091fSJames Wright // SPDX-FileCopyrightText: Copyright (c) 2017-2024, HONEE contributors.
2ae2b091fSJames Wright // SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause
3149fb536SJames Wright #pragma once
4149fb536SJames Wright 
5149fb536SJames Wright #include <ceed.h>
6149fb536SJames Wright #include <bc_definition.h>
7b7e55d06SJames Wright #include <dm-utils.h>
893ca29b6SJames Wright #include <honee-file.h>
978c5b8e5SJames Wright #include <honee.h>
10149fb536SJames Wright #include <log_events.h>
11149fb536SJames Wright #include <mat-ceed.h>
12149fb536SJames Wright #include <petsc-ceed-utils.h>
13149fb536SJames Wright #include <petscts.h>
14149fb536SJames Wright #include <stdbool.h>
15354560d1SJames Wright #include <time.h>
16149fb536SJames Wright 
17149fb536SJames Wright #include <petsc_ops.h>
18149fb536SJames Wright #include "../qfunctions/newtonian_types.h"
19149fb536SJames Wright 
20214d311dSJeremy L Thompson #if PETSC_VERSION_LT(3, 22, 0)
21214d311dSJeremy L Thompson #error "PETSc v3.22 or later is required"
22149fb536SJames Wright #endif
23149fb536SJames Wright 
24149fb536SJames Wright // -----------------------------------------------------------------------------
25149fb536SJames Wright // Enums
26149fb536SJames Wright // -----------------------------------------------------------------------------
27149fb536SJames Wright 
28149fb536SJames Wright // Euler - test cases
29149fb536SJames Wright typedef enum {
30149fb536SJames Wright   EULER_TEST_ISENTROPIC_VORTEX = 0,
31149fb536SJames Wright   EULER_TEST_1                 = 1,
32149fb536SJames Wright   EULER_TEST_2                 = 2,
33149fb536SJames Wright   EULER_TEST_3                 = 3,
34149fb536SJames Wright   EULER_TEST_4                 = 4,
35149fb536SJames Wright   EULER_TEST_5                 = 5,
36149fb536SJames Wright } EulerTestType;
37149fb536SJames Wright static const char *const EulerTestTypes[] = {"ISENTROPIC_VORTEX", "1", "2", "3", "4", "5", "EulerTestType", "EULER_TEST_", NULL};
38149fb536SJames Wright 
39149fb536SJames Wright // Advection - Wind types
403d1afcc1SJames Wright static const char *const AdvDifWindTypes[] = {"ROTATION", "TRANSLATION", "BOUNDARY_LAYER", "WindType", "ADVDIF_WIND_", NULL};
41149fb536SJames Wright 
42149fb536SJames Wright // Advection - Initial Condition Types
433d1afcc1SJames Wright static const char *const AdvDifICTypes[] = {"SPHERE",         "CYLINDER",        "COSINE_HILL", "SKEW", "WAVE",
443d1afcc1SJames Wright                                             "BOUNDARY_LAYER", "AdvectionICType", "ADVDIF_IC_",  NULL};
45a62be6baSJames Wright 
46a62be6baSJames Wright // Advection - Wave Types
47a62be6baSJames Wright static const char *const AdvDifWaveTypes[] = {"SINE", "SQUARE", "AdvDifWaveType", "ADVDIF_WAVE_", NULL};
48149fb536SJames Wright 
49149fb536SJames Wright // Advection - Bubble Continuity Types
505f636aeaSJames Wright static const char *const AdvDifBubbleContinuityTypes[] = {
515f636aeaSJames Wright     "SMOOTH", "BACK_SHARP", "THICK", "COSINE", "BubbleContinuityType", "ADVDIF_BUBBLE_CONTINUITY_", NULL};
52149fb536SJames Wright 
53149fb536SJames Wright // Stabilization methods
54149fb536SJames Wright static const char *const StabilizationTypes[] = {"NONE", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
55149fb536SJames Wright 
56149fb536SJames Wright // Stabilization tau constants
573a9e4118SJames Wright static const char *const StabilizationTauTypes[] = {"CTAU", "ADVDIFF_SHAKIB", "StabilizationTauType", "STAB_TAU_", NULL};
58149fb536SJames Wright 
59149fb536SJames Wright // Test mode type
60149fb536SJames Wright typedef enum {
61149fb536SJames Wright   TESTTYPE_NONE           = 0,
62149fb536SJames Wright   TESTTYPE_SOLVER         = 1,
63149fb536SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
64149fb536SJames Wright   TESTTYPE_DIFF_FILTER    = 3,
65149fb536SJames Wright } TestType;
66149fb536SJames Wright static const char *const TestTypes[] = {"NONE", "SOLVER", "TURB_SPANSTATS", "DIFF_FILTER", "TestType", "TESTTYPE_", NULL};
67149fb536SJames Wright 
68149fb536SJames Wright // Subgrid-Stress mode type
69149fb536SJames Wright typedef enum {
70149fb536SJames Wright   SGS_MODEL_NONE        = 0,
71149fb536SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
72149fb536SJames Wright } SGSModelType;
73149fb536SJames Wright static const char *const SGSModelTypes[] = {"NONE", "DATA_DRIVEN", "SGSModelType", "SGS_MODEL_", NULL};
74149fb536SJames Wright 
75149fb536SJames Wright // Subgrid-Stress mode type
76149fb536SJames Wright typedef enum {
77149fb536SJames Wright   SGS_MODEL_DD_FUSED           = 0,
78149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_CEED  = 1,
79149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_TORCH = 2,
80149fb536SJames Wright } SGSModelDDImplementation;
81149fb536SJames Wright static const char *const SGSModelDDImplementations[] = {"FUSED", "SEQUENTIAL_CEED", "SEQUENTIAL_TORCH", "SGSModelDDImplementation", "SGS_MODEL_DD_",
82149fb536SJames Wright                                                         NULL};
83149fb536SJames Wright 
84149fb536SJames Wright // Mesh transformation type
85149fb536SJames Wright typedef enum {
86149fb536SJames Wright   MESH_TRANSFORM_NONE      = 0,
87149fb536SJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
88149fb536SJames Wright } MeshTransformType;
89149fb536SJames Wright static const char *const MeshTransformTypes[] = {"NONE", "PLATEMESH", "MeshTransformType", "MESH_TRANSFORM_", NULL};
90149fb536SJames Wright 
91149fb536SJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
92149fb536SJames Wright     "NONE", "VAN_DRIEST", "MMS", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
93149fb536SJames Wright 
948c85b835SJames Wright static const char *const DivDiffFluxProjectionMethods[] = {"NONE", "DIRECT", "INDIRECT", "DivDiffFluxProjectionMethod", "DIV_DIFF_FLUX_PROJ_", NULL};
958c85b835SJames Wright 
9687fd7f33SJames Wright static const char *const StateVariables[] = {"CONSERVATIVE", "PRIMITIVE", "ENTROPY", "StateVariable", "STATEVAR_", NULL};
9787fd7f33SJames Wright 
98149fb536SJames Wright // -----------------------------------------------------------------------------
99149fb536SJames Wright // Structs
100149fb536SJames Wright // -----------------------------------------------------------------------------
101149fb536SJames Wright // Structs declarations
102149fb536SJames Wright typedef struct AppCtx_private      *AppCtx;
103149fb536SJames Wright typedef struct Units_private       *Units;
104149fb536SJames Wright typedef struct SimpleBC_private    *SimpleBC;
105149fb536SJames Wright typedef struct Physics_private     *Physics;
106149fb536SJames Wright typedef struct ProblemData_private *ProblemData;
107149fb536SJames Wright 
108149fb536SJames Wright // Application context from user command line options
109149fb536SJames Wright struct AppCtx_private {
110149fb536SJames Wright   // libCEED arguments
111149fb536SJames Wright   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
112149fb536SJames Wright   PetscInt degree;
113149fb536SJames Wright   PetscInt q_extra;
114149fb536SJames Wright   // Solver arguments
115149fb536SJames Wright   MatType amat_type;
116149fb536SJames Wright   // Post-processing arguments
117149fb536SJames Wright   PetscInt  checkpoint_interval;
118149fb536SJames Wright   PetscInt  viz_refine;
119481d14cbSJames Wright   PetscBool use_continue_file;
120149fb536SJames Wright   PetscInt  cont_steps;
121149fb536SJames Wright   PetscReal cont_time;
122149fb536SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
123149fb536SJames Wright   char      output_dir[PETSC_MAX_PATH_LEN];
124149fb536SJames Wright   PetscBool add_stepnum2bin;
125149fb536SJames Wright   PetscBool checkpoint_vtk;
126149fb536SJames Wright   // Problem type arguments
127149fb536SJames Wright   PetscFunctionList problems;
128149fb536SJames Wright   char              problem_name[PETSC_MAX_PATH_LEN];
129149fb536SJames Wright   // Test mode arguments
130149fb536SJames Wright   TestType    test_type;
131149fb536SJames Wright   PetscScalar test_tol;
132149fb536SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
133149fb536SJames Wright   // Wall forces
134149fb536SJames Wright   struct {
135149fb536SJames Wright     PetscInt          num_wall;
136149fb536SJames Wright     PetscInt         *walls;
137149fb536SJames Wright     PetscViewer       viewer;
138149fb536SJames Wright     PetscViewerFormat viewer_format;
139149fb536SJames Wright     PetscBool         header_written;
140149fb536SJames Wright   } wall_forces;
141149fb536SJames Wright   // Subgrid Stress Model
142149fb536SJames Wright   SGSModelType sgs_model_type;
143149fb536SJames Wright   PetscBool    sgs_train_enable;
144149fb536SJames Wright   // Differential Filtering
145149fb536SJames Wright   PetscBool         diff_filter_monitor;
146149fb536SJames Wright   MeshTransformType mesh_transform_type;
1478c85b835SJames Wright   // Divergence of Diffusive Flux Projection
1488c85b835SJames Wright   DivDiffFluxProjectionMethod divFdiffproj_method;
1498b774af8SJames Wright 
1508b774af8SJames Wright   PetscInt check_step_interval;
151149fb536SJames Wright };
152149fb536SJames Wright 
153149fb536SJames Wright typedef struct {
154149fb536SJames Wright   DM                   dm;
155149fb536SJames Wright   PetscInt             num_comp;
156149fb536SJames Wright   OperatorApplyContext l2_rhs_ctx;
157149fb536SJames Wright   KSP                  ksp;
158149fb536SJames Wright } *NodalProjectionData;
159149fb536SJames Wright 
16036038bbcSJames Wright typedef struct DivDiffFluxProjectionData_private *DivDiffFluxProjectionData;
16136038bbcSJames Wright 
16236038bbcSJames Wright struct DivDiffFluxProjectionData_private {
1638c85b835SJames Wright   PetscInt                    num_diff_flux_comps;
1648c85b835SJames Wright   DivDiffFluxProjectionMethod method;
1658c85b835SJames Wright   NodalProjectionData         projection;
16636038bbcSJames Wright 
16736038bbcSJames Wright   // CeedOperator Objects
16836038bbcSJames Wright   CeedElemRestriction elem_restr_div_diff_flux;
16936038bbcSJames Wright   CeedBasis           basis_div_diff_flux;
17036038bbcSJames Wright   CeedEvalMode        eval_mode_div_diff_flux;
1718c85b835SJames Wright   CeedVector          div_diff_flux_ceed;
17236038bbcSJames Wright 
17336038bbcSJames Wright   // Problem specific setup functions
174e3663b90SJames Wright   PetscErrorCode (*CreateRHSOperator_Direct)(Honee, DivDiffFluxProjectionData, CeedOperator *);
175e3663b90SJames Wright   PetscErrorCode (*CreateRHSOperator_Indirect)(Honee, DivDiffFluxProjectionData, CeedOperator *);
17636038bbcSJames Wright 
1778c85b835SJames Wright   // Only used for direct method:
1788c85b835SJames Wright   Vec          DivDiffFlux_loc;
1798c85b835SJames Wright   PetscMemType DivDiffFlux_memtype;
1808c85b835SJames Wright   PetscBool    ceed_vec_has_array;
18136038bbcSJames Wright 
18236038bbcSJames Wright   // Only used for indirect method:
18336038bbcSJames Wright   OperatorApplyContext calc_div_diff_flux;
18436038bbcSJames Wright };
1858c85b835SJames Wright 
1860c373b74SJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(Honee honee, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
187149fb536SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
188149fb536SJames Wright typedef struct {
189149fb536SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
190149fb536SJames Wright   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
191149fb536SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
192149fb536SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
193149fb536SJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
194149fb536SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
195149fb536SJames Wright   void                     *sgs_nodal_inference_ctx;
196149fb536SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
197149fb536SJames Wright } *SgsDDData;
198149fb536SJames Wright 
199149fb536SJames Wright typedef struct {
200149fb536SJames Wright   DM                   dm_dd_training;
201149fb536SJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval, num_filter_widths;
202149fb536SJames Wright   PetscScalar          filter_widths[16];
203149fb536SJames Wright   OperatorApplyContext op_training_data_calc_ctx;
204149fb536SJames Wright   NodalProjectionData  filtered_grad_velo_proj;
205149fb536SJames Wright   size_t               training_data_array_dims[2];
206149fb536SJames Wright   PetscBool            overwrite_training_data;
207149fb536SJames Wright } *SGS_DD_TrainingData;
208149fb536SJames Wright 
209149fb536SJames Wright typedef struct {
210149fb536SJames Wright   DM                    dm_filter;
211149fb536SJames Wright   PetscInt              num_filtered_fields;
212149fb536SJames Wright   CeedInt              *num_field_components;
213149fb536SJames Wright   PetscInt              field_prim_state, field_velo_prod;
214149fb536SJames Wright   OperatorApplyContext  op_rhs_ctx;
215149fb536SJames Wright   KSP                   ksp;
216149fb536SJames Wright   PetscObjectState      X_loc_state;
217149fb536SJames Wright   PetscBool             do_mms_test;
218149fb536SJames Wright   CeedContextFieldLabel filter_width_scaling_label;
219149fb536SJames Wright } *DiffFilterData;
220149fb536SJames Wright 
221149fb536SJames Wright typedef struct {
222149fb536SJames Wright   void    *client;
223149fb536SJames Wright   char     rank_id_name[16];
224149fb536SJames Wright   PetscInt collocated_database_num_ranks;
225149fb536SJames Wright } *SmartSimData;
226149fb536SJames Wright 
227149fb536SJames Wright // PETSc user data
2280c373b74SJames Wright struct Honee_private {
229149fb536SJames Wright   MPI_Comm                  comm;
230149fb536SJames Wright   DM                        dm;
231149fb536SJames Wright   DM                        dm_viz;
232149fb536SJames Wright   Mat                       interp_viz;
233149fb536SJames Wright   Ceed                      ceed;
234149fb536SJames Wright   Units                     units;
235149fb536SJames Wright   Vec                       Q_loc, Q_dot_loc;
236149fb536SJames Wright   Physics                   phys;
237149fb536SJames Wright   AppCtx                    app_ctx;
238149fb536SJames Wright   CeedVector                q_ceed, q_dot_ceed, g_ceed, x_ceed;
239149fb536SJames Wright   CeedOperator              op_ifunction;
240149fb536SJames Wright   Mat                       mat_ijacobian;
241149fb536SJames Wright   KSP                       mass_ksp;
242149fb536SJames Wright   OperatorApplyContext      op_rhs_ctx, op_strong_bc_ctx;
243149fb536SJames Wright   CeedScalar                time_bc_set;
244149fb536SJames Wright   NodalProjectionData       grad_velo_proj;
245149fb536SJames Wright   SgsDDData                 sgs_dd_data;
246149fb536SJames Wright   DiffFilterData            diff_filter;
247149fb536SJames Wright   SmartSimData              smartsim;
248149fb536SJames Wright   SGS_DD_TrainingData       sgs_dd_train;
2498c85b835SJames Wright   DivDiffFluxProjectionData diff_flux_proj;
250e3663b90SJames Wright 
25178c5b8e5SJames Wright   ProblemData problem_data;
25278c5b8e5SJames Wright 
253e3663b90SJames Wright   // old CeedData
254e3663b90SJames Wright   CeedVector           x_coord;
255e3663b90SJames Wright   CeedBasis            basis_x, basis_q;
256e3663b90SJames Wright   CeedElemRestriction  elem_restr_x, elem_restr_q;
257e3663b90SJames Wright   OperatorApplyContext op_ics_ctx;
258354560d1SJames Wright 
2594c6ae86eSJames Wright   PetscBool set_poststep;
260354560d1SJames Wright   time_t    start_time;
261354560d1SJames Wright   time_t    max_wall_time;
262354560d1SJames Wright   PetscInt  max_wall_time_interval;
263149fb536SJames Wright };
264149fb536SJames Wright 
265149fb536SJames Wright // Units
266149fb536SJames Wright struct Units_private {
267149fb536SJames Wright   // fundamental units
268149fb536SJames Wright   PetscScalar meter;
269149fb536SJames Wright   PetscScalar kilogram;
270149fb536SJames Wright   PetscScalar second;
271149fb536SJames Wright   PetscScalar Kelvin;
272149fb536SJames Wright   // derived units
273149fb536SJames Wright   PetscScalar Pascal;
274149fb536SJames Wright   PetscScalar J_per_kg_K;
275149fb536SJames Wright   PetscScalar m_per_squared_s;
276149fb536SJames Wright   PetscScalar W_per_m_K;
277149fb536SJames Wright   PetscScalar Joule;
278149fb536SJames Wright };
279149fb536SJames Wright 
280149fb536SJames Wright // Boundary conditions
281149fb536SJames Wright struct SimpleBC_private {
282*f978755dSJames Wright   PetscInt num_inflow;
283*f978755dSJames Wright   PetscInt inflows[16];
284149fb536SJames Wright };
285149fb536SJames Wright 
286149fb536SJames Wright // Struct that contains all enums and structs used for the physics of all problems
287149fb536SJames Wright struct Physics_private {
288149fb536SJames Wright   PetscBool             implicit;
289149fb536SJames Wright   StateVariable         state_var;
290149fb536SJames Wright   CeedContextFieldLabel solution_time_label;
291149fb536SJames Wright   CeedContextFieldLabel stg_solution_time_label;
292149fb536SJames Wright   CeedContextFieldLabel timestep_size_label;
293149fb536SJames Wright   CeedContextFieldLabel ics_time_label;
294149fb536SJames Wright };
295149fb536SJames Wright 
2965e79d562SJames Wright typedef struct {
2975e79d562SJames Wright   Honee                honee;
2985e79d562SJames Wright   CeedInt              jac_data_size_sur;
2995e79d562SJames Wright   CeedQFunctionContext qfctx;
3005e79d562SJames Wright   void                *ctx;
3015e79d562SJames Wright   PetscCtxDestroyFn   *DestroyCtx;
3025e79d562SJames Wright } *HoneeBCStruct;
3035e79d562SJames Wright 
3040c373b74SJames Wright PetscErrorCode BoundaryConditionSetUp(Honee honee, ProblemData problem, AppCtx app_ctx, SimpleBC bc);
3055e79d562SJames Wright PetscErrorCode HoneeBCDestroy(void **ctx);
3065e79d562SJames Wright PetscErrorCode HoneeBCCreateIFunctionQF(BCDefinition bc_def, CeedQFunctionUser qf_func_ptr, const char *qf_loc, CeedQFunctionContext qfctx,
3075e79d562SJames Wright                                         CeedQFunction *qf_ifunc);
3085e79d562SJames Wright PetscErrorCode HoneeBCCreateIJacobianQF(BCDefinition bc_def, CeedQFunctionUser qf_func_ptr, const char *qf_loc, CeedQFunctionContext qfctx,
3095e79d562SJames Wright                                         CeedQFunction *qf_ijac);
3105e79d562SJames Wright PetscErrorCode HoneeBCAddIFunctionOp(BCDefinition bc_def, DMLabel domain_label, PetscInt label_value, CeedQFunction qf_ifunc, CeedOperator op_ifunc,
3115e79d562SJames Wright                                      CeedOperator *sub_op_ifunc);
3125e79d562SJames Wright PetscErrorCode HoneeBCAddIJacobianOp(BCDefinition bc_def, CeedOperator sub_op_ifunc, DMLabel domain_label, PetscInt label_value,
3135e79d562SJames Wright                                      CeedQFunction qf_ijac, CeedOperator op_ijac);
314149fb536SJames Wright 
315149fb536SJames Wright typedef struct {
316e07531f7SJames Wright   CeedQFunctionUser    qf_func_ptr;  // !< QFunction function pointer
317e07531f7SJames Wright   const char          *qf_loc;       // !< Absolute path to QFunction source file
318e07531f7SJames Wright   CeedQFunctionContext qfctx;        // !< QFunctionContext to attach to QFunction
319149fb536SJames Wright } ProblemQFunctionSpec;
320149fb536SJames Wright 
321149fb536SJames Wright // Problem specific data
322149fb536SJames Wright struct ProblemData_private {
32328160fc2SJames Wright   CeedInt              jac_data_size_vol, jac_data_size_sur;
324*f978755dSJames Wright   ProblemQFunctionSpec ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_inflow_jacobian;
325149fb536SJames Wright   bool                 compute_exact_solution_error;
32628160fc2SJames Wright   PetscBool            set_bc_from_ics, use_strong_bc_ceed;
327ddb7a641SJames Wright   PetscCount           num_bc_defs;
328149fb536SJames Wright   BCDefinition        *bc_defs;
3290c373b74SJames Wright   PetscErrorCode (*print_info)(Honee, ProblemData, AppCtx);
3300c373b74SJames Wright   PetscErrorCode (*create_mass_operator)(Honee, CeedOperator *);
331149fb536SJames Wright };
332149fb536SJames Wright 
333149fb536SJames Wright extern int FreeContextPetsc(void *);
334149fb536SJames Wright 
335149fb536SJames Wright // -----------------------------------------------------------------------------
336149fb536SJames Wright // Set up problems
337149fb536SJames Wright // -----------------------------------------------------------------------------
338149fb536SJames Wright // Set up function for each problem
339149fb536SJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
340149fb536SJames Wright extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
341149fb536SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
342149fb536SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
343149fb536SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
344149fb536SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
345149fb536SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
346149fb536SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
347149fb536SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
348149fb536SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
349149fb536SJames Wright 
350149fb536SJames Wright // Print function for each problem
3510c373b74SJames Wright extern PetscErrorCode PRINT_NEWTONIAN(Honee honee, ProblemData problem, AppCtx app_ctx);
3520c373b74SJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(Honee honee, ProblemData problem, AppCtx app_ctx);
3530c373b74SJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(Honee honee, ProblemData problem, AppCtx app_ctx);
3540c373b74SJames Wright extern PetscErrorCode PRINT_ADVECTION(Honee honee, ProblemData problem, AppCtx app_ctx);
3550c373b74SJames Wright extern PetscErrorCode PRINT_ADVECTION2D(Honee honee, ProblemData problem, AppCtx app_ctx);
356149fb536SJames Wright 
3570c373b74SJames Wright PetscErrorCode PrintRunInfo(Honee honee, Physics phys_ctx, ProblemData problem, TS ts);
358149fb536SJames Wright 
359149fb536SJames Wright // -----------------------------------------------------------------------------
360149fb536SJames Wright // libCEED functions
361149fb536SJames Wright // -----------------------------------------------------------------------------
362e3663b90SJames Wright PetscErrorCode SetupLibceed(Ceed ceed, DM dm, Honee honee, AppCtx app_ctx, ProblemData problem, SimpleBC bc);
363149fb536SJames Wright 
364149fb536SJames Wright PetscErrorCode QDataGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
365149fb536SJames Wright                         CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
366149fb536SJames Wright PetscErrorCode QDataGetNumComponents(DM dm, CeedInt *q_data_size);
367149fb536SJames Wright PetscErrorCode QDataBoundaryGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
368149fb536SJames Wright                                 CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
369149fb536SJames Wright PetscErrorCode QDataBoundaryGetNumComponents(DM dm, CeedInt *q_data_size);
3708c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGetNumComponents(DM dm, CeedInt *q_data_size);
3718c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedVector x_coord,
37200dbc7b1SJames Wright                                         CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
373e816a7e4SJames Wright PetscErrorCode QDataClearStoredData();
374149fb536SJames Wright // -----------------------------------------------------------------------------
375149fb536SJames Wright // Time-stepping functions
376149fb536SJames Wright // -----------------------------------------------------------------------------
377149fb536SJames Wright PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
378149fb536SJames Wright PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
379149fb536SJames Wright PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
3802a9a4b51SJames Wright PetscErrorCode TSSolve_NS(DM dm, Honee honee, AppCtx app_ctx, Physics phys, ProblemData problem, Vec Q, PetscScalar *f_time, TS *ts);
3810c373b74SJames Wright PetscErrorCode UpdateBoundaryValues(Honee honee, Vec Q_loc, PetscReal t);
382149fb536SJames Wright 
383149fb536SJames Wright // -----------------------------------------------------------------------------
384149fb536SJames Wright // Setup DM
385149fb536SJames Wright // -----------------------------------------------------------------------------
386149fb536SJames Wright PetscErrorCode CreateDM(MPI_Comm comm, ProblemData problem, MatType, VecType, DM *dm);
387149fb536SJames Wright PetscErrorCode SetUpDM(DM dm, ProblemData problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
3880c373b74SJames Wright PetscErrorCode VizRefineDM(DM dm, Honee honee, ProblemData problem, SimpleBC bc, Physics phys);
3894cb09fddSJames Wright 
390149fb536SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
391149fb536SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
392149fb536SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
393149fb536SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
394149fb536SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
395149fb536SJames Wright 
396149fb536SJames Wright // -----------------------------------------------------------------------------
397149fb536SJames Wright // Process command line options
398149fb536SJames Wright // -----------------------------------------------------------------------------
39973170398SJames Wright PetscErrorCode ProcessCommandLineOptions(Honee honee, SimpleBC bc);
40059572072SJames Wright PetscErrorCode HoneeOptionsSetValueDefault(PetscOptions options, const char name[], const char value[]);
401149fb536SJames Wright 
402149fb536SJames Wright // -----------------------------------------------------------------------------
403149fb536SJames Wright // Miscellaneous utility functions
404149fb536SJames Wright // -----------------------------------------------------------------------------
405149fb536SJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
406149fb536SJames Wright                                       PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity,
407149fb536SJames Wright                                       CeedVector *inv_multiplicity);
408e3663b90SJames Wright PetscErrorCode ICs_FixMultiplicity(DM dm, Honee honee, Vec Q_loc, Vec Q, CeedScalar time);
409149fb536SJames Wright 
410149fb536SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
411149fb536SJames Wright                                                   Vec grad_FVM);
412149fb536SJames Wright 
413149fb536SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
414e3663b90SJames Wright PetscErrorCode PrintError(DM dm, Honee honee, Vec Q, PetscScalar final_time);
415e3663b90SJames Wright PetscErrorCode PostProcess(TS ts, DM dm, ProblemData problem, Honee honee, Vec Q, PetscScalar final_time);
416149fb536SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
41764dd23feSJames Wright PetscErrorCode HoneeMassQFunctionCreate(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
41825125139SJames Wright PetscErrorCode HoneeCalculateDomainSize(Honee honee, PetscScalar *volume);
419149fb536SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
420149fb536SJames Wright 
421149fb536SJames Wright // -----------------------------------------------------------------------------
422149fb536SJames Wright // Turbulence Statistics Collection Functions
423149fb536SJames Wright // -----------------------------------------------------------------------------
42478c5b8e5SJames Wright PetscErrorCode SpanwiseStatisticsSetup_Turbulence(TS ts, PetscViewerAndFormat *ctx);
42578c5b8e5SJames Wright PetscErrorCode TSMonitor_TurbulenceSpanwiseStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
426149fb536SJames Wright 
427149fb536SJames Wright // -----------------------------------------------------------------------------
428149fb536SJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
429149fb536SJames Wright // -----------------------------------------------------------------------------
430e3663b90SJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, Honee honee, ProblemData problem);
431149fb536SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
4320c373b74SJames Wright PetscErrorCode SgsDDApplyIFunction(Honee honee, const Vec Q_loc, Vec G_loc);
433e3663b90SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, Honee honee, ProblemData problem, StateVariable state_var_input,
434149fb536SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
435149fb536SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
436e3663b90SJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, Honee honee, CeedElemRestriction *elem_restr_grid_aniso,
437149fb536SJames Wright                                                         CeedVector *grid_aniso_vector);
438e3663b90SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, Honee honee, CeedElemRestriction *elem_restr_grid_aniso,
439149fb536SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
440149fb536SJames Wright 
441149fb536SJames Wright // -----------------------------------------------------------------------------
442149fb536SJames Wright // Boundary Condition Related Functions
443149fb536SJames Wright // -----------------------------------------------------------------------------
444e3663b90SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, DM dm, Honee honee, ProblemData problem, SimpleBC bc);
445d4e423e7SJames Wright PetscErrorCode FreestreamBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx,
446d4e423e7SJames Wright                                  const StatePrimitive *reference);
447*f978755dSJames Wright PetscErrorCode OutflowBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx,
448*f978755dSJames Wright                               const StatePrimitive *reference);
4495e79d562SJames Wright PetscErrorCode SlipBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
450149fb536SJames Wright 
451149fb536SJames Wright // -----------------------------------------------------------------------------
452149fb536SJames Wright // Differential Filtering Functions
453149fb536SJames Wright // -----------------------------------------------------------------------------
454e3663b90SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, Honee honee, ProblemData problem);
455149fb536SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
456149fb536SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4570c373b74SJames Wright PetscErrorCode DifferentialFilterApply(Honee honee, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
458149fb536SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData problem);
459149fb536SJames Wright 
460149fb536SJames Wright // -----------------------------------------------------------------------------
461149fb536SJames Wright // SGS Data-Driven Training via SmartSim
462149fb536SJames Wright // -----------------------------------------------------------------------------
4630c373b74SJames Wright PetscErrorCode SmartSimSetup(Honee honee);
464149fb536SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
465e3663b90SJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, Honee honee, ProblemData problem);
466149fb536SJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
467149fb536SJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
468149fb536SJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
4698c85b835SJames Wright 
4708c85b835SJames Wright // -----------------------------------------------------------------------------
4718c85b835SJames Wright // Divergence of Diffusive Flux Projection
4728c85b835SJames Wright // -----------------------------------------------------------------------------
4730c373b74SJames Wright PetscErrorCode DivDiffFluxProjectionCreate(Honee honee, PetscInt num_diff_flux_comps, DivDiffFluxProjectionData *pdiff_flux_proj);
4740880fbb6SJames Wright PetscErrorCode DivDiffFluxProjectionGetOperatorFieldData(DivDiffFluxProjectionData diff_flux_proj, CeedElemRestriction *elem_restr, CeedBasis *basis,
4750880fbb6SJames Wright                                                          CeedVector *vector, CeedEvalMode *eval_mode);
476e3663b90SJames Wright PetscErrorCode DivDiffFluxProjectionSetup(Honee honee, DivDiffFluxProjectionData diff_flux_proj);
47736038bbcSJames Wright PetscErrorCode DivDiffFluxProjectionApply(DivDiffFluxProjectionData diff_flux_proj, Vec Q_loc);
4788c85b835SJames Wright PetscErrorCode DivDiffFluxProjectionDataDestroy(DivDiffFluxProjectionData diff_flux_proj);
47925125139SJames Wright 
48025125139SJames Wright PetscErrorCode SetupMontiorTotalKineticEnergy(TS ts, PetscViewerAndFormat *ctx);
48125125139SJames Wright PetscErrorCode TSMonitor_TotalKineticEnergy(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
48287fd7f33SJames Wright 
48387fd7f33SJames Wright PetscErrorCode SetupMontiorCfl(TS ts, PetscViewerAndFormat *ctx);
48487fd7f33SJames Wright PetscErrorCode TSMonitor_Cfl(TS ts, PetscInt step, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
48516cb6b6bSJames Wright 
48616cb6b6bSJames Wright PetscErrorCode KSPPostSolve_Honee(KSP ksp, Vec rhs, Vec x, void *ctx);
487