field Module Reference

Defines a field.

Data Types
type	field_ptr_t
	field_ptr_t, To easily obtain a pointer to a field More...
type	field_t

Functions/Subroutines
subroutine	field_init_internal_dof (this, msh, space, fld_name)
	Initialize a field this on the mesh msh using an internal dofmap.
subroutine	field_init_external_dof (this, dof, fld_name)
	Initialize a field this on the mesh msh using an internal dofmap.
subroutine	field_init_common (this, fld_name)
	Initialize a field this.
subroutine	field_free (this)
	Deallocate a field f.
subroutine	field_copy_from (this, memdir, sync)
	Easy way to copy between host and device.
subroutine	field_assign_field (this, g)
	Assignment \( this = G \).
subroutine	field_assign_scalar (this, a)
	Assignment \( this = a \).
subroutine	field_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) \).
subroutine	field_add_scalar (this, a)
	Add \( this(u_1, u_2, ... , u_n) = this(u_1, u_2, ... , u_n) + a \).
pure integer function	field_size (this)
	Return the size of the field based on the underlying dofmap.

Function/Subroutine Documentation

field_add_field()

subroutine field::field_add_field ( class(field_t), intent(inout)  this, type(field_t), intent(in)  g  )

private

Note

Component wise

Definition at line 271 of file field.f90.

field_add_scalar()

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

private

Definition at line 286 of file field.f90.

field_assign_field()

subroutine field::field_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 209 of file field.f90.

field_assign_scalar()

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

private

Definition at line 247 of file field.f90.

field_copy_from()

subroutine field::field_copy_from ( class(field_t), intent(inout)  this, integer, intent(in)  memdir, logical, intent(in)  sync  )

private

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 194 of file field.f90.

field_free()

subroutine field::field_free ( class(field_t), intent(inout)  this )

private

Definition at line 168 of file field.f90.

field_init_common()

subroutine field::field_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 133 of file field.f90.

Here is the call graph for this function:

field_init_external_dof()

subroutine field::field_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 113 of file field.f90.

field_init_internal_dof()

subroutine field::field_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
	)

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 89 of file field.f90.

field_size()

pure integer function field::field_size ( class(field_t), intent(in)  this )

private

Definition at line 299 of file field.f90.