Inheritance diagram for adv_oifs::adv_oifs_t:

Collaboration diagram for adv_oifs::adv_oifs_t:

[legend]

Public Member Functions
procedure, pass(this)	compute (this, vx, vy, vz, fx, fy, fz, xh, coef, n, dt)
	Add the advection term for the fluid, i.e. \(u \cdot \nabla u \), to the RHS.

procedure, pass(this)	compute_scalar (this, vx, vy, vz, s, fs, xh, coef, n, dt)
	Add the advection term for a scalar, i.e. \(u \cdot \nabla s \), to the RHS.

procedure, pass(this)	init (this, lxd, coef, ctarget, ulag, vlag, wlag, dtlag, tlag, time_scheme, slag)
	Constructor.

procedure, pass(this)	set_conv_velocity_fst (this, u, v, w)
	setting characteristic convecting field

procedure, pass(this)	free (this)
	Destructor.

procedure(compute_adv), deferred, pass	compute (this, vx, vy, vz, fx, fy, fz, xh, coef, n, dt)

procedure(compute_scalar_adv), deferred, pass	compute_scalar (this, vx, vy, vz, s, fs, xh, coef, n, dt)

procedure(advection_free), deferred, pass	free (this)

Public Attributes
integer	ntaubd
	Number of RK4 sub-steps.

type(coef_t)	coef_gl
	Coeffs of the higher-order space.

type(coef_t), pointer	coef_gll => null()
	Coeffs of the original space in the simulation.

type(interpolator_t)	gll_to_gl
	Interpolator between the original and higher-order spaces.

type(space_t)	xh_gl
	The additional higher-order space used in dealiasing.

type(space_t), pointer	xh_gll => null()
	The original space used in the simulation.

type(time_interpolator_t)	dtime
	The time interpolator scheme.

type(field_series_t), pointer	ulag
	The lagged velocity and scalar fields.

type(field_series_t), pointer	vlag

type(field_series_t), pointer	wlag

type(field_series_t), pointer	slag => null()

real(kind=rp), dimension(:), pointer	ctlag => null()
	The times corresponding to the lagged fields.

real(kind=rp), dimension(:), pointer	dctlag => null()
	The time-steps corresponding to the lagged fields.

type(time_scheme_controller_t), pointer	oifs_scheme => null()
	The time scheme controller for the oifs scheme.

real(kind=rp), dimension(:), allocatable	cx
	The convecting velocity field in GLL space.

real(kind=rp), dimension(:), allocatable	cy

real(kind=rp), dimension(:), allocatable	cz

real(kind=rp), dimension(:,:), allocatable	c
	The convecting field in GL space.

Detailed Description

Definition at line 58 of file adv_oifs.f90.

Member Function/Subroutine Documentation

◆ compute() [1/2]

procedure(compute_adv), deferred, pass advection::advection_t::compute	(	class(advection_t), intent(inout)	this,
		type(field_t), intent(inout)	vx,
		type(field_t), intent(inout)	vy,
		type(field_t), intent(inout)	vz,
		type(field_t), intent(inout)	fx,
		type(field_t), intent(inout)	fy,
		type(field_t), intent(inout)	fz,
		type(space_t), intent(in)	xh,
		type(coef_t), intent(in)	coef,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	dt
	)

pure virtualinherited

Definition at line 48 of file advection.f90.

◆ compute() [2/2]

procedure, pass(this) adv_oifs::adv_oifs_t::compute	(	class(adv_oifs_t), intent(inout)	this,
		type(field_t), intent(inout)	vx,
		type(field_t), intent(inout)	vy,
		type(field_t), intent(inout)	vz,
		type(field_t), intent(inout)	fx,
		type(field_t), intent(inout)	fy,
		type(field_t), intent(inout)	fz,
		type(space_t), intent(in)	xh,
		type(coef_t), intent(in)	coef,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	dt
	)

Parameters

vx	The x component of velocity.
vy	The y component of velocity.
vz	The z component of velocity.
fx	The x component of source term.
fy	The y component of source term.
fz	The z component of source term.
Xh	The function space.
coef	The coefficients of the (Xh, mesh) pair.
n	Typically the size of the mesh.
dt	Current time-step.

Definition at line 88 of file adv_oifs.f90.

◆ compute_scalar() [1/2]

procedure(compute_scalar_adv), deferred, pass advection::advection_t::compute_scalar	(	class(advection_t), intent(inout)	this,
		type(field_t), intent(inout)	vx,
		type(field_t), intent(inout)	vy,
		type(field_t), intent(inout)	vz,
		type(field_t), intent(inout)	s,
		type(field_t), intent(inout)	fs,
		type(space_t), intent(in)	xh,
		type(coef_t), intent(in)	coef,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	dt
	)

pure virtualinherited

Definition at line 49 of file advection.f90.

◆ compute_scalar() [2/2]

procedure, pass(this) adv_oifs::adv_oifs_t::compute_scalar	(	class(adv_oifs_t), intent(inout)	this,
		type(field_t), intent(inout)	vx,
		type(field_t), intent(inout)	vy,
		type(field_t), intent(inout)	vz,
		type(field_t), intent(inout)	s,
		type(field_t), intent(inout)	fs,
		type(space_t), intent(in)	xh,
		type(coef_t), intent(in)	coef,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	dt
	)

Parameters

this	The object.
vx	The x component of velocity.
vy	The y component of velocity.
vz	The z component of velocity.
s	The scalar.
fs	The source term.
Xh	The function space.
coef	The coefficients of the (Xh, mesh) pair.
n	Typically the size of the mesh.
dt	Current time-step.

Definition at line 91 of file adv_oifs.f90.

