thincurr_f Module Reference

Detailed Description

Fortran part of Python wrapper for ThinCurr thin-wall eddy current functionality.

Authors

Chris Hansen

Date

March 2024

Functions/Subroutines
subroutine	thincurr_bmat (tw_ptr, hodlr_ptr, bmat_ptr, bdr_ptr, cache_file, error_str)
	Needs docs.
subroutine	thincurr_cross_coupling (tw_ptr1, tw_ptr2, mmat, cache_file, error_str)
	Needs docs.
subroutine	thincurr_cross_eval (tw_ptr1, tw_ptr2, nrhs, vec1, vec2, error_str)
	Needs docs.
subroutine	thincurr_curr_regmat (tw_ptr, rmat, error_str)
	Needs docs.
subroutine	thincurr_eigenvalues (tw_ptr, direct, neigs, eig_vals, eig_vec, hodlr_ptr, error_str)
	Needs docs.
subroutine	thincurr_freq_response (tw_ptr, direct, fr_limit, freq, fr_driver, hodlr_ptr, error_str)
	Needs docs.
subroutine	thincurr_get_eta (tw_ptr, eta_ptr, error_str)
	Needs docs.
subroutine	thincurr_get_sensor_name (sensor_ptr, sensor_ind, sensor_name, error_str)
	Needs docs.
subroutine	thincurr_lmat (tw_ptr, use_hodlr, lmat_ptr, cache_file, error_str)
	Needs docs.
subroutine	thincurr_mcoil (tw_ptr, mc_ptr, cache_file, error_str)
	Needs docs.
subroutine	thincurr_msensor (tw_ptr, sensor_file, ms_ptr, msc_ptr, nsensors, njumpers, sensor_ptr, cache_file, error_str)
	Needs docs.
subroutine	thincurr_recon_curr (tw_ptr, vals, curr, format)
	Needs docs.
subroutine	thincurr_recon_field (tw_ptr, pot, coils, field, hodlr_ptr)
	Needs docs.
subroutine	thincurr_reduce_model (tw_ptr, filename, neigs, eig_vec, compute_b, sensor_ptr, hodlr_ptr, error_str)
	Needs docs.
subroutine	thincurr_rmat (tw_ptr, copy_out, rmat, error_str)
	Needs docs.
subroutine	thincurr_save_field (tw_ptr, vals, fieldname)
	Needs docs.
subroutine	thincurr_save_scalar (tw_ptr, vals, fieldname)
	Needs docs.
subroutine	thincurr_scale_va (tw_ptr, vals, div_flag)
	Needs docs.
subroutine	thincurr_set_eta (tw_ptr, eta_ptr, error_str)
	Needs docs.
subroutine	thincurr_setup (mesh_file, np, r_loc, nc, lc_loc, reg_loc, pmap_loc, jumper_start_in, tw_ptr, sizes, error_str, xml_ptr)
	Needs docs.
subroutine	thincurr_setup_io (tw_ptr, basepath, save_debug, legacy_hdf5, error_str)
	Needs docs.
subroutine	thincurr_time_domain (tw_ptr, direct, dt, nsteps, cg_tol, timestep_cn, nstatus, nplot, vec_ic, sensor_ptr, ncurr, curr_ptr, nvolt, volt_ptr, volts_full, sensor_vals_ptr, hodlr_ptr, error_str)
	Needs docs.
subroutine	thincurr_time_domain_plot (tw_ptr, compute_b, rebuild_sensors, nsteps, nplot, sensor_ptr, sensor_vals_ptr, nsensor, hodlr_ptr, 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

thincurr_bmat()

subroutine thincurr_bmat	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	hodlr_ptr,
		type(c_ptr), intent(out)	bmat_ptr,
		type(c_ptr), intent(out)	bdr_ptr,
		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]	tw_ptr	Needs docs
[in]	hodlr_ptr	Needs docs
[out]	bmat_ptr	Needs docs
[out]	bdr_ptr	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

thincurr_cross_coupling()

subroutine thincurr_cross_coupling	(	type(c_ptr), intent(in), value	tw_ptr1,
		type(c_ptr), intent(in), value	tw_ptr2,
		type(c_ptr), intent(in), value	mmat,
		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]	tw_ptr1	Needs docs
[in]	tw_ptr2	Needs docs
[in]	mmat	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

thincurr_cross_eval()

