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

Functions/Subroutines
subroutine	marklin_apply_int (int_obj, int_type, pt, fbary_tol, cell, field)
	Needs docs.
subroutine	marklin_compute (order, nmodes, minlev, save_rst, eig_vals, error_str)
	Needs docs.
subroutine	marklin_get_aint (imode, int_obj, zero_norm, error_str)
	Needs docs.
subroutine	marklin_get_bint (imode, int_obj, error_str)
	Needs docs.
subroutine	marklin_save_visit (int_obj, int_type, key, error_str)
	Needs docs.
subroutine	marklin_setup_io (basepath, error_str)
	Needs docs.

Variables
integer(i4), dimension(:,:), pointer	lc_plot
	Needs docs.
real(r8), dimension(:,:), pointer	r_plot
	Needs docs.
integer(i4), dimension(:), pointer	reg_plot
	Needs docs.

Function/Subroutine Documentation

marklin_apply_int()

subroutine marklin_apply_int	(	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]	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_compute()

subroutine marklin_compute	(	integer(kind=c_int), intent(in), value	order,
		integer(kind=c_int), intent(in), value	nmodes,
		integer(kind=c_int), intent(in), value	minlev,
		logical(c_bool), intent(in), value	save_rst,
		type(c_ptr), intent(in), value	eig_vals,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	order	Needs docs
[in]	nmodes	Needs docs
[in]	minlev	Needs docs
[in]	save_rst	Needs docs
[in]	eig_vals	Needs docs
[out]	error_str	Needs docs

marklin_get_aint()

subroutine marklin_get_aint	(	integer(kind=c_int), intent(in), value	imode,
		type(c_ptr), intent(out)	int_obj,
		logical(c_bool), intent(in), value	zero_norm,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	imode	Needs docs
[out]	int_obj	Needs docs
[in]	zero_norm	Needs docs
[out]	error_str	Needs docs

marklin_get_bint()

subroutine marklin_get_bint	(	integer(kind=c_int), intent(in), value	imode,
		type(c_ptr), intent(out)	int_obj,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	imode	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	int_obj,
		integer(c_int), intent(in), value	int_type,
		character(kind=c_char), dimension(80), intent(in)	key,
		character(kind=c_char), dimension(80), intent(out)	error_str
	)

Needs docs.

Parameters

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

marklin_setup_io()

subroutine marklin_setup_io	(	character(kind=c_char), dimension(oft_path_slen), intent(in)	basepath,
		character(kind=c_char), dimension(200), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	basepath	Needs docs
[out]	error_str	Needs docs

Variable Documentation

lc_plot

integer(i4), dimension(:,:), pointer lc_plot

Needs docs.

r_plot

real(r8), dimension(:,:), pointer r_plot

Needs docs.

reg_plot

integer(i4), dimension(:), pointer reg_plot

Needs docs.