| 
    Neko 0.9.1
    
   A portable framework for high-order spectral element flow simulations 
   | 
 


Public Member Functions | |
| procedure, pass(this) | init (this, msh, lx, params, user, time_scheme) | 
| procedure, pass(this) | free (this) | 
| procedure, pass(this) | step (this, t, tstep, dt, ext_bdf, dt_controller) | 
| Advance fluid simulation in time.   | |
| procedure, pass(this) | restart (this, dtlag, tlag) | 
| procedure, pass(this) | fluid_scheme_init_all (this, msh, lx, params, kspv_init, kspp_init, scheme, user) | 
| Constructor for the base type.   | |
| procedure, pass(this) | fluid_scheme_init_common (this, msh, lx, params, scheme, user, kspv_init) | 
| Initialise a fluid scheme.   | |
| generic | scheme_init (this, msh, lx, params, kspv_init, kspp_init, scheme, user) | 
| Constructor for the base type.   | |
| generic | scheme_init (this, msh, lx, params, scheme, user, kspv_init) | 
| Initialise a fluid scheme.   | |
| procedure, pass(this) | scheme_free (this) | 
| Destructor for the base type.   | |
| procedure, pass(this) | validate (this) | 
| Validate that all components are properly allocated.   | |
| procedure, pass(this) | bc_apply_vel (this, t, tstep) | 
| Apply pressure boundary conditions.   | |
| procedure, pass(this) | bc_apply_prs (this, t, tstep) | 
| Apply velocity boundary conditions.   | |
| procedure, pass(this) | set_usr_inflow (this, usr_eval) | 
| Set the user inflow procedure.   | |
| procedure, pass(this) | compute_cfl (this, dt) | 
| Compute the CFL number.   | |
| procedure, pass(this) | set_material_properties (this, params, user) | 
| Set rho and mu.   | |
| procedure(fluid_scheme_init_intrf), deferred, pass | init (this, msh, lx, params, user, time_scheme) | 
| Constructor.   | |
| procedure(fluid_scheme_free_intrf), deferred, pass | free (this) | 
| Destructor.   | |
| procedure(fluid_scheme_step_intrf), deferred, pass | step (this, t, tstep, dt, ext_bdf, dt_controller) | 
| Advance one step in time.   | |
| procedure(fluid_scheme_restart_intrf), deferred, pass | restart (this, dtlag, tlag) | 
| Restart from a checkpoint.   | |
| procedure, pass(this) | update_material_properties (this) | 
| Update variable material properties.   | |
Public Attributes | |
| type(field_t) | p_res | 
| type(field_t) | u_res | 
| type(field_t) | v_res | 
| type(field_t) | w_res | 
| type(field_t) | dp | 
| type(field_t) | du | 
| type(field_t) | dv | 
| type(field_t) | dw | 
| class(ax_t), allocatable | ax_vel | 
| class(ax_t), allocatable | ax_prs | 
| type(projection_t) | proj_prs | 
| type(projection_t) | proj_u | 
| type(projection_t) | proj_v | 
| type(projection_t) | proj_w | 
| type(facet_normal_t) | bc_prs_surface | 
| Surface term in pressure rhs.   | |
| type(facet_normal_t) | bc_sym_surface | 
| Surface term in pressure rhs.   | |
| type(dirichlet_t) | bc_vel_res | 
| Dirichlet condition vel. res.   | |
| type(dirichlet_t) | bc_field_dirichlet_p | 
| Dirichlet condition vel. res.   | |
| type(dirichlet_t) | bc_field_dirichlet_u | 
| Dirichlet condition vel. res.   | |
| type(dirichlet_t) | bc_field_dirichlet_v | 
| Dirichlet condition vel. res.   | |
| type(dirichlet_t) | bc_field_dirichlet_w | 
| Dirichlet condition vel. res.   | |
| type(non_normal_t) | bc_vel_res_non_normal | 
| Dirichlet condition vel. res.   | |
| type(bc_list_t) | bclst_vel_res | 
| type(bc_list_t) | bclst_du | 
| type(bc_list_t) | bclst_dv | 
| type(bc_list_t) | bclst_dw | 
| type(bc_list_t) | bclst_dp | 
| class(advection_t), allocatable | adv | 
| logical | oifs | 
| type(field_t) | abx1 | 
| type(field_t) | aby1 | 
| type(field_t) | abz1 | 
| type(field_t) | abx2 | 
| type(field_t) | aby2 | 
| type(field_t) | abz2 | 
| type(field_t) | advx | 
| type(field_t) | advy | 
| type(field_t) | advz | 
| class(pnpn_prs_res_t), allocatable | prs_res | 
| Pressure residual.   | |
| class(pnpn_vel_res_t), allocatable | vel_res | 
| Velocity residual.   | |
| class(rhs_maker_sumab_t), allocatable | sumab | 
| Summation of AB/BDF contributions.   | |
| class(rhs_maker_ext_t), allocatable | makeabf | 
| Contributions to kth order extrapolation scheme.   | |
| class(rhs_maker_bdf_t), allocatable | makebdf | 
| Contributions to F from lagged BD terms.   | |
| class(rhs_maker_oifs_t), allocatable | makeoifs | 
| Contributions to the RHS from the OIFS method.   | |
| type(fluid_volflow_t) | vol_flow | 
| Adjust flow volume.   | |
| type(field_t), pointer | u => null() | 
| x-component of Velocity   | |
| type(field_t), pointer | v => null() | 
| y-component of Velocity   | |
| type(field_t), pointer | w => null() | 
| z-component of Velocity   | |
| type(field_t), pointer | p => null() | 
| Pressure.   | |
| type(field_series_t) | ulag | 
| type(field_series_t) | vlag | 
| type(field_series_t) | wlag | 
| fluid field (lag)   | |
| type(space_t) | xh | 
| Function space \( X_h \).   | |
| type(dofmap_t) | dm_xh | 
| Dofmap associated with \( X_h \).   | |
| type(gs_t) | gs_xh | 
| Gather-scatter associated with \( X_h \).   | |
| type(coef_t) | c_xh | 
| Coefficients associated with \( X_h \).   | |
| type(fluid_source_term_t) | source_term | 
| The source term for the momentum equation.   | |
| type(field_t), pointer | f_x => null() | 
| X-component of the right-hand side.   | |
| type(field_t), pointer | f_y => null() | 
| Y-component of the right-hand side.   | |
| type(field_t), pointer | f_z => null() | 
| Z-component of the right-hand side.   | |
| class(ksp_t), allocatable | ksp_vel | 
| Krylov solver for velocity.   | |
| class(ksp_t), allocatable | ksp_prs | 
| Krylov solver for pressure.   | |
| class(pc_t), allocatable | pc_vel | 
| Velocity Preconditioner.   | |
| class(pc_t), allocatable | pc_prs | 
| Velocity Preconditioner.   | |
| integer | vel_projection_dim | 
| Size of the projection space for ksp_vel.   | |
| integer | pr_projection_dim | 
| Size of the projection space for ksp_pr.   | |
| integer | vel_projection_activ_step | 
| Steps to activate projection for ksp_vel.   | |
| integer | pr_projection_activ_step | 
| Steps to activate projection for ksp_pr.   | |
| type(no_slip_wall_t) | bc_wall | 
| No-slip wall for velocity.   | |
| class(bc_t), allocatable | bc_inflow | 
| Dirichlet inflow for velocity.   | |
| type(wall_model_bc_t) | bc_wallmodel | 
| Wall model boundary condition.   | |
| logical | if_gradient_jump_penalty | 
| Gradient jump panelty.   | |
| type(gradient_jump_penalty_t) | gradient_jump_penalty_u | 
| type(gradient_jump_penalty_t) | gradient_jump_penalty_v | 
| type(gradient_jump_penalty_t) | gradient_jump_penalty_w | 
| type(field_dirichlet_vector_t) | user_field_bc_vel | 
| User-computed Dirichlet velocity condition.   | |
| type(field_dirichlet_t) | user_field_bc_prs | 
| User-computed Dirichlet pressure condition.   | |
| type(dirichlet_t) | bc_prs | 
| Dirichlet pressure condition.   | |
| type(dong_outflow_t) | bc_dong | 
| Dong outflow condition.   | |
| type(symmetry_t) | bc_sym | 
| Symmetry plane for velocity.   | |
| type(shear_stress_t) | bc_sh | 
| Symmetry plane for velocity.   | |
| type(bc_list_t) | bclst_vel | 
| List of velocity conditions.   | |
| type(bc_list_t) | bclst_vel_neumann | 
| List of neumann velocity conditions.   | |
| type(bc_list_t) | bclst_prs | 
| List of pressure conditions.   | |
| type(field_t) | bdry | 
| Boundary markings.   | |
| type(json_file), pointer | params | 
| Parameters.   | |
| type(mesh_t), pointer | msh => null() | 
| Mesh.   | |
| type(chkp_t) | chkp | 
| Checkpoint.   | |
| type(mean_flow_t) | mean | 
| Mean flow field.   | |
| type(fluid_stats_t) | stats | 
| Fluid statistics.   | |
| type(mean_sqr_flow_t) | mean_sqr | 
| Mean squared flow field.   | |
| logical | forced_flow_rate = .false. | 
| Is the flow rate forced?   | |
| logical | freeze = .false. | 
| Freeze velocity at initial condition?   | |
| real(kind=rp) | mu | 
| Dynamic viscosity.   | |
| type(field_t) | mu_field | 
| The variable mu field.   | |
| character(len=:), allocatable | nut_field_name | 
| The turbulent kinematic viscosity field name.   | |
| logical | variable_material_properties = .false. | 
| Is mu varying in time? Currently only due to LES models.   | |
| real(kind=rp) | rho | 
| Density.   | |
| type(field_t) | rho_field | 
| The variable density field.   | |
| type(scratch_registry_t) | scratch | 
| Manager for temporary fields.   | |
| character(len=neko_msh_max_zlbl_len), dimension(:), allocatable | bc_labels | 
| Boundary condition labels (if any)   | |
Private Member Functions | |
| procedure, pass(this), private | set_bc_type_output (this, params) | 
| Set boundary types for the diagnostic output.   | |
Definition at line 74 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 170 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 168 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 174 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 160 of file fluid_scheme.f90.
      
  | 
  inherited | 
