bem_periodic_zero_mode_c Module

C ABI wrapper for the physical periodic zero mode.

Uses

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer(kind=c_int),	public,	parameter	::	beach_zero_mode_ok	=	0_c_int
integer(kind=c_int),	public,	parameter	::	beach_zero_mode_invalid_handle	=	1_c_int
integer(kind=c_int),	public,	parameter	::	beach_zero_mode_invalid_argument	=	2_c_int
integer(kind=c_int),	public,	parameter	::	beach_zero_mode_not_ready	=	3_c_int

Functions

public function beach_zero_mode_create(handle) result(status) bind(C, name='beach_zero_mode_create'))

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),	intent(out)			::	handle

Return Value integer(kind=c_int)

public function beach_zero_mode_destroy(handle) result(status) bind(C, name='beach_zero_mode_destroy'))

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),			value	::	handle

Return Value integer(kind=c_int)

public function beach_zero_mode_build(handle, nsrc, source_heights_ptr, area_xy) result(status) bind(C, name='beach_zero_mode_build'))

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),			value	::	handle
integer(kind=c_int),			value	::	nsrc
type(c_ptr),			value	::	source_heights_ptr
real(kind=c_double),			value	::	area_xy

Return Value integer(kind=c_int)

public function beach_zero_mode_update(handle, nsrc, charge_ptr, e_bottom, z_gauge, phi_gauge) result(status) bind(C, name='beach_zero_mode_update'))

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),			value	::	handle
integer(kind=c_int),			value	::	nsrc
type(c_ptr),			value	::	charge_ptr
real(kind=c_double),			value	::	e_bottom
real(kind=c_double),			value	::	z_gauge
real(kind=c_double),			value	::	phi_gauge

Return Value integer(kind=c_int)

public function beach_zero_mode_eval(handle, ntarget, z_ptr, trace, phi_ptr, ez_ptr) result(status) bind(C, name='beach_zero_mode_eval'))

Arguments

Type	Intent	Optional	Attributes		Name
type(c_ptr),			value	::	handle
integer(kind=c_int),			value	::	ntarget
type(c_ptr),			value	::	z_ptr
integer(kind=c_int),			value	::	trace
type(c_ptr),			value	::	phi_ptr
type(c_ptr),			value	::	ez_ptr

Return Value integer(kind=c_int)