bc_list::bc_list_t Type Reference

A list of allocatable `bc_t`. Follows the standard interface of lists. More...

Public Member Functions
procedure, pass(this)	init (this, size)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	append (this, bc)
	Append an item to the end of the list.
generic	apply (this, x, n, t, tstep)
	Apply all boundary conditions in the list.
generic	apply (this, x, y, z, n, t, tstep)
	Apply all boundary conditions in the list.
procedure, pass(this)	apply_scalar (this, x, n, t, tstep)
	Appply the boundary conditions to a scalar field.
procedure, pass(this)	apply_vector (this, x, y, z, n, t, tstep)
	Appply the boundary conditions to a vector field.
procedure, pass(this)	is_empty (this)
	Check wether the list is empty.

Public Attributes
class(bc_ptr_t), dimension(:), allocatable	items
integer	size
	Number of items in the list that are themselves allocated.
integer	capacity
	Capacity, i.e. the size of the items list. Some items may themselves be unallocated.

Detailed Description

Definition at line 46 of file bc_list.f90.

Member Function/Subroutine Documentation

append()

procedure, pass(this) bc_list::bc_list_t::append	(	class(bc_list_t), intent(inout)	this,
		class(bc_t), intent(inout), target	bc
	)

Parameters

bc	The boundary condition to add.

Definition at line 60 of file bc_list.f90.

apply() [1/2]

generic bc_list::bc_list_t::apply	(	class(bc_list_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
	)

Parameters

x	The field to apply the boundary conditions to.
n	The size of x.
t	Current time.
tstep	Current time-step.

Definition at line 62 of file bc_list.f90.

apply() [2/2]

generic bc_list::bc_list_t::apply	(	class(bc_list_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 comp of the field for which to apply the bcs.
y	The y comp of the field for which to apply the bcs.
z	The z comp of the field for which to apply the bcs.
n	The size of x, y, z.
t	Current time.
tstep	Current time-step.

Definition at line 62 of file bc_list.f90.

apply_scalar()

procedure, pass(this) bc_list::bc_list_t::apply_scalar	(	class(bc_list_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
	)

Parameters

x	The field to apply the boundary conditions to.
n	The size of x.
t	Current time.
tstep	Current time-step.

Definition at line 64 of file bc_list.f90.

apply_vector()

procedure, pass(this) bc_list::bc_list_t::apply_vector	(	class(bc_list_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 comp of the field for which to apply the bcs.
y	The y comp of the field for which to apply the bcs.
z	The z comp of the field for which to apply the bcs.
n	The size of x, y, z.
t	Current time.
tstep	Current time-step.

Definition at line 66 of file bc_list.f90.

free()

procedure, pass(this) bc_list::bc_list_t::free

(

class(bc_list_t), intent(inout)

this

)

Note

This will only nullify all pointers, not deallocate any conditions pointed to by the list

Definition at line 58 of file bc_list.f90.

init()

procedure, pass(this) bc_list::bc_list_t::init	(	class(bc_list_t), intent(inout), target	this,
		integer, optional	size
	)

Parameters

size	The size of the list to allocate.

Definition at line 56 of file bc_list.f90.

is_empty()

procedure, pass(this) bc_list::bc_list_t::is_empty

(

class(bc_list_t), intent(in), target

this

)

Definition at line 68 of file bc_list.f90.

Member Data Documentation

capacity

integer bc_list::bc_list_t::capacity

Definition at line 53 of file bc_list.f90.

items

class(bc_ptr_t), dimension(:), allocatable bc_list::bc_list_t::items

Definition at line 48 of file bc_list.f90.

size

integer bc_list::bc_list_t::size

Definition at line 50 of file bc_list.f90.

---

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

• /home/runner/work/neko/neko/src/bc/bc_list.f90