A shear stress boundary condition, computing the stress values using a wall model. More...

Inheritance diagram for wall_model_bc::wall_model_bc_t:

[legend]

Collaboration diagram for wall_model_bc::wall_model_bc_t:

[legend]

Public Member Functions
procedure, pass(this)	apply_scalar (this, x, n, t, tstep)
	Apply shear stress for a scalar field x.

procedure, pass(this)	apply_vector (this, x, y, z, n, t, tstep)
	Apply the boundary condition to the right-hand side.

procedure, pass(this)	apply_scalar_dev (this, x_d, t, tstep)
	Boundary condition apply for a generic wall_model_bc condition to a vector x (device version)

procedure, pass(this)	apply_vector_dev (this, x_d, y_d, z_d, t, tstep)
	Boundary condition apply for a generic wall_model_bc condition to vectors x, y and z (device version)

procedure, pass(this)	init_wall_model_bc (this, json, nu)
	Constructor.

procedure, pass(this)	apply_scalar (this, x, n, t, tstep)
	Apply shear stress for a scalar field x.

procedure(bc_apply_scalar), deferred, pass	apply_scalar (this, x, n, t, tstep)
	Apply the boundary condition to a scalar field.

procedure, pass(this)	apply_vector (this, x, y, z, n, t, tstep)
	Boundary condition apply for a generic shear_stress condition to vectors x, y and z.

procedure(bc_apply_vector), deferred, pass	apply_vector (this, x, y, z, n, t, tstep)
	Apply the boundary condition to a vector field.

procedure, pass(this)	apply_scalar_dev (this, x_d, t, tstep)
	Boundary condition apply for a generic shear_stress condition to a vector x (device version)

procedure(bc_apply_scalar_dev), deferred, pass	apply_scalar_dev (this, x_d, t, tstep)
	Device version of apply_scalar.

procedure, pass(this)	apply_vector_dev (this, x_d, y_d, z_d, t, tstep)
	Boundary condition apply for a generic shear_stress condition to vectors x, y and z (device version)

procedure(bc_apply_vector_dev), deferred, pass	apply_vector_dev (this, x_d, y_d, z_d, t, tstep)
	Device version of apply_vector.

procedure, pass(this)	init_shear_stress (this, coef)
	Additional constructor that should be run after the finalization of the bc. Similar to the symmetry condition.

procedure, pass(this)	set_stress_scalar (this, tau_x, tau_y, tau_z)
	Set the value of the shear stress vector using 3 scalars.

procedure, pass(this)	set_stress_array (this, tau_x, tau_y, tau_z)
	Set the shear stress components.

generic	set_stress (this, tau_x, tau_y, tau_z)
	Set the value of the shear stress vector using 3 scalars.

generic	set_stress (this, tau_x, tau_y, tau_z)
	Set the shear stress components.

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

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

procedure, pass(this)	init_base (this, coef)
	Constructor.

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

procedure, pass(this)	mark_facet (this, facet, el)
	Mark a facet on an element as part of the boundary condition.

procedure, pass(this)	mark_facets (this, facet_list)
	Mark all facets from a (facet, element) tuple list.

procedure, pass(this)	mark_zones_from_list (this, bc_zones, bc_key, bc_labels)
	Mark all facets from a list of zones, also marks type of bc in the mesh.

procedure, pass(this)	mark_zone (this, bc_zone)
	Mark all facets from a zone.

procedure, pass(this)	finalize (this)
	Finalize the construction of the bc by populting the msk and facet arrays.

Public Attributes
class(wall_model_t), allocatable	wall_model
	The wall model to compute the stress.

type(symmetry_t)	symmetry

type(neumann_t)	neumann_x
	Neumann condition for the x direction.

type(neumann_t)	neumann_y
	Neumann condition for the y direction.

type(neumann_t)	neumann_z
	Neumann condition for the z direction.

