adv_dummy::adv_dummy_t Type Reference

A zero-valued advection that can be used to kill the advection term. More...

Inheritance diagram for adv_dummy::adv_dummy_t:

Collaboration diagram for adv_dummy::adv_dummy_t:

Public Member Functions
procedure, pass(this)	init (this, coef)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
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(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)

Detailed Description

Definition at line 44 of file adv_dummy.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_dummy::adv_dummy_t::compute	(	class(adv_dummy_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
	)

Here, does nothing.

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, not required for this method.

Definition at line 52 of file adv_dummy.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_dummy::adv_dummy_t::compute_scalar	(	class(adv_dummy_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
	)

Here, does nothing.

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, not required for this method.

Definition at line 55 of file adv_dummy.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_dummy::adv_dummy_t::free

(

class(adv_dummy_t), intent(inout)

this

)

Definition at line 49 of file adv_dummy.f90.

init()

procedure, pass(this) adv_dummy::adv_dummy_t::init	(	class(adv_dummy_t), intent(inout)	this,
		type(coef_t), intent(in)	coef
	)

Parameters

coef	The coefficients of the (space, mesh) pair.

Definition at line 47 of file adv_dummy.f90.

---

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

• /home/runner/work/neko/neko/src/fluid/bcknd/advection/adv_dummy.f90