subroutine thincurr_cross_eval	(	type(c_ptr), intent(in), value	tw_ptr1,
		type(c_ptr), intent(in), value	tw_ptr2,
		integer(kind=c_int), intent(in), value	nrhs,
		type(c_ptr), intent(in), value	vec1,
		type(c_ptr), intent(in), value	vec2,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr1	Needs docs
[in]	tw_ptr2	Needs docs
[in]	vec1	Needs docs
[in]	vec2	Needs docs
[out]	error_str	Needs docs

thincurr_curr_regmat()

subroutine thincurr_curr_regmat	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	rmat,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	rmat	Needs docs
[out]	error_str	Needs docs

thincurr_eigenvalues()

subroutine thincurr_eigenvalues	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	direct,
		integer(kind=c_int), intent(in), value	neigs,
		type(c_ptr), intent(in), value	eig_vals,
		type(c_ptr), intent(in), value	eig_vec,
		type(c_ptr), intent(in), value	hodlr_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	direct	Needs docs
[in]	neigs	Needs docs
[in]	eig_vals	Needs docs
[in]	eig_vec	Needs docs
[in]	hodlr_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_freq_response()

subroutine thincurr_freq_response	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	direct,
		integer(kind=c_int), intent(in), value	fr_limit,
		real(kind=c_double), intent(in), value	freq,
		type(c_ptr), intent(in), value	fr_driver,
		type(c_ptr), intent(in), value	hodlr_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	direct	Needs docs
[in]	fr_limit	Needs docs
[in]	freq	Needs docs
[in]	fr_driver	Needs docs
[in]	hodlr_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_get_eta()

subroutine thincurr_get_eta	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	eta_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	eta_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_get_sensor_name()

subroutine thincurr_get_sensor_name	(	type(c_ptr), intent(in), value	sensor_ptr,
		integer(kind=c_int), intent(in), value	sensor_ind,
		character(kind=c_char), dimension(40), intent(out)	sensor_name,
		character(kind=c_char), dimension(200), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	sensor_ptr	Needs docs
[in]	sensor_ind	Needs docs
[out]	sensor_name	Needs docs
[out]	error_str	Needs docs

thincurr_lmat()

subroutine thincurr_lmat	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	use_hodlr,
		type(c_ptr), intent(out)	lmat_ptr,
		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]	tw_ptr	Needs docs
[out]	lmat_ptr	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

thincurr_mcoil()

subroutine thincurr_mcoil	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(out)	mc_ptr,
		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]	tw_ptr	Needs docs
[out]	mc_ptr	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

thincurr_msensor()

subroutine thincurr_msensor	(	type(c_ptr), intent(in), value	tw_ptr,
		character(kind=c_char), dimension(oft_path_slen), intent(in)	sensor_file,
		type(c_ptr), intent(out)	ms_ptr,
		type(c_ptr), intent(out)	msc_ptr,
		integer(kind=c_int), intent(out)	nsensors,
		integer(kind=c_int), intent(out)	njumpers,
		type(c_ptr), intent(inout)	sensor_ptr,
		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]	tw_ptr	Needs docs
[in]	sensor_file	Needs docs
[out]	ms_ptr	Needs docs
[out]	msc_ptr	Needs docs
[in,out]	sensor_ptr	Needs docs
[in]	cache_file	Needs docs
[out]	error_str	Needs docs

thincurr_recon_curr()

subroutine thincurr_recon_curr	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	vals,
		type(c_ptr), intent(in), value	curr,
		integer(kind=c_int), intent(in), value	format
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	vals	Needs docs
[in]	curr	Needs docs
[in]	format	Needs docs

thincurr_recon_field()

subroutine thincurr_recon_field	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	pot,
		type(c_ptr), intent(in), value	coils,
		type(c_ptr), intent(in), value	field,
		type(c_ptr), intent(in), value	hodlr_ptr
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	pot	Needs docs
[in]	coils	Needs docs
[in]	field	Needs docs
[in]	hodlr_ptr	Needs docs

thincurr_reduce_model()

