xref: /honee/include/navierstokes.h (revision 8340219bafa41388624676c9e984cd3223bcfb2c)
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 
17*8340219bSJames Wright #include <nodal_projection.h>
18*8340219bSJames Wright 
19149fb536SJames Wright #include <petsc_ops.h>
20149fb536SJames Wright #include "../qfunctions/newtonian_types.h"
21149fb536SJames Wright 
22a7a18c73SJames Wright #if PETSC_VERSION_LT(3, 23, 0)
23a7a18c73SJames Wright #error "PETSc v3.23 or later is required"
24149fb536SJames Wright #endif
25149fb536SJames Wright 
26149fb536SJames Wright // -----------------------------------------------------------------------------
27149fb536SJames Wright // Enums
28149fb536SJames Wright // -----------------------------------------------------------------------------
29149fb536SJames Wright 
30149fb536SJames Wright // Euler - test cases
31149fb536SJames Wright typedef enum {
32149fb536SJames Wright   EULER_TEST_ISENTROPIC_VORTEX = 0,
33149fb536SJames Wright   EULER_TEST_1                 = 1,
34149fb536SJames Wright   EULER_TEST_2                 = 2,
35149fb536SJames Wright   EULER_TEST_3                 = 3,
36149fb536SJames Wright   EULER_TEST_4                 = 4,
37149fb536SJames Wright   EULER_TEST_5                 = 5,
38149fb536SJames Wright } EulerTestType;
39149fb536SJames Wright static const char *const EulerTestTypes[] = {"ISENTROPIC_VORTEX", "1", "2", "3", "4", "5", "EulerTestType", "EULER_TEST_", NULL};
40149fb536SJames Wright 
41149fb536SJames Wright // Test mode type
42149fb536SJames Wright typedef enum {
43149fb536SJames Wright   TESTTYPE_NONE           = 0,
44149fb536SJames Wright   TESTTYPE_SOLVER         = 1,
45149fb536SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
46149fb536SJames Wright   TESTTYPE_DIFF_FILTER    = 3,
47149fb536SJames Wright } TestType;
48149fb536SJames Wright static const char *const TestTypes[] = {"NONE", "SOLVER", "TURB_SPANSTATS", "DIFF_FILTER", "TestType", "TESTTYPE_", NULL};
49149fb536SJames Wright 
50149fb536SJames Wright // Subgrid-Stress mode type
51149fb536SJames Wright typedef enum {
52149fb536SJames Wright   SGS_MODEL_NONE        = 0,
53149fb536SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
54149fb536SJames Wright } SGSModelType;
55149fb536SJames Wright static const char *const SGSModelTypes[] = {"NONE", "DATA_DRIVEN", "SGSModelType", "SGS_MODEL_", NULL};
56149fb536SJames Wright 
57149fb536SJames Wright // Subgrid-Stress mode type
58149fb536SJames Wright typedef enum {
59149fb536SJames Wright   SGS_MODEL_DD_FUSED           = 0,
60149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_CEED  = 1,
61149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_TORCH = 2,
62149fb536SJames Wright } SGSModelDDImplementation;
63149fb536SJames Wright static const char *const SGSModelDDImplementations[] = {"FUSED", "SEQUENTIAL_CEED", "SEQUENTIAL_TORCH", "SGSModelDDImplementation", "SGS_MODEL_DD_",
64149fb536SJames Wright                                                         NULL};
65149fb536SJames Wright 
66149fb536SJames Wright // Mesh transformation type
67149fb536SJames Wright typedef enum {
68149fb536SJames Wright   MESH_TRANSFORM_NONE      = 0,
69149fb536SJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
70149fb536SJames Wright } MeshTransformType;
71149fb536SJames Wright static const char *const MeshTransformTypes[] = {"NONE", "PLATEMESH", "MeshTransformType", "MESH_TRANSFORM_", NULL};
72149fb536SJames Wright 
73149fb536SJames Wright // -----------------------------------------------------------------------------
74149fb536SJames Wright // Structs
75149fb536SJames Wright // -----------------------------------------------------------------------------
76149fb536SJames Wright // Structs declarations
77149fb536SJames Wright typedef struct AppCtx_private      *AppCtx;
78149fb536SJames Wright typedef struct Units_private       *Units;
79149fb536SJames Wright typedef struct SimpleBC_private    *SimpleBC;
80149fb536SJames Wright typedef struct Physics_private     *Physics;
81149fb536SJames Wright typedef struct ProblemData_private *ProblemData;
82149fb536SJames Wright 
83149fb536SJames Wright // Application context from user command line options
84149fb536SJames Wright struct AppCtx_private {
85149fb536SJames Wright   // libCEED arguments
86149fb536SJames Wright   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
87149fb536SJames Wright   PetscInt degree;
88149fb536SJames Wright   PetscInt q_extra;
89149fb536SJames Wright   // Solver arguments
90149fb536SJames Wright   MatType amat_type;
91149fb536SJames Wright   // Post-processing arguments
92149fb536SJames Wright   PetscInt  checkpoint_interval;
93149fb536SJames Wright   PetscInt  viz_refine;
94481d14cbSJames Wright   PetscBool use_continue_file;
95149fb536SJames Wright   PetscInt  cont_steps;
96149fb536SJames Wright   PetscReal cont_time;
97149fb536SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
98149fb536SJames Wright   char      output_dir[PETSC_MAX_PATH_LEN];
99149fb536SJames Wright   PetscBool add_stepnum2bin;
100149fb536SJames Wright   PetscBool checkpoint_vtk;
101149fb536SJames Wright   // Problem type arguments
102149fb536SJames Wright   PetscFunctionList problems;
103149fb536SJames Wright   char              problem_name[PETSC_MAX_PATH_LEN];
104149fb536SJames Wright   // Test mode arguments
105149fb536SJames Wright   TestType    test_type;
106149fb536SJames Wright   PetscScalar test_tol;
107149fb536SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
108149fb536SJames Wright   // Wall forces
109149fb536SJames Wright   struct {
110149fb536SJames Wright     PetscInt          num_wall;
111149fb536SJames Wright     PetscInt         *walls;
112149fb536SJames Wright     PetscViewer       viewer;
113149fb536SJames Wright     PetscViewerFormat viewer_format;
114149fb536SJames Wright     PetscBool         header_written;
115149fb536SJames Wright   } wall_forces;
116149fb536SJames Wright   // Subgrid Stress Model
117149fb536SJames Wright   SGSModelType sgs_model_type;
118149fb536SJames Wright   PetscBool    sgs_train_enable;
119149fb536SJames Wright   // Differential Filtering
120149fb536SJames Wright   PetscBool         diff_filter_monitor;
121149fb536SJames Wright   MeshTransformType mesh_transform_type;
1228c85b835SJames Wright   // Divergence of Diffusive Flux Projection
1238c85b835SJames Wright   DivDiffFluxProjectionMethod divFdiffproj_method;
1248b774af8SJames Wright 
1258b774af8SJames Wright   PetscInt check_step_interval;
126149fb536SJames Wright };
127149fb536SJames Wright 
12836038bbcSJames Wright typedef struct DivDiffFluxProjectionData_private *DivDiffFluxProjectionData;
12936038bbcSJames Wright 
13036038bbcSJames Wright struct DivDiffFluxProjectionData_private {
1318c85b835SJames Wright   PetscInt                    num_diff_flux_comps;
1328c85b835SJames Wright   DivDiffFluxProjectionMethod method;
1338c85b835SJames Wright   NodalProjectionData         projection;
13436038bbcSJames Wright 
13536038bbcSJames Wright   // CeedOperator Objects
13636038bbcSJames Wright   CeedElemRestriction elem_restr_div_diff_flux;
13736038bbcSJames Wright   CeedBasis           basis_div_diff_flux;
13836038bbcSJames Wright   CeedEvalMode        eval_mode_div_diff_flux;
1398c85b835SJames Wright   CeedVector          div_diff_flux_ceed;
14036038bbcSJames Wright 
14136038bbcSJames Wright   // Problem specific setup functions
142e3663b90SJames Wright   PetscErrorCode (*CreateRHSOperator_Direct)(Honee, DivDiffFluxProjectionData, CeedOperator *);
143e3663b90SJames Wright   PetscErrorCode (*CreateRHSOperator_Indirect)(Honee, DivDiffFluxProjectionData, CeedOperator *);
14436038bbcSJames Wright 
1458c85b835SJames Wright   // Only used for direct method:
1468c85b835SJames Wright   Vec          DivDiffFlux_loc;
1478c85b835SJames Wright   PetscMemType DivDiffFlux_memtype;
1488c85b835SJames Wright   PetscBool    ceed_vec_has_array;
14936038bbcSJames Wright 
15036038bbcSJames Wright   // Only used for indirect method:
15136038bbcSJames Wright   OperatorApplyContext calc_div_diff_flux;
15236038bbcSJames Wright };
1538c85b835SJames Wright 
1540c373b74SJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(Honee honee, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
155149fb536SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
156149fb536SJames Wright typedef struct {
157149fb536SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
158149fb536SJames Wright   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
159149fb536SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
160149fb536SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
161149fb536SJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
162149fb536SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
163149fb536SJames Wright   void                     *sgs_nodal_inference_ctx;
164149fb536SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
165149fb536SJames Wright } *SgsDDData;
166149fb536SJames Wright 
167149fb536SJames Wright typedef struct {
168149fb536SJames Wright   DM                   dm_dd_training;
169149fb536SJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval, num_filter_widths;
170149fb536SJames Wright   PetscScalar          filter_widths[16];
171149fb536SJames Wright   OperatorApplyContext op_training_data_calc_ctx;
172149fb536SJames Wright   NodalProjectionData  filtered_grad_velo_proj;
173149fb536SJames Wright   size_t               training_data_array_dims[2];
174149fb536SJames Wright   PetscBool            overwrite_training_data;
175149fb536SJames Wright } *SGS_DD_TrainingData;
176149fb536SJames Wright 
177149fb536SJames Wright typedef struct {
178149fb536SJames Wright   DM                    dm_filter;
179149fb536SJames Wright   PetscInt              num_filtered_fields;
180149fb536SJames Wright   CeedInt              *num_field_components;
181149fb536SJames Wright   PetscInt              field_prim_state, field_velo_prod;
182149fb536SJames Wright   OperatorApplyContext  op_rhs_ctx;
183149fb536SJames Wright   KSP                   ksp;
184149fb536SJames Wright   PetscObjectState      X_loc_state;
185149fb536SJames Wright   PetscBool             do_mms_test;
186149fb536SJames Wright   CeedContextFieldLabel filter_width_scaling_label;
187149fb536SJames Wright } *DiffFilterData;
188149fb536SJames Wright 
189149fb536SJames Wright typedef struct {
190149fb536SJames Wright   void    *client;
191149fb536SJames Wright   char     rank_id_name[16];
192149fb536SJames Wright   PetscInt collocated_database_num_ranks;
193149fb536SJames Wright } *SmartSimData;
194149fb536SJames Wright 
1956a9fb8efSJames Wright typedef struct _HoneeOps *HoneeOps;
1966a9fb8efSJames Wright struct _HoneeOps {};
1976a9fb8efSJames Wright 
1986a9fb8efSJames Wright PetscErrorCode HoneeInit(MPI_Comm comm, Honee *honee);
1996a9fb8efSJames Wright PetscErrorCode HoneeDestroy(Honee *honee);
2006a9fb8efSJames Wright 
201149fb536SJames Wright // PETSc user data
2020c373b74SJames Wright struct Honee_private {
2036a9fb8efSJames Wright   PETSCHEADER(struct _HoneeOps);
204149fb536SJames Wright   MPI_Comm                  comm;
205149fb536SJames Wright   DM                        dm;
206149fb536SJames Wright   DM                        dm_viz;
207149fb536SJames Wright   Mat                       interp_viz;
208149fb536SJames Wright   Ceed                      ceed;
209149fb536SJames Wright   Units                     units;
210149fb536SJames Wright   Vec                       Q_loc, Q_dot_loc;
211149fb536SJames Wright   Physics                   phys;
212149fb536SJames Wright   AppCtx                    app_ctx;
213149fb536SJames Wright   CeedVector                q_ceed, q_dot_ceed, g_ceed, x_ceed;
214149fb536SJames Wright   CeedOperator              op_ifunction;
215149fb536SJames Wright   Mat                       mat_ijacobian;
216149fb536SJames Wright   KSP                       mass_ksp;
217149fb536SJames Wright   OperatorApplyContext      op_rhs_ctx, op_strong_bc_ctx;
218149fb536SJames Wright   CeedScalar                time_bc_set;
219149fb536SJames Wright   SgsDDData                 sgs_dd_data;
220149fb536SJames Wright   DiffFilterData            diff_filter;
221149fb536SJames Wright   SmartSimData              smartsim;
222149fb536SJames Wright   SGS_DD_TrainingData       sgs_dd_train;
2238c85b835SJames Wright   DivDiffFluxProjectionData diff_flux_proj;
224e3663b90SJames Wright 
22578c5b8e5SJames Wright   ProblemData problem_data;
22678c5b8e5SJames Wright 
227e3663b90SJames Wright   // old CeedData
228e3663b90SJames Wright   CeedVector           x_coord;
229e3663b90SJames Wright   CeedBasis            basis_x, basis_q;
230e3663b90SJames Wright   CeedElemRestriction  elem_restr_x, elem_restr_q;
231e3663b90SJames Wright   OperatorApplyContext op_ics_ctx;
232354560d1SJames Wright 
2334c6ae86eSJames Wright   PetscBool set_poststep;
234354560d1SJames Wright   time_t    start_time;
235354560d1SJames Wright   time_t    max_wall_time;
236354560d1SJames Wright   PetscInt  max_wall_time_interval;
237149fb536SJames Wright };
238149fb536SJames Wright 
239149fb536SJames Wright // Units
240149fb536SJames Wright struct Units_private {
241149fb536SJames Wright   // fundamental units
242149fb536SJames Wright   PetscScalar meter;
243149fb536SJames Wright   PetscScalar kilogram;
244149fb536SJames Wright   PetscScalar second;
245149fb536SJames Wright   PetscScalar Kelvin;
246149fb536SJames Wright   // derived units
247149fb536SJames Wright   PetscScalar Pascal;
248149fb536SJames Wright   PetscScalar J_per_kg_K;
249149fb536SJames Wright   PetscScalar m_per_squared_s;
250149fb536SJames Wright   PetscScalar W_per_m_K;
251149fb536SJames Wright   PetscScalar Joule;
252149fb536SJames Wright };
253149fb536SJames Wright 
254149fb536SJames Wright // Struct that contains all enums and structs used for the physics of all problems
255149fb536SJames Wright struct Physics_private {
256149fb536SJames Wright   PetscBool             implicit;
257149fb536SJames Wright   StateVariable         state_var;
258149fb536SJames Wright   CeedContextFieldLabel solution_time_label;
259149fb536SJames Wright   CeedContextFieldLabel stg_solution_time_label;
260149fb536SJames Wright   CeedContextFieldLabel timestep_size_label;
261149fb536SJames Wright   CeedContextFieldLabel ics_time_label;
262149fb536SJames Wright };
263149fb536SJames Wright 
2645e79d562SJames Wright typedef struct {
2655e79d562SJames Wright   Honee                honee;
2661abc2837SJames Wright   CeedInt              num_comps_jac_data;
2675e79d562SJames Wright   CeedQFunctionContext qfctx;
2685e79d562SJames Wright   void                *ctx;
2695e79d562SJames Wright   PetscCtxDestroyFn   *DestroyCtx;
2705e79d562SJames Wright } *HoneeBCStruct;
2715e79d562SJames Wright 
272d3c60affSJames Wright PetscErrorCode BoundaryConditionSetUp(Honee honee, ProblemData problem, AppCtx app_ctx);
2735e79d562SJames Wright PetscErrorCode HoneeBCDestroy(void **ctx);
2745e79d562SJames Wright PetscErrorCode HoneeBCCreateIFunctionQF(BCDefinition bc_def, CeedQFunctionUser qf_func_ptr, const char *qf_loc, CeedQFunctionContext qfctx,
2755e79d562SJames Wright                                         CeedQFunction *qf_ifunc);
2765e79d562SJames Wright PetscErrorCode HoneeBCCreateIJacobianQF(BCDefinition bc_def, CeedQFunctionUser qf_func_ptr, const char *qf_loc, CeedQFunctionContext qfctx,
2775e79d562SJames Wright                                         CeedQFunction *qf_ijac);
2785e79d562SJames Wright PetscErrorCode HoneeBCAddIFunctionOp(BCDefinition bc_def, DMLabel domain_label, PetscInt label_value, CeedQFunction qf_ifunc, CeedOperator op_ifunc,
2795e79d562SJames Wright                                      CeedOperator *sub_op_ifunc);
2805e79d562SJames Wright PetscErrorCode HoneeBCAddIJacobianOp(BCDefinition bc_def, CeedOperator sub_op_ifunc, DMLabel domain_label, PetscInt label_value,
2815e79d562SJames Wright                                      CeedQFunction qf_ijac, CeedOperator op_ijac);
282149fb536SJames Wright 
283149fb536SJames Wright typedef struct {
284e07531f7SJames Wright   CeedQFunctionUser    qf_func_ptr;  // !< QFunction function pointer
285e07531f7SJames Wright   const char          *qf_loc;       // !< Absolute path to QFunction source file
286e07531f7SJames Wright   CeedQFunctionContext qfctx;        // !< QFunctionContext to attach to QFunction
287149fb536SJames Wright } ProblemQFunctionSpec;
288149fb536SJames Wright 
289149fb536SJames Wright // Problem specific data
290149fb536SJames Wright struct ProblemData_private {
2911abc2837SJames Wright   CeedInt              num_comps_jac_data;
292d6cac220SJames Wright   ProblemQFunctionSpec ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian;
293149fb536SJames Wright   bool                 compute_exact_solution_error;
29428160fc2SJames Wright   PetscBool            set_bc_from_ics, use_strong_bc_ceed;
295ddb7a641SJames Wright   PetscCount           num_bc_defs;
296149fb536SJames Wright   BCDefinition        *bc_defs;
2970c373b74SJames Wright   PetscErrorCode (*print_info)(Honee, ProblemData, AppCtx);
2980c373b74SJames Wright   PetscErrorCode (*create_mass_operator)(Honee, CeedOperator *);
299149fb536SJames Wright };
300149fb536SJames Wright 
301149fb536SJames Wright extern int FreeContextPetsc(void *);
302149fb536SJames Wright 
303149fb536SJames Wright // -----------------------------------------------------------------------------
304149fb536SJames Wright // Set up problems
305149fb536SJames Wright // -----------------------------------------------------------------------------
306149fb536SJames Wright // Set up function for each problem
307d3c60affSJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData problem, DM dm, void *ctx);
308d3c60affSJames Wright extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData problem, DM dm, void *ctx);
309d3c60affSJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData problem, DM dm, void *ctx);
310d3c60affSJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData problem, DM dm, void *ctx);
311d3c60affSJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx);
312d3c60affSJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData problem, DM dm, void *ctx);
313d3c60affSJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData problem, DM dm, void *ctx);
314d3c60affSJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData problem, DM dm, void *ctx);
315d3c60affSJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx);
316149fb536SJames Wright 
317149fb536SJames Wright // Print function for each problem
3180c373b74SJames Wright extern PetscErrorCode PRINT_NEWTONIAN(Honee honee, ProblemData problem, AppCtx app_ctx);
3190c373b74SJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(Honee honee, ProblemData problem, AppCtx app_ctx);
3200c373b74SJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(Honee honee, ProblemData problem, AppCtx app_ctx);
3210c373b74SJames Wright extern PetscErrorCode PRINT_ADVECTION(Honee honee, ProblemData problem, AppCtx app_ctx);
3220c373b74SJames Wright extern PetscErrorCode PRINT_ADVECTION2D(Honee honee, ProblemData problem, AppCtx app_ctx);
323149fb536SJames Wright 
3240c373b74SJames Wright PetscErrorCode PrintRunInfo(Honee honee, Physics phys_ctx, ProblemData problem, TS ts);
325149fb536SJames Wright 
326149fb536SJames Wright // -----------------------------------------------------------------------------
327149fb536SJames Wright // libCEED functions
328149fb536SJames Wright // -----------------------------------------------------------------------------
329d3c60affSJames Wright PetscErrorCode SetupLibceed(Ceed ceed, DM dm, Honee honee, AppCtx app_ctx, ProblemData problem);
330149fb536SJames Wright 
331149fb536SJames Wright PetscErrorCode QDataGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
332149fb536SJames Wright                         CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
333149fb536SJames Wright PetscErrorCode QDataGetNumComponents(DM dm, CeedInt *q_data_size);
334149fb536SJames Wright PetscErrorCode QDataBoundaryGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
335149fb536SJames Wright                                 CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
336149fb536SJames Wright PetscErrorCode QDataBoundaryGetNumComponents(DM dm, CeedInt *q_data_size);
3378c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGetNumComponents(DM dm, CeedInt *q_data_size);
3388c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedVector x_coord,
33900dbc7b1SJames Wright                                         CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
340e816a7e4SJames Wright PetscErrorCode QDataClearStoredData();
341149fb536SJames Wright // -----------------------------------------------------------------------------
342149fb536SJames Wright // Time-stepping functions
343149fb536SJames Wright // -----------------------------------------------------------------------------
344149fb536SJames Wright PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
345149fb536SJames Wright PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
346149fb536SJames Wright PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
3472a9a4b51SJames Wright PetscErrorCode TSSolve_NS(DM dm, Honee honee, AppCtx app_ctx, Physics phys, ProblemData problem, Vec Q, PetscScalar *f_time, TS *ts);
3480c373b74SJames Wright PetscErrorCode UpdateBoundaryValues(Honee honee, Vec Q_loc, PetscReal t);
349149fb536SJames Wright 
350149fb536SJames Wright // -----------------------------------------------------------------------------
351149fb536SJames Wright // Setup DM
352149fb536SJames Wright // -----------------------------------------------------------------------------
353149fb536SJames Wright PetscErrorCode CreateDM(MPI_Comm comm, ProblemData problem, MatType, VecType, DM *dm);
354d3c60affSJames Wright PetscErrorCode SetUpDM(DM dm, ProblemData problem, PetscInt degree, PetscInt q_extra, Physics phys);
355d3c60affSJames Wright PetscErrorCode VizRefineDM(DM dm, Honee honee, ProblemData problem, Physics phys);
3564cb09fddSJames Wright 
357149fb536SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
358149fb536SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
359149fb536SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
360149fb536SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
361149fb536SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
362149fb536SJames Wright 
363149fb536SJames Wright // -----------------------------------------------------------------------------
364149fb536SJames Wright // Process command line options
365149fb536SJames Wright // -----------------------------------------------------------------------------
366d3c60affSJames Wright PetscErrorCode ProcessCommandLineOptions(Honee honee);
36759572072SJames Wright PetscErrorCode HoneeOptionsSetValueDefault(PetscOptions options, const char name[], const char value[]);
368149fb536SJames Wright 
369149fb536SJames Wright // -----------------------------------------------------------------------------
370149fb536SJames Wright // Miscellaneous utility functions
371149fb536SJames Wright // -----------------------------------------------------------------------------
372149fb536SJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
373149fb536SJames Wright                                       PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity,
374149fb536SJames Wright                                       CeedVector *inv_multiplicity);
375e3663b90SJames Wright PetscErrorCode ICs_FixMultiplicity(DM dm, Honee honee, Vec Q_loc, Vec Q, CeedScalar time);
376149fb536SJames Wright 
377149fb536SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
378149fb536SJames Wright                                                   Vec grad_FVM);
379149fb536SJames Wright 
380149fb536SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
381e3663b90SJames Wright PetscErrorCode PrintError(DM dm, Honee honee, Vec Q, PetscScalar final_time);
382e3663b90SJames Wright PetscErrorCode PostProcess(TS ts, DM dm, ProblemData problem, Honee honee, Vec Q, PetscScalar final_time);
383149fb536SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
38464dd23feSJames Wright PetscErrorCode HoneeMassQFunctionCreate(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
38525125139SJames Wright PetscErrorCode HoneeCalculateDomainSize(Honee honee, PetscScalar *volume);
386149fb536SJames Wright 
387149fb536SJames Wright // -----------------------------------------------------------------------------
388149fb536SJames Wright // Turbulence Statistics Collection Functions
389149fb536SJames Wright // -----------------------------------------------------------------------------
39078c5b8e5SJames Wright PetscErrorCode SpanwiseStatisticsSetup_Turbulence(TS ts, PetscViewerAndFormat *ctx);
39178c5b8e5SJames Wright PetscErrorCode TSMonitor_TurbulenceSpanwiseStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
392149fb536SJames Wright 
393149fb536SJames Wright // -----------------------------------------------------------------------------
394149fb536SJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
395149fb536SJames Wright // -----------------------------------------------------------------------------
396e3663b90SJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, Honee honee, ProblemData problem);
397149fb536SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
3980c373b74SJames Wright PetscErrorCode SgsDDApplyIFunction(Honee honee, const Vec Q_loc, Vec G_loc);
399e3663b90SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, Honee honee, ProblemData problem, StateVariable state_var_input,
400149fb536SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
401149fb536SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
402e3663b90SJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, Honee honee, CeedElemRestriction *elem_restr_grid_aniso,
403149fb536SJames Wright                                                         CeedVector *grid_aniso_vector);
404e3663b90SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, Honee honee, CeedElemRestriction *elem_restr_grid_aniso,
405149fb536SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
406149fb536SJames Wright 
407149fb536SJames Wright // -----------------------------------------------------------------------------
408149fb536SJames Wright // Boundary Condition Related Functions
409149fb536SJames Wright // -----------------------------------------------------------------------------
410d3c60affSJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, DM dm, Honee honee, ProblemData problem);
411d4e423e7SJames Wright PetscErrorCode FreestreamBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx,
412d4e423e7SJames Wright                                  const StatePrimitive *reference);
413f978755dSJames Wright PetscErrorCode OutflowBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx,
414f978755dSJames Wright                               const StatePrimitive *reference);
4155e79d562SJames Wright PetscErrorCode SlipBCSetup(BCDefinition bc_def, ProblemData problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
416149fb536SJames Wright 
417149fb536SJames Wright // -----------------------------------------------------------------------------
418149fb536SJames Wright // Differential Filtering Functions
419149fb536SJames Wright // -----------------------------------------------------------------------------
420e3663b90SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, Honee honee, ProblemData problem);
421149fb536SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
422149fb536SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4230c373b74SJames Wright PetscErrorCode DifferentialFilterApply(Honee honee, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
424149fb536SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData problem);
425149fb536SJames Wright 
426149fb536SJames Wright // -----------------------------------------------------------------------------
427149fb536SJames Wright // SGS Data-Driven Training via SmartSim
428149fb536SJames Wright // -----------------------------------------------------------------------------
4290c373b74SJames Wright PetscErrorCode SmartSimSetup(Honee honee);
430149fb536SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
431e3663b90SJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, Honee honee, ProblemData problem);
432149fb536SJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
433149fb536SJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
434149fb536SJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
4358c85b835SJames Wright 
4368c85b835SJames Wright // -----------------------------------------------------------------------------
4378c85b835SJames Wright // Divergence of Diffusive Flux Projection
4388c85b835SJames Wright // -----------------------------------------------------------------------------
4390c373b74SJames Wright PetscErrorCode DivDiffFluxProjectionCreate(Honee honee, PetscInt num_diff_flux_comps, DivDiffFluxProjectionData *pdiff_flux_proj);
4400880fbb6SJames Wright PetscErrorCode DivDiffFluxProjectionGetOperatorFieldData(DivDiffFluxProjectionData diff_flux_proj, CeedElemRestriction *elem_restr, CeedBasis *basis,
4410880fbb6SJames Wright                                                          CeedVector *vector, CeedEvalMode *eval_mode);
442e3663b90SJames Wright PetscErrorCode DivDiffFluxProjectionSetup(Honee honee, DivDiffFluxProjectionData diff_flux_proj);
44336038bbcSJames Wright PetscErrorCode DivDiffFluxProjectionApply(DivDiffFluxProjectionData diff_flux_proj, Vec Q_loc);
4448c85b835SJames Wright PetscErrorCode DivDiffFluxProjectionDataDestroy(DivDiffFluxProjectionData diff_flux_proj);
44525125139SJames Wright 
44625125139SJames Wright PetscErrorCode SetupMontiorTotalKineticEnergy(TS ts, PetscViewerAndFormat *ctx);
44725125139SJames Wright PetscErrorCode TSMonitor_TotalKineticEnergy(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
44887fd7f33SJames Wright 
44987fd7f33SJames Wright PetscErrorCode SetupMontiorCfl(TS ts, PetscViewerAndFormat *ctx);
45087fd7f33SJames Wright PetscErrorCode TSMonitor_Cfl(TS ts, PetscInt step, PetscReal solution_time, Vec Q, PetscViewerAndFormat *ctx);
45116cb6b6bSJames Wright 
45216cb6b6bSJames Wright PetscErrorCode KSPPostSolve_Honee(KSP ksp, Vec rhs, Vec x, void *ctx);
453