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> 109d992146SJames Wright #include <log_events.h> 1191c97f41SJames Wright #include <mat-ceed.h> 125037d55dSJames Wright #include <petsc-ceed-utils.h> 1377841947SLeila Ghaffari #include <petscts.h> 1477841947SLeila Ghaffari #include <stdbool.h> 152b730f8bSJeremy L Thompson 164021610dSJames Wright #include "./include/petsc_ops.h" 1797baf651SJames Wright #include "qfunctions/newtonian_types.h" 1877841947SLeila Ghaffari 1949a40c8aSKenneth E. Jansen #if PETSC_VERSION_LT(3, 21, 0) 20fd9d666bSJames Wright #error "PETSc v3.21 or later is required" 2149a40c8aSKenneth E. Jansen #endif 2249a40c8aSKenneth E. Jansen 2377841947SLeila Ghaffari // ----------------------------------------------------------------------------- 2477841947SLeila Ghaffari // Enums 2577841947SLeila Ghaffari // ----------------------------------------------------------------------------- 2677841947SLeila Ghaffari 2777841947SLeila Ghaffari // Euler - test cases 2877841947SLeila Ghaffari typedef enum { 29bc7bbd5dSLeila Ghaffari EULER_TEST_ISENTROPIC_VORTEX = 0, 3077841947SLeila Ghaffari EULER_TEST_1 = 1, 3177841947SLeila Ghaffari EULER_TEST_2 = 2, 3277841947SLeila Ghaffari EULER_TEST_3 = 3, 3377841947SLeila Ghaffari EULER_TEST_4 = 4, 3432f166c6SLeila Ghaffari EULER_TEST_5 = 5, 3577841947SLeila Ghaffari } EulerTestType; 36*fc39c77eSJames Wright static const char *const EulerTestTypes[] = {"ISENTROPIC_VORTEX", "1", "2", "3", "4", "5", "EulerTestType", "EULER_TEST_", NULL}; 3777841947SLeila Ghaffari 38700ae941SJames Wright // Advection - Wind types 39*fc39c77eSJames Wright static const char *const WindTypes[] = {"ROTATION", "TRANSLATION", "WindType", "WIND_", NULL}; 40700ae941SJames Wright 417b77ddfdSJames Wright // Advection - Initial Condition Types 42*fc39c77eSJames Wright static const char *const AdvectionICTypes[] = {"SPHERE", "CYLINDER", "COSINE_HILL", "SKEW", "AdvectionICType", "ADVECTIONIC_", NULL}; 43700ae941SJames Wright 44700ae941SJames Wright // Advection - Bubble Continuity Types 45*fc39c77eSJames Wright static const char *const BubbleContinuityTypes[] = {"SMOOTH", "BACK_SHARP", "THICK", "COSINE", "BubbleContinuityType", "BUBBLE_CONTINUITY_", NULL}; 46700ae941SJames Wright 4777841947SLeila Ghaffari // Stabilization methods 48*fc39c77eSJames Wright static const char *const StabilizationTypes[] = {"NONE", "SU", "SUPG", "StabilizationType", "STAB_", NULL}; 4977841947SLeila Ghaffari 50b18328c4SJames Wright // Stabilization tau constants 51*fc39c77eSJames Wright static const char *const StabilizationTauTypes[] = {"CTAU", "ADVDIFF_SHAKIB", "ADVDIFF_SHAKIB_P", "StabilizationTauType", "STAB_TAU_", NULL}; 52b18328c4SJames Wright 5351b00d91SJames Wright // Test mode type 548fb33541SJames Wright typedef enum { 558fb33541SJames Wright TESTTYPE_NONE = 0, 568fb33541SJames Wright TESTTYPE_SOLVER = 1, 578fb33541SJames Wright TESTTYPE_TURB_SPANSTATS = 2, 58970fa48bSJames Wright TESTTYPE_DIFF_FILTER = 3, 598fb33541SJames Wright } TestType; 60*fc39c77eSJames Wright static const char *const TestTypes[] = {"NONE", "SOLVER", "TURB_SPANSTATS", "DIFF_FILTER", "TestType", "TESTTYPE_", NULL}; 618fb33541SJames Wright 622526956eSJames Wright // Subgrid-Stress mode type 6319ffbc25SJames Wright typedef enum { 6419ffbc25SJames Wright SGS_MODEL_NONE = 0, 6519ffbc25SJames Wright SGS_MODEL_DATA_DRIVEN = 1, 6619ffbc25SJames Wright } SGSModelType; 67*fc39c77eSJames Wright static const char *const SGSModelTypes[] = {"NONE", "DATA_DRIVEN", "SGSModelType", "SGS_MODEL_", NULL}; 6819ffbc25SJames Wright 69013a5551SJames Wright // Subgrid-Stress mode type 70013a5551SJames Wright typedef enum { 71013a5551SJames Wright SGS_MODEL_DD_FUSED = 0, 72013a5551SJames Wright SGS_MODEL_DD_SEQENTIAL_CEED = 1, 73013a5551SJames Wright SGS_MODEL_DD_SEQENTIAL_TORCH = 2, 74013a5551SJames Wright } SGSModelDDImplementation; 75*fc39c77eSJames Wright static const char *const SGSModelDDImplementations[] = {"FUSED", "SEQUENTIAL_CEED", "SEQUENTIAL_TORCH", "SGSModelDDImplementation", "SGS_MODEL_DD_", 76013a5551SJames Wright NULL}; 77013a5551SJames Wright 782526956eSJames Wright // Mesh transformation type 792526956eSJames Wright typedef enum { 802526956eSJames Wright MESH_TRANSFORM_NONE = 0, 812526956eSJames Wright MESH_TRANSFORM_PLATEMESH = 1, 822526956eSJames Wright } MeshTransformType; 83*fc39c77eSJames Wright static const char *const MeshTransformTypes[] = {"NONE", "PLATEMESH", "MeshTransformType", "MESH_TRANSFORM_", NULL}; 842526956eSJames Wright 85bd882c8aSJames Wright static const char *const DifferentialFilterDampingFunctions[] = { 86*fc39c77eSJames Wright "NONE", "VAN_DRIEST", "MMS", "DifferentialFilterDampingFunction", "DIFF_FILTER_DAMP_", NULL}; 87bd882c8aSJames Wright 8877841947SLeila Ghaffari // ----------------------------------------------------------------------------- 8977841947SLeila Ghaffari // Structs 9077841947SLeila Ghaffari // ----------------------------------------------------------------------------- 9177841947SLeila Ghaffari // Structs declarations 9277841947SLeila Ghaffari typedef struct AppCtx_private *AppCtx; 9377841947SLeila Ghaffari typedef struct CeedData_private *CeedData; 9477841947SLeila Ghaffari typedef struct User_private *User; 9577841947SLeila Ghaffari typedef struct Units_private *Units; 9677841947SLeila Ghaffari typedef struct SimpleBC_private *SimpleBC; 9777841947SLeila Ghaffari typedef struct Physics_private *Physics; 9877841947SLeila Ghaffari 9977841947SLeila Ghaffari // Application context from user command line options 10077841947SLeila Ghaffari struct AppCtx_private { 10177841947SLeila Ghaffari // libCEED arguments 10277841947SLeila Ghaffari char ceed_resource[PETSC_MAX_PATH_LEN]; // libCEED backend 10377841947SLeila Ghaffari PetscInt degree; 10477841947SLeila Ghaffari PetscInt q_extra; 105544be873SJed Brown // Solver arguments 106544be873SJed Brown MatType amat_type; 10777841947SLeila Ghaffari // Post-processing arguments 10837cbb16aSJed Brown PetscInt checkpoint_interval; 10977841947SLeila Ghaffari PetscInt viz_refine; 11077841947SLeila Ghaffari PetscInt cont_steps; 1114de8550aSJed Brown PetscReal cont_time; 11269293791SJames Wright char cont_file[PETSC_MAX_PATH_LEN]; 11369293791SJames Wright char cont_time_file[PETSC_MAX_PATH_LEN]; 11477841947SLeila Ghaffari char output_dir[PETSC_MAX_PATH_LEN]; 11569293791SJames Wright PetscBool add_stepnum2bin; 11637cbb16aSJed Brown PetscBool checkpoint_vtk; 11777841947SLeila Ghaffari // Problem type arguments 11877841947SLeila Ghaffari PetscFunctionList problems; 11977841947SLeila Ghaffari char problem_name[PETSC_MAX_PATH_LEN]; 12077841947SLeila Ghaffari // Test mode arguments 1218fb33541SJames Wright TestType test_type; 12277841947SLeila Ghaffari PetscScalar test_tol; 123b7d66439SJames Wright char test_file_path[PETSC_MAX_PATH_LEN]; 124b7d66439SJames Wright // Turbulent spanwise statistics 125b7d66439SJames Wright PetscBool turb_spanstats_enable; 126b7d66439SJames Wright PetscInt turb_spanstats_collect_interval; 127b7d66439SJames Wright PetscInt turb_spanstats_viewer_interval; 128b7d66439SJames Wright PetscViewer turb_spanstats_viewer; 129b7d66439SJames Wright PetscViewerFormat turb_spanstats_viewer_format; 130ca69d878SAdeleke O. Bankole // Wall forces 131ca69d878SAdeleke O. Bankole struct { 132ca69d878SAdeleke O. Bankole PetscInt num_wall; 133ca69d878SAdeleke O. Bankole PetscInt *walls; 134ca69d878SAdeleke O. Bankole PetscViewer viewer; 135ca69d878SAdeleke O. Bankole PetscViewerFormat viewer_format; 136ca69d878SAdeleke O. Bankole PetscBool header_written; 137ca69d878SAdeleke O. Bankole } wall_forces; 13819ffbc25SJames Wright // Subgrid Stress Model 13919ffbc25SJames Wright SGSModelType sgs_model_type; 14028134cfaSJames Wright PetscBool sgs_train_enable; 1414e9802d1SJames Wright // Differential Filtering 1424e9802d1SJames Wright PetscBool diff_filter_monitor; 1432526956eSJames Wright MeshTransformType mesh_transform_type; 14477841947SLeila Ghaffari }; 14577841947SLeila Ghaffari 14677841947SLeila Ghaffari // libCEED data struct 14777841947SLeila Ghaffari struct CeedData_private { 14877841947SLeila Ghaffari CeedVector x_coord, q_data; 149e9c36be0SJames Wright CeedBasis basis_x, basis_q; 15077841947SLeila Ghaffari CeedElemRestriction elem_restr_x, elem_restr_q, elem_restr_qd_i; 1515263e9c6SJames Wright OperatorApplyContext op_ics_ctx; 15277841947SLeila Ghaffari }; 15377841947SLeila Ghaffari 15451ee423eSJames Wright typedef struct { 15551ee423eSJames Wright DM dm; 1561737222fSJames Wright PetscSF sf; // For communicating child data to parents 157ed331efdSJames Wright OperatorApplyContext op_stats_collect_ctx, op_proj_rhs_ctx; 15851ee423eSJames Wright PetscInt num_comp_stats; 159ed331efdSJames Wright Vec Child_Stats_loc, Parent_Stats_loc; 160a175e481SJames Wright KSP ksp; // For the L^2 projection solve 161a175e481SJames Wright CeedScalar span_width; // spanwise width of the child domain 162b7d66439SJames Wright PetscBool do_mms_test; 1634021610dSJames Wright OperatorApplyContext mms_error_ctx; 164495b9769SJames Wright CeedContextFieldLabel solution_time_label, previous_time_label; 165cbef7084SJames Wright } SpanStatsData; 16651ee423eSJames Wright 167999ff5c7SJames Wright typedef struct { 168999ff5c7SJames Wright DM dm; 169999ff5c7SJames Wright PetscInt num_comp; 170999ff5c7SJames Wright OperatorApplyContext l2_rhs_ctx; 171999ff5c7SJames Wright KSP ksp; 172999ff5c7SJames Wright } *NodalProjectionData; 173999ff5c7SJames Wright 1746b3fb9aeSJames Wright typedef PetscErrorCode (*SgsDDNodalStressEval)(User user, Vec Q_loc, Vec VelocityGradient, Vec SGSNodal_loc); 1751250e899SJames Wright typedef PetscErrorCode (*SgsDDNodalStressInference)(Vec DD_Inputs_loc, Vec DD_Outputs_loc, void *ctx); 1769a17443dSJames Wright typedef struct { 1771250e899SJames Wright DM dm_sgs, dm_dd_inputs, dm_dd_outputs; 1785f5d6789SAlex Lindsay PetscInt num_comp_sgs, num_comp_inputs, num_comp_outputs; 1791250e899SJames Wright OperatorApplyContext op_nodal_evaluation_ctx, op_nodal_dd_inputs_ctx, op_nodal_dd_outputs_ctx, op_sgs_apply_ctx; 1801250e899SJames Wright CeedVector sgs_nodal_ceed, grad_velo_ceed; 1816b3fb9aeSJames Wright SgsDDNodalStressEval sgs_nodal_eval; 1821250e899SJames Wright SgsDDNodalStressInference sgs_nodal_inference; 1831250e899SJames Wright void *sgs_nodal_inference_ctx; 1841250e899SJames Wright PetscErrorCode (*sgs_nodal_inference_ctx_destroy)(void *ctx); 185cbef7084SJames Wright } *SgsDDData; 1869a17443dSJames Wright 1874e9802d1SJames Wright typedef struct { 188ee3b213aSJames Wright DM dm_dd_training; 189c79b0730SJames Wright PetscInt num_comp_dd_inputs, write_data_interval, num_filter_widths; 190c79b0730SJames Wright PetscScalar filter_widths[16]; 191ee3b213aSJames Wright OperatorApplyContext op_training_data_calc_ctx; 192ee3b213aSJames Wright NodalProjectionData filtered_grad_velo_proj; 193ee3b213aSJames Wright size_t training_data_array_dims[2]; 194ee3b213aSJames Wright PetscBool overwrite_training_data; 195ee3b213aSJames Wright } *SGS_DD_TrainingData; 196ee3b213aSJames Wright 197ee3b213aSJames Wright typedef struct { 1984e9802d1SJames Wright DM dm_filter; 19981530087SJames Wright PetscInt num_filtered_fields; 20081530087SJames Wright CeedInt *num_field_components; 201051427eeSJames Wright PetscInt field_prim_state, field_velo_prod; 2024e9802d1SJames Wright OperatorApplyContext op_rhs_ctx; 2034e9802d1SJames Wright KSP ksp; 20456f5e811SJames Wright PetscObjectState X_loc_state; 2052029a677SJames Wright PetscBool do_mms_test; 206c79b0730SJames Wright CeedContextFieldLabel filter_width_scaling_label; 2074e9802d1SJames Wright } *DiffFilterData; 2084e9802d1SJames Wright 2098146534cSJames Wright typedef struct { 2108146534cSJames Wright void *client; 2118146534cSJames Wright char rank_id_name[16]; 2128146534cSJames Wright PetscInt collocated_database_num_ranks; 2138146534cSJames Wright } *SmartSimData; 2148146534cSJames Wright 21577841947SLeila Ghaffari // PETSc user data 21677841947SLeila Ghaffari struct User_private { 21777841947SLeila Ghaffari MPI_Comm comm; 21877841947SLeila Ghaffari DM dm; 21977841947SLeila Ghaffari DM dm_viz; 22077841947SLeila Ghaffari Mat interp_viz; 22177841947SLeila Ghaffari Ceed ceed; 22277841947SLeila Ghaffari Units units; 22304292f7dSJames Wright Vec Q_loc, Q_dot_loc; 22477841947SLeila Ghaffari Physics phys; 22577841947SLeila Ghaffari AppCtx app_ctx; 22691c97f41SJames Wright CeedVector q_ceed, q_dot_ceed, g_ceed, x_ceed; 227a5b0ec6fSJames Wright CeedOperator op_ifunction; 22891c97f41SJames Wright Mat mat_ijacobian; 22904292f7dSJames Wright KSP mass_ksp; 2309ad5e8e4SJames Wright OperatorApplyContext op_rhs_ctx, op_strong_bc_ctx; 23115637395SJames Wright CeedScalar time_bc_set; 232cbef7084SJames Wright SpanStatsData spanstats; 233999ff5c7SJames Wright NodalProjectionData grad_velo_proj; 234cbef7084SJames Wright SgsDDData sgs_dd_data; 2354e9802d1SJames Wright DiffFilterData diff_filter; 2368146534cSJames Wright SmartSimData smartsim; 237ee3b213aSJames Wright SGS_DD_TrainingData sgs_dd_train; 23877841947SLeila Ghaffari }; 23977841947SLeila Ghaffari 24077841947SLeila Ghaffari // Units 24177841947SLeila Ghaffari struct Units_private { 24277841947SLeila Ghaffari // fundamental units 24377841947SLeila Ghaffari PetscScalar meter; 24477841947SLeila Ghaffari PetscScalar kilogram; 24577841947SLeila Ghaffari PetscScalar second; 24677841947SLeila Ghaffari PetscScalar Kelvin; 24777841947SLeila Ghaffari // derived units 24877841947SLeila Ghaffari PetscScalar Pascal; 24977841947SLeila Ghaffari PetscScalar J_per_kg_K; 25077841947SLeila Ghaffari PetscScalar m_per_squared_s; 25177841947SLeila Ghaffari PetscScalar W_per_m_K; 25277841947SLeila Ghaffari PetscScalar Joule; 25377841947SLeila Ghaffari }; 25477841947SLeila Ghaffari 25577841947SLeila Ghaffari // Boundary conditions 25677841947SLeila Ghaffari struct SimpleBC_private { 2572fe7aee7SLeila Ghaffari PetscInt num_wall, // Number of faces with wall BCs 2582fe7aee7SLeila Ghaffari wall_comps[5], // An array of constrained component numbers 2592fe7aee7SLeila Ghaffari num_comps, 2607c5bba50SJames Wright num_symmetry[3], // Number of faces with symmetry BCs 2619f844368SJames Wright num_inflow, num_outflow, num_freestream, num_slip; 2629f844368SJames Wright PetscInt walls[16], symmetries[3][16], inflows[16], outflows[16], freestreams[16], slips[16]; 26377841947SLeila Ghaffari }; 26477841947SLeila Ghaffari 26577841947SLeila Ghaffari // Struct that contains all enums and structs used for the physics of all problems 26677841947SLeila Ghaffari struct Physics_private { 26777841947SLeila Ghaffari PetscBool implicit; 26897baf651SJames Wright StateVariable state_var; 26911436a05SJames Wright CeedContextFieldLabel solution_time_label; 270cd4035ffSJames Wright CeedContextFieldLabel stg_solution_time_label; 27188626eedSJames Wright CeedContextFieldLabel timestep_size_label; 272841e4c73SJed Brown CeedContextFieldLabel ics_time_label; 27377841947SLeila Ghaffari }; 27477841947SLeila Ghaffari 27591e5af17SJed Brown typedef struct { 27691e5af17SJed Brown CeedQFunctionUser qfunction; 27791e5af17SJed Brown const char *qfunction_loc; 278841e4c73SJed Brown CeedQFunctionContext qfunction_context; 27991e5af17SJed Brown } ProblemQFunctionSpec; 28091e5af17SJed Brown 28177841947SLeila Ghaffari // Problem specific data 282731c13d7SJames Wright typedef struct ProblemData_private *ProblemData; 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; 28877841947SLeila Ghaffari bool non_zero_time; 289752a08a7SJames Wright PetscBool bc_from_ics, use_strong_bc_ceed, uses_newtonian; 290731c13d7SJames Wright PetscErrorCode (*print_info)(User, ProblemData, AppCtx); 291b4e9a8f8SJames Wright PetscErrorCode (*create_mass_operator)(User, CeedOperator *); 292841e4c73SJed Brown }; 29377841947SLeila Ghaffari 294841e4c73SJed Brown extern int FreeContextPetsc(void *); 295841e4c73SJed Brown 29677841947SLeila Ghaffari // ----------------------------------------------------------------------------- 29777841947SLeila Ghaffari // Set up problems 29877841947SLeila Ghaffari // ----------------------------------------------------------------------------- 29977841947SLeila Ghaffari // Set up function for each problem 300731c13d7SJames Wright extern PetscErrorCode NS_TAYLOR_GREEN(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 301731c13d7SJames Wright extern PetscErrorCode NS_GAUSSIAN_WAVE(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 302731c13d7SJames Wright extern PetscErrorCode NS_CHANNEL(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 303731c13d7SJames Wright extern PetscErrorCode NS_BLASIUS(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 304731c13d7SJames Wright extern PetscErrorCode NS_NEWTONIAN_IG(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 305731c13d7SJames Wright extern PetscErrorCode NS_DENSITY_CURRENT(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 306731c13d7SJames Wright extern PetscErrorCode NS_EULER_VORTEX(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 307731c13d7SJames Wright extern PetscErrorCode NS_SHOCKTUBE(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 308731c13d7SJames Wright extern PetscErrorCode NS_ADVECTION(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 309731c13d7SJames Wright extern PetscErrorCode NS_ADVECTION2D(ProblemData problem, DM dm, void *ctx, SimpleBC bc); 31077841947SLeila Ghaffari 31177841947SLeila Ghaffari // Print function for each problem 312731c13d7SJames Wright extern PetscErrorCode PRINT_NEWTONIAN(User user, ProblemData problem, AppCtx app_ctx); 31377841947SLeila Ghaffari 314731c13d7SJames Wright extern PetscErrorCode PRINT_EULER_VORTEX(User user, ProblemData problem, AppCtx app_ctx); 31577841947SLeila Ghaffari 316731c13d7SJames Wright extern PetscErrorCode PRINT_SHOCKTUBE(User user, ProblemData problem, AppCtx app_ctx); 317019b7682STimothy Aiken 318731c13d7SJames Wright extern PetscErrorCode PRINT_ADVECTION(User user, ProblemData problem, AppCtx app_ctx); 31977841947SLeila Ghaffari 320731c13d7SJames Wright extern PetscErrorCode PRINT_ADVECTION2D(User user, ProblemData problem, AppCtx app_ctx); 32177841947SLeila Ghaffari 3227bc7b61fSJames Wright PetscErrorCode PrintRunInfo(User user, Physics phys_ctx, ProblemData problem, TS ts); 3232e31f396SJames Wright 32477841947SLeila Ghaffari // ----------------------------------------------------------------------------- 32577841947SLeila Ghaffari // libCEED functions 32677841947SLeila Ghaffari // ----------------------------------------------------------------------------- 32777841947SLeila Ghaffari // Utility function to create local CEED restriction 328431cd09aSJames Wright PetscErrorCode CreateRestrictionFromPlex(Ceed ceed, DM dm, CeedInt height, DMLabel domain_label, CeedInt label_value, PetscInt dm_field, 329431cd09aSJames Wright CeedElemRestriction *elem_restr); 33077841947SLeila Ghaffari 331bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field, 332bb85d312SJames Wright CeedElemRestriction *restriction); 333bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCoordinateCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, 334bb85d312SJames Wright CeedElemRestriction *restriction); 335bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionQDataCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, 336bb85d312SJames Wright PetscInt q_data_size, CeedElemRestriction *restriction); 337bb85d312SJames Wright PetscErrorCode DMPlexCeedElemRestrictionCollocatedCreate(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, 338bb85d312SJames Wright PetscInt q_data_size, CeedElemRestriction *restriction); 33977841947SLeila Ghaffari 3400814d5a7SKenneth E. Jansen PetscErrorCode CreateBasisFromPlex(Ceed ceed, DM dm, DMLabel domain_label, CeedInt label_value, CeedInt height, CeedInt dm_field, CeedBasis *basis); 3410814d5a7SKenneth E. Jansen 342731c13d7SJames Wright PetscErrorCode SetupLibceed(Ceed ceed, CeedData ceed_data, DM dm, User user, AppCtx app_ctx, ProblemData problem, SimpleBC bc); 34377841947SLeila Ghaffari 344cfb075a4SJames Wright PetscErrorCode QDataGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x, 345cfb075a4SJames Wright CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size); 346cfb075a4SJames Wright PetscErrorCode QDataGetNumComponents(DM dm, CeedInt *q_data_size); 347cfb075a4SJames Wright PetscErrorCode QDataBoundaryGet(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, CeedElemRestriction elem_restr_x, CeedBasis basis_x, 348cfb075a4SJames Wright CeedVector x_coord, CeedElemRestriction *elem_restr_qd, CeedVector *q_data, CeedInt *q_data_size); 349cfb075a4SJames Wright PetscErrorCode QDataBoundaryGetNumComponents(DM dm, CeedInt *q_data_size); 35077841947SLeila Ghaffari // ----------------------------------------------------------------------------- 35177841947SLeila Ghaffari // Time-stepping functions 35277841947SLeila Ghaffari // ----------------------------------------------------------------------------- 35377841947SLeila Ghaffari // RHS (Explicit time-stepper) function setup 35477841947SLeila Ghaffari PetscErrorCode RHS_NS(TS ts, PetscReal t, Vec Q, Vec G, void *user_data); 35577841947SLeila Ghaffari 35677841947SLeila Ghaffari // Implicit time-stepper function setup 3572b730f8bSJeremy L Thompson PetscErrorCode IFunction_NS(TS ts, PetscReal t, Vec Q, Vec Q_dot, Vec G, void *user_data); 35877841947SLeila Ghaffari 35977841947SLeila Ghaffari // User provided TS Monitor 3602b730f8bSJeremy L Thompson PetscErrorCode TSMonitor_NS(TS ts, PetscInt step_no, PetscReal time, Vec Q, void *ctx); 36177841947SLeila Ghaffari 36277841947SLeila Ghaffari // TS: Create, setup, and solve 36324078fc4SJames Wright PetscErrorCode TSSolve_NS(DM dm, User user, AppCtx app_ctx, Physics phys, ProblemData problem, Vec *Q, PetscScalar *f_time, TS *ts); 36477841947SLeila Ghaffari 365a0b9a424SJames Wright // Update Boundary Values when time has changed 366a0b9a424SJames Wright PetscErrorCode UpdateBoundaryValues(User user, Vec Q_loc, PetscReal t); 367a0b9a424SJames Wright 36877841947SLeila Ghaffari // ----------------------------------------------------------------------------- 36977841947SLeila Ghaffari // Setup DM 37077841947SLeila Ghaffari // ----------------------------------------------------------------------------- 3711864f1c2SLeila Ghaffari // Create mesh 372731c13d7SJames Wright PetscErrorCode CreateDM(MPI_Comm comm, ProblemData problem, MatType, VecType, DM *dm); 37377841947SLeila Ghaffari 37477841947SLeila Ghaffari // Set up DM 375731c13d7SJames Wright PetscErrorCode SetUpDM(DM dm, ProblemData problem, PetscInt degree, PetscInt q_extra, SimpleBC bc, Physics phys); 376d68a66c4SJames Wright PetscErrorCode DMSetupByOrderBegin_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra, 37785df0564SJames Wright PetscInt num_fields, const PetscInt *field_sizes, DM dm); 378d68a66c4SJames Wright PetscErrorCode DMSetupByOrderEnd_FEM(PetscBool setup_coords, DM dm); 379d68a66c4SJames Wright PetscErrorCode DMSetupByOrder_FEM(PetscBool setup_faces, PetscBool setup_coords, PetscInt degree, PetscInt coord_order, PetscInt q_extra, 38085df0564SJames Wright PetscInt num_fields, const PetscInt *field_sizes, DM dm); 38177841947SLeila Ghaffari 38277841947SLeila Ghaffari // Refine DM for high-order viz 383731c13d7SJames Wright PetscErrorCode VizRefineDM(DM dm, User user, ProblemData problem, SimpleBC bc, Physics phys); 38477841947SLeila Ghaffari 38577841947SLeila Ghaffari // ----------------------------------------------------------------------------- 38677841947SLeila Ghaffari // Process command line options 38777841947SLeila Ghaffari // ----------------------------------------------------------------------------- 38877841947SLeila Ghaffari // Register problems to be available on the command line 38977841947SLeila Ghaffari PetscErrorCode RegisterProblems_NS(AppCtx app_ctx); 39077841947SLeila Ghaffari 39177841947SLeila Ghaffari // Process general command line options 3922b730f8bSJeremy L Thompson PetscErrorCode ProcessCommandLineOptions(MPI_Comm comm, AppCtx app_ctx, SimpleBC bc); 39377841947SLeila Ghaffari 39477841947SLeila Ghaffari // ----------------------------------------------------------------------------- 39577841947SLeila Ghaffari // Miscellaneous utility functions 39677841947SLeila Ghaffari // ----------------------------------------------------------------------------- 3973a10b0eeSJames Wright PetscErrorCode GetInverseMultiplicity(Ceed ceed, DM dm, DMLabel domain_label, PetscInt label_value, PetscInt height, PetscInt dm_field, 3983a10b0eeSJames Wright PetscBool get_global_multiplicity, CeedElemRestriction *elem_restr_inv_multiplicity, 3993a10b0eeSJames Wright CeedVector *inv_multiplicity); 4002b730f8bSJeremy L Thompson PetscErrorCode ICs_FixMultiplicity(DM dm, CeedData ceed_data, User user, Vec Q_loc, Vec Q, CeedScalar time); 40177841947SLeila Ghaffari 4023c9e7ad1SJames Wright PetscErrorCode DMPlexInsertBoundaryValues_FromICs(DM dm, PetscBool insert_essential, Vec Q_loc, PetscReal time, Vec face_geom_FVM, Vec cell_geom_FVM, 4032b730f8bSJeremy L Thompson Vec grad_FVM); 40477841947SLeila Ghaffari 40577841947SLeila Ghaffari // Compare reference solution values with current test run for CI 4063c9e7ad1SJames Wright PetscErrorCode RegressionTest(AppCtx app_ctx, Vec Q); 40777841947SLeila Ghaffari 40877841947SLeila Ghaffari // Get error for problems with exact solutions 4093c9e7ad1SJames Wright PetscErrorCode PrintError(CeedData ceed_data, DM dm, User user, Vec Q, PetscScalar final_time); 41077841947SLeila Ghaffari 41177841947SLeila Ghaffari // Post-processing 412731c13d7SJames Wright PetscErrorCode PostProcess(TS ts, CeedData ceed_data, DM dm, ProblemData problem, User user, Vec Q, PetscScalar final_time); 41377841947SLeila Ghaffari 41477841947SLeila Ghaffari // -- Gather initial Q values in case of continuation of simulation 41577841947SLeila Ghaffari PetscErrorCode SetupICsFromBinary(MPI_Comm comm, AppCtx app_ctx, Vec Q); 41677841947SLeila Ghaffari 41777841947SLeila Ghaffari // Record boundary values from initial condition 4183c9e7ad1SJames Wright PetscErrorCode SetBCsFromICs(DM dm, Vec Q, Vec Q_loc); 41977841947SLeila Ghaffari 4204de8550aSJed Brown // Versioning token for binary checkpoints 4210de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN; // for backwards compatibility 4220de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_32; 4230de6a49fSJames Wright extern const PetscInt32 FLUIDS_FILE_TOKEN_64; 4244de8550aSJed Brown 425ef080ff9SJames Wright // Create appropriate mass qfunction based on number of components N 426ef080ff9SJames Wright PetscErrorCode CreateMassQFunction(Ceed ceed, CeedInt N, CeedInt q_data_size, CeedQFunction *qf); 427ef080ff9SJames Wright 428999ff5c7SJames Wright PetscErrorCode NodalProjectionDataDestroy(NodalProjectionData context); 429999ff5c7SJames Wright 430cbef7084SJames Wright PetscErrorCode PhastaDatFileOpen(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], const PetscInt char_array_len, PetscInt dims[2], 4318b892a05SJames Wright FILE **fp); 4328b892a05SJames Wright 433cbef7084SJames Wright PetscErrorCode PhastaDatFileGetNRows(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscInt *nrows); 4348b892a05SJames Wright 435cbef7084SJames Wright PetscErrorCode PhastaDatFileReadToArrayReal(const MPI_Comm comm, const char path[PETSC_MAX_PATH_LEN], PetscReal array[]); 4364cc9442bSJames Wright 4378b892a05SJames Wright // ----------------------------------------------------------------------------- 4388b892a05SJames Wright // Turbulence Statistics Collection Functions 4398b892a05SJames Wright // ----------------------------------------------------------------------------- 4408b892a05SJames Wright 441731c13d7SJames Wright PetscErrorCode TurbulenceStatisticsSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem); 442f5452247SJames Wright PetscErrorCode TSMonitor_TurbulenceStatistics(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx); 443f5452247SJames Wright PetscErrorCode TurbulenceStatisticsDestroy(User user, CeedData ceed_data); 444fd170fd0SJames Wright 44577841947SLeila Ghaffari // ----------------------------------------------------------------------------- 4464cc9442bSJames Wright // Data-Driven Subgrid Stress (DD-SGS) Modeling Functions 4474cc9442bSJames Wright // ----------------------------------------------------------------------------- 4484cc9442bSJames Wright 449731c13d7SJames Wright PetscErrorCode SgsDDSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem); 450cbef7084SJames Wright PetscErrorCode SgsDDDataDestroy(SgsDDData sgs_dd_data); 4518f5ab23bSJames Wright PetscErrorCode SgsDDApplyIFunction(User user, const Vec Q_loc, Vec G_loc); 452731c13d7SJames Wright PetscErrorCode VelocityGradientProjectionSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem, StateVariable state_var_input, 4537618d7b7SJames Wright CeedElemRestriction elem_restr_input, CeedBasis basis_input, NodalProjectionData *pgrad_velo_proj); 4547618d7b7SJames Wright PetscErrorCode VelocityGradientProjectionApply(NodalProjectionData grad_velo_proj, Vec Q_loc, Vec VelocityGradient); 455052409adSJames Wright PetscErrorCode GridAnisotropyTensorProjectionSetupApply(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso, 456052409adSJames Wright CeedVector *grid_aniso_vector); 457900aec75SJames Wright PetscErrorCode GridAnisotropyTensorCalculateCollocatedVector(Ceed ceed, User user, CeedData ceed_data, CeedElemRestriction *elem_restr_grid_aniso, 458900aec75SJames Wright CeedVector *aniso_colloc_ceed, PetscInt *num_comp_aniso); 4594cc9442bSJames Wright 4604cc9442bSJames Wright // ----------------------------------------------------------------------------- 461dada6cc0SJames Wright // Boundary Condition Related Functions 462dada6cc0SJames Wright // ----------------------------------------------------------------------------- 463dada6cc0SJames Wright 464dada6cc0SJames Wright // Setup StrongBCs that use QFunctions 465731c13d7SJames Wright PetscErrorCode SetupStrongBC_Ceed(Ceed ceed, CeedData ceed_data, DM dm, User user, ProblemData problem, SimpleBC bc); 466b7c563b6SJeremy L Thompson 467731c13d7SJames Wright PetscErrorCode FreestreamBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference); 468731c13d7SJames Wright PetscErrorCode OutflowBCSetup(ProblemData problem, DM dm, void *ctx, NewtonianIdealGasContext newtonian_ig_ctx, const StatePrimitive *reference); 469731c13d7SJames Wright PetscErrorCode SlipBCSetup(ProblemData problem, DM dm, void *ctx, CeedQFunctionContext newtonian_ig_qfctx); 4702b730f8bSJeremy L Thompson 4714e9802d1SJames Wright // ----------------------------------------------------------------------------- 4724e9802d1SJames Wright // Differential Filtering Functions 4734e9802d1SJames Wright // ----------------------------------------------------------------------------- 4744e9802d1SJames Wright 475731c13d7SJames Wright PetscErrorCode DifferentialFilterSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem); 4764e9802d1SJames Wright PetscErrorCode DifferentialFilterDataDestroy(DiffFilterData diff_filter); 4774e9802d1SJames Wright PetscErrorCode TSMonitor_DifferentialFilter(TS ts, PetscInt steps, PetscReal solution_time, Vec Q, void *ctx); 4784e9802d1SJames Wright PetscErrorCode DifferentialFilterApply(User user, const PetscReal solution_time, const Vec Q, Vec Filtered_Solution); 479731c13d7SJames Wright PetscErrorCode DifferentialFilterMmsICSetup(ProblemData problem); 4804e9802d1SJames Wright 4818146534cSJames Wright // ----------------------------------------------------------------------------- 4828146534cSJames Wright // SGS Data-Driven Training via SmartSim 4838146534cSJames Wright // ----------------------------------------------------------------------------- 4848146534cSJames Wright PetscErrorCode SmartSimSetup(User user); 485b306c3f1SJames Wright PetscErrorCode SmartSimDataDestroy(SmartSimData smartsim); 486731c13d7SJames Wright PetscErrorCode SGS_DD_TrainingSetup(Ceed ceed, User user, CeedData ceed_data, ProblemData problem); 487ee3b213aSJames Wright PetscErrorCode TSMonitor_SGS_DD_Training(TS ts, PetscInt step_num, PetscReal solution_time, Vec Q, void *ctx); 4881a7db67cSJames Wright PetscErrorCode TSPostStep_SGS_DD_Training(TS ts); 489ee3b213aSJames Wright PetscErrorCode SGS_DD_TrainingDataDestroy(SGS_DD_TrainingData sgs_dd_train); 490