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)	init (this, coef, json)
	Constructor.

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

procedure, pass(this)	finalize (this)
	Finalize by building mask arrays and init'ing the wall model.

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

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

procedure, pass(this)	apply_scalar_dev (this, x_d, t, tstep, strong)
	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, strong)
	Boundary condition apply for a generic wall_model_bc condition to vectors x, y and z (device version)

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

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

procedure, pass(this)	apply_vector (this, x, y, z, n, t, tstep, strong)
	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, strong)
	Apply the boundary condition to a vector field on the CPU.

procedure, pass(this)	apply_scalar_dev (this, x_d, t, tstep, strong)
	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, strong)
	Device version of apply_scalar on the device.

procedure, pass(this)	apply_vector_dev (this, x_d, y_d, z_d, t, tstep, strong)
	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, strong)
	Device version of apply_vector on the device.

procedure, pass(this)	init (this, coef, json)
	Constructor.

procedure(bc_constructor), deferred, pass	init (this, coef, json)
	Deferred constructor.

procedure, pass(this)	init_from_components (this, coef, value)
	Constructor from components.

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 shear stress to apply.

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

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

procedure(bc_destructor), deferred, pass	free (this)
	Deferred destructor.

procedure, pass(this)	finalize (this)
	Finalize the construction.

procedure(bc_finalize), deferred, pass	finalize (this)
	Deferred finalizer.

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_zone (this, bc_zone)
	Mark all facets from a zone.

procedure, pass(this)	finalize_base (this, only_facets)
	Finalize the construction of the bc by populating the msk and facet arrays.

procedure, pass(this)	apply_scalar_generic (this, x, n, t, tstep)
	Apply the boundary condition to a scalar field. Dispatches to the CPU or the device version.

procedure, pass(this)	apply_vector_generic (this, x, y, z, n, t, tstep)
	Apply the boundary condition to a vector field. Dispatches to the CPU or the device version.

procedure, pass(this)	debug_mask_ (this, file_name)
	Write a field showing the mask of the bcs.

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

real(kind=rp)	nu
	The kinematic viscosity.

type(json_file)	params_
	Parameter dictionary for the wall model.

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 => null()
	Map of degrees of freedom.

type(coef_t), pointer	coef => null()
	SEM coefficients.

type(mesh_t), pointer	msh => null()
	The mesh.

type(space_t), pointer	xh => null()
	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.

logical	strong = .true.
	Wether the bc is strongly enforced. Essentially valid for all Dirichlet types of bcs. These need to be masked out for solvers etc, so that values are not affected. Mixed bcs are, by convention, weak.

logical	updated = .false.
	Indicates wether the bc has been updated, for those BCs that need additional computations.

Detailed Description

Warning: Only works with axis-aligned boundaries.

Definition at line 53 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,
		logical, intent(in), optional	strong
	)

pure virtualinherited

Definition at line 108 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,
		logical, intent(in), optional	strong
	)

inherited

Definition at line 63 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,
		logical, intent(in), optional	strong
	)

Definition at line 67 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,
		logical, intent(in), optional	strong
	)

pure virtualinherited

Definition at line 112 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,
		logical, intent(in), optional	strong
	)

inherited

Definition at line 65 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,
		logical, intent(in), optional	strong
	)

Definition at line 69 of file wall_model_bc.f90.

◆ apply_scalar_generic()

procedure, pass(this) bc::bc_t::apply_scalar_generic	(	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
	)

inherited

Parameters

x	The x comp of the field for which to apply the bc.
y	The y comp of the field for which to apply the bc.
z	The z comp of the field for which to apply the bc.
n	The size of x, y, and z.
t	Current time.
tstep	The current time iteration.

Definition at line 101 of file 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,
		logical, intent(in), optional	strong
	)

pure virtualinherited

Definition at line 110 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,
		logical, intent(in), optional	strong
	)

inherited

Definition at line 64 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,
		logical, intent(in), optional	strong
	)

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 68 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,
		logical, intent(in), optional	strong
	)

pure virtualinherited

Definition at line 114 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,
		logical, intent(in), optional	strong
	)

inherited

Definition at line 66 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,
		logical, intent(in), optional	strong
	)

Definition at line 71 of file wall_model_bc.f90.

◆ apply_vector_generic()

procedure, pass(this) bc::bc_t::apply_vector_generic	(	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
	)

inherited

Parameters

x	The x comp of the field for which to apply the bc.
y	The y comp of the field for which to apply the bc.
z	The z comp of the field for which to apply the bc.
n	The size of x, y, and z.
t	Current time.
tstep	The current time iteration.

Definition at line 104 of file bc.f90.

◆ debug_mask_()

procedure, pass(this) bc::bc_t::debug_mask_	(	class(bc_t), intent(inout)	this,
		character(len=*), intent(in)	file_name
	)

inherited

The mask will be marked with 1.

Parameters

file_name The name of the fld file.

Definition at line 106 of file bc.f90.

◆ finalize() [1/3]

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

pure virtualinherited

Definition at line 120 of file bc.f90.

◆ finalize() [2/3]

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

inherited

Definition at line 81 of file shear_stress.f90.

◆ finalize() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::finalize ( class(wall_model_bc_t), intent(inout), target this )

Definition at line 66 of file wall_model_bc.f90.

