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