Overset interface BC for a scalar field. More...

Inheritance diagram for overset_interface::overset_interface_t:

Collaboration diagram for overset_interface::overset_interface_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, coef, json)
	Constructor.

procedure, pass(this)	init_from_components (this, coef, field_name, tol, pad)
	Constructor from components.

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

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

procedure, pass(this)	apply_scalar (this, x, n, time, strong)
	Apply scalar by performing a masked copy.

procedure, pass(this)	apply_vector (this, x, y, z, n, time, strong)
	(No-op) Apply vector.

procedure, pass(this)	apply_vector_dev (this, x_d, y_d, z_d, time, strong, strm)
	(No-op) Apply vector (device).

procedure, pass(this)	apply_scalar_dev (this, x_d, time, strong, strm)
	Apply scalar (device).

procedure, pass(this)	update (this, time)
	Update values at the overset interface.

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, time, strong, strm)
	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, time, strong, strm)
	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, time, 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, time, 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, time, strong, strm)
	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, time, strong, strm)
	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, only_facets)
	Deferred finalizer.

Public Attributes
type(field_dirichlet_t)	bc_s
	Underlying scalar field Dirichlet bc.

type(field_list_t)	field_list
	Single-field list for compatibility with field-based update patterns.

character(len=:), allocatable	field_name
	Name of the scalar field to interpolate from the registry.

type(global_interpolation_t)	interface_interpolator
	Interpolator.

type(mask_t)	interface_dof_mask
	Mask for overset interface points.

type(mask_t)	domain_element_mask

type(vector_t)	x_dof
	Vectors holding dof coordinates for cases where mesh moves.

type(vector_t)	y_dof

type(vector_t)	z_dof

type(vector_t)	x_interface_dof

type(vector_t)	y_interface_dof

type(vector_t)	z_interface_dof

type(vector_t)	s_interface
	Interpolated scalar values on the interface.

type(vector_list_t)	interface_dof

type(vector_list_t)	interface_field

type(global_interpolation_settings_t)	interpolation_settings
	Interpolation settings.

logical	find_interface = .false.

logical	setup = .false.

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.

character(len=:), allocatable	name

integer, dimension(:), allocatable	zone_indices

Static Public Attributes
procedure(morph_overset_interface), pointer, nopass	morph_interface => null()
	Function pointer to the user routine performing the update of the values of the boundary fields.

Private Member Functions
procedure, pass, private	build_masks_ (this)
	Build domain masks for the overset interface.

procedure, pass, private	gather_interface_dofs_ (this)
	Gather the dofs at the interface.

procedure, pass, private	setup_interpolator_ (this)
	Set up the interpolator.

Detailed Description

Definition at line 64 of file overset_interface.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,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong
	)

pure virtualinherited

Definition at line 117 of file bc.f90.

◆ apply_scalar() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::apply_scalar	(	class(overset_interface_t), intent(inout)	this,
		real(kind=rp), dimension(n), intent(inout)	x,
		integer, intent(in)	n,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong
	)

Parameters

x	Field onto which to copy the values.
n	Size of the array `x`.
time	The current time state.

Definition at line 102 of file overset_interface.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), intent(inout)	x_d,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout)	strm
	)

pure virtualinherited

Definition at line 121 of file bc.f90.

◆ apply_scalar_dev() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::apply_scalar_dev	(	class(overset_interface_t), intent(inout), target	this,
		type(c_ptr), intent(inout)	x_d,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout)	strm
	)

Parameters

x_d	Device pointer to the field onto which to copy the values.
time	The current time state.
strm	Device stream

Definition at line 108 of file overset_interface.f90.

◆ apply_scalar_generic()

procedure, pass(this) bc::bc_t::apply_scalar_generic	(	class(bc_t), intent(inout)	this,
		type(field_t), intent(inout)	x,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout), optional	strm
	)

inherited

Parameters

x	The x comp of the field for which to apply the bc.
time	Current time state.
strong	Whether we are setting a strong or a weak bc.
strm	Device stream

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

pure virtualinherited

Definition at line 119 of file bc.f90.

