Defines the base class of the type model_class. The model contains information not specific to the equilibrium. More...

Data Types
interface	model_class
	Base class representing a model. More...

Functions/Subroutines
class(model_class) function, pointer	model_construct (ne_type, sxrem_type, te_type, ti_type, ne_unit, ne_min, te_min, ti_min, sxrem_min, pressure_fraction, emission, equilibrium, sxrem_te, sxrem_ratio, resonace_range, coosig_wgts, state_flags, signal_factor, signal_offset, int_params)
	Construct a model_class containing an equilibrium object. More...

subroutine	model_destruct (this)
	Deconstruct a model_class object. More...

subroutine	model_set_param (this, id, i_index, j_index, value, eq_comm)
	Sets the value of a reconstruction model parameter. More...

subroutine	model_set_grid_params (this, size)
	Sets grid parameters. More...

subroutine	model_set_grid_profiles (this)
	Sets grid profile values. More...

integer function	model_get_param_id (this, param_name)
	Get the id for a parameter. More...

real(rprec) function	model_get_param_value (this, id, i_index, j_index)
	Gets the value of a model parameter. More...

character(len=data_name_length) function	model_get_param_name (this, id)
	Gets the name of a model parameter. More...

integer function	model_get_gp_ne_num_hyper_param (this)
	Get the number of electron density gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	model_get_ne_af (this)
	Gets the electron density profile af array. More...

real(rprec) function	model_get_gp_ne_ij (this, i, j)
	Get the electron density gp kernel value for the two indicies. More...

real(rprec) function	model_get_gp_ne_pi (this, x_cart, i)
	Get the electron density gp kernel value for the position and index. More...

real(rprec) function	model_get_gp_ne_pp (this, x_cart, y_cart)
	Get the electron density gp kernel value for the position and position. More...

real(rprec) function	model_get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position. More...

real(rprec) function	model_get_ne_radial (this, s)
	Gets the electron density at a radial position. More...

integer function	model_get_gp_te_num_hyper_param (this)
	Get the number of electron temperature gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	model_get_te_af (this)
	Gets the electron temperature profile af array. More...

real(rprec) function	model_get_gp_te_ij (this, i, j)
	Get the electron temperature gp kernel value for the two indicies. More...

real(rprec) function	model_get_gp_te_pi (this, x_cart, i)
	Get the electron temperature gp kernel value for the position and index. More...

real(rprec) function	model_get_gp_te_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position. More...

real(rprec) function	model_get_te_cart (this, x_cart)
	Gets the electron temperature at a cartesian position. More...

real(rprec) function	model_get_te_radial (this, s)
	Gets the electron temperature at a radial position. More...

integer function	model_get_gp_ti_num_hyper_param (this)
	Get the number of ion temperature gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	model_get_ti_af (this)
	Gets the ion temperature profile af array. More...

real(rprec) function	model_get_gp_ti_ij (this, i, j)
	Get the ion temperature gp kernel value for the two indicies. More...

real(rprec) function	model_get_gp_ti_pi (this, x_cart, i)
	Get the ion temperature gp kernel value for the position and index. More...

real(rprec) function	model_get_gp_ti_pp (this, x_cart, y_cart)
	Get the electron temperature gp kernel value for the position and position. More...

real(rprec) function	model_get_ti_cart (this, x_cart)
	Gets the ion temperature at a cartesian position. More...

real(rprec) function	model_get_ti_radial (this, s)
	Gets the ion temperature at a radial position. More...

integer function	model_get_gp_sxrem_num_hyper_param (this, index)
	Get the number of soft x-ray emission gp kernel hyper parameters. More...

real(rprec) function, dimension(:), pointer	model_get_sxrem_af (this, index)
	Gets the soft x-ray emissivity profile af array. More...

real(rprec) function	model_get_gp_sxrem_ij (this, i, j, index)
	Get the soft x-ray emissivity gp kernel value for the two indicies. More...

real(rprec) function	model_get_gp_sxrem_pi (this, x_cart, i, index)
	Get the soft x-ray emissivity gp kernel value for the position and index. More...

