Processing math: 100%
Neko 0.9.99
A portable framework for high-order spectral element flow simulations
All Classes Namespaces Files Functions Variables Typedefs Enumerator Macros Pages
fluid_scheme_compressible::fluid_scheme_compressible_t Type Referenceabstract

Base type of compressible fluid formulations. More...

Inheritance diagram for fluid_scheme_compressible::fluid_scheme_compressible_t:
Collaboration diagram for fluid_scheme_compressible::fluid_scheme_compressible_t:

Public Member Functions

procedure, pass(thisscheme_init (this, msh, lx, params, scheme, user)
 Constructors.
 
procedure, pass(thisscheme_free (this)
 Destructor for the base type.
 
procedure, pass(thisvalidate (this)
 Validate that all components are properly allocated.
 
procedure, pass(thiscompute_cfl (this, dt)
 Compute the CFL number.
 
procedure, pass(thisupdate_material_properties (this)
 Set rho and mu.
 
procedure(fluid_scheme_base_init_intrf), deferred, pass init (this, msh, lx, params, user)
 Constructor.
 
procedure(fluid_scheme_base_free_intrf), deferred, pass free (this)
 Destructor.
 
procedure(fluid_scheme_base_step_intrf), deferred, pass step (this, t, tstep, dt, ext_bdf, dt_controller)
 Advance one step in time.
 
procedure(fluid_scheme_base_restart_intrf), deferred, pass restart (this, dtlag, tlag)
 Restart from a checkpoint.
 
procedure(fluid_scheme_setup_bcs_intrf), deferred, pass setup_bcs (this, user, params)
 
procedure(validate_intrf), deferred, pass validate (this)
 Set the user inflow.
 
procedure(fluid_scheme_base_compute_cfl_intrf), deferred, pass compute_cfl (this, dt)
 Compute the CFL number.
 
procedure(update_material_properties), deferred, pass update_material_properties (this)
 Set rho and mu.
 

Public Attributes

type(field_t), pointer m_x => null()
 The momentum field.
 
type(field_t), pointer m_y => null()
 y-component of Momentum
 
type(field_t), pointer m_z => null()
 z-component of Momentum
 
type(field_t), pointer e => null()
 Total energy.
 
real(kind=rp) gamma
 
type(scratch_registry_tscratch
 Manager for temporary fields.
 
type(space_txh
 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)
 
real(kind=rp) rho
 Density.
 
type(field_trho_field
 
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.
 
type(chkp_t) chkp
 Checkpoint.
 
character(len=neko_msh_max_zlbl_len), dimension(:), allocatable bc_labels
 Boundary condition labels (if any)
 
real(kind=rp) mu
 Dynamic viscosity.
 
type(field_tmu_field
 The variable mu field.
 
logical variable_material_properties = .false.
 Is mu varying in time? Currently only due to LES models.
 
logical freeze = .false.
 Is the fluid frozen at the moment.
 

Detailed Description

Definition at line 53 of file fluid_scheme_compressible.f90.

Member Function/Subroutine Documentation

◆ compute_cfl() [1/2]

procedure(fluid_scheme_base_compute_cfl_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::compute_cfl ( class(fluid_scheme_base_t), intent(in this,
real(kind=rp), intent(in dt 
)
pure virtualinherited

Definition at line 124 of file fluid_scheme_base.f90.

◆ compute_cfl() [2/2]

procedure, pass(this) fluid_scheme_compressible::fluid_scheme_compressible_t::compute_cfl ( class(fluid_scheme_compressible_t), intent(in this,
real(kind=rp), intent(in dt 
)
Parameters
thisThe compressible fluid scheme object
dtCurrent timestep size
Returns
Computed CFL number

Definition at line 73 of file fluid_scheme_compressible.f90.

◆ free()

procedure(fluid_scheme_base_free_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::free ( class(fluid_scheme_base_t), intent(inout this)
pure virtualinherited

Definition at line 113 of file fluid_scheme_base.f90.

◆ init()

procedure(fluid_scheme_base_init_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::init ( class(fluid_scheme_base_t), intent(inout), target  this,
type(mesh_t), intent(inout), target  msh,
integer, intent(in lx,
type(json_file), intent(inout), target  params,
type(user_t), intent(in), target  user 
)
pure virtualinherited

Definition at line 111 of file fluid_scheme_base.f90.

◆ restart()

procedure(fluid_scheme_base_restart_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::restart ( class(fluid_scheme_base_t), intent(inout), target  this,
real(kind=rp), dimension(10)  dtlag,
real(kind=rp), dimension(10)  tlag 
)
pure virtualinherited

Definition at line 117 of file fluid_scheme_base.f90.

◆ scheme_free()

procedure, pass(this) fluid_scheme_compressible::fluid_scheme_compressible_t::scheme_free ( class(fluid_scheme_compressible_t), intent(inout this)
Parameters
thisThe compressible fluid scheme object to destroy

Definition at line 68 of file fluid_scheme_compressible.f90.

◆ scheme_init()

procedure, pass(this) fluid_scheme_compressible::fluid_scheme_compressible_t::scheme_init ( class(fluid_scheme_compressible_t), intent(inout), target  this,
type(mesh_t), intent(inout), target  msh,
integer, intent(in lx,
type(json_file), intent(inout), target  params,
character(len=*), intent(in scheme,
type(user_t), intent(in), target  user 
)
Parameters
thisThe compressible fluid scheme object
mshMesh data structure
lxPolynomial order in x-direction
paramsJSON configuration parameters
schemeName of the numerical scheme
userUser-defined parameters and functions

Definition at line 66 of file fluid_scheme_compressible.f90.

◆ setup_bcs()

procedure(fluid_scheme_setup_bcs_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::setup_bcs ( class(fluid_scheme_base_t), intent(inout this,
type(user_t), intent(in), target  user,
type(json_file), intent(inout params 
)
pure virtualinherited

Definition at line 119 of file fluid_scheme_base.f90.

◆ step()

procedure(fluid_scheme_base_step_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::step ( class(fluid_scheme_base_t), intent(inout), target  this,
real(kind=rp), intent(in t,
integer, intent(in tstep,
real(kind=rp), intent(in dt,
type(time_scheme_controller_t), intent(in ext_bdf,
type(time_step_controller_t), intent(in dt_controller 
)
pure virtualinherited

Definition at line 115 of file fluid_scheme_base.f90.

◆ update_material_properties() [1/2]

procedure(update_material_properties), deferred, pass fluid_scheme_base::fluid_scheme_base_t::update_material_properties ( class(fluid_scheme_base_t), intent(inout this)
pure virtualinherited

Definition at line 126 of file fluid_scheme_base.f90.

◆ update_material_properties() [2/2]

procedure, pass(this) fluid_scheme_compressible::fluid_scheme_compressible_t::update_material_properties ( class(fluid_scheme_compressible_t), intent(inout this)
Parameters
thisThe compressible fluid scheme object

Definition at line 76 of file fluid_scheme_compressible.f90.

◆ validate() [1/2]

procedure(validate_intrf), deferred, pass fluid_scheme_base::fluid_scheme_base_t::validate ( class(fluid_scheme_base_t), intent(inout), target  this)
pure virtualinherited

Definition at line 122 of file fluid_scheme_base.f90.

◆ validate() [2/2]

procedure, pass(this) fluid_scheme_compressible::fluid_scheme_compressible_t::validate ( class(fluid_scheme_compressible_t), intent(inout), target  this)
Parameters
thisThe compressible fluid scheme object

Definition at line 71 of file fluid_scheme_compressible.f90.

Member Data Documentation

◆ bc_labels

character(len=neko_msh_max_zlbl_len), dimension(:), allocatable fluid_scheme_base::fluid_scheme_base_t::bc_labels
inherited

Definition at line 96 of file fluid_scheme_base.f90.

◆ bcs_prs

type(bc_list_t) fluid_scheme_base::fluid_scheme_base_t::bcs_prs
inherited

Definition at line 87 of file fluid_scheme_base.f90.

◆ bcs_vel

type(bc_list_t) fluid_scheme_base::fluid_scheme_base_t::bcs_vel
inherited

Definition at line 89 of file fluid_scheme_base.f90.

◆ c_xh

type(coef_t) fluid_scheme_base::fluid_scheme_base_t::c_xh
inherited

Definition at line 63 of file fluid_scheme_base.f90.

◆ chkp

type(chkp_t) fluid_scheme_base::fluid_scheme_base_t::chkp
inherited

Definition at line 93 of file fluid_scheme_base.f90.

◆ dm_xh

type(dofmap_t) fluid_scheme_base::fluid_scheme_base_t::dm_xh
inherited

Definition at line 61 of file fluid_scheme_base.f90.

◆ e

type(field_t), pointer fluid_scheme_compressible::fluid_scheme_compressible_t::e => null()

Definition at line 58 of file fluid_scheme_compressible.f90.

◆ ext_bdf

type(time_scheme_controller_t), allocatable fluid_scheme_base::fluid_scheme_base_t::ext_bdf
inherited

Definition at line 65 of file fluid_scheme_base.f90.

◆ f_x

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::f_x => null()
inherited

Definition at line 79 of file fluid_scheme_base.f90.

◆ f_y

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::f_y => null()
inherited

Definition at line 81 of file fluid_scheme_base.f90.

◆ f_z

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::f_z => null()
inherited

Definition at line 83 of file fluid_scheme_base.f90.

◆ freeze

logical fluid_scheme_base::fluid_scheme_base_t::freeze = .false.
inherited

Definition at line 107 of file fluid_scheme_base.f90.

◆ gamma

real(kind=rp) fluid_scheme_compressible::fluid_scheme_compressible_t::gamma

Definition at line 60 of file fluid_scheme_compressible.f90.

◆ gs_xh

type(gs_t) fluid_scheme_base::fluid_scheme_base_t::gs_xh
inherited

Definition at line 62 of file fluid_scheme_base.f90.

◆ m_x

type(field_t), pointer fluid_scheme_compressible::fluid_scheme_compressible_t::m_x => null()

x-component of Momentum

Definition at line 55 of file fluid_scheme_compressible.f90.

◆ m_y

type(field_t), pointer fluid_scheme_compressible::fluid_scheme_compressible_t::m_y => null()

Definition at line 56 of file fluid_scheme_compressible.f90.

◆ m_z

type(field_t), pointer fluid_scheme_compressible::fluid_scheme_compressible_t::m_z => null()

Definition at line 57 of file fluid_scheme_compressible.f90.

◆ msh

type(mesh_t), pointer fluid_scheme_base::fluid_scheme_base_t::msh => null()
inherited

Definition at line 92 of file fluid_scheme_base.f90.

◆ mu

real(kind=rp) fluid_scheme_base::fluid_scheme_base_t::mu
inherited

Definition at line 99 of file fluid_scheme_base.f90.

◆ mu_field

type(field_t) fluid_scheme_base::fluid_scheme_base_t::mu_field
inherited

Definition at line 102 of file fluid_scheme_base.f90.

◆ p

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::p => null()
inherited

Definition at line 71 of file fluid_scheme_base.f90.

◆ params

type(json_file), pointer fluid_scheme_base::fluid_scheme_base_t::params
inherited

Definition at line 91 of file fluid_scheme_base.f90.

◆ rho

real(kind=rp) fluid_scheme_base::fluid_scheme_base_t::rho
inherited

Definition at line 75 of file fluid_scheme_base.f90.

◆ rho_field

type(field_t) fluid_scheme_base::fluid_scheme_base_t::rho_field
inherited

Definition at line 76 of file fluid_scheme_base.f90.

◆ scratch

type(scratch_registry_t) fluid_scheme_compressible::fluid_scheme_compressible_t::scratch

Definition at line 62 of file fluid_scheme_compressible.f90.

◆ u

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::u => null()
inherited

x-component of Velocity

Definition at line 68 of file fluid_scheme_base.f90.

◆ ulag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::ulag
inherited

Definition at line 72 of file fluid_scheme_base.f90.

◆ v

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::v => null()
inherited

Definition at line 69 of file fluid_scheme_base.f90.

◆ variable_material_properties

logical fluid_scheme_base::fluid_scheme_base_t::variable_material_properties = .false.
inherited

Definition at line 105 of file fluid_scheme_base.f90.

◆ vlag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::vlag
inherited

Definition at line 72 of file fluid_scheme_base.f90.

◆ w

type(field_t), pointer fluid_scheme_base::fluid_scheme_base_t::w => null()
inherited

Definition at line 70 of file fluid_scheme_base.f90.

◆ wlag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::wlag
inherited

Definition at line 72 of file fluid_scheme_base.f90.

◆ xh

type(space_t) fluid_scheme_base::fluid_scheme_base_t::xh
inherited

Definition at line 60 of file fluid_scheme_base.f90.


The documentation for this type was generated from the following file: