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


Public Member Functions | |
| procedure, pass(this) | init (this, msh, lx, param) | 
| procedure, pass(this) | free (this) | 
| procedure, pass(this) | step (this, t, tstep, ext_bdf, dt_controller) | 
| procedure, pass(this) | init_base (this, msh, lx, params, scheme, user, kspv_init) | 
| Constructor for the base type.   | |
| procedure, pass(this) | scheme_free (this) | 
| procedure, pass(this) | validate (this) | 
| Validate that all components are properly allocated.   | |
| procedure(validate_intrf), deferred, pass | validate (this) | 
| Set the user inflow.   | |
| procedure, pass(this) | bc_apply_vel (this, time, strong) | 
| Apply pressure boundary conditions.   | |
| procedure, pass(this) | bc_apply_prs (this, time) | 
| Apply velocity boundary conditions.   | |
| procedure, pass(this) | compute_cfl (this, dt) | 
| Compute the CFL number.   | |
| procedure(fluid_scheme_base_compute_cfl_intrf), deferred, pass | compute_cfl (this, dt) | 
| Compute the CFL number.   | |
| procedure, pass(this) | set_material_properties (this, params, user) | 
| Set rho and mu.   | |
| procedure, pass(this) | update_material_properties (this, time) | 
| Update variable material properties.   | |
| procedure(update_material_properties), deferred, pass | update_material_properties (this, time) | 
| Set rho and mu.   | |
| procedure, pass(this) | precon_factory_ (this, pc, ksp, coef, dof, gs, bclst, pctype, pcparams) | 
| Preconditioner factory.   | |
| procedure(fluid_scheme_base_init_intrf), deferred, pass | init (this, msh, lx, params, user, chkp) | 
| Constructor.   | |
| procedure(fluid_scheme_base_free_intrf), deferred, pass | free (this) | 
| Destructor.   | |
| procedure(fluid_scheme_base_step_intrf), deferred, pass | step (this, time, dt_controller) | 
| Advance one step in time.   | |
| procedure(fluid_scheme_base_restart_intrf), deferred, pass | restart (this, chkp) | 
| Restart from a checkpoint.   | |
| procedure(fluid_scheme_setup_bcs_intrf), deferred, pass | setup_bcs (this, user, params) | 
Static Public Member Functions | |
| procedure, nopass | solver_factory (ksp, n, solver, max_iter, abstol, monitor) | 
| Linear solver factory, wraps a KSP constructor.   | |
Public Attributes | |
| type(space_t) | yh | 
| Function space for pressure \( Xh - 2 \).   | |
| type(dofmap_t) | dm_yh | 
| Dofmap associated with \( Yh \).   | |
| type(gs_t) | gs_yh | 
| Gather-scatter associated with \( Y_h \).   | |
| type(coef_t) | c_yh | 
| Coefficients associated with \( Y_h \).   | |
| type(fluid_source_term_t) | source_term | 
| The source term for the momentum equation.   | |
| 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.   | |
| logical | strict_convergence | 
| Strict convergence for the velocity solver.   | |
| type(field_t), pointer | u_e => null() | 
| Extrapolation velocity fields for LES.   | |
| type(field_t), pointer | v_e => null() | 
| Extrapolated y-Velocity.   | |
| type(field_t), pointer | w_e => null() | 
| Extrapolated z-Velocity.   | |
| type(fluid_stats_t) | stats | 
| Fluid statistics.   | |
| logical | forced_flow_rate = .false. | 
| Is the flow rate forced?   | |
| character(len=:), allocatable | nut_field_name | 
| The turbulent kinematic viscosity field name.   | |
| type(field_t), pointer | mu_tot => null() | 
| integer(kind=i8) | glb_n_points | 
| Global number of GLL points for the fluid (not unique)   | |
| integer(kind=i8) | glb_unique_points | 
| Global number of GLL points for the fluid (unique)   | |
| type(scratch_registry_t) | scratch | 
| Manager for temporary fields.   | |
| character(len=:), allocatable | name | 
| A name that can be used to distinguish this solver in e.g. user routines.   | |
| 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(time_scheme_controller_t), allocatable | ext_bdf | 
| type(field_t), pointer | u => null() | 
| The velocity field.   | |
| 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(chkp_t), pointer | chkp => null() | 
| Checkpoint.   | |
| 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.   | |
| type(bc_list_t) | bcs_prs | 
| Boundary conditions.   | |
| type(bc_list_t) | bcs_vel | 
| type(json_file), pointer | params | 
| Parameters.   | |
| type(mesh_t), pointer | msh => null() | 
| Mesh.   | |
| character(len=neko_msh_max_zlbl_len), dimension(:), allocatable | bc_labels | 
| Boundary condition labels (if any)   | |
| type(field_t), pointer | rho => null() | 
| Density field.   | |
| type(field_t), pointer | mu => null() | 
| The dynamic viscosity.   | |
| type(field_list_t) | material_properties | 
| A helper that packs material properties to pass to the user routine.   | |
| logical | freeze = .false. | 
| Is the fluid frozen at the moment.   | |
Static Public Attributes | |
| procedure(user_material_properties_intf), pointer, nopass | user_material_properties => null() | 
| User material properties routine.   | |
Definition at line 10 of file fluid_plan1.f90.
      
  | 
  inherited | 