subroutine thincurr_reduce_model	(	type(c_ptr), intent(in), value	tw_ptr,
		character(kind=c_char), dimension(oft_path_slen), intent(in)	filename,
		integer(kind=c_int), intent(in), value	neigs,
		type(c_ptr), intent(in), value	eig_vec,
		logical(kind=c_bool), intent(in), value	compute_b,
		type(c_ptr), intent(in), value	sensor_ptr,
		type(c_ptr), intent(in), value	hodlr_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	filename	Needs docs
[in]	neigs	Needs docs
[in]	eig_vec	Needs docs
[in]	compute_b	Needs docs
[in]	sensor_ptr	Needs docs
[in]	hodlr_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_rmat()

subroutine thincurr_rmat	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	copy_out,
		type(c_ptr), intent(in), value	rmat,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	copy_out	Needs docs
[in]	rmat	Needs docs
[out]	error_str	Needs docs

thincurr_save_field()

subroutine thincurr_save_field	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	vals,
		character(kind=c_char), dimension(oft_slen), intent(in)	fieldname
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	vals	Needs docs
[in]	fieldname	Needs docs

thincurr_save_scalar()

subroutine thincurr_save_scalar	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	vals,
		character(kind=c_char), dimension(oft_slen), intent(in)	fieldname
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	vals	Needs docs
[in]	fieldname	Needs docs

thincurr_scale_va()

subroutine thincurr_scale_va	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	vals,
		logical, intent(in), value	div_flag
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	vals	Needs docs
[in]	div_flag	Needs docs

thincurr_set_eta()

subroutine thincurr_set_eta	(	type(c_ptr), intent(in), value	tw_ptr,
		type(c_ptr), intent(in), value	eta_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	eta_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_setup()

subroutine thincurr_setup	(	character(kind=c_char), dimension(oft_path_slen), intent(in)	mesh_file,
		integer(c_int), intent(in), value	np,
		type(c_ptr), intent(in), value	r_loc,
		integer(c_int), intent(in), value	nc,
		type(c_ptr), intent(in), value	lc_loc,
		type(c_ptr), intent(in), value	reg_loc,
		type(c_ptr), intent(in), value	pmap_loc,
		integer(c_int), intent(in), value	jumper_start_in,
		type(c_ptr), intent(out)	tw_ptr,
		type(c_ptr), intent(in), value	sizes,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str,
		type(c_ptr), intent(in), value	xml_ptr
	)

Needs docs.

Parameters

[in]	mesh_file	Needs docs
[in]	r_loc	Needs docs
[in]	lc_loc	Needs docs
[in]	reg_loc	Needs docs
[in]	pmap_loc	Needs docs
[in]	np	Needs docs
[in]	nc	Needs docs
[in]	jumper_start_in	Needs docs
[in]	sizes	Needs docs
[out]	tw_ptr	Needs docs
[out]	error_str	Needs docs
[in]	xml_ptr	Needs docs

thincurr_setup_io()

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

Needs docs.

Parameters

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

thincurr_time_domain()

subroutine thincurr_time_domain	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	direct,
		real(kind=c_double), intent(in), value	dt,
		integer(kind=c_int), intent(in), value	nsteps,
		real(kind=c_double), intent(in), value	cg_tol,
		logical(kind=c_bool), intent(in), value	timestep_cn,
		integer(kind=c_int), intent(in), value	nstatus,
		integer(kind=c_int), intent(in), value	nplot,
		type(c_ptr), intent(in), value	vec_ic,
		type(c_ptr), intent(in), value	sensor_ptr,
		integer(kind=c_int), intent(in), value	ncurr,
		type(c_ptr), intent(in), value	curr_ptr,
		integer(kind=c_int), intent(in), value	nvolt,
		type(c_ptr), intent(in), value	volt_ptr,
		logical(kind=c_bool), intent(in), value	volts_full,
		type(c_ptr), intent(in), value	sensor_vals_ptr,
		type(c_ptr), intent(in), value	hodlr_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	direct	Needs docs
[in]	dt	Needs docs
[in]	nsteps	Needs docs
[in]	cg_tol	Needs docs
[in]	timestep_cn	Needs docs
[in]	nstatus	Needs docs
[in]	nplot	Needs docs
[in]	vec_ic	Needs docs
[in]	sensor_ptr	Needs docs
[in]	ncurr	Needs docs
[in]	curr_ptr	Needs docs
[in]	nvolt	Needs docs
[in]	volt_ptr	Needs docs
[in]	volts_full	Needs docs
[in]	sensor_vals_ptr	Needs docs
[in]	hodlr_ptr	Needs docs
[out]	error_str	Needs docs

thincurr_time_domain_plot()

subroutine thincurr_time_domain_plot	(	type(c_ptr), intent(in), value	tw_ptr,
		logical(kind=c_bool), intent(in), value	compute_b,
		logical(kind=c_bool), intent(in), value	rebuild_sensors,
		integer(kind=c_int), intent(in), value	nsteps,
		integer(kind=c_int), intent(in), value	nplot,
		type(c_ptr), intent(in), value	sensor_ptr,
		type(c_ptr), intent(in), value	sensor_vals_ptr,
		integer(kind=c_int), intent(in), value	nsensor,
		type(c_ptr), intent(in), value	hodlr_ptr,
		character(kind=c_char), dimension(oft_error_slen), intent(out)	error_str
	)

Needs docs.

Parameters

[in]	tw_ptr	Needs docs
[in]	compute_b	Needs docs
[in]	rebuild_sensors	Needs docs
[in]	nsteps	Needs docs
[in]	nplot	Needs docs
[in]	sensor_ptr	Needs docs
[in]	sensor_vals_ptr	Needs docs
[in]	nsensor	Needs docs
[in]	hodlr_ptr	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.