◆ apply_vector() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::apply_vector	(	class(overset_interface_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,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong
	)

Definition at line 104 of file overset_interface.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), intent(inout)	x_d,
		type(c_ptr), intent(inout)	y_d,
		type(c_ptr), intent(inout)	z_d,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout)	strm
	)

pure virtualinherited

Definition at line 123 of file bc.f90.

◆ apply_vector_dev() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::apply_vector_dev	(	class(overset_interface_t), intent(inout), target	this,
		type(c_ptr), intent(inout)	x_d,
		type(c_ptr), intent(inout)	y_d,
		type(c_ptr), intent(inout)	z_d,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout)	strm
	)

Definition at line 106 of file overset_interface.f90.

◆ apply_vector_generic()

procedure, pass(this) bc::bc_t::apply_vector_generic	(	class(bc_t), intent(inout)	this,
		type(field_t), intent(inout)	x,
		type(field_t), intent(inout)	y,
		type(field_t), intent(inout)	z,
		type(time_state_t), intent(in), optional	time,
		logical, intent(in), optional	strong,
		type(c_ptr), intent(inout), optional	strm
	)

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.
time	Current time state.
strong	Whether we are setting a strong or a weak bc.
Device	stream

Definition at line 113 of file bc.f90.

◆ build_masks_()

procedure, pass, private overset_interface::overset_interface_t::build_masks_ ( class(overset_interface_t), intent(inout) this )

private

Definition at line 112 of file overset_interface.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 115 of file bc.f90.

◆ finalize() [1/2]

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

pure virtualinherited

Definition at line 129 of file bc.f90.

◆ finalize() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::finalize	(	class(overset_interface_t), intent(inout), target	this,
		logical, intent(in), optional	only_facets
	)

Definition at line 100 of file overset_interface.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 106 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 125 of file bc.f90.

◆ free() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::free ( class(overset_interface_t), intent(inout), target this )

Definition at line 98 of file overset_interface.f90.

◆ free_base()

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

inherited

Definition at line 97 of file bc.f90.

◆ gather_interface_dofs_()

procedure, pass, private overset_interface::overset_interface_t::gather_interface_dofs_ ( class(overset_interface_t), intent(inout) this )

private

Definition at line 114 of file overset_interface.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), target	coef,
		type(json_file), intent(inout)	json
	)

pure virtualinherited

Definition at line 127 of file bc.f90.

◆ init() [2/2]

