class_scalar_field_procedures Submodule

Contents

Module Procedures

assign_scalar_field_s assign_scalar_field_v check_mesh_consistency_sf create_scalar_field free_field get_base get_scalar_field_bx get_scalar_field_element get_scalar_field_element_prev get_scalar_field_mat_id get_scalar_field_x get_scalar_field_xp interp_on_faces_s nemo_scalar_field_norm1 nemo_scalar_field_normi nemo_sizeof scalar_field_ scalar_field_dif scalar_field_dif_s scalar_field_div scalar_field_mul scalar_field_scal scalar_field_sum set_scalar_field_element set_scalar_field_group update_scalar_field

Module Procedures

module procedure assign_scalar_field_s module subroutine assign_scalar_field_s(f, x)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	f
real(kind=psb_dpk_),	intent(in)			::	x

module procedure assign_scalar_field_v module subroutine assign_scalar_field_v(f, x)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	f
real(kind=psb_dpk_),	intent(in)			::	x(:)

module procedure check_mesh_consistency_sf module subroutine check_mesh_consistency_sf(f1, f2, where)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
type(scalar_field),	intent(in)			::	f2
character(len=*),	intent(in)			::	where

module procedure create_scalar_field module subroutine create_scalar_field(fld, msh, dim, bc, mats, on_faces, x0, name)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(out)			::	fld
type(mesh),	intent(in),		target	::	msh
type(dimensions),	intent(in),	optional		::	dim
type(bc_poly),	intent(in),	optional	target	::	bc(:)
type(matptr),	intent(in),	optional	target	::	mats(:)
logical,	intent(in),	optional		::	on_faces
real(kind=psb_dpk_),	intent(in),	optional		::	x0
character(len=*),	intent(in),	optional		::	name

module procedure free_field module subroutine free_field(fld)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	fld

module procedure get_base module subroutine get_base(fld, base)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
type(field),	intent(out)			::	base

module procedure get_scalar_field_bx module subroutine get_scalar_field_bx(fld, bx)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
real(kind=psb_dpk_),	intent(out),		allocatable	::	bx(:)

module procedure get_scalar_field_element module subroutine get_scalar_field_element(fld, x, i)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
real(kind=psb_dpk_),	intent(out)			::	x
integer,	intent(in)			::	i

module procedure get_scalar_field_element_prev module subroutine get_scalar_field_element_prev(fld, xp, i)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
real(kind=psb_dpk_),	intent(out)			::	xp
integer,	intent(in)			::	i

module procedure get_scalar_field_mat_id module function get_scalar_field_mat_id(fld, i)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
integer,	intent(in)			::	i

Return Value integer

module procedure get_scalar_field_x module subroutine get_scalar_field_x(fld, x)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
real(kind=psb_dpk_),	intent(out),		allocatable	::	x(:)

module procedure get_scalar_field_xp module subroutine get_scalar_field_xp(fld, xp)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld
real(kind=psb_dpk_),	intent(out),		allocatable	::	xp(:)

module procedure interp_on_faces_s module function interp_on_faces_s(fld) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld

Return Value type(scalar_field)

module procedure nemo_scalar_field_norm1 module function nemo_scalar_field_norm1(fld) result(norm)

$ msh => msh_(fld%field)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld

Return Value real(kind=psb_dpk_)

module procedure nemo_scalar_field_normi module function nemo_scalar_field_normi(fld) result(norm)

$ msh => msh_(fld%field)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld

Return Value real(kind=psb_dpk_)

module procedure nemo_sizeof module function nemo_sizeof(fld)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	fld

Return Value integer(kind=nemo_int_long_)

module procedure scalar_field_ module procedure scalar_field_()

Workaround for Intel 18 error #6053: Structure constructor may not have fields with a PRIVATE attribute

Arguments

None

module procedure scalar_field_dif module function scalar_field_dif(f1, f2) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
type(scalar_field),	intent(in)			::	f2

Return Value type(scalar_field)

module procedure scalar_field_dif_s module function scalar_field_dif_s(f1, f2) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
real(kind=psb_dpk_),	intent(in)			::	f2

Return Value type(scalar_field)

module procedure scalar_field_div module function scalar_field_div(f1, f2) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
type(scalar_field),	intent(in)			::	f2

Return Value type(scalar_field)

module procedure scalar_field_mul module function scalar_field_mul(f1, f2) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
type(scalar_field),	intent(in)			::	f2

Return Value type(scalar_field)

module procedure scalar_field_scal module function scalar_field_scal(a, f) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=psb_dpk_),	intent(in)			::	a
class(scalar_field),	intent(in)			::	f

Return Value type(scalar_field)

module procedure scalar_field_sum module function scalar_field_sum(f1, f2) result(r)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(in)			::	f1
type(scalar_field),	intent(in)			::	f2

Return Value type(scalar_field)

module procedure set_scalar_field_element module subroutine set_scalar_field_element(f, i, x)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	f
integer,	intent(in)			::	i	element number to set
real(kind=psb_dpk_),	intent(in)			::	x	value

module procedure set_scalar_field_group module subroutine set_scalar_field_group(f, ig, x)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	f
integer,	intent(in)			::	ig
real(kind=psb_dpk_),	intent(in)			::	x

module procedure update_scalar_field module subroutine update_scalar_field(fld, mats, temp)

$ msh => msh_(fld%field)

Arguments

Type	Intent	Optional	Attributes		Name
class(scalar_field),	intent(inout)			::	fld
type(matptr),	intent(in),		pointer	::	mats(:)
type(scalar_field),	intent(in),	optional		::	temp	temperature