xref: /honee/include/navierstokes.h (revision 5f636aea165df8f29c894386258db4ad81178b28)
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>
793ca29b6SJames Wright #include <honee-file.h>
8149fb536SJames Wright #include <log_events.h>
9149fb536SJames Wright #include <mat-ceed.h>
10149fb536SJames Wright #include <petsc-ceed-utils.h>
11149fb536SJames Wright #include <petscts.h>
12149fb536SJames Wright #include <stdbool.h>
13149fb536SJames Wright 
14149fb536SJames Wright #include <petsc_ops.h>
15149fb536SJames Wright #include "../qfunctions/newtonian_types.h"
16149fb536SJames Wright 
17149fb536SJames Wright #if PETSC_VERSION_LT(3, 21, 0)
18149fb536SJames Wright #error "PETSc v3.21 or later is required"
19149fb536SJames Wright #endif
20149fb536SJames Wright 
21149fb536SJames Wright // -----------------------------------------------------------------------------
22149fb536SJames Wright // Enums
23149fb536SJames Wright // -----------------------------------------------------------------------------
24149fb536SJames Wright 
25149fb536SJames Wright // Euler - test cases
26149fb536SJames Wright typedef enum {
27149fb536SJames Wright   EULER_TEST_ISENTROPIC_VORTEX = 0,
28149fb536SJames Wright   EULER_TEST_1                 = 1,
29149fb536SJames Wright   EULER_TEST_2                 = 2,
30149fb536SJames Wright   EULER_TEST_3                 = 3,
31149fb536SJames Wright   EULER_TEST_4                 = 4,
32149fb536SJames Wright   EULER_TEST_5                 = 5,
33149fb536SJames Wright } EulerTestType;
34149fb536SJames Wright static const char *const EulerTestTypes[] = {"ISENTROPIC_VORTEX", "1", "2", "3", "4", "5", "EulerTestType", "EULER_TEST_", NULL};
35149fb536SJames Wright 
36149fb536SJames Wright // Advection - Wind types
37*5f636aeaSJames Wright static const char *const AdvDifWindTypes[] = {"ROTATION", "TRANSLATION", "WindType", "ADVDIF_WIND_", NULL};
38149fb536SJames Wright 
39149fb536SJames Wright // Advection - Initial Condition Types
40*5f636aeaSJames Wright static const char *const AdvDifICTypes[] = {"SPHERE", "CYLINDER", "COSINE_HILL", "SKEW", "WAVE", "AdvectionICType", "ADVDIF_IC_", NULL};
41a62be6baSJames Wright 
42a62be6baSJames Wright // Advection - Wave Types
43a62be6baSJames Wright static const char *const AdvDifWaveTypes[] = {"SINE", "SQUARE", "AdvDifWaveType", "ADVDIF_WAVE_", NULL};
44149fb536SJames Wright 
45149fb536SJames Wright // Advection - Bubble Continuity Types
46*5f636aeaSJames Wright static const char *const AdvDifBubbleContinuityTypes[] = {
47*5f636aeaSJames Wright     "SMOOTH", "BACK_SHARP", "THICK", "COSINE", "BubbleContinuityType", "ADVDIF_BUBBLE_CONTINUITY_", NULL};
48149fb536SJames Wright 
49149fb536SJames Wright // Stabilization methods
50149fb536SJames Wright static const char *const StabilizationTypes[] = {"NONE", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
51149fb536SJames Wright 
52149fb536SJames Wright // Stabilization tau constants
533a9e4118SJames Wright static const char *const StabilizationTauTypes[] = {"CTAU", "ADVDIFF_SHAKIB", "StabilizationTauType", "STAB_TAU_", NULL};
54149fb536SJames Wright 
55149fb536SJames Wright // Test mode type
56149fb536SJames Wright typedef enum {
57149fb536SJames Wright   TESTTYPE_NONE           = 0,
58149fb536SJames Wright   TESTTYPE_SOLVER         = 1,
59149fb536SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
60149fb536SJames Wright   TESTTYPE_DIFF_FILTER    = 3,
61149fb536SJames Wright } TestType;
62149fb536SJames Wright static const char *const TestTypes[] = {"NONE", "SOLVER", "TURB_SPANSTATS", "DIFF_FILTER", "TestType", "TESTTYPE_", NULL};
63149fb536SJames Wright 
64149fb536SJames Wright // Subgrid-Stress mode type
65149fb536SJames Wright typedef enum {
66149fb536SJames Wright   SGS_MODEL_NONE        = 0,
67149fb536SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
68149fb536SJames Wright } SGSModelType;
69149fb536SJames Wright static const char *const SGSModelTypes[] = {"NONE", "DATA_DRIVEN", "SGSModelType", "SGS_MODEL_", NULL};
70149fb536SJames Wright 
71149fb536SJames Wright // Subgrid-Stress mode type
72149fb536SJames Wright typedef enum {
73149fb536SJames Wright   SGS_MODEL_DD_FUSED           = 0,
74149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_CEED  = 1,
75149fb536SJames Wright   SGS_MODEL_DD_SEQENTIAL_TORCH = 2,
76149fb536SJames Wright } SGSModelDDImplementation;
77149fb536SJames Wright static const char *const SGSModelDDImplementations[] = {"FUSED", "SEQUENTIAL_CEED", "SEQUENTIAL_TORCH", "SGSModelDDImplementation", "SGS_MODEL_DD_",
78149fb536SJames Wright                                                         NULL};
79149fb536SJames Wright 
80149fb536SJames Wright // Mesh transformation type
81149fb536SJames Wright typedef enum {
82149fb536SJames Wright   MESH_TRANSFORM_NONE      = 0,
83149fb536SJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
84149fb536SJames Wright } MeshTransformType;
85149fb536SJames Wright static const char *const MeshTransformTypes[] = {"NONE", "PLATEMESH", "MeshTransformType", "MESH_TRANSFORM_", NULL};
86149fb536SJames Wright 
87149fb536SJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
88149fb536SJames Wright     "NONE", "VAN_DRIEST", "MMS", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
89149fb536SJames Wright 
908c85b835SJames Wright static const char *const DivDiffFluxProjectionMethods[] = {"NONE", "DIRECT", "INDIRECT", "DivDiffFluxProjectionMethod", "DIV_DIFF_FLUX_PROJ_", NULL};
918c85b835SJames Wright 
92149fb536SJames Wright // -----------------------------------------------------------------------------
93149fb536SJames Wright // Structs
94149fb536SJames Wright // -----------------------------------------------------------------------------
95149fb536SJames Wright // Structs declarations
96149fb536SJames Wright typedef struct AppCtx_private      *AppCtx;
97149fb536SJames Wright typedef struct CeedData_private    *CeedData;
98149fb536SJames Wright typedef struct User_private        *User;
99149fb536SJames Wright typedef struct Units_private       *Units;
100149fb536SJames Wright typedef struct SimpleBC_private    *SimpleBC;
101149fb536SJames Wright typedef struct Physics_private     *Physics;
102149fb536SJames Wright typedef struct ProblemData_private *ProblemData;
103149fb536SJames Wright 
104149fb536SJames Wright // Application context from user command line options
105149fb536SJames Wright struct AppCtx_private {
106149fb536SJames Wright   // libCEED arguments
107149fb536SJames Wright   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
108149fb536SJames Wright   PetscInt degree;
109149fb536SJames Wright   PetscInt q_extra;
110149fb536SJames Wright   // Solver arguments
111149fb536SJames Wright   MatType amat_type;
112149fb536SJames Wright   // Post-processing arguments
113149fb536SJames Wright   PetscInt  checkpoint_interval;
114149fb536SJames Wright   PetscInt  viz_refine;
115149fb536SJames Wright   PetscInt  cont_steps;
116149fb536SJames Wright   PetscReal cont_time;
117149fb536SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
118149fb536SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
119149fb536SJames Wright   char      output_dir[PETSC_MAX_PATH_LEN];
120149fb536SJames Wright   PetscBool add_stepnum2bin;
121149fb536SJames Wright   PetscBool checkpoint_vtk;
122149fb536SJames Wright   // Problem type arguments
123149fb536SJames Wright   PetscFunctionList problems;
124149fb536SJames Wright   char              problem_name[PETSC_MAX_PATH_LEN];
125149fb536SJames Wright   // Test mode arguments
126149fb536SJames Wright   TestType    test_type;
127149fb536SJames Wright   PetscScalar test_tol;
128149fb536SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
129149fb536SJames Wright   // Turbulent spanwise statistics
130149fb536SJames Wright   PetscBool         turb_spanstats_enable;
131149fb536SJames Wright   PetscInt          turb_spanstats_collect_interval;
132149fb536SJames Wright   PetscInt          turb_spanstats_viewer_interval;
133149fb536SJames Wright   PetscViewer       turb_spanstats_viewer;
134149fb536SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
135149fb536SJames Wright   // Wall forces
136149fb536SJames Wright   struct {
137149fb536SJames Wright     PetscInt          num_wall;
138149fb536SJames Wright     PetscInt         *walls;
139149fb536SJames Wright     PetscViewer       viewer;
140149fb536SJames Wright     PetscViewerFormat viewer_format;
141149fb536SJames Wright     PetscBool         header_written;
142149fb536SJames Wright   } wall_forces;
143149fb536SJames Wright   // Subgrid Stress Model
144149fb536SJames Wright   SGSModelType sgs_model_type;
145149fb536SJames Wright   PetscBool    sgs_train_enable;
146149fb536SJames Wright   // Differential Filtering
147149fb536SJames Wright   PetscBool         diff_filter_monitor;
148149fb536SJames Wright   MeshTransformType mesh_transform_type;
1498c85b835SJames Wright   // Divergence of Diffusive Flux Projection
1508c85b835SJames Wright   DivDiffFluxProjectionMethod divFdiffproj_method;
151149fb536SJames Wright };
152149fb536SJames Wright 
153149fb536SJames Wright // libCEED data struct
154149fb536SJames Wright struct CeedData_private {
155be29160dSJames Wright   CeedVector           x_coord;
156149fb536SJames Wright   CeedBasis            basis_x, basis_q;
157be29160dSJames Wright   CeedElemRestriction  elem_restr_x, elem_restr_q;
158149fb536SJames Wright   OperatorApplyContext op_ics_ctx;
159149fb536SJames Wright };
160149fb536SJames Wright 
161149fb536SJames Wright typedef struct {
162149fb536SJames Wright   DM                    dm;
163149fb536SJames Wright   PetscSF               sf;  // For communicating child data to parents
164149fb536SJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
165149fb536SJames Wright   PetscInt              num_comp_stats;
166149fb536SJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
167149fb536SJames Wright   KSP                   ksp;         // For the L^2 projection solve
168149fb536SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
169149fb536SJames Wright   PetscBool             do_mms_test;
170149fb536SJames Wright   OperatorApplyContext  mms_error_ctx;
171149fb536SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
172149fb536SJames Wright } SpanStatsData;
173149fb536SJames Wright 
174149fb536SJames Wright typedef struct {
175149fb536SJames Wright   DM                   dm;
176149fb536SJames Wright   PetscInt             num_comp;
177149fb536SJames Wright   OperatorApplyContext l2_rhs_ctx;
178149fb536SJames Wright   KSP                  ksp;
179149fb536SJames Wright } *NodalProjectionData;
180149fb536SJames Wright 
18136038bbcSJames Wright typedef struct DivDiffFluxProjectionData_private *DivDiffFluxProjectionData;
18236038bbcSJames Wright 
18336038bbcSJames Wright struct DivDiffFluxProjectionData_private {
1848c85b835SJames Wright   PetscInt                    num_diff_flux_comps;
1858c85b835SJames Wright   DivDiffFluxProjectionMethod method;
1868c85b835SJames Wright   NodalProjectionData         projection;
18736038bbcSJames Wright 
18836038bbcSJames Wright   // CeedOperator Objects
18936038bbcSJames Wright   CeedElemRestriction elem_restr_div_diff_flux;
19036038bbcSJames Wright   CeedBasis           basis_div_diff_flux;
19136038bbcSJames Wright   CeedEvalMode        eval_mode_div_diff_flux;
1928c85b835SJames Wright   CeedVector          div_diff_flux_ceed;
19336038bbcSJames Wright 
19436038bbcSJames Wright   // Problem specific setup functions
19536038bbcSJames Wright   PetscErrorCode (*CreateRHSOperator_Direct)(User, CeedData, DivDiffFluxProjectionData, CeedOperator *);
19636038bbcSJames Wright   PetscErrorCode (*CreateRHSOperator_Indirect)(User, CeedData, DivDiffFluxProjectionData, CeedOperator *);
19736038bbcSJames Wright 
1988c85b835SJames Wright   // Only used for direct method:
1998c85b835SJames Wright   Vec          DivDiffFlux_loc;
2008c85b835SJames Wright   PetscMemType DivDiffFlux_memtype;
2018c85b835SJames Wright   PetscBool    ceed_vec_has_array;
20236038bbcSJames Wright 
20336038bbcSJames Wright   // Only used for indirect method:
20436038bbcSJames Wright   OperatorApplyContext calc_div_diff_flux;
20536038bbcSJames Wright };
2068c85b835SJames Wright 
207149fb536SJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
208149fb536SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
209149fb536SJames Wright typedef struct {
210149fb536SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
211149fb536SJames Wright   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
212149fb536SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
213149fb536SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
214149fb536SJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
215149fb536SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
216149fb536SJames Wright   void                     *sgs_nodal_inference_ctx;
217149fb536SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
218149fb536SJames Wright } *SgsDDData;
219149fb536SJames Wright 
220149fb536SJames Wright typedef struct {
221149fb536SJames Wright   DM                   dm_dd_training;
222149fb536SJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval, num_filter_widths;
223149fb536SJames Wright   PetscScalar          filter_widths[16];
224149fb536SJames Wright   OperatorApplyContext op_training_data_calc_ctx;
225149fb536SJames Wright   NodalProjectionData  filtered_grad_velo_proj;
226149fb536SJames Wright   size_t               training_data_array_dims[2];
227149fb536SJames Wright   PetscBool            overwrite_training_data;
228149fb536SJames Wright } *SGS_DD_TrainingData;
229149fb536SJames Wright 
230149fb536SJames Wright typedef struct {
231149fb536SJames Wright   DM                    dm_filter;
232149fb536SJames Wright   PetscInt              num_filtered_fields;
233149fb536SJames Wright   CeedInt              *num_field_components;
234149fb536SJames Wright   PetscInt              field_prim_state, field_velo_prod;
235149fb536SJames Wright   OperatorApplyContext  op_rhs_ctx;
236149fb536SJames Wright   KSP                   ksp;
237149fb536SJames Wright   PetscObjectState      X_loc_state;
238149fb536SJames Wright   PetscBool             do_mms_test;
239149fb536SJames Wright   CeedContextFieldLabel filter_width_scaling_label;
240149fb536SJames Wright } *DiffFilterData;
241149fb536SJames Wright 
242149fb536SJames Wright typedef struct {
243149fb536SJames Wright   void    *client;
244149fb536SJames Wright   char     rank_id_name[16];
245149fb536SJames Wright   PetscInt collocated_database_num_ranks;
246149fb536SJames Wright } *SmartSimData;
247149fb536SJames Wright 
248149fb536SJames Wright // PETSc user data
249149fb536SJames Wright struct User_private {
250149fb536SJames Wright   MPI_Comm                  comm;
251149fb536SJames Wright   DM                        dm;
252149fb536SJames Wright   DM                        dm_viz;
253149fb536SJames Wright   Mat                       interp_viz;
254149fb536SJames Wright   Ceed                      ceed;
255149fb536SJames Wright   Units                     units;
256149fb536SJames Wright   Vec                       Q_loc, Q_dot_loc;
257149fb536SJames Wright   Physics                   phys;
258149fb536SJames Wright   AppCtx                    app_ctx;
259149fb536SJames Wright   CeedVector                q_ceed, q_dot_ceed, g_ceed, x_ceed;
260149fb536SJames Wright   CeedOperator              op_ifunction;
261149fb536SJames Wright   Mat                       mat_ijacobian;
262149fb536SJames Wright   KSP                       mass_ksp;
263149fb536SJames Wright   OperatorApplyContext      op_rhs_ctx, op_strong_bc_ctx;
264149fb536SJames Wright   CeedScalar                time_bc_set;
265149fb536SJames Wright   SpanStatsData             spanstats;
266149fb536SJames Wright   NodalProjectionData       grad_velo_proj;
267149fb536SJames Wright   SgsDDData                 sgs_dd_data;
268149fb536SJames Wright   DiffFilterData            diff_filter;
269149fb536SJames Wright   SmartSimData              smartsim;
270149fb536SJames Wright   SGS_DD_TrainingData       sgs_dd_train;
2718c85b835SJames Wright   DivDiffFluxProjectionData diff_flux_proj;
272149fb536SJames Wright };
273149fb536SJames Wright 
274149fb536SJames Wright // Units
275149fb536SJames Wright struct Units_private {
276149fb536SJames Wright   // fundamental units
277149fb536SJames Wright   PetscScalar meter;
278149fb536SJames Wright   PetscScalar kilogram;
279149fb536SJames Wright   PetscScalar second;
280149fb536SJames Wright   PetscScalar Kelvin;
281149fb536SJames Wright   // derived units
282149fb536SJames Wright   PetscScalar Pascal;
283149fb536SJames Wright   PetscScalar J_per_kg_K;
284149fb536SJames Wright   PetscScalar m_per_squared_s;
285149fb536SJames Wright   PetscScalar W_per_m_K;
286149fb536SJames Wright   PetscScalar Joule;
287149fb536SJames Wright };
288149fb536SJames Wright 
289149fb536SJames Wright // Boundary conditions
290149fb536SJames Wright struct SimpleBC_private {
291149fb536SJames Wright   PetscInt num_inflow, num_outflow, num_freestream, num_slip;
292149fb536SJames Wright   PetscInt inflows[16], outflows[16], freestreams[16], slips[16];
293149fb536SJames Wright };
294149fb536SJames Wright 
295149fb536SJames Wright // Struct that contains all enums and structs used for the physics of all problems
296149fb536SJames Wright struct Physics_private {
297149fb536SJames Wright   PetscBool             implicit;
298149fb536SJames Wright   StateVariable         state_var;
299149fb536SJames Wright   CeedContextFieldLabel solution_time_label;
300149fb536SJames Wright   CeedContextFieldLabel stg_solution_time_label;
301149fb536SJames Wright   CeedContextFieldLabel timestep_size_label;
302149fb536SJames Wright   CeedContextFieldLabel ics_time_label;
303149fb536SJames Wright };
304149fb536SJames Wright 
305149fb536SJames Wright PetscErrorCode BoundaryConditionSetUp(User user, ProblemData problem, AppCtx app_ctx, SimpleBC bc);
306149fb536SJames Wright 
307149fb536SJames Wright typedef struct {
308e07531f7SJames Wright   CeedQFunctionUser    qf_func_ptr;  // !< QFunction function pointer
309e07531f7SJames Wright   const char          *qf_loc;       // !< Absolute path to QFunction source file
310e07531f7SJames Wright   CeedQFunctionContext qfctx;        // !< QFunctionContext to attach to QFunction
311149fb536SJames Wright } ProblemQFunctionSpec;
312149fb536SJames Wright 
313149fb536SJames Wright // Problem specific data
314149fb536SJames Wright struct ProblemData_private {
31528160fc2SJames Wright   CeedInt              jac_data_size_vol, jac_data_size_sur;
316149fb536SJames Wright   ProblemQFunctionSpec ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow, apply_freestream, apply_slip,
317149fb536SJames Wright       apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian, apply_slip_jacobian;
318149fb536SJames Wright   bool          compute_exact_solution_error;
31928160fc2SJames Wright   PetscBool     set_bc_from_ics, use_strong_bc_ceed;
320149fb536SJames Wright   size_t        num_bc_defs;
321149fb536SJames Wright   BCDefinition *bc_defs;
322149fb536SJames Wright   PetscErrorCode (*print_info)(User, ProblemData, AppCtx);
323149fb536SJames Wright   PetscErrorCode (*create_mass_operator)(User, CeedOperator *);
324149fb536SJames Wright };
325149fb536SJames Wright 
326149fb536SJames Wright extern int FreeContextPetsc(void *);
327149fb536SJames Wright 
328149fb536SJames Wright // -----------------------------------------------------------------------------
329149fb536SJames Wright // Set up problems
330149fb536SJames Wright // -----------------------------------------------------------------------------
331149fb536SJames Wright // Set up function for each problem
332149fb536SJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
333149fb536SJames Wright extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
334149fb536SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
335149fb536SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
336149fb536SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
337149fb536SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
338149fb536SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
339149fb536SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
340149fb536SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
341149fb536SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
342149fb536SJames Wright 
343149fb536SJames Wright // Print function for each problem
344149fb536SJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData problem, AppCtx app_ctx);
345149fb536SJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData problem, AppCtx app_ctx);
346149fb536SJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData problem, AppCtx app_ctx);
347149fb536SJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData problem, AppCtx app_ctx);
348149fb536SJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData problem, AppCtx app_ctx);
349149fb536SJames Wright 
350149fb536SJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData problem, TS ts);
351149fb536SJames Wright 
352149fb536SJames Wright // -----------------------------------------------------------------------------
353149fb536SJames Wright // libCEED functions
354149fb536SJames Wright // -----------------------------------------------------------------------------
355149fb536SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
356149fb536SJames Wright                                                CeedElemRestriction *restriction);
357149fb536SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
358149fb536SJames Wright                                                          CeedElemRestriction *restriction);
359149fb536SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
360149fb536SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
361149fb536SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
362149fb536SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
363149fb536SJames Wright 
364149fb536SJames Wright PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3658c85b835SJames Wright PetscErrorCode CreateCoordinateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, CeedBasis *basis);
36621ba7ba4SJames Wright PetscErrorCode DMPlexCeedBasisCellToFaceCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt face,
36721ba7ba4SJames Wright                                                          CeedBasis *basis);
36821ba7ba4SJames Wright PetscErrorCode DMPlexCeedBasisCellToFaceCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt face, PetscInt dm_field,
36921ba7ba4SJames Wright                                                CeedBasis *basis);
3705f65e1a7SJames Wright PetscErrorCode DMPlexCreateFaceLabel(DM dm, PetscInt dm_face, char **face_label_name);
3715f65e1a7SJames Wright PetscErrorCode DMLabelCreateGlobalValueArray(DM dm, DMLabel label, PetscInt *num_values, PetscInt **value_array);
372149fb536SJames Wright 
373149fb536SJames Wright PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData problem, SimpleBC bc);
374149fb536SJames Wright 
375149fb536SJames Wright PetscErrorCode QDataGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
376149fb536SJames Wright                         CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
377149fb536SJames Wright PetscErrorCode QDataGetNumComponents(DM dm, CeedInt *q_data_size);
378149fb536SJames Wright PetscErrorCode QDataBoundaryGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
379149fb536SJames Wright                                 CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
380149fb536SJames Wright PetscErrorCode QDataBoundaryGetNumComponents(DM dm, CeedInt *q_data_size);
3818c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGetNumComponents(DM dm, CeedInt *q_data_size);
3828c85b835SJames Wright PetscErrorCode QDataBoundaryGradientGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedVector x_coord,
38300dbc7b1SJames Wright                                         CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
384e816a7e4SJames Wright PetscErrorCode QDataClearStoredData();
385149fb536SJames Wright // -----------------------------------------------------------------------------
386149fb536SJames Wright // Time-stepping functions
387149fb536SJames Wright // -----------------------------------------------------------------------------
388149fb536SJames Wright PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
389149fb536SJames Wright PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
390149fb536SJames Wright PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
391149fb536SJames Wright PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, ProblemData problem, Vec *Q, PetscScalar *f_time, TS *ts);
392149fb536SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
393149fb536SJames Wright 
394149fb536SJames Wright // -----------------------------------------------------------------------------
395149fb536SJames Wright // Setup DM
396149fb536SJames Wright // -----------------------------------------------------------------------------
397149fb536SJames Wright PetscErrorCode CreateDM(MPI_Comm comm, ProblemData problem, MatType, VecType, DM *dm);
398149fb536SJames Wright PetscErrorCode SetUpDM(DM dm, ProblemData problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
3994cb09fddSJames Wright PetscErrorCode VizRefineDM(DM dm, User user, ProblemData problem, SimpleBC bc, Physics phys);
4004cb09fddSJames Wright 
401149fb536SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
402149fb536SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
403149fb536SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
404149fb536SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
405149fb536SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
406149fb536SJames Wright 
407149fb536SJames Wright // -----------------------------------------------------------------------------
408149fb536SJames Wright // Process command line options
409149fb536SJames Wright // -----------------------------------------------------------------------------
410149fb536SJames Wright PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
411149fb536SJames Wright PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
41259572072SJames Wright PetscErrorCode HoneeOptionsSetValueDefault(PetscOptions options, const char name[], const char value[]);
413149fb536SJames Wright 
414149fb536SJames Wright // -----------------------------------------------------------------------------
415149fb536SJames Wright // Miscellaneous utility functions
416149fb536SJames Wright // -----------------------------------------------------------------------------
417149fb536SJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
418149fb536SJames Wright                                       PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity,
419149fb536SJames Wright                                       CeedVector *inv_multiplicity);
420149fb536SJames Wright PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
421149fb536SJames Wright 
422149fb536SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
423149fb536SJames Wright                                                   Vec grad_FVM);
424149fb536SJames Wright 
425149fb536SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
426149fb536SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
427149fb536SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData problem, User user, Vec Q, PetscScalar final_time);
428149fb536SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
429149fb536SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
430149fb536SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
431149fb536SJames Wright 
432149fb536SJames Wright // -----------------------------------------------------------------------------
433149fb536SJames Wright // Turbulence Statistics Collection Functions
434149fb536SJames Wright // -----------------------------------------------------------------------------
435149fb536SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
436149fb536SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
437149fb536SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
438149fb536SJames Wright 
439149fb536SJames Wright // -----------------------------------------------------------------------------
440149fb536SJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
441149fb536SJames Wright // -----------------------------------------------------------------------------
442149fb536SJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
443149fb536SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
444149fb536SJames Wright PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
445149fb536SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem, StateVariable state_var_input,
446149fb536SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
447149fb536SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
448149fb536SJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
449149fb536SJames Wright                                                         CeedVector *grid_aniso_vector);
450149fb536SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
451149fb536SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
452149fb536SJames Wright 
453149fb536SJames Wright // -----------------------------------------------------------------------------
454149fb536SJames Wright // Boundary Condition Related Functions
455149fb536SJames Wright // -----------------------------------------------------------------------------
456149fb536SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData problem, SimpleBC bc);
457149fb536SJames Wright PetscErrorCode FreestreamBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
458149fb536SJames Wright PetscErrorCode OutflowBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
459149fb536SJames Wright PetscErrorCode SlipBCSetup(ProblemData problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
460149fb536SJames Wright 
461149fb536SJames Wright // -----------------------------------------------------------------------------
462149fb536SJames Wright // Differential Filtering Functions
463149fb536SJames Wright // -----------------------------------------------------------------------------
464149fb536SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
465149fb536SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
466149fb536SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
467149fb536SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
468149fb536SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData problem);
469149fb536SJames Wright 
470149fb536SJames Wright // -----------------------------------------------------------------------------
471149fb536SJames Wright // SGS Data-Driven Training via SmartSim
472149fb536SJames Wright // -----------------------------------------------------------------------------
473149fb536SJames Wright PetscErrorCode SmartSimSetup(User user);
474149fb536SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
475149fb536SJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
476149fb536SJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
477149fb536SJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
478149fb536SJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
4798c85b835SJames Wright 
4808c85b835SJames Wright // -----------------------------------------------------------------------------
4818c85b835SJames Wright // Divergence of Diffusive Flux Projection
4828c85b835SJames Wright // -----------------------------------------------------------------------------
48336038bbcSJames Wright PetscErrorCode DivDiffFluxProjectionCreate(User user, PetscInt num_diff_flux_comps, DivDiffFluxProjectionData *pdiff_flux_proj);
4840880fbb6SJames Wright PetscErrorCode DivDiffFluxProjectionGetOperatorFieldData(DivDiffFluxProjectionData diff_flux_proj, CeedElemRestriction *elem_restr, CeedBasis *basis,
4850880fbb6SJames Wright                                                          CeedVector *vector, CeedEvalMode *eval_mode);
4868561fee2SJames Wright PetscErrorCode DivDiffFluxProjectionSetup(User user, CeedData ceed_data, DivDiffFluxProjectionData diff_flux_proj);
48736038bbcSJames Wright PetscErrorCode DivDiffFluxProjectionApply(DivDiffFluxProjectionData diff_flux_proj, Vec Q_loc);
4888c85b835SJames Wright PetscErrorCode DivDiffFluxProjectionDataDestroy(DivDiffFluxProjectionData diff_flux_proj);
489