Initialize common data for the current scheme
Definition at line 161 of file fluid_scheme.f90.
Definition at line 137 of file fluid_pnpn.f90.
      
  | 
  pure virtualinherited | 
Definition at line 181 of file fluid_scheme.f90.
| procedure, pass(this) fluid_pnpn::fluid_pnpn_t::init | ( | class(fluid_pnpn_t), intent(inout), target | this, | 
| type(mesh_t), intent(inout), target | msh, | ||
| integer, intent(inout) | lx, | ||
| type(json_file), intent(inout), target | params, | ||
| type(user_t), intent(in), target | user, | ||
| type(time_scheme_controller_t), intent(in), target | time_scheme | ||
| ) | 
Definition at line 136 of file fluid_pnpn.f90.
      
  | 
  pure virtualinherited | 
Definition at line 179 of file fluid_scheme.f90.
| procedure, pass(this) fluid_pnpn::fluid_pnpn_t::restart | ( | class(fluid_pnpn_t), intent(inout), target | this, | 
| real(kind=rp), dimension(10) | dtlag, | ||
| real(kind=rp), dimension(10) | tlag | ||
| ) | 
Definition at line 139 of file fluid_pnpn.f90.
      
  | 
  pure virtualinherited | 
Definition at line 185 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 164 of file fluid_scheme.f90.
      
  | 
  inherited | 
      
  | 
  inherited | 
