field_list::field_list_t Type Reference

field_list_t, To be able to group fields together More...

Collaboration diagram for field_list::field_list_t:

Public Member Functions
procedure, pass(this)	init (this, size)
	Constructor. Allocates array and pointers.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	append (this, f)
	Append a field to the list.
generic	get (this, i)
	Get an item pointer by array index.
generic	get (this, name)
	Get an item pointer by field name.
procedure, pass(this)	get_by_index (this, i)
	Get an item pointer by array index.
procedure, pass(this)	get_by_name (this, name)
	Get an item pointer by field name.
generic	assign (this, i, ptr)
	Point item at given index.
generic	assign (this, i, ptr)
	Point item at given index.
generic	assign (this, other)
	Point item at given index.
procedure, pass(this)	assign_to_ptr (this, i, ptr)
	Point item at a given index.
procedure, pass(this)	assign_to_field_ptr (this, i, ptr)
	Point item at a given index.
procedure, pass(this)	assign_to_field (this, i, fld)
	Point item at a given index.
procedure, pass(this)	assign_to_list (this, other)
	Point item at a given index.
procedure, pass(this)	x_d (this, i)
	Get device pointer for a given index.
procedure, pass(this)	x (this, i)
	Get pointer to the raw data array for a given index.
procedure, pass(this)	size (this)
	Get number of items in the list.
procedure, pass(this)	item_size (this, i)
	Get the size of dofmap for an item in the list.
procedure, pass(this)	dof (this, i)
	Get the dofmap for an item in the list.
procedure, pass(this)	xh (this, i)
	Get the space for an item in the list.
procedure, pass(this)	msh (this, i)
	Get the mesh for an item in the list.
procedure, pass(this)	internal_dofmap (this, i)
	Check wether the dofmap is internal for an item in the list.
procedure, pass(this)	name (this, i)
	Get the name for an item in the list.
procedure, pass(this)	copy_from (this, memdir, sync)
	Copy all fields to or from the design.

Public Attributes
type(field_ptr_t), dimension(:), allocatable	items

Detailed Description

Definition at line 47 of file field_list.f90.

Member Function/Subroutine Documentation

append()

procedure, pass(this) field_list::field_list_t::append	(	class(field_list_t), intent(inout)	this,
		class(field_t), intent(in), target	f
	)

Parameters

f	The field to append.

Definition at line 55 of file field_list.f90.

assign() [1/3]

generic field_list::field_list_t::assign	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i,
		type(field_t), intent(in), pointer	ptr
	)

Parameters

i	The index of the item.
ptr	A field pointer to point the item to.

Definition at line 62 of file field_list.f90.

assign() [2/3]

generic field_list::field_list_t::assign	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i,
		type(field_ptr_t), intent(in), target	ptr
	)

Parameters

i	The index of the item.
ptr	An encapsulated field pointer to point the item to.

Definition at line 62 of file field_list.f90.

assign() [3/3]

generic field_list::field_list_t::assign	(	class(field_list_t), intent(inout)	this,
		type(field_list_t), intent(in)	other
	)

Parameters

i	The index of the item.
field	A field to point the item to.

Definition at line 62 of file field_list.f90.

assign_to_field()

procedure, pass(this) field_list::field_list_t::assign_to_field	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i,
		type(field_t), intent(in), target	fld
	)

Parameters

i	The index of the item.
field	A field to point the item to.

Definition at line 67 of file field_list.f90.

assign_to_field_ptr()

procedure, pass(this) field_list::field_list_t::assign_to_field_ptr	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i,
		type(field_ptr_t), intent(in), target	ptr
	)

Parameters

i	The index of the item.
ptr	An encapsulated field pointer to point the item to.

Definition at line 65 of file field_list.f90.

assign_to_list()

procedure, pass(this) field_list::field_list_t::assign_to_list	(	class(field_list_t), intent(inout)	this,
		type(field_list_t), intent(in)	other
	)

Parameters

i	The index of the item.
field	A field to point the item to.

Definition at line 68 of file field_list.f90.

assign_to_ptr()

procedure, pass(this) field_list::field_list_t::assign_to_ptr	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i,
		type(field_t), intent(in), pointer	ptr
	)

Parameters

i	The index of the item.
ptr	A field pointer to point the item to.

Definition at line 64 of file field_list.f90.

copy_from()

procedure, pass(this) field_list::field_list_t::copy_from	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	memdir,
		logical, intent(in)	sync
	)

Call the memory copy for each field in the list. If sync is true, synchronize on the last copy.

Parameters

memdir	The direction of the copy.
sync	Whether to synchronize after the copy.

Definition at line 89 of file field_list.f90.

dof()

procedure, pass(this) field_list::field_list_t::dof	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 79 of file field_list.f90.

free()

procedure, pass(this) field_list::field_list_t::free

(

class(field_list_t), intent(inout)

this

)

Definition at line 53 of file field_list.f90.

get() [1/2]

generic field_list::field_list_t::get	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 56 of file field_list.f90.

get() [2/2]

generic field_list::field_list_t::get	(	class(field_list_t), intent(inout)	this,
		character(len=*), intent(in)	name
	)

Parameters

i	The index of the item.

Definition at line 56 of file field_list.f90.

get_by_index()

procedure, pass(this) field_list::field_list_t::get_by_index	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 58 of file field_list.f90.

get_by_name()

procedure, pass(this) field_list::field_list_t::get_by_name	(	class(field_list_t), intent(inout)	this,
		character(len=*), intent(in)	name
	)

Parameters

i	The index of the item.

Definition at line 60 of file field_list.f90.

init()

procedure, pass(this) field_list::field_list_t::init	(	class(field_list_t), intent(inout)	this,
		integer, intent(in)	size
	)

Parameters

size	The size of the list to preallocate

Definition at line 51 of file field_list.f90.

internal_dofmap()

procedure, pass(this) field_list::field_list_t::internal_dofmap	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 85 of file field_list.f90.

item_size()

procedure, pass(this) field_list::field_list_t::item_size	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 77 of file field_list.f90.

msh()

procedure, pass(this) field_list::field_list_t::msh	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 83 of file field_list.f90.

name()

procedure, pass(this) field_list::field_list_t::name	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 87 of file field_list.f90.

size()

procedure, pass(this) field_list::field_list_t::size

(

class(field_list_t), intent(in)

this

)

Definition at line 75 of file field_list.f90.

x()

procedure, pass(this) field_list::field_list_t::x	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Definition at line 73 of file field_list.f90.

x_d()

procedure, pass(this) field_list::field_list_t::x_d	(	class(field_list_t), intent(in)	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 71 of file field_list.f90.

xh()

procedure, pass(this) field_list::field_list_t::xh	(	class(field_list_t), intent(in), target	this,
		integer, intent(in)	i
	)

Parameters

i	The index of the item.

Definition at line 81 of file field_list.f90.

Member Data Documentation

items

type(field_ptr_t), dimension(:), allocatable field_list::field_list_t::items

Definition at line 48 of file field_list.f90.

---

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

• /home/runner/work/neko/neko/src/field/field_list.f90