bc Module Reference

Defines a boundary condition.

Data Types
type	bc_alloc_t
interface	bc_apply_scalar
	Apply the boundary condition to a scalar field. More...
interface	bc_apply_scalar_dev
	Apply the boundary condition to a scalar field on the device. More...
interface	bc_apply_vector
	Apply the boundary condition to a vector field. More...
interface	bc_apply_vector_dev
	Apply the boundary condition to a vector field on the device. More...
interface	bc_constructor
	Constructor. More...
interface	bc_destructor
	Destructor. More...
interface	bc_finalize
	Finalize by building the mask and facet arrays. More...
type	bc_ptr_t
	Pointer to a `bc_t`. More...
type	bc_t
	Base type for a boundary condition. More...

Functions/Subroutines
subroutine	bc_init_base (this, coef)
	Constructor.
subroutine	bc_free_base (this)
	Destructor for the base type, bc_t.
subroutine	bc_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.
subroutine	bc_apply_scalar_generic (this, x, n, t, tstep)
	Apply the boundary condition to a scalar field. Dispatches to the CPU or the device version.
subroutine	bc_mark_facet (this, facet, el)
	Mark facet on element el as part of the boundary condition.
subroutine	bc_mark_facets (this, facet_list)
	Mark all facets from a (facet, el) tuple list.
subroutine	bc_mark_zone (this, bc_zone)
	Mark all facets from a zone.
subroutine	bc_finalize_base (this, only_facets)
	Finalize the construction of the bc by populting the msk and facet arrays.
subroutine	bc_debug_mask (this, file_name)
	Write a field showing the mask of the bc.

Function/Subroutine Documentation

bc_apply_scalar_generic()

subroutine bc::bc_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  )

private

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 346 of file bc.f90.

bc_apply_vector_generic()

subroutine bc::bc_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  )

private

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 297 of file bc.f90.

bc_debug_mask()

subroutine bc::bc_debug_mask ( class(bc_t), intent(inout)  this, character(len=*), intent(in)  file_name  )

private

The mask will be marked with 1.

Parameters

file_name

The name of the fld file.

Definition at line 574 of file bc.f90.

bc_finalize_base()

subroutine bc::bc_finalize_base ( class(bc_t), intent(inout), target  this, logical, intent(in), optional  only_facets  )

private

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.

Todo:

add 2D case

Definition at line 428 of file bc.f90.

Here is the call graph for this function:

bc_free_base()

subroutine bc::bc_free_base ( class(bc_t), intent(inout)  this )

private

Definition at line 259 of file bc.f90.

Here is the call graph for this function:

bc_init_base()

subroutine bc::bc_init_base ( class(bc_t), intent(inout)  this, type(coef_t), intent(in), target  coef  )

private

Parameters

dof	Map of degrees of freedom.

Definition at line 243 of file bc.f90.

bc_mark_facet()

subroutine bc::bc_mark_facet ( class(bc_t), intent(inout)  this, integer, intent(in)  facet, integer, intent(in)  el  )

private

Parameters

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

Definition at line 384 of file bc.f90.

bc_mark_facets()

subroutine bc::bc_mark_facets ( class(bc_t), intent(inout)  this, type(stack_i4t2_t), intent(inout)  facet_list  )

private

Parameters

facet_list

The list of tuples.

Definition at line 397 of file bc.f90.

bc_mark_zone()

subroutine bc::bc_mark_zone ( class(bc_t), intent(inout)  this, class(facet_zone_t), intent(in)  bc_zone  )

private

Parameters

bc_zone

Boundary zone to be marked.

Definition at line 412 of file bc.f90.