◆ finalize_base()

procedure, pass(this) bc::bc_t::finalize_base	(	class(bc_t), intent(inout), target	this,
		logical, intent(in), optional	only_facets
	)

inherited

Parameters

only_facets,if the bc is only to be applied on facets. Relevant for bcs where the normal direction is important and where and shared dofs should not be included.

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

Definition at line 97 of file bc.f90.

◆ free() [1/3]

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

pure virtualinherited

Definition at line 116 of file bc.f90.

◆ free() [2/3]

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

inherited

Definition at line 79 of file shear_stress.f90.

◆ free() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::free ( class(wall_model_bc_t), intent(inout), target this )

Definition at line 64 of file wall_model_bc.f90.

◆ free_base()

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

inherited

Definition at line 88 of file bc.f90.

◆ init() [1/3]

procedure(bc_constructor), deferred, pass bc::bc_t::init	(	class(bc_t), intent(inout), target	this,
		type(coef_t), intent(in)	coef,
		type(json_file), intent(inout)	json
	)

pure virtualinherited

Definition at line 118 of file bc.f90.

◆ init() [2/3]

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

inherited

Parameters

[in]	coef	The SEM coefficients.
[in,out]	json	The JSON object configuring the boundary condition.

Definition at line 68 of file shear_stress.f90.

◆ init() [3/3]

procedure, pass(this) wall_model_bc::wall_model_bc_t::init	(	class(wall_model_bc_t), intent(inout), target	this,
		type(coef_t), intent(in)	coef,
		type(json_file), intent(inout)	json
	)

Parameters

[in]	coef	The SEM coefficients.
[in,out]	json	The JSON object configuring the boundary condition.

Definition at line 62 of file wall_model_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 86 of file bc.f90.

◆ init_from_components()

procedure, pass(this) shear_stress::shear_stress_t::init_from_components	(	class(shear_stress_t), intent(inout), target	this,
		type(coef_t), intent(in)	coef,
		real(kind=rp), dimension(3), intent(in)	value
	)

inherited

Parameters

[in]	coef	The SEM coefficients.
[in]	value	The value of the shear stress to apply.

Definition at line 70 of file shear_stress.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 90 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 92 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(in)	bc_zone
	)

inherited

Parameters

bc_zone Boundary zone to be marked.

Definition at line 94 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), 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 77 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), intent(in)	tau_x,
		real(kind=rp), intent(in)	tau_y,
		real(kind=rp), intent(in)	tau_z
	)

inherited

Definition at line 77 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 74 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 72 of file shear_stress.f90.

Member Data Documentation

◆ coef

type(coef_t), pointer bc::bc_t::coef => null()

inherited

Definition at line 65 of file bc.f90.

◆ dof

type(dofmap_t), pointer bc::bc_t::dof => null()

inherited

Definition at line 63 of file bc.f90.

◆ facet

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

inherited

Definition at line 61 of file bc.f90.

◆ facet_d

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

inherited

Definition at line 75 of file bc.f90.

◆ marked_facet

type(stack_i4t2_t) bc::bc_t::marked_facet

inherited

Definition at line 71 of file bc.f90.

◆ msh

type(mesh_t), pointer bc::bc_t::msh => null()

inherited

Definition at line 67 of file bc.f90.

◆ msk

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

inherited

Definition at line 59 of file bc.f90.

◆ msk_d

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

inherited

Definition at line 73 of file bc.f90.

◆ neumann_x

type(neumann_t) shear_stress::shear_stress_t::neumann_x

inherited

Definition at line 57 of file shear_stress.f90.

◆ neumann_y

type(neumann_t) shear_stress::shear_stress_t::neumann_y

inherited

Definition at line 59 of file shear_stress.f90.

◆ neumann_z

type(neumann_t) shear_stress::shear_stress_t::neumann_z

inherited

Definition at line 61 of file shear_stress.f90.

◆ nu

real(kind=rp) wall_model_bc::wall_model_bc_t::nu

Definition at line 57 of file wall_model_bc.f90.

◆ params_

type(json_file) wall_model_bc::wall_model_bc_t::params_

Definition at line 59 of file wall_model_bc.f90.

◆ strong

logical bc::bc_t::strong = .true.

inherited

Definition at line 80 of file bc.f90.

◆ symmetry

type(symmetry_t) shear_stress::shear_stress_t::symmetry

inherited

Definition at line 54 of file shear_stress.f90.

◆ updated

logical bc::bc_t::updated = .false.

inherited

Definition at line 83 of file bc.f90.

◆ wall_model

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

Definition at line 55 of file wall_model_bc.f90.

◆ xh

type(space_t), pointer bc::bc_t::xh => null()

inherited

Definition at line 69 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_scalar_generic()

◆ 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]

◆ apply_vector_generic()

◆ debug_mask_()

◆ finalize() [1/3]

◆ finalize() [2/3]

◆ finalize() [3/3]

◆ finalize_base()

◆ free() [1/3]

◆ free() [2/3]

◆ free() [3/3]

◆ free_base()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]

◆ init_base()

◆ init_from_components()

◆ mark_facet()

◆ mark_facets()

◆ mark_zone()

◆ 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

◆ nu

◆ params_

◆ strong

◆ symmetry

◆ updated

◆ wall_model

◆ xh