procedure, pass(this) overset_interface::overset_interface_t::init	(	class(overset_interface_t), intent(inout), target	this,
		type(coef_t), intent(in), target	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 93 of file overset_interface.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 95 of file bc.f90.

◆ init_from_components()

procedure, pass(this) overset_interface::overset_interface_t::init_from_components	(	class(overset_interface_t), intent(inout), target	this,
		type(coef_t), intent(in)	coef,
		character(len=*), intent(in)	field_name,
		real(kind=rp), intent(in), optional	tol,
		real(kind=rp), intent(in), optional	pad
	)

Parameters

[in] coef The SEM coefficients.

Definition at line 95 of file overset_interface.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 99 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 101 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 103 of file bc.f90.

◆ setup_interpolator_()

procedure, pass, private overset_interface::overset_interface_t::setup_interpolator_ ( class(overset_interface_t), intent(inout) this )

private

Definition at line 116 of file overset_interface.f90.

◆ update()

procedure, pass(this) overset_interface::overset_interface_t::update	(	class(overset_interface_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Definition at line 109 of file overset_interface.f90.

Member Data Documentation

◆ bc_s

type(field_dirichlet_t) overset_interface::overset_interface_t::bc_s

Definition at line 66 of file overset_interface.f90.

◆ coef

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

inherited

Definition at line 70 of file bc.f90.

◆ dof

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

inherited

Definition at line 68 of file bc.f90.

◆ domain_element_mask

type(mask_t) overset_interface::overset_interface_t::domain_element_mask

Definition at line 75 of file overset_interface.f90.

◆ facet

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

inherited

Definition at line 66 of file bc.f90.

◆ facet_d

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

inherited

Definition at line 80 of file bc.f90.

◆ field_list

type(field_list_t) overset_interface::overset_interface_t::field_list

Definition at line 68 of file overset_interface.f90.

◆ field_name

character(len=:), allocatable overset_interface::overset_interface_t::field_name

Definition at line 70 of file overset_interface.f90.

◆ find_interface

logical overset_interface::overset_interface_t::find_interface = .false.

Definition at line 84 of file overset_interface.f90.

◆ interface_dof

type(vector_list_t) overset_interface::overset_interface_t::interface_dof

Definition at line 81 of file overset_interface.f90.

◆ interface_dof_mask

type(mask_t) overset_interface::overset_interface_t::interface_dof_mask

Definition at line 74 of file overset_interface.f90.

◆ interface_field

type(vector_list_t) overset_interface::overset_interface_t::interface_field

Definition at line 81 of file overset_interface.f90.

◆ interface_interpolator

type(global_interpolation_t) overset_interface::overset_interface_t::interface_interpolator

Definition at line 72 of file overset_interface.f90.

◆ interpolation_settings

type(global_interpolation_settings_t) overset_interface::overset_interface_t::interpolation_settings

Definition at line 83 of file overset_interface.f90.

◆ marked_facet

type(stack_i4t2_t) bc::bc_t::marked_facet

inherited

Definition at line 76 of file bc.f90.

◆ morph_interface

procedure(morph_overset_interface), pointer, nopass overset_interface::overset_interface_t::morph_interface => null()

static

Definition at line 89 of file overset_interface.f90.

◆ msh

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

inherited

Definition at line 72 of file bc.f90.

◆ msk

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

inherited

Definition at line 64 of file bc.f90.

◆ msk_d

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

inherited

Definition at line 78 of file bc.f90.

◆ name

character(len=:), allocatable bc::bc_t::name

inherited

Definition at line 90 of file bc.f90.

◆ s_interface

type(vector_t) overset_interface::overset_interface_t::s_interface

Definition at line 80 of file overset_interface.f90.

◆ setup

logical overset_interface::overset_interface_t::setup = .false.

Definition at line 85 of file overset_interface.f90.

◆ strong

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

inherited

Definition at line 85 of file bc.f90.

◆ updated

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

inherited

Definition at line 88 of file bc.f90.

◆ x_dof

type(vector_t) overset_interface::overset_interface_t::x_dof

Definition at line 77 of file overset_interface.f90.

◆ x_interface_dof

type(vector_t) overset_interface::overset_interface_t::x_interface_dof

Definition at line 78 of file overset_interface.f90.

◆ xh

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

inherited

Definition at line 74 of file bc.f90.

◆ y_dof

type(vector_t) overset_interface::overset_interface_t::y_dof

Definition at line 77 of file overset_interface.f90.

◆ y_interface_dof

type(vector_t) overset_interface::overset_interface_t::y_interface_dof

Definition at line 78 of file overset_interface.f90.

◆ z_dof

type(vector_t) overset_interface::overset_interface_t::z_dof

Definition at line 77 of file overset_interface.f90.

◆ z_interface_dof

type(vector_t) overset_interface::overset_interface_t::z_interface_dof

Definition at line 78 of file overset_interface.f90.

◆ zone_indices

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

inherited

Definition at line 92 of file bc.f90.

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

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

◆ build_masks_()

◆ debug_mask_()

◆ finalize() [1/2]

◆ finalize() [2/2]

◆ finalize_base()

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ gather_interface_dofs_()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ init_from_components()

◆ mark_facet()

◆ mark_facets()

◆ mark_zone()

◆ setup_interpolator_()

◆ update()

Member Data Documentation

◆ bc_s

◆ coef

◆ dof

◆ domain_element_mask

◆ facet

◆ facet_d

◆ field_list

◆ field_name

◆ find_interface

◆ interface_dof

◆ interface_dof_mask

◆ interface_field

◆ interface_interpolator

◆ interpolation_settings

◆ marked_facet

◆ morph_interface

◆ msh

◆ msk

◆ msk_d

◆ name

◆ s_interface

◆ setup

◆ strong

◆ updated

◆ x_dof

◆ x_interface_dof

◆ xh

◆ y_dof

◆ y_interface_dof

◆ z_dof

◆ z_interface_dof

◆ zone_indices