◆ free() [1/2]

procedure(advection_free), deferred, pass advection::advection_t::free ( class(advection_t), intent(inout) this )

pure virtualinherited

Definition at line 50 of file advection.f90.

◆ free() [2/2]

procedure, pass(this) adv_oifs::adv_oifs_t::free ( class(adv_oifs_t), intent(inout) this )

Definition at line 97 of file adv_oifs.f90.

◆ init()

procedure, pass(this) adv_oifs::adv_oifs_t::init	(	class(adv_oifs_t)	this,
		integer, intent(in)	lxd,
		type(coef_t), target	coef,
		real(kind=rp), intent(in)	ctarget,
		type(field_series_t), intent(in), target	ulag,
		type(field_series_t), intent(in), target	vlag,
		type(field_series_t), intent(in), target	wlag,
		real(kind=rp), dimension(10), intent(in), target	dtlag,
		real(kind=rp), dimension(10), intent(in), target	tlag,
		type(time_scheme_controller_t), intent(in), target	time_scheme,
		type(field_series_t), optional, target	slag
	)

Parameters

lxd	The polynomial order of the space used in the dealiasing.
coef	The coefficients of the (space, mesh) pair.
ctarget	Target CFL number.
ulag	The x component of lagged velocity.
vlag	The y component of lagged velocity.
wlag	The z component of lagged velocity.
dtlag	Lagged time steps.
tlag	Lagged simulation times.
time_scheme	The bdf-ext time scheme used in the method.
slag	The lagged scalar field.

Definition at line 93 of file adv_oifs.f90.

◆ set_conv_velocity_fst()

procedure, pass(this) adv_oifs::adv_oifs_t::set_conv_velocity_fst	(	class(adv_oifs_t), intent(inout)	this,
		type(field_t), intent(inout)	u,
		type(field_t), intent(inout)	v,
		type(field_t), intent(inout)	w
	)

Parameters

u	Velocity component in x-direction
v	Velocity component in y-direction
w	Velocity component in z-direction

Note: similar to set_ct_cvx in NEK5000

Definition at line 95 of file adv_oifs.f90.

Member Data Documentation

◆ c

real(kind=rp), dimension(:,:), allocatable adv_oifs::adv_oifs_t::c

Definition at line 84 of file adv_oifs.f90.

◆ coef_gl

type(coef_t) adv_oifs::adv_oifs_t::coef_gl

Definition at line 62 of file adv_oifs.f90.

◆ coef_gll

type(coef_t), pointer adv_oifs::adv_oifs_t::coef_gll => null()

Definition at line 64 of file adv_oifs.f90.

◆ ctlag

real(kind=rp), dimension(:), pointer adv_oifs::adv_oifs_t::ctlag => null()

Definition at line 76 of file adv_oifs.f90.

◆ cx

real(kind=rp), dimension(:), allocatable adv_oifs::adv_oifs_t::cx

Definition at line 82 of file adv_oifs.f90.

◆ cy

real(kind=rp), dimension(:), allocatable adv_oifs::adv_oifs_t::cy

Definition at line 82 of file adv_oifs.f90.

◆ cz

real(kind=rp), dimension(:), allocatable adv_oifs::adv_oifs_t::cz

Definition at line 82 of file adv_oifs.f90.

◆ dctlag

real(kind=rp), dimension(:), pointer adv_oifs::adv_oifs_t::dctlag => null()

Definition at line 78 of file adv_oifs.f90.

◆ dtime

type(time_interpolator_t) adv_oifs::adv_oifs_t::dtime

Definition at line 72 of file adv_oifs.f90.

◆ gll_to_gl

type(interpolator_t) adv_oifs::adv_oifs_t::gll_to_gl

Definition at line 66 of file adv_oifs.f90.

◆ ntaubd

integer adv_oifs::adv_oifs_t::ntaubd

Definition at line 60 of file adv_oifs.f90.

◆ oifs_scheme

type(time_scheme_controller_t), pointer adv_oifs::adv_oifs_t::oifs_scheme => null()

Definition at line 80 of file adv_oifs.f90.

◆ slag

type(field_series_t), pointer adv_oifs::adv_oifs_t::slag => null()

Definition at line 74 of file adv_oifs.f90.

◆ ulag

type(field_series_t), pointer adv_oifs::adv_oifs_t::ulag

Definition at line 74 of file adv_oifs.f90.

◆ vlag

type(field_series_t), pointer adv_oifs::adv_oifs_t::vlag

Definition at line 74 of file adv_oifs.f90.

◆ wlag

type(field_series_t), pointer adv_oifs::adv_oifs_t::wlag

Definition at line 74 of file adv_oifs.f90.

◆ xh_gl

type(space_t) adv_oifs::adv_oifs_t::xh_gl

Definition at line 68 of file adv_oifs.f90.

◆ xh_gll

type(space_t), pointer adv_oifs::adv_oifs_t::xh_gll => null()

Definition at line 70 of file adv_oifs.f90.

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

/home/runner/work/neko/neko/src/fluid/bcknd/advection/adv_oifs.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ compute() [1/2]

◆ compute() [2/2]

◆ compute_scalar() [1/2]

◆ compute_scalar() [2/2]

◆ free() [1/2]

◆ free() [2/2]

◆ init()

◆ set_conv_velocity_fst()

Member Data Documentation

◆ c

◆ coef_gl

◆ coef_gll

◆ ctlag

◆ cx

◆ cy

◆ cz

◆ dctlag

◆ dtime

◆ gll_to_gl

◆ ntaubd

◆ oifs_scheme

◆ slag

◆ ulag

◆ vlag

◆ wlag

◆ xh_gl

◆ xh_gll