Initialize common data for the current scheme
Definition at line 162 of file fluid_scheme.f90.
      
  | 
  privateinherited | 
| params | The JSON case file. | 
Definition at line 186 of file fluid_scheme.f90.
      
  | 
  inherited | 
| params | The case paramter file. | 
| user | The user interface. | 
Definition at line 176 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 172 of file fluid_scheme.f90.
| procedure, pass(this) fluid_pnpn::fluid_pnpn_t::step | ( | class(fluid_pnpn_t), intent(inout), target | this, | 
| real(kind=rp), intent(inout) | t, | ||
| integer, intent(inout) | tstep, | ||
| real(kind=rp), intent(in) | dt, | ||
| type(time_scheme_controller_t), intent(inout) | ext_bdf, | ||
| type(time_step_controller_t), intent(in) | dt_controller | ||
| ) | 
| t | The time value. | 
| tstep | The current interation. | 
| dt | The timestep | 
| ext_bdf | Time integration logic. | 
| dt_controller | timestep controller | 
Definition at line 138 of file fluid_pnpn.f90.
      
  | 
  pure virtualinherited | 
Definition at line 183 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 189 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 166 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::abx1 | 
Definition at line 109 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::abx2 | 
Definition at line 110 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::aby1 | 
Definition at line 109 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::aby2 | 
Definition at line 110 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::abz1 | 
Definition at line 109 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::abz2 | 
Definition at line 110 of file fluid_pnpn.f90.
| class(advection_t), allocatable fluid_pnpn::fluid_pnpn_t::adv | 
Definition at line 103 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::advx | 
Definition at line 112 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::advy | 
Definition at line 112 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::advz | 
Definition at line 112 of file fluid_pnpn.f90.
| class(ax_t), allocatable fluid_pnpn::fluid_pnpn_t::ax_prs | 
Definition at line 82 of file fluid_pnpn.f90.
| class(ax_t), allocatable fluid_pnpn::fluid_pnpn_t::ax_vel | 
Definition at line 80 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 128 of file fluid_scheme.f90.
| type(dirichlet_t) fluid_pnpn::fluid_pnpn_t::bc_field_dirichlet_p | 
Definition at line 92 of file fluid_pnpn.f90.
| type(dirichlet_t) fluid_pnpn::fluid_pnpn_t::bc_field_dirichlet_u | 
Definition at line 93 of file fluid_pnpn.f90.
| type(dirichlet_t) fluid_pnpn::fluid_pnpn_t::bc_field_dirichlet_v | 
Definition at line 94 of file fluid_pnpn.f90.
| type(dirichlet_t) fluid_pnpn::fluid_pnpn_t::bc_field_dirichlet_w | 
Definition at line 95 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 116 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 157 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 127 of file fluid_scheme.f90.
| type(facet_normal_t) fluid_pnpn::fluid_pnpn_t::bc_prs_surface | 
Definition at line 89 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 130 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 129 of file fluid_scheme.f90.
| type(facet_normal_t) fluid_pnpn::fluid_pnpn_t::bc_sym_surface | 
Definition at line 90 of file fluid_pnpn.f90.
| type(dirichlet_t) fluid_pnpn::fluid_pnpn_t::bc_vel_res | 
Definition at line 91 of file fluid_pnpn.f90.
| type(non_normal_t) fluid_pnpn::fluid_pnpn_t::bc_vel_res_non_normal | 
Definition at line 96 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 115 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 117 of file fluid_scheme.f90.
| type(bc_list_t) fluid_pnpn::fluid_pnpn_t::bclst_dp | 
Definition at line 101 of file fluid_pnpn.f90.
| type(bc_list_t) fluid_pnpn::fluid_pnpn_t::bclst_du | 
Definition at line 98 of file fluid_pnpn.f90.
| type(bc_list_t) fluid_pnpn::fluid_pnpn_t::bclst_dv | 
Definition at line 99 of file fluid_pnpn.f90.
| type(bc_list_t) fluid_pnpn::fluid_pnpn_t::bclst_dw | 
Definition at line 100 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 133 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 131 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 132 of file fluid_scheme.f90.
| type(bc_list_t) fluid_pnpn::fluid_pnpn_t::bclst_vel_res | 
Definition at line 97 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 134 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 98 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 137 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 96 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::dp | 
Definition at line 77 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::du | 
Definition at line 77 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::dv | 
Definition at line 77 of file fluid_pnpn.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::dw | 
Definition at line 77 of file fluid_pnpn.f90.
Definition at line 102 of file fluid_scheme.f90.
Definition at line 104 of file fluid_scheme.f90.
Definition at line 106 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 141 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 142 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 120 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 121 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 122 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 97 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 119 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 108 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 107 of file fluid_scheme.f90.
| class(rhs_maker_ext_t), allocatable fluid_pnpn::fluid_pnpn_t::makeabf | 
Definition at line 124 of file fluid_pnpn.f90.
| class(rhs_maker_bdf_t), allocatable fluid_pnpn::fluid_pnpn_t::makebdf | 
Definition at line 127 of file fluid_pnpn.f90.
| class(rhs_maker_oifs_t), allocatable fluid_pnpn::fluid_pnpn_t::makeoifs | 
Definition at line 130 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 138 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 140 of file fluid_scheme.f90.
Definition at line 136 of file fluid_scheme.f90.
Definition at line 144 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 146 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 148 of file fluid_scheme.f90.
| logical fluid_pnpn::fluid_pnpn_t::oifs | 
Definition at line 106 of file fluid_pnpn.f90.
Definition at line 93 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::p_res | 
Definition at line 75 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 135 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 110 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 109 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 114 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 112 of file fluid_scheme.f90.
| type(projection_t) fluid_pnpn::fluid_pnpn_t::proj_prs | 
Definition at line 84 of file fluid_pnpn.f90.
| type(projection_t) fluid_pnpn::fluid_pnpn_t::proj_u | 
Definition at line 85 of file fluid_pnpn.f90.
| type(projection_t) fluid_pnpn::fluid_pnpn_t::proj_v | 
Definition at line 86 of file fluid_pnpn.f90.
| type(projection_t) fluid_pnpn::fluid_pnpn_t::proj_w | 
Definition at line 87 of file fluid_pnpn.f90.
| class(pnpn_prs_res_t), allocatable fluid_pnpn::fluid_pnpn_t::prs_res | 
Definition at line 115 of file fluid_pnpn.f90.
Definition at line 152 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 154 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 155 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 100 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 139 of file fluid_scheme.f90.
| class(rhs_maker_sumab_t), allocatable fluid_pnpn::fluid_pnpn_t::sumab | 
Definition at line 121 of file fluid_pnpn.f90.
Definition at line 90 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::u_res | 
Definition at line 75 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 94 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 126 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 125 of file fluid_scheme.f90.
Definition at line 91 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::v_res | 
Definition at line 75 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 150 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 113 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 111 of file fluid_scheme.f90.
| class(pnpn_vel_res_t), allocatable fluid_pnpn::fluid_pnpn_t::vel_res | 
Definition at line 118 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 94 of file fluid_scheme.f90.
| type(fluid_volflow_t) fluid_pnpn::fluid_pnpn_t::vol_flow | 
Definition at line 133 of file fluid_pnpn.f90.
Definition at line 92 of file fluid_scheme.f90.
| type(field_t) fluid_pnpn::fluid_pnpn_t::w_res | 
Definition at line 75 of file fluid_pnpn.f90.
      
  | 
  inherited | 
Definition at line 94 of file fluid_scheme.f90.
      
  | 
  inherited | 
Definition at line 95 of file fluid_scheme.f90.