User defined dirichlet condition for scalars. More...

Inheritance diagram for usr_scalar::usr_scalar_t:

Collaboration diagram for usr_scalar::usr_scalar_t:

[legend]

Public Member Functions
procedure, pass(this)	apply_scalar (this, x, n, t, tstep, strong)
	Scalar apply Just imitating inflow for now, but we should look this over Applies boundary conditions in eval on x.

procedure, pass(this)	apply_vector (this, x, y, z, n, t, tstep, strong)
	No-op vector apply.

procedure, pass(this)	validate (this)
	Validate user scalar condition.

procedure, pass(this)	set_eval (this, user_scalar_bc)
	Assign user provided eval function.

procedure, pass(this)	apply_vector_dev (this, x_d, y_d, z_d, t, tstep, strong)
	No-op vector apply (device version)

procedure, pass(this)	apply_scalar_dev (this, x_d, t, tstep, strong)
	Scalar apply (device version) Just imitating inflow for now, but we should look this over Applies boundary conditions in eval on x.

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

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

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

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.

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

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(bc_destructor), deferred, pass	free (this)
	Deferred destructor.

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

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

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

Static Public Attributes
procedure(usr_scalar_bc_eval), pointer, nopass	eval => null()

Private Attributes
type(c_ptr), private	usr_x_d = C_NULL_PTR

Detailed Description

Definition at line 46 of file usr_scalar.f90.

Member Function/Subroutine Documentation

◆ apply_scalar() [1/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::apply_scalar	(	class(usr_scalar_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
	)

Parameters

x	The field array to apply the boundary condition to.
n	The size of x.

Definition at line 50 of file usr_scalar.f90.

◆ apply_scalar_dev() [1/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::apply_scalar_dev	(	class(usr_scalar_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
	)

Parameters

x	The array of values to apply.
n	The size of x.

Definition at line 55 of file usr_scalar.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/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::apply_vector	(	class(usr_scalar_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
	)

Definition at line 51 of file usr_scalar.f90.

◆ apply_vector_dev() [1/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::apply_vector_dev	(	class(usr_scalar_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 54 of file usr_scalar.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/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::finalize ( class(usr_scalar_t), intent(inout), target this )

Definition at line 61 of file usr_scalar.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/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::free ( class(usr_scalar_t), intent(inout), target this )

Definition at line 59 of file usr_scalar.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/2]

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/2]

procedure, pass(this) usr_scalar::usr_scalar_t::init	(	class(usr_scalar_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 57 of file usr_scalar.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.

◆ 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_eval()

procedure, pass(this) usr_scalar::usr_scalar_t::set_eval	(	class(usr_scalar_t), intent(inout)	this,
		procedure(usr_scalar_bc_eval)	user_scalar_bc
	)

Parameters

user_scalar_bc User specified scalar boundary condition

Definition at line 53 of file usr_scalar.f90.

◆ validate()

procedure, pass(this) usr_scalar::usr_scalar_t::validate ( class(usr_scalar_t), intent(inout) this )

Definition at line 52 of file usr_scalar.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.

◆ eval

procedure(usr_scalar_bc_eval), pointer, nopass usr_scalar::usr_scalar_t::eval => null()

static

Definition at line 47 of file usr_scalar.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.

◆ strong

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

inherited

Definition at line 80 of file bc.f90.

◆ updated

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

inherited

Definition at line 83 of file bc.f90.

◆ usr_x_d

type(c_ptr), private usr_scalar::usr_scalar_t::usr_x_d = C_NULL_PTR

private

Definition at line 48 of file usr_scalar.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/usr_scalar.f90

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ apply_scalar() [1/2]

◆ apply_scalar() [2/2]

◆ apply_scalar_dev() [1/2]

◆ apply_scalar_dev() [2/2]

◆ apply_scalar_generic()

◆ apply_vector() [1/2]

◆ apply_vector() [2/2]

◆ apply_vector_dev() [1/2]

◆ apply_vector_dev() [2/2]

◆ apply_vector_generic()

◆ debug_mask_()

◆ finalize() [1/2]

◆ finalize() [2/2]

◆ finalize_base()

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ mark_facet()

◆ mark_facets()

◆ mark_zone()

◆ set_eval()

◆ validate()

Member Data Documentation

◆ coef

◆ dof

◆ eval

◆ facet

◆ facet_d

◆ marked_facet

◆ msh

◆ msk

◆ msk_d

◆ strong

◆ updated

◆ usr_x_d

◆ xh