marklin_f Module Reference

Detailed Description

Fortran part of Python wrapper for Marklin force-free ideal MHD equilibrium functionality.

Authors

Chris Hansen

Date

May 2023

Data Types
type	marklin_obj

Functions/Subroutines
subroutine	marklin_apply_int (marklin_ptr, int_obj, int_type, pt, fbary_tol, cell, field)
	Needs docs.
logical function	marklin_ccast (marklin_cptr, marklin_fptr, error_str)
	Needs docs.
subroutine	marklin_compute_eig (marklin_ptr, nmodes, eig_vals, cache_file, error_str)
	Needs docs.
subroutine	marklin_compute_pardiff (marklin_ptr, int_obj, int_type, k_perp, error_str)
	Needs docs.
subroutine	marklin_compute_vac (marklin_ptr, nh, hcpc, hcpv, cache_file, error_str)
	Needs docs.
subroutine	marklin_destroy (marklin_ptr, error_str)
	Needs docs.
subroutine	marklin_get_aint (marklin_ptr, hmode_facs, int_obj, zero_norm, error_str)
	Needs docs.
subroutine	marklin_get_bint (marklin_ptr, hmode_facs, vac_facs, int_obj, error_str)
	Needs docs.
subroutine	marklin_save_visit (marklin_ptr, int_obj, int_type, key, error_str)
	Needs docs.
subroutine	marklin_setup (marklin_ptr, mesh_ptr, order, minlev, error_str)
	Needs docs.
subroutine	marklin_setup_io (marklin_ptr, basepath, legacy_hdf5, error_str)
	Needs docs.

Function/Subroutine Documentation

marklin_apply_int()

subroutine marklin_apply_int	(	type(c_ptr), intent(in), value	marklin_ptr,
		type(c_ptr), intent(in), value	int_obj,
		integer(c_int), intent(in), value	int_type,
		real(c_double), dimension(3), intent(in)	pt,
		real(c_double), intent(in), value	fbary_tol,
		integer(c_int), intent(inout)	cell,
		real(c_double), dimension(3), intent(out)	field
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	int_obj	Needs docs
[in]	int_type	Needs docs
[in]	pt	Needs docs
[in]	fbary_tol	Needs docs
[in,out]	cell	Needs docs
[out]	field	Needs docs

marklin_ccast()

logical function marklin_ccast	(	type(c_ptr), intent(in)	marklin_cptr,
		type(marklin_obj), intent(out), pointer	marklin_fptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out), optional	error_str
	)

Needs docs.

Parameters

[in]	marklin_cptr	C pointer to TokaMaker object
[out]	error_str	Error string (empty if no error)

marklin_compute_eig()

subroutine marklin_compute_eig	(	type(c_ptr), intent(in), value	marklin_ptr,
		integer(kind=c_int), intent(in), value	nmodes,
		type(c_ptr), intent(in), value	eig_vals,
		character(kind=c_char), dimension(oft_path_slen), intent(in)	cache_file,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	nmodes	Needs docs
[in]	eig_vals	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

marklin_compute_pardiff()

subroutine marklin_compute_pardiff	(	type(c_ptr), intent(in), value	marklin_ptr,
		type(c_ptr), intent(in), value	int_obj,
		integer(c_int), intent(in), value	int_type,
		real(c_double), intent(in), value	k_perp,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	int_obj	Needs docs
[in]	int_type	Needs docs
[in]	k_perp	Needs docs
[out]	error_str	Needs docs

marklin_compute_vac()

subroutine marklin_compute_vac	(	type(c_ptr), intent(in), value	marklin_ptr,
		integer(kind=c_int), intent(in), value	nh,
		type(c_ptr), intent(in), value	hcpc,
		type(c_ptr), intent(in), value	hcpv,
		character(kind=c_char), dimension(oft_path_slen), intent(in)	cache_file,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	nh	Needs docs
[in]	hcpc	Needs docs
[in]	hcpv	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

marklin_destroy()

subroutine marklin_destroy	(	type(c_ptr), intent(in), value	marklin_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Pointer to Marklin object
[out]	error_str	Error string (empty if no error)

marklin_get_aint()

subroutine marklin_get_aint	(	type(c_ptr), intent(in), value	marklin_ptr,
		type(c_ptr), intent(in), value	hmode_facs,
		type(c_ptr), intent(out)	int_obj,
		logical(c_bool), intent(in), value	zero_norm,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	hmode_facs	Needs docs
[out]	int_obj	Needs docs
[in]	zero_norm	Needs docs
[out]	error_str	Needs docs

marklin_get_bint()

subroutine marklin_get_bint	(	type(c_ptr), intent(in), value	marklin_ptr,
		type(c_ptr), intent(in), value	hmode_facs,
		type(c_ptr), intent(in), value	vac_facs,
		type(c_ptr), intent(out)	int_obj,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	hmode_facs	Needs docs
[in]	vac_facs	Needs docs
[out]	int_obj	Needs docs
[out]	error_str	Needs docs

marklin_save_visit()

subroutine marklin_save_visit	(	type(c_ptr), intent(in), value	marklin_ptr,
		type(c_ptr), intent(in), value	int_obj,
		integer(c_int), intent(in), value	int_type,
		character(kind=c_char), dimension(oft_slen), intent(in)	key,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	int_obj	Needs docs
[in]	int_type	Needs docs
[in]	key	Needs docs
[out]	error_str	Needs docs

marklin_setup()

subroutine marklin_setup	(	type(c_ptr), intent(out)	marklin_ptr,
		type(c_ptr), intent(in), value	mesh_ptr,
		integer(kind=c_int), intent(in), value	order,
		integer(kind=c_int), intent(in), value	minlev,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[out]	marklin_ptr	Needs docs
[in]	mesh_ptr	Needs docs
[in]	order	Needs docs
[in]	minlev	Needs docs
[out]	error_str	Needs docs

marklin_setup_io()

subroutine marklin_setup_io	(	type(c_ptr), intent(in), value	marklin_ptr,
		character(kind=c_char), dimension(oft_path_slen), intent(in)	basepath,
		logical(c_bool), intent(in), value	legacy_hdf5,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	marklin_ptr	Needs docs
[in]	basepath	Needs docs
[in]	legacy_hdf5	Use legacy HDF5 format?
[out]	error_str	Needs docs