Collaboration diagram for field::field_t:

[legend]

Public Member Functions
procedure, pass(this)	copy_from (this, memdir, sync)
	Easy way to copy between host and device.

procedure, pass(this)	free (this)
	Deallocate a field f.

procedure, pass(this)	size (this)
	Return the size of the field.

generic	init (this, dof, fld_name)
	Initialise a field.

generic	init (this, msh, space, fld_name)
	Initialise a field.

generic	assignment (this, g)
	Assignemnt to current field.

generic	assignment (this, a)
	Assignemnt to current field.

generic	add (this, g)
	Add to current field.

generic	add (this, a)
	Add to current field.

Public Attributes
real(kind=rp), dimension(:,:,:,:), allocatable	x
	Field data.

type(space_t), pointer	xh
	Function space \( X_h \).

type(mesh_t), pointer	msh
	Mesh.

type(dofmap_t), pointer	dof
	Dofmap.

logical	internal_dofmap = .false.
	Does the field have an own dofmap.

character(len=neko_varname_len)	name = ""
	Name of the field.

type(c_ptr)	x_d = C_NULL_PTR

Private Member Functions
procedure, pass(this), private	init_common (this, fld_name)
	Initialize a field this.

procedure, pass(this), private	init_external_dof (this, dof, fld_name)
	Initialize a field this on the mesh msh using an internal dofmap.

procedure, pass(this), private	init_internal_dof (this, msh, space, fld_name)
	Initialize a field this on the mesh msh using an internal dofmap.

procedure, pass(this), private	assign_field (this, g)
	Assignment \( this = G \).

procedure, pass(this), private	assign_scalar (this, a)
	Assignment \( this = a \).

procedure, pass(this), private	add_field (this, g)
	Add \( this(u_1, u_2, ... , u_n) = this(u_1, u_2, ... , u_n) + G(u_1, u_2, ... , u_n) \).

procedure, pass(this), private	add_scalar (this, a)
	Add \( this(u_1, u_2, ... , u_n) = this(u_1, u_2, ... , u_n) + a \).

Detailed Description

Definition at line 48 of file field.f90.

Member Function/Subroutine Documentation

◆ add() [1/2]

generic field::field_t::add	(	class(field_t), intent(inout)	this,
		real(kind=rp), intent(in)	a
	)

Note: We don't overload operator(+), to avoid the extra assignemnt operator

Definition at line 79 of file field.f90.

◆ add() [2/2]

generic field::field_t::add	(	class(field_t), intent(inout)	this,
		type(field_t), intent(in)	g
	)

Note: We don't overload operator(+), to avoid the extra assignemnt operator

Definition at line 79 of file field.f90.

◆ add_field()

procedure, pass(this), private field::field_t::add_field	(	class(field_t), intent(inout)	this,
		type(field_t), intent(in)	g
	)

private

Note: Component wise

Definition at line 66 of file field.f90.

◆ add_scalar()

procedure, pass(this), private field::field_t::add_scalar	(	class(field_t), intent(inout)	this,
		real(kind=rp), intent(in)	a
	)

private

Definition at line 67 of file field.f90.

◆ assign_field()

procedure, pass(this), private field::field_t::assign_field	(	class(field_t), intent(inout)	this,
		type(field_t), intent(in)	g
	)

private

Note: this will be initialized if it has a different size than G or it's not allocated

Definition at line 64 of file field.f90.

◆ assign_scalar()

procedure, pass(this), private field::field_t::assign_scalar	(	class(field_t), intent(inout)	this,
		real(kind=rp), intent(in)	a
	)

private

Definition at line 65 of file field.f90.

◆ assignment() [1/2]

generic field::field_t::assignment	(	class(field_t), intent(inout)	this,
		real(kind=rp), intent(in)	a
	)

Definition at line 75 of file field.f90.

◆ assignment() [2/2]

generic field::field_t::assignment	(	class(field_t), intent(inout)	this,
		type(field_t), intent(in)	g
	)