real(rprec) function	model_get_gp_sxrem_pp (this, x_cart, y_cart, index)
	Get the soft x-ray emissivity gp kernel value for the position and position. More...

real(rprec) function	model_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position. More...

real(rprec) function	model_get_sxrem_radial (this, s, index)
	Gets the soft x-ray emissivity at a radial position. More...

real(rprec) function	model_get_sxrem_ratio (this, te)
	Gets the soft x-ray emissivity ratio. More...

character(len=data_name_length) function	model_get_ne_type (this)
	Gets the electron density type as a string. More...

character(len=data_name_length) function	model_get_te_type (this)
	Gets the electron temperature type as a string. More...

character(len=data_name_length) function	model_get_ti_type (this)
	Gets the ion temperature type as a string. More...

character(len=data_name_length) function	model_get_sxrem_type (this, index)
	Gets the soft x-ray emissivity type as a string. More...

real(rprec) function	model_get_signal_factor (this, index)
	Get the scale factor for a signal. More...

real(rprec) function	model_get_signal_offset (this, index)
	Get the offset factor for a signal. More...

logical function	model_is_recon_param (this, id)
	Determines if a parameter id is a reconstruction parameter. More...

logical function	model_has_vacuum_field (this)
	Determines if vacuum field information is available. More...

logical function	model_is_in_plasma (this, x_cart)
	Determines if a point is inside the plasma or outside. More...

type(vertex) function, pointer	model_limit_path_to_boundary (this, path)
	Limit an integration path to the boundary. More...

subroutine	model_reset_state (this)
	Reset the internal state of the model. More...

subroutine	model_save_state (this)
	Save the internal state of the model. More...

logical function	model_converge (this, num_iter, iou, eq_comm, param_name)
	Solves the model. More...

subroutine	model_write (this, iou)
	Write out the model to an output file. More...

subroutine	model_def_result (this, result_ncid, maxnsteps_dim_id, string_len_dim_id)
	Define NetCDF variables for the result file. More...

subroutine	model_write_init_data (this, result_ncid)
	Write inital data to NetCDF result file. More...

subroutine	model_write_step_data (this, result_ncid, current_step)
	Write step data to NetCDF result file. More...

subroutine	model_restart (this, result_ncid, current_step)
	Restart the model. More...

subroutine	model_sync_state (this, recon_comm)
	Syncronize the model state to children. More...

subroutine	model_sync_child (this, index, recon_comm)
	Syncronize a child model state to the parent. More...

Variables
integer, parameter	model_ne_unit_id = 0
	Parameter id for the electron density units.

integer, parameter	model_ne_min_id = 1
	Parameter id for the minimum electron density.

integer, parameter	model_te_min_id = 2
	Parameter id for the minimum electron temperature.

integer, parameter	model_ti_min_id = 3
	Parameter id for the minimum electron temperature.

integer, parameter	model_pressure_fraction_id = 4
	Parameter id for the electrion fraction of the pressure.

integer, parameter	model_sxrem_min_id = 5
	Parameter id for the electrion fraction of the pressure.

integer, parameter	model_coosig_wgts_id = 6
	Parameter id for the combination signal weights.

integer, parameter	model_signal_factor_id = 7
	Parameter id for the modeled signal scale factors.

integer, parameter	model_signal_offset_id = 8
	Parameter id for the modeled signal offset factors.

integer, parameter	model_ne_grid_id = 9
	Parameter id for the electrion density grid.

integer, parameter	model_te_grid_id = 10
	Parameter id for the electrion temperature grid.

integer, parameter	model_ti_grid_id = 11
	Parameter id for the ion temperature grid.

integer, parameter	model_sxrem_grid_id = 12
	Parameter id for the soft x-ray emissivity grid.

real(rprec), parameter	ev_per_joule = one/1.602e-19_rprec
	Conversion from Joules to eV.

Detailed Description

Defines the base class of the type model_class. The model contains information not specific to the equilibrium.

