xref: /libCEED/examples/fluids/navierstokes.h (revision de327db462e8afadb04b2fd99bdb39cfb29a1d98)
15aed82e4SJeremy L Thompson // Copyright (c) 2017-2024, Lawrence Livermore National Security, LLC and other CEED contributors.
23d8e8822SJeremy L Thompson // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
377841947SLeila Ghaffari //
43d8e8822SJeremy L Thompson // SPDX-License-Identifier: BSD-2-Clause
577841947SLeila Ghaffari //
63d8e8822SJeremy L Thompson // This file is part of CEED:  http://github.com/ceed
724a65d3dSJeremy L Thompson #pragma once
877841947SLeila Ghaffari 
977841947SLeila Ghaffari #include <ceed.h>
10a8748852SJames Wright #include <bc_definition.h>
119d992146SJames Wright #include <log_events.h>
1291c97f41SJames Wright #include <mat-ceed.h>
135037d55dSJames Wright #include <petsc-ceed-utils.h>
1477841947SLeila Ghaffari #include <petscts.h>
1577841947SLeila Ghaffari #include <stdbool.h>
162b730f8bSJeremy L Thompson 
174021610dSJames Wright #include "./include/petsc_ops.h"
1897baf651SJames Wright #include "qfunctions/newtonian_types.h"
1977841947SLeila Ghaffari 
2049a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0)
21fd9d666bSJames Wright #error "PETSc v3.21 or later is required"
2249a40c8aSKenneth E. Jansen #endif
2349a40c8aSKenneth E. Jansen 
2477841947SLeila Ghaffari // -----------------------------------------------------------------------------
2577841947SLeila Ghaffari // Enums
2677841947SLeila Ghaffari // -----------------------------------------------------------------------------
2777841947SLeila Ghaffari 
2877841947SLeila Ghaffari // Euler - test cases
2977841947SLeila Ghaffari typedef enum {
30bc7bbd5dSLeila Ghaffari   EULER_TEST_ISENTROPIC_VORTEX = 0,
3177841947SLeila Ghaffari   EULER_TEST_1                 = 1,
3277841947SLeila Ghaffari   EULER_TEST_2                 = 2,
3377841947SLeila Ghaffari   EULER_TEST_3                 = 3,
3477841947SLeila Ghaffari   EULER_TEST_4                 = 4,
3532f166c6SLeila Ghaffari   EULER_TEST_5                 = 5,
3677841947SLeila Ghaffari } EulerTestType;
372b730f8bSJeremy L Thompson static const char *const EulerTestTypes[] = {"isentropic_vortex", "test_1",      "test_2", "test_3", "test_4", "test_5",
382b730f8bSJeremy L Thompson                                              "EulerTestType",     "EULER_TEST_", NULL};
3977841947SLeila Ghaffari 
40700ae941SJames Wright // Advection - Wind types
41700ae941SJames Wright static const char *const WindTypes[] = {"rotation", "translation", "WindType", "WIND_", NULL};
42700ae941SJames Wright 
437b77ddfdSJames Wright // Advection - Initial Condition Types
447b77ddfdSJames Wright static const char *const AdvectionICTypes[] = {"sphere", "cylinder", "cosine_hill", "skew", "AdvectionICType", "ADVECTIONIC_", NULL};
45700ae941SJames Wright 
46700ae941SJames Wright // Advection - Bubble Continuity Types
4793639ffbSJames Wright static const char *const BubbleContinuityTypes[] = {"smooth", "back_sharp", "thick", "cosine", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL};
48700ae941SJames Wright 
4977841947SLeila Ghaffari // Stabilization methods
502b730f8bSJeremy L Thompson static const char *const StabilizationTypes[] = {"none", "SU", "SUPG", "StabilizationType", "STAB_", NULL};
5177841947SLeila Ghaffari 
52b18328c4SJames Wright // Stabilization tau constants
53b18328c4SJames Wright static const char *const StabilizationTauTypes[] = {"Ctau", "AdvDiff_Shakib", "AdvDiff_Shakib_P", "StabilizationTauType", "STAB_TAU_", NULL};
54b18328c4SJames Wright 
5551b00d91SJames Wright // Test mode type
568fb33541SJames Wright typedef enum {
578fb33541SJames Wright   TESTTYPE_NONE           = 0,
588fb33541SJames Wright   TESTTYPE_SOLVER         = 1,
598fb33541SJames Wright   TESTTYPE_TURB_SPANSTATS = 2,
60970fa48bSJames Wright   TESTTYPE_DIFF_FILTER    = 3,
618fb33541SJames Wright } TestType;
62970fa48bSJames Wright static const char *const TestTypes[] = {"none", "solver", "turb_spanstats", "diff_filter", "TestType", "TESTTYPE_", NULL};
638fb33541SJames Wright 
642526956eSJames Wright // Subgrid-Stress mode type
6519ffbc25SJames Wright typedef enum {
6619ffbc25SJames Wright   SGS_MODEL_NONE        = 0,
6719ffbc25SJames Wright   SGS_MODEL_DATA_DRIVEN = 1,
6819ffbc25SJames Wright } SGSModelType;
6919ffbc25SJames Wright static const char *const SGSModelTypes[] = {"none", "data_driven", "SGSModelType", "SGS_MODEL_", NULL};
7019ffbc25SJames Wright 
71013a5551SJames Wright // Subgrid-Stress mode type
72013a5551SJames Wright typedef enum {
73013a5551SJames Wright   SGS_MODEL_DD_FUSED           = 0,
74013a5551SJames Wright   SGS_MODEL_DD_SEQENTIAL_CEED  = 1,
75013a5551SJames Wright   SGS_MODEL_DD_SEQENTIAL_TORCH = 2,
76013a5551SJames Wright } SGSModelDDImplementation;
77013a5551SJames Wright static const char *const SGSModelDDImplementations[] = {"fused", "sequential_ceed", "sequential_torch", "SGSModelDDImplementation", "SGS_MODEL_DD_",
78013a5551SJames Wright                                                         NULL};
79013a5551SJames Wright 
802526956eSJames Wright // Mesh transformation type
812526956eSJames Wright typedef enum {
822526956eSJames Wright   MESH_TRANSFORM_NONE      = 0,
832526956eSJames Wright   MESH_TRANSFORM_PLATEMESH = 1,
842526956eSJames Wright } MeshTransformType;
852526956eSJames Wright static const char *const MeshTransformTypes[] = {"none", "platemesh", "MeshTransformType", "MESH_TRANSFORM_", NULL};
862526956eSJames Wright 
87bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = {
88bd882c8aSJames Wright     "none", "van_driest", "mms", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL};
89bd882c8aSJames Wright 
9077841947SLeila Ghaffari // -----------------------------------------------------------------------------
9177841947SLeila Ghaffari // Structs
9277841947SLeila Ghaffari // -----------------------------------------------------------------------------
9377841947SLeila Ghaffari // Structs declarations
9477841947SLeila Ghaffari typedef struct AppCtx_private      *AppCtx;
9577841947SLeila Ghaffari typedef struct CeedData_private    *CeedData;
9677841947SLeila Ghaffari typedef struct User_private        *User;
9777841947SLeila Ghaffari typedef struct Units_private       *Units;
9877841947SLeila Ghaffari typedef struct SimpleBC_private    *SimpleBC;
9977841947SLeila Ghaffari typedef struct Physics_private     *Physics;
100a8748852SJames Wright typedef struct ProblemData_private *ProblemData;
10177841947SLeila Ghaffari 
10277841947SLeila Ghaffari // Application context from user command line options
10377841947SLeila Ghaffari struct AppCtx_private {
10477841947SLeila Ghaffari   // libCEED arguments
10577841947SLeila Ghaffari   char     ceed_resource[PETSC_MAX_PATH_LEN];  // libCEED backend
10677841947SLeila Ghaffari   PetscInt degree;
10777841947SLeila Ghaffari   PetscInt q_extra;
108544be873SJed Brown   // Solver arguments
109544be873SJed Brown   MatType amat_type;
11077841947SLeila Ghaffari   // Post-processing arguments
11137cbb16aSJed Brown   PetscInt  checkpoint_interval;
11277841947SLeila Ghaffari   PetscInt  viz_refine;
11377841947SLeila Ghaffari   PetscInt  cont_steps;
1144de8550aSJed Brown   PetscReal cont_time;
11569293791SJames Wright   char      cont_file[PETSC_MAX_PATH_LEN];
11669293791SJames Wright   char      cont_time_file[PETSC_MAX_PATH_LEN];
11777841947SLeila Ghaffari   char      output_dir[PETSC_MAX_PATH_LEN];
11869293791SJames Wright   PetscBool add_stepnum2bin;
11937cbb16aSJed Brown   PetscBool checkpoint_vtk;
12077841947SLeila Ghaffari   // Problem type arguments
12177841947SLeila Ghaffari   PetscFunctionList problems;
12277841947SLeila Ghaffari   char              problem_name[PETSC_MAX_PATH_LEN];
12377841947SLeila Ghaffari   // Test mode arguments
1248fb33541SJames Wright   TestType    test_type;
12577841947SLeila Ghaffari   PetscScalar test_tol;
126b7d66439SJames Wright   char        test_file_path[PETSC_MAX_PATH_LEN];
127b7d66439SJames Wright   // Turbulent spanwise statistics
128b7d66439SJames Wright   PetscBool         turb_spanstats_enable;
129b7d66439SJames Wright   PetscInt          turb_spanstats_collect_interval;
130b7d66439SJames Wright   PetscInt          turb_spanstats_viewer_interval;
131b7d66439SJames Wright   PetscViewer       turb_spanstats_viewer;
132b7d66439SJames Wright   PetscViewerFormat turb_spanstats_viewer_format;
133ca69d878SAdeleke O. Bankole   // Wall forces
134ca69d878SAdeleke O. Bankole   struct {
135ca69d878SAdeleke O. Bankole     PetscInt          num_wall;
136ca69d878SAdeleke O. Bankole     PetscInt         *walls;
137ca69d878SAdeleke O. Bankole     PetscViewer       viewer;
138ca69d878SAdeleke O. Bankole     PetscViewerFormat viewer_format;
139ca69d878SAdeleke O. Bankole     PetscBool         header_written;
140ca69d878SAdeleke O. Bankole   } wall_forces;
14119ffbc25SJames Wright   // Subgrid Stress Model
14219ffbc25SJames Wright   SGSModelType sgs_model_type;
14328134cfaSJames Wright   PetscBool    sgs_train_enable;
1444e9802d1SJames Wright   // Differential Filtering
1454e9802d1SJames Wright   PetscBool         diff_filter_monitor;
1462526956eSJames Wright   MeshTransformType mesh_transform_type;
14777841947SLeila Ghaffari };
14877841947SLeila Ghaffari 
14977841947SLeila Ghaffari // libCEED data struct
15077841947SLeila Ghaffari struct CeedData_private {
15177841947SLeila Ghaffari   CeedVector           x_coord, q_data;
152e9c36be0SJames Wright   CeedBasis            basis_x, basis_q;
15377841947SLeila Ghaffari   CeedElemRestriction  elem_restr_x, elem_restr_q, elem_restr_qd_i;
1545263e9c6SJames Wright   OperatorApplyContext op_ics_ctx;
15577841947SLeila Ghaffari };
15677841947SLeila Ghaffari 
15751ee423eSJames Wright typedef struct {
15851ee423eSJames Wright   DM                    dm;
1591737222fSJames Wright   PetscSF               sf;  // For communicating child data to parents
160ed331efdSJames Wright   OperatorApplyContext  op_stats_collect_ctx, op_proj_rhs_ctx;
16151ee423eSJames Wright   PetscInt              num_comp_stats;
162ed331efdSJames Wright   Vec                   Child_Stats_loc, Parent_Stats_loc;
163a175e481SJames Wright   KSP                   ksp;         // For the L^2 projection solve
164a175e481SJames Wright   CeedScalar            span_width;  // spanwise width of the child domain
165b7d66439SJames Wright   PetscBool             do_mms_test;
1664021610dSJames Wright   OperatorApplyContext  mms_error_ctx;
167495b9769SJames Wright   CeedContextFieldLabel solution_time_label, previous_time_label;
168cbef7084SJames Wright } SpanStatsData;
16951ee423eSJames Wright 
170999ff5c7SJames Wright typedef struct {
171999ff5c7SJames Wright   DM                   dm;
172999ff5c7SJames Wright   PetscInt             num_comp;
173999ff5c7SJames Wright   OperatorApplyContext l2_rhs_ctx;
174999ff5c7SJames Wright   KSP                  ksp;
175999ff5c7SJames Wright } *NodalProjectionData;
176999ff5c7SJames Wright 
1776b3fb9aeSJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc);
1781250e899SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx);
1799a17443dSJames Wright typedef struct {
1801250e899SJames Wright   DM                        dm_sgs, dm_dd_inputs, dm_dd_outputs;
1815f5d6789SAlex Lindsay   PetscInt                  num_comp_sgs, num_comp_inputs, num_comp_outputs;
1821250e899SJames Wright   OperatorApplyContext      op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx;
1831250e899SJames Wright   CeedVector                sgs_nodal_ceed, grad_velo_ceed;
1846b3fb9aeSJames Wright   SgsDDNodalStressEval      sgs_nodal_eval;
1851250e899SJames Wright   SgsDDNodalStressInference sgs_nodal_inference;
1861250e899SJames Wright   void                     *sgs_nodal_inference_ctx;
1871250e899SJames Wright   PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx);
188cbef7084SJames Wright } *SgsDDData;
1899a17443dSJames Wright 
1904e9802d1SJames Wright typedef struct {
191ee3b213aSJames Wright   DM                   dm_dd_training;
192c79b0730SJames Wright   PetscInt             num_comp_dd_inputs, write_data_interval, num_filter_widths;
193c79b0730SJames Wright   PetscScalar          filter_widths[16];
194ee3b213aSJames Wright   OperatorApplyContext op_training_data_calc_ctx;
195ee3b213aSJames Wright   NodalProjectionData  filtered_grad_velo_proj;
196ee3b213aSJames Wright   size_t               training_data_array_dims[2];
197ee3b213aSJames Wright   PetscBool            overwrite_training_data;
198ee3b213aSJames Wright } *SGS_DD_TrainingData;
199ee3b213aSJames Wright 
200ee3b213aSJames Wright typedef struct {
2014e9802d1SJames Wright   DM                    dm_filter;
20281530087SJames Wright   PetscInt              num_filtered_fields;
20381530087SJames Wright   CeedInt              *num_field_components;
204051427eeSJames Wright   PetscInt              field_prim_state, field_velo_prod;
2054e9802d1SJames Wright   OperatorApplyContext  op_rhs_ctx;
2064e9802d1SJames Wright   KSP                   ksp;
20756f5e811SJames Wright   PetscObjectState      X_loc_state;
2082029a677SJames Wright   PetscBool             do_mms_test;
209c79b0730SJames Wright   CeedContextFieldLabel filter_width_scaling_label;
2104e9802d1SJames Wright } *DiffFilterData;
2114e9802d1SJames Wright 
2128146534cSJames Wright typedef struct {
2138146534cSJames Wright   void    *client;
2148146534cSJames Wright   char     rank_id_name[16];
2158146534cSJames Wright   PetscInt collocated_database_num_ranks;
2168146534cSJames Wright } *SmartSimData;
2178146534cSJames Wright 
21877841947SLeila Ghaffari // PETSc user data
21977841947SLeila Ghaffari struct User_private {
22077841947SLeila Ghaffari   MPI_Comm             comm;
22177841947SLeila Ghaffari   DM                   dm;
22277841947SLeila Ghaffari   DM                   dm_viz;
22377841947SLeila Ghaffari   Mat                  interp_viz;
22477841947SLeila Ghaffari   Ceed                 ceed;
22577841947SLeila Ghaffari   Units                units;
22604292f7dSJames Wright   Vec                  Q_loc, Q_dot_loc;
22777841947SLeila Ghaffari   Physics              phys;
22877841947SLeila Ghaffari   AppCtx               app_ctx;
22991c97f41SJames Wright   CeedVector           q_ceed, q_dot_ceed, g_ceed, x_ceed;
230a5b0ec6fSJames Wright   CeedOperator         op_ifunction;
23191c97f41SJames Wright   Mat                  mat_ijacobian;
23204292f7dSJames Wright   KSP                  mass_ksp;
2339ad5e8e4SJames Wright   OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx;
23415637395SJames Wright   CeedScalar           time_bc_set;
235cbef7084SJames Wright   SpanStatsData        spanstats;
236999ff5c7SJames Wright   NodalProjectionData  grad_velo_proj;
237cbef7084SJames Wright   SgsDDData            sgs_dd_data;
2384e9802d1SJames Wright   DiffFilterData       diff_filter;
2398146534cSJames Wright   SmartSimData         smartsim;
240ee3b213aSJames Wright   SGS_DD_TrainingData  sgs_dd_train;
24177841947SLeila Ghaffari };
24277841947SLeila Ghaffari 
24377841947SLeila Ghaffari // Units
24477841947SLeila Ghaffari struct Units_private {
24577841947SLeila Ghaffari   // fundamental units
24677841947SLeila Ghaffari   PetscScalar meter;
24777841947SLeila Ghaffari   PetscScalar kilogram;
24877841947SLeila Ghaffari   PetscScalar second;
24977841947SLeila Ghaffari   PetscScalar Kelvin;
25077841947SLeila Ghaffari   // derived units
25177841947SLeila Ghaffari   PetscScalar Pascal;
25277841947SLeila Ghaffari   PetscScalar J_per_kg_K;
25377841947SLeila Ghaffari   PetscScalar m_per_squared_s;
25477841947SLeila Ghaffari   PetscScalar W_per_m_K;
25577841947SLeila Ghaffari   PetscScalar Joule;
25677841947SLeila Ghaffari };
25777841947SLeila Ghaffari 
25877841947SLeila Ghaffari // Boundary conditions
25977841947SLeila Ghaffari struct SimpleBC_private {
260a8748852SJames Wright   PetscInt num_inflow, num_outflow, num_freestream, num_slip;
261a8748852SJames Wright   PetscInt inflows[16], outflows[16], freestreams[16], slips[16];
26277841947SLeila Ghaffari };
26377841947SLeila Ghaffari 
26477841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems
26577841947SLeila Ghaffari struct Physics_private {
26677841947SLeila Ghaffari   PetscBool             implicit;
26797baf651SJames Wright   StateVariable         state_var;
26811436a05SJames Wright   CeedContextFieldLabel solution_time_label;
269cd4035ffSJames Wright   CeedContextFieldLabel stg_solution_time_label;
27088626eedSJames Wright   CeedContextFieldLabel timestep_size_label;
271841e4c73SJed Brown   CeedContextFieldLabel ics_time_label;
27277841947SLeila Ghaffari };
27377841947SLeila Ghaffari 
274a8748852SJames Wright PetscErrorCode BoundaryConditionSetUp(User user, ProblemData problem, AppCtx app_ctx, SimpleBC bc);
275a8748852SJames Wright 
27691e5af17SJed Brown typedef struct {
27791e5af17SJed Brown   CeedQFunctionUser    qfunction;
27891e5af17SJed Brown   const char          *qfunction_loc;
279841e4c73SJed Brown   CeedQFunctionContext qfunction_context;
28091e5af17SJed Brown } ProblemQFunctionSpec;
28191e5af17SJed Brown 
28277841947SLeila Ghaffari // Problem specific data
283841e4c73SJed Brown struct ProblemData_private {
284e334ad8fSJed Brown   CeedInt              dim, q_data_size_vol, q_data_size_sur, jac_data_size_sur;
2851864f1c2SLeila Ghaffari   CeedScalar           dm_scale;
286cfb075a4SJames Wright   ProblemQFunctionSpec ics, apply_vol_rhs, apply_vol_ifunction, apply_vol_ijacobian, apply_inflow, apply_outflow, apply_freestream, apply_slip,
287cfb075a4SJames Wright       apply_inflow_jacobian, apply_outflow_jacobian, apply_freestream_jacobian, apply_slip_jacobian;
288*de327db4SJames Wright   bool          compute_exact_solution_error;
289*de327db4SJames Wright   PetscBool     set_bc_from_ics, use_strong_bc_ceed, uses_newtonian;
290a8748852SJames Wright   size_t        num_bc_defs;
291a8748852SJames Wright   BCDefinition *bc_defs;
292731c13d7SJames Wright   PetscErrorCode (*print_info)(User, ProblemData, AppCtx);
293b4e9a8f8SJames Wright   PetscErrorCode (*create_mass_operator)(User, CeedOperator *);
294841e4c73SJed Brown };
29577841947SLeila Ghaffari 
296841e4c73SJed Brown extern int FreeContextPetsc(void *);
297841e4c73SJed Brown 
29877841947SLeila Ghaffari // -----------------------------------------------------------------------------
29977841947SLeila Ghaffari // Set up problems
30077841947SLeila Ghaffari // -----------------------------------------------------------------------------
30177841947SLeila Ghaffari // Set up function for each problem
302731c13d7SJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
303731c13d7SJames Wright extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
304731c13d7SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
305731c13d7SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
306731c13d7SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
307731c13d7SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
308731c13d7SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
309731c13d7SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
310731c13d7SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
311731c13d7SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData problem, DM dm, void *ctx, SimpleBC bc);
31277841947SLeila Ghaffari 
31377841947SLeila Ghaffari // Print function for each problem
314731c13d7SJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData problem, AppCtx app_ctx);
31577841947SLeila Ghaffari 
316731c13d7SJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData problem, AppCtx app_ctx);
31777841947SLeila Ghaffari 
318731c13d7SJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData problem, AppCtx app_ctx);
319019b7682STimothy Aiken 
320731c13d7SJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData problem, AppCtx app_ctx);
32177841947SLeila Ghaffari 
322731c13d7SJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData problem, AppCtx app_ctx);
32377841947SLeila Ghaffari 
3247bc7b61fSJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData problem, TS ts);
3252e31f396SJames Wright 
32677841947SLeila Ghaffari // -----------------------------------------------------------------------------
32777841947SLeila Ghaffari // libCEED functions
32877841947SLeila Ghaffari // -----------------------------------------------------------------------------
32977841947SLeila Ghaffari // Utility function to create local CEED restriction
330431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field,
331431cd09aSJames Wright                                          CeedElemRestriction *elem_restr);
33277841947SLeila Ghaffari 
333bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
334bb85d312SJames Wright                                                CeedElemRestriction *restriction);
335bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
336bb85d312SJames Wright                                                          CeedElemRestriction *restriction);
337bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
338bb85d312SJames Wright                                                     PetscInt q_data_size, CeedElemRestriction *restriction);
339bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height,
340bb85d312SJames Wright                                                          PetscInt q_data_size, CeedElemRestriction *restriction);
34177841947SLeila Ghaffari 
3420814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis);
3430814d5a7SKenneth E. Jansen 
344731c13d7SJames Wright PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData problem, SimpleBC bc);
34577841947SLeila Ghaffari 
346cfb075a4SJames Wright PetscErrorCode QDataGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
347cfb075a4SJames Wright                         CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
348cfb075a4SJames Wright PetscErrorCode QDataGetNumComponents(DM dm, CeedInt *q_data_size);
349cfb075a4SJames Wright PetscErrorCode QDataBoundaryGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x,
350cfb075a4SJames Wright                                 CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size);
351cfb075a4SJames Wright PetscErrorCode QDataBoundaryGetNumComponents(DM dm, CeedInt *q_data_size);
35277841947SLeila Ghaffari // -----------------------------------------------------------------------------
35377841947SLeila Ghaffari // Time-stepping functions
35477841947SLeila Ghaffari // -----------------------------------------------------------------------------
35577841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup
35677841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data);
35777841947SLeila Ghaffari 
35877841947SLeila Ghaffari // Implicit time-stepper function setup
3592b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data);
36077841947SLeila Ghaffari 
36177841947SLeila Ghaffari // User provided TS Monitor
3622b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx);
36377841947SLeila Ghaffari 
36477841947SLeila Ghaffari // TS: Create, setup, and solve
36524078fc4SJames Wright PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, ProblemData problem, Vec *Q, PetscScalar *f_time, TS *ts);
36677841947SLeila Ghaffari 
367a0b9a424SJames Wright // Update Boundary Values when time has changed
368a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t);
369a0b9a424SJames Wright 
37077841947SLeila Ghaffari // -----------------------------------------------------------------------------
37177841947SLeila Ghaffari // Setup DM
37277841947SLeila Ghaffari // -----------------------------------------------------------------------------
3731864f1c2SLeila Ghaffari // Create mesh
374731c13d7SJames Wright PetscErrorCode CreateDM(MPI_Comm comm, ProblemData problem, MatType, VecType, DM *dm);
37577841947SLeila Ghaffari 
37677841947SLeila Ghaffari // Set up DM
377731c13d7SJames Wright PetscErrorCode SetUpDM(DM dm, ProblemData problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys);
378d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
37985df0564SJames Wright                                        PetscInt num_fields, const PetscInt *field_sizes, DM dm);
380d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm);
381d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra,
38285df0564SJames Wright                                   PetscInt num_fields, const PetscInt *field_sizes, DM dm);
38377841947SLeila Ghaffari 
38477841947SLeila Ghaffari // Refine DM for high-order viz
385731c13d7SJames Wright PetscErrorCode VizRefineDM(DM dm, User user, ProblemData problem, SimpleBC bc, Physics phys);
38677841947SLeila Ghaffari 
38777841947SLeila Ghaffari // -----------------------------------------------------------------------------
38877841947SLeila Ghaffari // Process command line options
38977841947SLeila Ghaffari // -----------------------------------------------------------------------------
39077841947SLeila Ghaffari // Register problems to be available on the command line
39177841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx);
39277841947SLeila Ghaffari 
39377841947SLeila Ghaffari // Process general command line options
3942b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc);
39577841947SLeila Ghaffari 
39677841947SLeila Ghaffari // -----------------------------------------------------------------------------
39777841947SLeila Ghaffari // Miscellaneous utility functions
39877841947SLeila Ghaffari // -----------------------------------------------------------------------------
3993a10b0eeSJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field,
4003a10b0eeSJames Wright                                       PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity,
4013a10b0eeSJames Wright                                       CeedVector *inv_multiplicity);
4022b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time);
40377841947SLeila Ghaffari 
4043c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM,
4052b730f8bSJeremy L Thompson                                                   Vec grad_FVM);
40677841947SLeila Ghaffari 
40777841947SLeila Ghaffari // Compare reference solution values with current test run for CI
4083c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q);
40977841947SLeila Ghaffari 
41077841947SLeila Ghaffari // Get error for problems with exact solutions
4113c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time);
41277841947SLeila Ghaffari 
41377841947SLeila Ghaffari // Post-processing
414731c13d7SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData problem, User user, Vec Q, PetscScalar final_time);
41577841947SLeila Ghaffari 
41677841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation
41777841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q);
41877841947SLeila Ghaffari 
41977841947SLeila Ghaffari // Record boundary values from initial condition
4203c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc);
42177841947SLeila Ghaffari 
4224de8550aSJed Brown // Versioning token for binary checkpoints
4230de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN;  // for backwards compatibility
4240de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32;
4250de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64;
4264de8550aSJed Brown 
427ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N
428ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf);
429ef080ff9SJames Wright 
430999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context);
431999ff5c7SJames Wright 
432cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2],
4338b892a05SJames Wright                                  FILE **fp);
4348b892a05SJames Wright 
435cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows);
4368b892a05SJames Wright 
437cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]);
4384cc9442bSJames Wright 
4398b892a05SJames Wright // -----------------------------------------------------------------------------
4408b892a05SJames Wright // Turbulence Statistics Collection Functions
4418b892a05SJames Wright // -----------------------------------------------------------------------------
4428b892a05SJames Wright 
443731c13d7SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
444f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
445f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data);
446fd170fd0SJames Wright 
44777841947SLeila Ghaffari // -----------------------------------------------------------------------------
4484cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions
4494cc9442bSJames Wright // -----------------------------------------------------------------------------
4504cc9442bSJames Wright 
451731c13d7SJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
452cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data);
4538f5ab23bSJames Wright PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc);
454731c13d7SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem, StateVariable state_var_input,
4557618d7b7SJames Wright                                                CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj);
4567618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient);
457052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
458052409adSJames Wright                                                         CeedVector *grid_aniso_vector);
459900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso,
460900aec75SJames Wright                                                              CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso);
4614cc9442bSJames Wright 
4624cc9442bSJames Wright // -----------------------------------------------------------------------------
463dada6cc0SJames Wright // Boundary Condition Related Functions
464dada6cc0SJames Wright // -----------------------------------------------------------------------------
465dada6cc0SJames Wright 
466dada6cc0SJames Wright // Setup StrongBCs that use QFunctions
467731c13d7SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData problem, SimpleBC bc);
468b7c563b6SJeremy L Thompson 
469731c13d7SJames Wright PetscErrorCode FreestreamBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
470731c13d7SJames Wright PetscErrorCode OutflowBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference);
471731c13d7SJames Wright PetscErrorCode SlipBCSetup(ProblemData problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx);
4722b730f8bSJeremy L Thompson 
4734e9802d1SJames Wright // -----------------------------------------------------------------------------
4744e9802d1SJames Wright // Differential Filtering Functions
4754e9802d1SJames Wright // -----------------------------------------------------------------------------
4764e9802d1SJames Wright 
477731c13d7SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
4784e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter);
4794e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx);
4804e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution);
481731c13d7SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData problem);
4824e9802d1SJames Wright 
4838146534cSJames Wright // -----------------------------------------------------------------------------
4848146534cSJames Wright // SGS Data-Driven Training via SmartSim
4858146534cSJames Wright // -----------------------------------------------------------------------------
4868146534cSJames Wright PetscErrorCode SmartSimSetup(User user);
487b306c3f1SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim);
488731c13d7SJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem);
489ee3b213aSJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx);
4901a7db67cSJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts);
491ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train);
492