integer, dimension(:), allocatable	msk
	The linear index of each node in each boundary facet.

integer, dimension(:), allocatable	facet
	A list of facet ids (1 to 6), one for each element in msk.

type(dofmap_t), pointer	dof
	Map of degrees of freedom.

type(coef_t), pointer	coef
	SEM coefficients.

type(mesh_t), pointer	msh
	The mesh.

type(space_t), pointer	xh
	The function space.

type(stack_i4t2_t)	marked_facet
	Index tuples (facet, element) marked as part of the boundary condition.

type(c_ptr)	msk_d = C_NULL_PTR
	Device pointer for msk.

type(c_ptr)	facet_d = C_NULL_PTR
	Device pointer for facet.

Detailed Description

Warning: Only works with axis-aligned boundaries.

Definition at line 52 of file wall_model_bc.f90.

Member Function/Subroutine Documentation

◆ apply_scalar() [1/3]

procedure(bc_apply_scalar), deferred, pass bc::bc_t::apply_scalar	(	class(bc_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

pure virtualinherited

Definition at line 87 of file bc.f90.

◆ apply_scalar() [2/3]

procedure, pass(this) shear_stress::shear_stress_t::apply_scalar	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

inherited

Definition at line 61 of file shear_stress.f90.

◆ apply_scalar() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::apply_scalar	(	class(wall_model_bc_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

Definition at line 56 of file wall_model_bc.f90.

◆ apply_scalar_dev() [1/3]

procedure(bc_apply_scalar_dev), deferred, pass bc::bc_t::apply_scalar_dev	(	class(bc_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

pure virtualinherited

Definition at line 91 of file bc.f90.

◆ apply_scalar_dev() [2/3]

procedure, pass(this) shear_stress::shear_stress_t::apply_scalar_dev	(	class(shear_stress_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

inherited

Definition at line 63 of file shear_stress.f90.

◆ apply_scalar_dev() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::apply_scalar_dev	(	class(wall_model_bc_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

Definition at line 58 of file wall_model_bc.f90.

◆ apply_vector() [1/3]

procedure(bc_apply_vector), deferred, pass bc::bc_t::apply_vector	(	class(bc_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		real(kind=rp), dimension(n), intent(inout)	y,
		real(kind=rp), dimension(n), intent(inout)	z,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

pure virtualinherited

Definition at line 89 of file bc.f90.

◆ apply_vector() [2/3]

procedure, pass(this) shear_stress::shear_stress_t::apply_vector	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		real(kind=rp), dimension(n), intent(inout)	y,
		real(kind=rp), dimension(n), intent(inout)	z,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

inherited

Definition at line 62 of file shear_stress.f90.

◆ apply_vector() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::apply_vector	(	class(wall_model_bc_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		real(kind=rp), dimension(n), intent(inout)	y,
		real(kind=rp), dimension(n), intent(inout)	z,
		integer, intent(in)	n,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

Parameters

x	The x component of the right-hand side
y	The y component of the right-hand side
z	The z component of the right-hand side
n	The size of the right-hand side arrays.
t	The time value.
tstep	The time step.

Definition at line 57 of file wall_model_bc.f90.

◆ apply_vector_dev() [1/3]

procedure(bc_apply_vector_dev), deferred, pass bc::bc_t::apply_vector_dev	(	class(bc_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		type(c_ptr)	y_d,
		type(c_ptr)	z_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

pure virtualinherited

Definition at line 93 of file bc.f90.

◆ apply_vector_dev() [2/3]

procedure, pass(this) shear_stress::shear_stress_t::apply_vector_dev	(	class(shear_stress_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		type(c_ptr)	y_d,
		type(c_ptr)	z_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

inherited

Definition at line 64 of file shear_stress.f90.

◆ apply_vector_dev() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::apply_vector_dev	(	class(wall_model_bc_t), intent(inout), target	this,
		type(c_ptr)	x_d,
		type(c_ptr)	y_d,
		type(c_ptr)	z_d,
		real(kind=rp), intent(in), optional	t,
		integer, intent(in), optional	tstep
	)

Definition at line 60 of file wall_model_bc.f90.

◆ finalize()

procedure, pass(this) bc::bc_t::finalize ( class(bc_t), intent(inout), target this )

inherited

This will linearize the marked facet's indicies in the msk array.

Definition at line 85 of file bc.f90.

◆ free() [1/2]

procedure(bc_destructor), deferred, pass bc::bc_t::free ( class(bc_t), intent(inout), target this )

pure virtualinherited

Definition at line 95 of file bc.f90.

◆ free() [2/2]

procedure, pass(this) shear_stress::shear_stress_t::free ( class(shear_stress_t), intent(inout), target this )

inherited

Definition at line 72 of file shear_stress.f90.

◆ free_base()

procedure, pass(this) bc::bc_t::free_base ( class(bc_t), intent(inout) this )

inherited

Definition at line 74 of file bc.f90.

◆ init_base()

procedure, pass(this) bc::bc_t::init_base	(	class(bc_t), intent(inout)	this,
		type(coef_t), intent(in), target	coef
	)

inherited

Parameters

dof	Map of degrees of freedom.

Definition at line 72 of file bc.f90.

◆ init_shear_stress()

procedure, pass(this) shear_stress::shear_stress_t::init_shear_stress	(	class(shear_stress_t), intent(inout)	this,
		type(coef_t), intent(in), target	coef
	)

inherited

Parameters

coef	The SEM coefficients.

Definition at line 65 of file shear_stress.f90.

◆ init_wall_model_bc()

procedure, pass(this) wall_model_bc::wall_model_bc_t::init_wall_model_bc	(	class(wall_model_bc_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		real(kind=rp), intent(in)	nu
	)

Parameters

coef	The SEM coefficients.

Definition at line 62 of file wall_model_bc.f90.

◆ mark_facet()

procedure, pass(this) bc::bc_t::mark_facet	(	class(bc_t), intent(inout)	this,
		integer, intent(in)	facet,
		integer, intent(in)	el
	)

inherited

Parameters

facet	The index of the facet.
el	The index of the element.

Definition at line 76 of file bc.f90.

◆ mark_facets()

procedure, pass(this) bc::bc_t::mark_facets	(	class(bc_t), intent(inout)	this,
		type(stack_i4t2_t), intent(inout)	facet_list
	)

inherited

Parameters

facet_list The list of tuples.

Definition at line 78 of file bc.f90.

◆ mark_zone()

procedure, pass(this) bc::bc_t::mark_zone	(	class(bc_t), intent(inout)	this,
		class(facet_zone_t), intent(inout)	bc_zone
	)

inherited

Parameters

bc_zone Boundary zone to be marked.

Definition at line 82 of file bc.f90.

◆ mark_zones_from_list()

procedure, pass(this) bc::bc_t::mark_zones_from_list	(	class(bc_t), intent(inout)	this,
		class(facet_zone_t), dimension(:), intent(inout)	bc_zones,
		character(len=*)	bc_key,
		character(len=neko_msh_max_zlbl_len), dimension(:)	bc_labels
	)

inherited

Parameters

bc_zone	Array of boundary zones.
bc_key	Boundary condition label, e.g. 'w' for wall.
bc_label	List of boundary condition labels.

Definition at line 80 of file bc.f90.

◆ set_stress() [1/2]

generic shear_stress::shear_stress_t::set_stress	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), intent(in)	tau_x,
		real(kind=rp), intent(in)	tau_y,
		real(kind=rp), intent(in)	tau_z
	)

inherited

Definition at line 71 of file shear_stress.f90.

◆ set_stress() [2/2]

generic shear_stress::shear_stress_t::set_stress	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_x,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_y,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_z
	)

inherited

Definition at line 71 of file shear_stress.f90.

◆ set_stress_array()

procedure, pass(this) shear_stress::shear_stress_t::set_stress_array	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_x,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_y,
		real(kind=rp), dimension(this%msk(0)), intent(in)	tau_z
	)

inherited

Definition at line 69 of file shear_stress.f90.

◆ set_stress_scalar()

procedure, pass(this) shear_stress::shear_stress_t::set_stress_scalar	(	class(shear_stress_t), intent(inout)	this,
		real(kind=rp), intent(in)	tau_x,
		real(kind=rp), intent(in)	tau_y,
		real(kind=rp), intent(in)	tau_z
	)

inherited

Definition at line 67 of file shear_stress.f90.

Member Data Documentation

◆ coef

type(coef_t), pointer bc::bc_t::coef

inherited

Definition at line 59 of file bc.f90.

◆ dof

type(dofmap_t), pointer bc::bc_t::dof

inherited

Definition at line 57 of file bc.f90.

◆ facet

integer, dimension(:), allocatable bc::bc_t::facet

inherited

Definition at line 55 of file bc.f90.

◆ facet_d

type(c_ptr) bc::bc_t::facet_d = C_NULL_PTR

inherited

Definition at line 69 of file bc.f90.

◆ marked_facet

type(stack_i4t2_t) bc::bc_t::marked_facet

inherited

Definition at line 65 of file bc.f90.

◆ msh

type(mesh_t), pointer bc::bc_t::msh

inherited

Definition at line 61 of file bc.f90.

◆ msk

integer, dimension(:), allocatable bc::bc_t::msk

inherited

Definition at line 53 of file bc.f90.

◆ msk_d

type(c_ptr) bc::bc_t::msk_d = C_NULL_PTR

inherited

Definition at line 67 of file bc.f90.

◆ neumann_x

type(neumann_t) shear_stress::shear_stress_t::neumann_x

inherited

Definition at line 55 of file shear_stress.f90.

◆ neumann_y

type(neumann_t) shear_stress::shear_stress_t::neumann_y

inherited

Definition at line 57 of file shear_stress.f90.

◆ neumann_z

type(neumann_t) shear_stress::shear_stress_t::neumann_z

inherited

Definition at line 59 of file shear_stress.f90.

◆ symmetry

type(symmetry_t) shear_stress::shear_stress_t::symmetry

inherited

Definition at line 52 of file shear_stress.f90.

◆ wall_model

class(wall_model_t), allocatable wall_model_bc::wall_model_bc_t::wall_model

Definition at line 54 of file wall_model_bc.f90.

◆ xh

type(space_t), pointer bc::bc_t::xh

inherited

Definition at line 63 of file bc.f90.

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

/home/runner/work/neko/neko/src/bc/wall_model_bc.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ apply_scalar() [1/3]

◆ apply_scalar() [2/3]

◆ apply_scalar() [3/3]

◆ apply_scalar_dev() [1/3]

◆ apply_scalar_dev() [2/3]

◆ apply_scalar_dev() [3/3]

◆ apply_vector() [1/3]

◆ apply_vector() [2/3]

◆ apply_vector() [3/3]

◆ apply_vector_dev() [1/3]

◆ apply_vector_dev() [2/3]

◆ apply_vector_dev() [3/3]

◆ finalize()

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ init_base()

◆ init_shear_stress()

◆ init_wall_model_bc()

◆ mark_facet()

◆ mark_facets()

◆ mark_zone()

◆ mark_zones_from_list()

◆ set_stress() [1/2]

◆ set_stress() [2/2]

◆ set_stress_array()

◆ set_stress_scalar()

Member Data Documentation

◆ coef

◆ dof

◆ facet

◆ facet_d

◆ marked_facet

◆ msh

◆ msk

◆ msk_d

◆ neumann_x

◆ neumann_y

◆ neumann_z

◆ symmetry

◆ wall_model

◆ xh