Function/Subroutine Documentation

◆ model_construct()

class (model_class) function, pointer model::model_construct	(	character (len=data_name_length), intent(in)	ne_type,
		character (len=data_name_length), dimension(:), intent(in)	sxrem_type,
		character (len=data_name_length), intent(in)	te_type,
		character (len=data_name_length), intent(in)	ti_type,
		real (rprec), intent(in)	ne_unit,
		real (rprec), intent(in)	ne_min,
		real (rprec), intent(in)	te_min,
		real (rprec), intent(in)	ti_min,
		real (rprec), dimension(:), intent(in)	sxrem_min,
		real (rprec), intent(in)	pressure_fraction,
		type (emission_class), pointer	emission,
		class (equilibrium_class), pointer	equilibrium,
		real (rprec), dimension(:), intent(in)	sxrem_te,
		real (rprec), dimension(:), intent(in)	sxrem_ratio,
		real (rprec), intent(in)	resonace_range,
		real (rprec), dimension(:), intent(in)	coosig_wgts,
		integer, intent(in)	state_flags,
		real (rprec), dimension(:), intent(in)	signal_factor,
		real (rprec), dimension(:), intent(in)	signal_offset,
		class (integration_path_class), pointer	int_params
	)

Construct a model_class containing an equilibrium object.

Allocates memory and initializes a model_class object.

Parameters

[in]	ne_type	Model type for the electron density.
[in]	sxrem_type	Model type for the soft x-ray emissivity.
[in]	te_type	Model type for the electron temperature.
[in]	ti_type	Model type for the ion temperature.
[in]	ne_unit	Scaleing of the electron denisty.
[in]	ne_min	Minimum electron density.
[in]	te_min	Minimum electron temperature.
[in]	ti_min	Minimum ion temperature.
[in]	sxrem_min	Minimum soft x-ray emission.
[in]	pressure_fraction	Fraction of the pressure provided by electrons.
[in]	equilibrium	An instance of an equilibrium.
[in]	sxrem_te	Soft x-ray ratio function te.
[in]	sxrem_ratio	Soft x-ray ratio function ratio.
[in]	resonace_range	ECE resonance interval.
[in]	coosig_wgts	Combination Signal Weights
[in]	not_converged	If true the equilibrium was constructed in an unconverged state.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.
[in]	signal_factor	Array of signal factors to scale model signals by.
[in]	signal_offset	Array of signal factors to offset model signals by.
[in]	int_params	Parameters for the integration method.

Returns: A pointer to a constructed model_class object.

Todo:: FIXME: Name here shouldn't have vmec in it

◆ model_converge()

logical function model::model_converge	(	class (model_class), intent(inout)	this,
		integer, intent(inout)	num_iter,
		integer, intent(in)	iou,
		integer, intent(in)	eq_comm,
		character (len=*), intent(in)	param_name
	)

Solves the model.

This solves the equilibirum model and computes modeled values. The modeled values computed are the grided model values.

Parameters

[in,out]	this	A model_class instance.
[in,out]	num_iter	Counter to track the number of iterations.
[in]	iou	Input/output unit of the file to write logs to.
[in]	eq_comm	MPI communicator pool for the equilibrium.
[in]	param_name	Name of the peturbed parameter.

Returns: True if the convergece was sucessful and false otherwise.

◆ model_def_result()

