Base type of all fluid formulations. More...

Inheritance diagram for fluid_scheme_base::fluid_scheme_base_t:

[legend]

Collaboration diagram for fluid_scheme_base::fluid_scheme_base_t:

[legend]

Public Member Functions
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)

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, time)
	Set rho and mu.

Public Attributes
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.

Detailed Description

Definition at line 58 of file fluid_scheme_base.f90.

Member Function/Subroutine Documentation

◆ compute_cfl()

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 virtual

Definition at line 129 of file fluid_scheme_base.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 virtual

Definition at line 118 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,
		type(chkp_t), intent(inout), target	chkp
	)

pure virtual

Definition at line 116 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,
		type(chkp_t), intent(inout)	chkp
	)

pure virtual

Definition at line 122 of file fluid_scheme_base.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), target	this,
		type(user_t), intent(in), target	user,
		type(json_file), intent(inout)	params
	)

pure virtual

Definition at line 124 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,
		type(time_state_t), intent(in)	time,
		type(time_step_controller_t), intent(in)	dt_controller
	)

pure virtual

Definition at line 120 of file fluid_scheme_base.f90.

◆ update_material_properties()

procedure(update_material_properties), deferred, pass fluid_scheme_base::fluid_scheme_base_t::update_material_properties	(	class(fluid_scheme_base_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

pure virtual

Definition at line 131 of file fluid_scheme_base.f90.

◆ validate()

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

pure virtual

Definition at line 127 of file fluid_scheme_base.f90.

Member Data Documentation

◆ bc_labels

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

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

Definition at line 88 of file fluid_scheme_base.f90.

◆ bcs_vel

type(bc_list_t) fluid_scheme_base::fluid_scheme_base_t::bcs_vel

Definition at line 90 of file fluid_scheme_base.f90.

◆ c_xh

type(coef_t) fluid_scheme_base::fluid_scheme_base_t::c_xh

Definition at line 65 of file fluid_scheme_base.f90.

◆ chkp

type(chkp_t), pointer fluid_scheme_base::fluid_scheme_base_t::chkp => null()

Definition at line 77 of file fluid_scheme_base.f90.

◆ dm_xh

type(dofmap_t) fluid_scheme_base::fluid_scheme_base_t::dm_xh

Definition at line 63 of file fluid_scheme_base.f90.

◆ ext_bdf

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

Definition at line 67 of file fluid_scheme_base.f90.

◆ f_x

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

Definition at line 80 of file fluid_scheme_base.f90.

◆ f_y

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

Definition at line 82 of file fluid_scheme_base.f90.

◆ f_z

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

Definition at line 84 of file fluid_scheme_base.f90.

◆ freeze

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

Definition at line 108 of file fluid_scheme_base.f90.

◆ gs_xh

type(gs_t) fluid_scheme_base::fluid_scheme_base_t::gs_xh

Definition at line 64 of file fluid_scheme_base.f90.

◆ material_properties

type(field_list_t) fluid_scheme_base::fluid_scheme_base_t::material_properties

Definition at line 105 of file fluid_scheme_base.f90.

◆ msh

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

Definition at line 93 of file fluid_scheme_base.f90.

◆ mu

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

Definition at line 102 of file fluid_scheme_base.f90.

◆ name

character(len=:), allocatable fluid_scheme_base::fluid_scheme_base_t::name

Definition at line 60 of file fluid_scheme_base.f90.

◆ p

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

Definition at line 73 of file fluid_scheme_base.f90.

◆ params

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

Definition at line 92 of file fluid_scheme_base.f90.

◆ rho

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

Definition at line 99 of file fluid_scheme_base.f90.

◆ u

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

x-component of Velocity

Definition at line 70 of file fluid_scheme_base.f90.

◆ ulag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::ulag

Definition at line 74 of file fluid_scheme_base.f90.

◆ user_material_properties

procedure(user_material_properties_intf), pointer, nopass fluid_scheme_base::fluid_scheme_base_t::user_material_properties => null()

static

Definition at line 111 of file fluid_scheme_base.f90.

◆ v

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

Definition at line 71 of file fluid_scheme_base.f90.

◆ vlag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::vlag

Definition at line 74 of file fluid_scheme_base.f90.

◆ w

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

Definition at line 72 of file fluid_scheme_base.f90.

◆ wlag

type(field_series_t) fluid_scheme_base::fluid_scheme_base_t::wlag

Definition at line 74 of file fluid_scheme_base.f90.

◆ xh

type(space_t) fluid_scheme_base::fluid_scheme_base_t::xh

Definition at line 62 of file fluid_scheme_base.f90.

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

/home/runner/work/neko/neko/src/fluid/fluid_scheme_base.f90

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ compute_cfl()

◆ free()

◆ init()

◆ restart()

◆ setup_bcs()

◆ step()

◆ update_material_properties()

◆ validate()

Member Data Documentation

◆ bc_labels

◆ bcs_prs

◆ bcs_vel

◆ c_xh

◆ chkp

◆ dm_xh

◆ ext_bdf

◆ f_x

◆ f_y

◆ f_z

◆ freeze

◆ gs_xh

◆ material_properties

◆ msh

◆ mu

◆ name

◆ p

◆ params

◆ rho

◆ u

◆ ulag

◆ user_material_properties

◆ v

◆ vlag

◆ w

◆ wlag

◆ xh