Definition at line 115 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 113 of file fluid_scheme_incompressible.f90.
      
  | 
  pure virtualinherited | 
Definition at line 129 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 117 of file fluid_scheme_incompressible.f90.
Definition at line 18 of file fluid_plan1.f90.
      
  | 
  pure virtualinherited | 
Definition at line 118 of file fluid_scheme_base.f90.
| procedure, pass(this) fluid_plan1::fluid_plan1_t::init | ( | class(fluid_plan1_t), intent(inout), target | this, | 
| type(mesh_t), intent(inout), target | msh, | ||
| integer, intent(in) | lx, | ||
| type(param_t), intent(inout), target | param | ||
| ) | 
Definition at line 17 of file fluid_plan1.f90.
      
  | 
  pure virtualinherited | 
Definition at line 116 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Initialize common data for the current scheme
Definition at line 108 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 128 of file fluid_scheme_incompressible.f90.
      
  | 
  pure virtualinherited | 
Definition at line 122 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 109 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
| params | The case paramter file. | 
| user | The user interface. | 
Definition at line 119 of file fluid_scheme_incompressible.f90.
      
  | 
  pure virtualinherited | 
Definition at line 124 of file fluid_scheme_base.f90.
      
  | 
  staticinherited | 
Definition at line 126 of file fluid_scheme_incompressible.f90.
| procedure, pass(this) fluid_plan1::fluid_plan1_t::step | ( | class(fluid_plan1_t), intent(inout), target | this, | 
| real(kind=rp), intent(in) | t, | ||
| integer, intent(in) | tstep, | ||
| type(time_scheme_controller_t), intent(in) | ext_bdf, | ||
| type(time_step_controller_t), intent(in) | dt_controller | ||
| ) | 
Definition at line 19 of file fluid_plan1.f90.
      
  | 
  pure virtualinherited | 
Definition at line 120 of file fluid_scheme_base.f90.
      
  | 
  pure virtualinherited | 
Definition at line 131 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
| t | Time value. | 
| tstep | Current time step. | 
Definition at line 123 of file fluid_scheme_incompressible.f90.
      
  | 
  pure virtualinherited | 
Definition at line 127 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 111 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 96 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 88 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 90 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 65 of file fluid_scheme_base.f90.
| type(coef_t) fluid_plan1::fluid_plan1_t::c_yh | 
Definition at line 14 of file fluid_plan1.f90.
Definition at line 77 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 63 of file fluid_scheme_base.f90.
| type(dofmap_t) fluid_plan1::fluid_plan1_t::dm_yh | 
Definition at line 12 of file fluid_plan1.f90.
      
  | 
  inherited | 
Definition at line 67 of file fluid_scheme_base.f90.
Definition at line 80 of file fluid_scheme_base.f90.
Definition at line 82 of file fluid_scheme_base.f90.
Definition at line 84 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 93 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 108 of file fluid_scheme_base.f90.
Definition at line 102 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 104 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 64 of file fluid_scheme_base.f90.
| type(gs_t) fluid_plan1::fluid_plan1_t::gs_yh | 
Definition at line 13 of file fluid_plan1.f90.
      
  | 
  inherited | 
Definition at line 79 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 78 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 105 of file fluid_scheme_base.f90.
Definition at line 93 of file fluid_scheme_base.f90.
Definition at line 102 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 99 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 60 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 96 of file fluid_scheme_incompressible.f90.
Definition at line 73 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 92 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 81 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 80 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 85 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 83 of file fluid_scheme_incompressible.f90.
Definition at line 99 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 105 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 77 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 92 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 86 of file fluid_scheme_incompressible.f90.
x-component of Velocity
Definition at line 70 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Extrapolated x-Velocity
Definition at line 88 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 74 of file fluid_scheme_base.f90.
      
  | 
  staticinherited | 
Definition at line 111 of file fluid_scheme_base.f90.
Definition at line 71 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 89 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 84 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 82 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 74 of file fluid_scheme_base.f90.
Definition at line 72 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 90 of file fluid_scheme_incompressible.f90.
      
  | 
  inherited | 
Definition at line 74 of file fluid_scheme_base.f90.
      
  | 
  inherited | 
Definition at line 62 of file fluid_scheme_base.f90.
| type(space_t) fluid_plan1::fluid_plan1_t::yh | 
Definition at line 11 of file fluid_plan1.f90.