subroutine model::model_def_result	(	class (model_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	maxnsteps_dim_id,
		integer, intent(in)	string_len_dim_id
	)

Define NetCDF variables for the result file.

Defines dimensions and variables for the model contribution of the result file. Multi dimensional arrays need to be transposed so arrays appear in the correct order in non fortran languages.

Parameters

[in]	this	A model_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	maxnsetps_dim_id	NetCDF dimension id of the number of steps dimension.

◆ model_destruct()

subroutine model::model_destruct ( type (model_class), intent(inout) this )

Deconstruct a model_class object.

Deallocates memory and uninitializes a model_class object.

Parameters

[in,out] this A model_class instance.

◆ model_get_gp_ne_ij()

real (rprec) function model::model_get_gp_ne_ij	(	class (model_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the electron density gp kernel value for the two indicies.

Gets the electron density gp kernel for two points. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ model_get_gp_ne_num_hyper_param()

integer function model::model_get_gp_ne_num_hyper_param ( class (model_class), intent(in) this )

Get the number of electron density gp kernel hyper parameters.

Returns the number of availible hyper parameters in the electron density guassian process kernel.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_gp_ne_pi()

real (rprec) function model::model_get_gp_ne_pi	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the electron density gp kernel value for the position and index.

Gets the electron density gp kernel for point and index. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the electron density at.
[in]	i	ith profile position.

Returns: The value of the gp kernel function for x_cart and i.

◆ model_get_gp_ne_pp()

real (rprec) function model::model_get_gp_ne_pp	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the electron density gp kernel value for the position and position.

Gets the electron density gp kernel for point and index. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ model_get_gp_sxrem_ij()

real (rprec) function model::model_get_gp_sxrem_ij	(	class (model_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the two indicies.

Gets the soft x-ray emissivity gp kernel for two points. This also sets the min value.

Parameters

[in]	this	A model_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The value of the gp kernel function for i, j.

◆ model_get_gp_sxrem_num_hyper_param()

integer function model::model_get_gp_sxrem_num_hyper_param	(	class (model_class), intent(in)	this,
		integer, intent(in)	index
	)

Get the number of soft x-ray emission gp kernel hyper parameters.

Returns the number of availible hyper parameters in the soft x-ray emission guassian process kernel.

Parameters

[in]	this	A model_class instance.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: Number of kernel hyper parameters.

◆ model_get_gp_sxrem_pi()

real (rprec) function model::model_get_gp_sxrem_pi	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the position and index.

Gets the soft x-ray emissivity gp kernel for point and index. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the electron temperature at.
[in]	i	ith profile position.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: The value of the gp kernel function for x_cart and i.

◆ model_get_gp_sxrem_pp()

real (rprec) function model::model_get_gp_sxrem_pp	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart,
		integer, intent(in)	index
	)

Get the soft x-ray emissivity gp kernel value for the position and position.

Gets the soft x-ray emissivity gp kernel for point and index. This also sets the min value.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.
[in]	index	Index of the soft x-ray emissivity profile to use.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ model_get_gp_te_ij()

real (rprec) function model::model_get_gp_te_ij	(	class (model_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the electron temperature gp kernel value for the two indicies.

Gets the electron temperature gp kernel for two points. This also sets the min value.

Parameters

[in]	this	A model_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ model_get_gp_te_num_hyper_param()

integer function model::model_get_gp_te_num_hyper_param ( class (model_class), intent(in) this )

Get the number of electron temperature gp kernel hyper parameters.

Returns the number of availible hyper parameters in the electron temperature guassian process kernel.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_gp_te_pi()

real (rprec) function model::model_get_gp_te_pi	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the electron temperature gp kernel value for the position and index.

Gets the electron temperature gp kernel for point and index. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the electron temperature at.
[in]	i	ith profile position.

Returns: The value of the gp kernel function for x_cart and i.

◆ model_get_gp_te_pp()

real (rprec) function model::model_get_gp_te_pp	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the electron temperature gp kernel value for the position and position.

Gets the electron temperature gp kernel for point and index.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ model_get_gp_ti_ij()

real (rprec) function model::model_get_gp_ti_ij	(	class (model_class), intent(in)	this,
		integer, intent(in)	i,
		integer, intent(in)	j
	)

Get the ion temperature gp kernel value for the two indicies.

Gets the ion temperature gp kernel for two points. This also sets the min value.

Parameters

[in]	this	A model_class instance.
[in]	i	ith profile position.
[in]	j	jth profile position.

Returns: The value of the gp kernel function for i, j.

◆ model_get_gp_ti_num_hyper_param()

integer function model::model_get_gp_ti_num_hyper_param ( class (model_class), intent(in) this )

Get the number of ion temperature gp kernel hyper parameters.

Returns the number of availible hyper parameters in the ion temperature guassian process kernel.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_gp_ti_pi()

real (rprec) function model::model_get_gp_ti_pi	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	i
	)

Get the ion temperature gp kernel value for the position and index.

Gets the ion temperature gp kernel for point and index. This also sets the scaling and min values.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the ion temperature at.
[in]	i	ith profile position.

Returns: The value of the gp kernel function for x_cart and i.

◆ model_get_gp_ti_pp()

real (rprec) function model::model_get_gp_ti_pp	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		real (rprec), dimension(3), intent(in)	y_cart
	)

Get the electron temperature gp kernel value for the position and position.

Gets the electron temperature gp kernel for point and index.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the kernel at.
[in]	y_cart	Cartesian position to get the kernel at.

Returns: The value of the gp kernel function for x_cart and y_cart.

◆ model_get_ne_af()

real (rprec) function, dimension(:), pointer model::model_get_ne_af ( class (model_class), intent(in) this )

Gets the electron density profile af array.

Returns the af array for the electron density profile.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_ne_cart()

real (rprec) function model::model_get_ne_cart	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron density at a cartesian position.

Gets the electron density at a cartesian position. Electron density is computed based on the type of model_class::ne_type.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the electron density at.

Returns: The electron density at x_cart.

◆ model_get_ne_radial()

real (rprec) function model::model_get_ne_radial	(	class (model_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron density at a radial position.

Gets the electron density at a radial position. Electron density is computed based on the type of model_class::ne_type.

Parameters

[in]	this	A model_class instance.
[in]	s	Radial position to get the electron density at.

Returns: The electron density at r.

◆ model_get_ne_type()

character (len=data_name_length) function model::model_get_ne_type ( class (model_class), intent(in) this )

Gets the electron density type as a string.

Parameters

[in] this A model_class instance.

Returns: A string description of the electron density type.

◆ model_get_param_id()

integer function model::model_get_param_id	(	class (model_class), intent(in)	this,
		character (len=*), intent(in)	param_name
	)

Get the id for a parameter.

Gets a model reconstruction parameter. If the id is not a model parameter, it is deferred to the equilibrium.

Parameters

[in]	this	A model_class instance.
[in]	param_name	Name of a reconstruction parameter.

Returns: The id for a reconstruction parameter.

◆ model_get_param_name()

character(len=data_name_length) function model::model_get_param_name	(	class (model_class), intent(in)	this,
		integer, intent(in)	id
	)

Gets the name of a model parameter.

Gets a model reconstruction parameter name. If the id is not a model parameter, it is deferred to the equilibrium.

Parameters

[in]	this	A model_class instance.
[in]	id	ID of the parameter.

Returns: The name of the parameter.

◆ model_get_param_value()

real (rprec) function model::model_get_param_value	(	class (model_class), intent(in)	this,
		integer, intent(in)	id,
		integer, intent(in)	i_index,
		integer, intent(in)	j_index
	)

Gets the value of a model parameter.

Gets a model reconstruction parameter value. If the id is not a model parameter, it is deferred to the equilibrium.

Parameters

[in]	this	A model_class instance.
[in]	id	ID of the parameter.
[in]	i_index	The ith index of the parameter.
[in]	j_index	The jth index of the parameter.

Returns: The value of the parameter.

Note: Model parameter do not use the indicies. However an equilibrium might.

◆ model_get_signal_factor()

real (rprec) function model::model_get_signal_factor	(	class (model_class), intent(in)	this,
		integer, intent(in)	index
	)

Get the scale factor for a signal.

Gets the model scale factor. The scaling defaults to 1.

Parameters

[in]	this	A model_class instance.
[in]	index	Index of the scale factor.

Returns: Scale factor value.

◆ model_get_signal_offset()

real (rprec) function model::model_get_signal_offset	(	class (model_class), intent(in)	this,
		integer, intent(in)	index
	)

Get the offset factor for a signal.

Gets the model offset factor. The offset defaults to 0.

Parameters

[in]	this	A model_class instance.
[in]	index	Index of the scale factor.

Returns: Scale factor value.

◆ model_get_sxrem_af()

real (rprec) function, dimension(:), pointer model::model_get_sxrem_af	(	class (model_class), intent(in)	this,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity profile af array.

Returns the af array for the electron density profile.

Parameters

[in]	this	A model_class instance.
[in]	index	Index of the soft x-ray emissivity profile.

Returns: Number of kernel hyper parameters.

◆ model_get_sxrem_cart()

real (rprec) function model::model_get_sxrem_cart	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a cartesian position.

Gets the soft x-ray emissivity at a cartesian position. Soft x-ray emissivity is computed based on the type of model_class::sxrem_type.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity model.

Returns: The soft x-ray emissivity at x_cart.

◆ model_get_sxrem_radial()

real (rprec) function model::model_get_sxrem_radial	(	class (model_class), intent(in)	this,
		real (rprec), intent(in)	s,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a radial position.

Gets the soft x-ray emissivity at a radial position. Soft x-ray emissivity is computed based on the type of model_class::sxrem_type.

Parameters

[in]	this	A model_class instance.
[in]	s	Radial position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity model.

Returns: The soft x-ray emissivity at r.

◆ model_get_sxrem_ratio()

real (rprec) function model::model_get_sxrem_ratio	(	class (model_class), intent(in)	this,
		real (rprec), intent(in)	te
	)

Gets the soft x-ray emissivity ratio.

Gets the soft x-ray emissivity at a radial position. Soft x-ray emissivity is computed based on the type of model_class::sxrem_type.

Parameters

[in]	this	A model_class instance.
[in]	r	Radial position to get the soft x-ray emissivity at.
[in]	length	Distance to the camera.
[in]	index	Index of the soft x-ray emissivity model.

Returns: The soft x-ray emissivity at r.

◆ model_get_sxrem_type()

character (len=data_name_length) function model::model_get_sxrem_type	(	class (model_class), intent(in)	this,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity type as a string.

Parameters

[in]	this	A model_class instance.
[in]	index	Index of the soft x-ray emissivity model.

Returns: A string description of the soft x-ray emissivity type.

◆ model_get_te_af()

real (rprec) function, dimension(:), pointer model::model_get_te_af ( class (model_class), intent(in) this )

Gets the electron temperature profile af array.

Returns the af array for the electron temperature profile.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_te_cart()

real (rprec) function model::model_get_te_cart	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron temperature at a cartesian position.

Gets the electron temperature at a cartesian position. Electron temperature is computed based on the type of model_class::te_type.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the electron temperature at.

Returns: The electron temperature at x_cart.

◆ model_get_te_radial()

real (rprec) function model::model_get_te_radial	(	class (model_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the electron temperature at a radial position.

Gets the electron temperature at a radial position. Electron temperature is computed based on the type of model_class::te_type.

Parameters

[in]	this	A model_class instance.
[in]	s	Radial position to get the electron temperature at.

Returns: The electron temperature at r.

◆ model_get_te_type()

character (len=data_name_length) function model::model_get_te_type ( class (model_class), intent(in) this )

Gets the electron temperature type as a string.

Parameters

[in] this A model_class instance.

Returns: A string description of the electron temperature type.

◆ model_get_ti_af()

real (rprec) function, dimension(:), pointer model::model_get_ti_af ( class (model_class), intent(in) this )

Gets the ion temperature profile af array.

Returns the af array for the ion temperature profile.

Parameters

[in] this A model_class instance.

Returns: Number of kernel hyper parameters.

◆ model_get_ti_cart()

real (rprec) function model::model_get_ti_cart	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the ion temperature at a cartesian position.

Gets the ion temperature at a cartesian position. Ion temperature is computed based on the type of model_class::ti_type.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to get the ion temperature at.

Returns: The ion temperature at x_cart.

◆ model_get_ti_radial()

real (rprec) function model::model_get_ti_radial	(	class (model_class), intent(in)	this,
		real (rprec), intent(in)	s
	)

Gets the ion temperature at a radial position.

Gets the ion temperature at a radial position. Electron temperature is computed based on the type of model_class::ti_type.

Parameters

[in]	this	A model_class instance.
[in]	s	Radial position to get the ion temperature at.

Returns: The ion temperature at r.

◆ model_get_ti_type()

character (len=data_name_length) function model::model_get_ti_type ( class (model_class), intent(in) this )

Gets the ion temperature type as a string.

Parameters

[in] this A model_class instance.

Returns: A string description of the ion temperature type.

◆ model_has_vacuum_field()

logical function model::model_has_vacuum_field ( class (model_class), intent(in) this )

Determines if vacuum field information is available.

Parameters

[in] this A model_class instance.

Returns: True of vacuum fields are available.

◆ model_is_in_plasma()

logical function model::model_is_in_plasma	(	class (model_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Determines if a point is inside the plasma or outside.

Parameters

[in]	this	A model_class instance.
[in]	x_cart	Cartesian position to check.

Returns: True if the point is inside the plasma.

◆ model_is_recon_param()

logical function model::model_is_recon_param	(	class (model_class), intent(in)	this,
		integer, intent(in)	id
	)

Determines if a parameter id is a reconstruction parameter.

Determines if a parameter id is a reconstruction parameter. If the parameter is not a model parameter, it is deferred to the equilibrium.

Parameters

[in]	this	A model_class instance.
[in]	id	ID of the parameter.

Returns: True if the id is a reconstruction parameter and false if not.

◆ model_limit_path_to_boundary()

type (vertex) function, pointer model::model_limit_path_to_boundary	(	class (model_class), intent(in)	this,
		type (vertex), pointer	path
	)

Limit an integration path to the boundary.

Parameters

[in]	this	A model_class instance.
[in]	path	A chord path.

Returns: The chord path limited to the boundary.

◆ model_reset_state()

subroutine model::model_reset_state ( class (model_class), intent(inout) this )

Reset the internal state of the model.

Clears out the model state flags then resets the equilibrium. This resets the profile grid if they were changed.

Parameters

[in,out] this A equilibrium_class instance.

◆ model_restart()

subroutine model::model_restart	(	class (model_class), intent(inout)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Restart the model.

Restarts the model from the result file.

Parameters

[in,out]	this	A model_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	current_step	Step index to read variables from.

◆ model_save_state()

subroutine model::model_save_state ( class (model_class), intent(inout) this )

Save the internal state of the model.

Clears out the model state flags then resets the equilibrium.

Parameters

[in,out] this A equilibrium_class instance.

◆ model_set_grid_params()

subroutine model::model_set_grid_params	(	class (model_class), intent(inout)	this,
		integer, intent(in)	size
	)

Sets grid parameters.

Sets the start and step size of the radial grids.

Parameters

[in,out]	this	A model_class instance.
[in]	size	Number of grid points.

◆ model_set_grid_profiles()

subroutine model::model_set_grid_profiles ( class (model_class), intent(inout) this )

Sets grid profile values.

Sets the grided profiles from the current equilibrium mode.

Parameters

[in,out] this A model_class instance.

◆ model_set_param()

subroutine model::model_set_param	(	class (model_class), intent(inout)	this,
		integer, intent(in)	id,
		integer, intent(in)	i_index,
		integer, intent(in)	j_index,
		real (rprec), intent(in)	value,
		integer, intent(in)	eq_comm
	)

Sets the value of a reconstruction model parameter.

Sets a model reconstruction parameter. If the id is not a model parameter, it is deferred to the equilibrium.

Parameters

[in,out]	this	A model_class instance.
[in]	id	ID of the parameter.
[in]	i_index	The ith index of the parameter.
[in]	j_index	The jth index of the parameter.
[in]	value	The value of the parameter.
[in]	eq_comm	MPI communicator for the child equilibrium processes.

Note: Model parameter do not use the indicies. However an equilibrium might.

◆ model_sync_child()

subroutine model::model_sync_child	(	class (model_class), intent(inout)	this,
		integer, intent(in)	index,
		integer, intent(in)	recon_comm
	)

Syncronize a child model state to the parent.

Syncs data between a child and the parent process. If MPI support is not compiled in this subroutine reduces to a no op.

Parameters

[in,out]	this	A model_class instance.
[in]	index	Reconstruction rank to sync.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ model_sync_state()

subroutine model::model_sync_state	(	class (model_class), intent(inout)	this,
		integer, intent(in)	recon_comm
	)

Syncronize the model state to children.

Syncs data between the parent and child processes. If MPI support is not compiled in this subroutine reduces to a no op.

Parameters

[in,out]	this	A model_class instance.
[in]	recon_comm	MPI communicator for the reconstruction processes.

◆ model_write()

subroutine model::model_write	(	class (model_class), intent(in)	this,
		integer, intent(in)	iou
	)

Write out the model to an output file.

Write out information about the model to an output file. This also then calls the equilibrium_write subroutine to write out the equilibrium information as well.

Parameters

[in]	this	A model_class instance.
[in]	iou	Input/output unit of the output file.

◆ model_write_init_data()

subroutine model::model_write_init_data	(	class (model_class), intent(in)	this,
		integer, intent(in)	result_ncid
	)

Write inital data to NetCDF result file.

This write the data that doesn't change.

Parameters

[in]	this	A model_class instance.
[in]	result_ncid	NetCDF file id of the result file.

◆ model_write_step_data()

subroutine model::model_write_step_data	(	class (model_class), intent(in)	this,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step
	)

Write step data to NetCDF result file.

This write the data that can change each reconstruction step.

Parameters

[in]	this	A model_class instance.
[in]	result_ncid	NetCDF file id of the result file.
[in]	current_step	Step index to write variables to.

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ model_construct()

◆ model_converge()

◆ model_def_result()

◆ model_destruct()

◆ model_get_gp_ne_ij()

◆ model_get_gp_ne_num_hyper_param()

◆ model_get_gp_ne_pi()

◆ model_get_gp_ne_pp()

◆ model_get_gp_sxrem_ij()

◆ model_get_gp_sxrem_num_hyper_param()

◆ model_get_gp_sxrem_pi()

◆ model_get_gp_sxrem_pp()

◆ model_get_gp_te_ij()

◆ model_get_gp_te_num_hyper_param()

◆ model_get_gp_te_pi()

◆ model_get_gp_te_pp()

◆ model_get_gp_ti_ij()

◆ model_get_gp_ti_num_hyper_param()

◆ model_get_gp_ti_pi()

◆ model_get_gp_ti_pp()

◆ model_get_ne_af()

◆ model_get_ne_cart()

◆ model_get_ne_radial()

◆ model_get_ne_type()

◆ model_get_param_id()

◆ model_get_param_name()

◆ model_get_param_value()

◆ model_get_signal_factor()

◆ model_get_signal_offset()

◆ model_get_sxrem_af()

◆ model_get_sxrem_cart()

◆ model_get_sxrem_radial()

◆ model_get_sxrem_ratio()

◆ model_get_sxrem_type()

◆ model_get_te_af()

◆ model_get_te_cart()

◆ model_get_te_radial()

◆ model_get_te_type()

◆ model_get_ti_af()

◆ model_get_ti_cart()

◆ model_get_ti_radial()

◆ model_get_ti_type()

◆ model_has_vacuum_field()

◆ model_is_in_plasma()

◆ model_is_recon_param()

◆ model_limit_path_to_boundary()

◆ model_reset_state()

◆ model_restart()

◆ model_save_state()

◆ model_set_grid_params()

◆ model_set_grid_profiles()

◆ model_set_param()

◆ model_sync_child()

◆ model_sync_state()

◆ model_write()

◆ model_write_init_data()

◆ model_write_step_data()