Note: this will be initialized if it has a different size than G or it's not allocated

Definition at line 75 of file field.f90.

◆ copy_from()

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

Parameters

this	field to copy to/from device/host @memdir direction to copy (HOST_TO_DEVICE or DEVICE_TO_HOST) @sync whether the memcopy to be blocking or not

Definition at line 68 of file field.f90.

◆ free()

procedure, pass(this) field::field_t::free ( class(field_t), intent(inout) this )

Definition at line 69 of file field.f90.

◆ init() [1/2]

generic field::field_t::init	(	class(field_t), intent(inout)	this,
		type(dofmap_t), intent(in), target	dof,
		character(len=*), optional	fld_name
	)

Parameters

[in,out]	this	Field to be initialized
[in]	dof	External dofmap for the field
	fld_name	Name of the field

Definition at line 73 of file field.f90.

◆ init() [2/2]

generic field::field_t::init	(	class(field_t), intent(inout)	this,
		type(mesh_t), intent(in), target	msh,
		type(space_t), intent(in), target	space,
		character(len=*), optional	fld_name
	)

Parameters

[in,out]	this	Field to be initialized
[in]	msh	underlying mesh of the field
[in]	space	Function space for the field
	fld_name	Name of the field

Definition at line 73 of file field.f90.

◆ init_common()

procedure, pass(this), private field::field_t::init_common	(	class(field_t), intent(inout)	this,
		character(len=*), optional	fld_name
	)

private

Parameters

[in,out]	this	Field to be initialized
	fld_name	Name of the field

Definition at line 59 of file field.f90.

◆ init_external_dof()

procedure, pass(this), private field::field_t::init_external_dof	(	class(field_t), intent(inout)	this,
		type(dofmap_t), intent(in), target	dof,
		character(len=*), optional	fld_name
	)

private

Parameters

[in,out]	this	Field to be initialized
[in]	dof	External dofmap for the field
	fld_name	Name of the field

Definition at line 60 of file field.f90.

◆ init_internal_dof()

procedure, pass(this), private field::field_t::init_internal_dof	(	class(field_t), intent(inout)	this,
		type(mesh_t), intent(in), target	msh,
		type(space_t), intent(in), target	space,
		character(len=*), optional	fld_name
	)

private

Parameters

[in,out]	this	Field to be initialized
[in]	msh	underlying mesh of the field
[in]	space	Function space for the field
	fld_name	Name of the field

Definition at line 62 of file field.f90.

◆ size()

procedure, pass(this) field::field_t::size ( class(field_t), intent(in) this )

Definition at line 71 of file field.f90.

Member Data Documentation

◆ dof

type(dofmap_t), pointer field::field_t::dof

Definition at line 53 of file field.f90.

◆ internal_dofmap

logical field::field_t::internal_dofmap = .false.

Definition at line 55 of file field.f90.

◆ msh

type(mesh_t), pointer field::field_t::msh

Definition at line 52 of file field.f90.

◆ name

character(len=neko_varname_len) field::field_t::name = ""

Definition at line 56 of file field.f90.

◆ x

real(kind=rp), dimension(:,:,:,:), allocatable field::field_t::x

Definition at line 49 of file field.f90.

◆ x_d

type(c_ptr) field::field_t::x_d = C_NULL_PTR

Definition at line 57 of file field.f90.

◆ xh

type(space_t), pointer field::field_t::xh

Definition at line 51 of file field.f90.

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

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

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ add_field()

◆ add_scalar()

◆ assign_field()

◆ assign_scalar()

◆ assignment() [1/2]

◆ assignment() [2/2]

◆ copy_from()

◆ free()

◆ init() [1/2]

◆ init() [2/2]

◆ init_common()

◆ init_external_dof()

◆ init_internal_dof()

◆ size()

Member Data Documentation

◆ dof

◆ internal_dofmap

◆ msh

◆ name

◆ x

◆ x_d

◆ xh