Stellarator-Tools
Loading...
Searching...
No Matches
magnetic::magnetic_class Interface Reference

Base class representing a magnetic signal. More...

Inheritance diagram for magnetic::magnetic_class:
signal::signal_class

Public Member Functions

procedure get_modeled_signal_last (this, a_model, sigma, last_value)
 Calculates the modeled signal.
procedure get_type (this)
 Gets a discription of the magnetic type.
procedure get_header (this, header)
 Gets a discription of the model and model sigma array indices.
FINAL magnetic_destruct (this)
 Deconstruct a magnetic_class object.
class(magnetic_class) function, pointer magnetic_construct_netcdf (mdsig_iou, use_coil_response, force_coil_reponse, use_3d_only, svd_cut_off)
 Construct a magnetic_class object containing a magnetic_response::magnetic_response_class object.
Public Member Functions inherited from signal::signal_class
procedure get_modeled_signal_cache (this, a_model, sigma, use_cache, last_value)
 Calculates the modeled signal.
procedure get_modeled_signal_last (this, a_model, sigma, last_value)
 Calculates the modeled signal.
GENERIC get_modeled_signal get_modeled_signal_cache, get_modeled_signal_last
procedure get_observed_signal (this, a_model)
 Calculates the observed signal.
procedure get_g2 (this, a_model, use_cache, last_value)
 Calculates the g^2 contribution of a signal.
procedure get_e (this, a_model, use_cache, last_value)
 Calculates the e contribution of a signal.
procedure get_sigma2 (this)
 Calculates the total sigma^2 of a signal.
procedure get_type (this)
 Gets a discription of the signal type.
procedure get_header (this, header)
 Gets a discription of the model and model sigma array indices.
procedure get_gp_i (this, a_model, i, flags)
 Gets the guassian process kernel for a signal and a position.
procedure get_gp_s (this, a_model, signal, flags)
 Gets the guassian process kernel for a signal and a signal.
procedure get_gp_x (this, a_model, x_cart, flags)
 Gets the guassian process kernel for a signal and cartesian position.
GENERIC get_gp get_gp_i, get_gp_s, get_gp_x
procedure scale_and_offset (this, a_model, value)
 Apply scale and offset to the value.
procedure sync_child (this, index, recon_comm)
 Syncronize a child signal state to the parent.
procedure write_header (this, iou)
 Write out the signal header information to an output file.
procedure write (this, iou, index, a_model)
 Write out the signal information to an output file.
procedure write_auxiliary (this, iou, index, a_model)
 Write out any auxiliary signal information to an output file.
procedure write_step_data (this, a_model, result_ncid, current_step, index, signal_model_value_id, signal_sigma_value_id)
 Write out the signal data for a step to the result netcdf file.
FINAL signal_destruct (this)
 Deconstruct a signal_class object.

Public Attributes

integer control_flags
 Setting to force the computing of the coil constribution.
type(magnetic_response_class), pointer response => null()
 Magnetic response function object.
Public Attributes inherited from signal::signal_class
character(len=data_short_name_length) s_name
 Short name of the signal.
character(len=data_name_length) l_name
 Long name of the signal.
character(len=data_short_name_length) units
 Physical units the signal measures.
real(rprec) observed
 Eperimentally measured signal value.
real(rprec) observed_sigma
 Eperimentally measured signal uncertainty.
real(rprec) weight
 Weighting parameter of the signal.
real(rprec), dimension(4) modeled
 Cached value of the modeled signal.
real(rprec), dimension(4) modeled_sigma
 Cached value of the modeled sigma.
integer scale_index
 Scale factor index.
integer offset_index
 Offset factor index.

Detailed Description

Base class representing a magnetic signal.

Interface for the construction of magnetic_class types using magnetic_construct_netcdf.

Super Class:
diagnostic

Member Function/Subroutine Documentation

◆ get_header()

procedure magnetic::magnetic_class::get_header ( class (magnetic_class), intent(in) this,
character (len=data_name_length), dimension(7), intent(inout) header )

Gets a discription of the model and model sigma array indices.

Returns a description of the array indices for use when writting output files.

Parameters
[in]thisA magnetic_class instance.
[in,out]headerBuffer arrays to write header strings to.
Returns
A string describing the model and model sigma array indices.

◆ get_modeled_signal_last()

procedure magnetic::magnetic_class::get_modeled_signal_last ( class (magnetic_class), intent(inout) this,
class (model_class), pointer a_model,
real (rprec), dimension(4), intent(out) sigma,
real (rprec), dimension(4), intent(in) last_value )

Calculates the modeled signal.

The modeled signal can be computed in one of two ways. Modeled as a full coil or as a point measurement.

Parameters
[in,out]thisA magnetic_class instance.
[in]a_modelA model instance.
[out]sigmaThe modeled sigma.
[in]last_valueLast good value in case the signal did not change.
Returns
The model value.

◆ get_type()

procedure magnetic::magnetic_class::get_type ( class (magnetic_class), intent(in) this)

Gets a discription of the magnetic type.

Returns a description of the magnetic type for use when writting output files.

Parameters
[in]thisA magnetic_class instance.
Returns
A string describing the magnetic type.

◆ magnetic_construct_netcdf()

class (magnetic_class) function, pointer magnetic::magnetic_class::magnetic_construct_netcdf ( integer, intent(in) mdsig_iou,
logical, intent(in) use_coil_response,
logical, intent(in) force_coil_reponse,
logical, intent(in) use_3d_only,
real (rprec), intent(in) svd_cut_off )

Construct a magnetic_class object containing a magnetic_response::magnetic_response_class object.

Allocates memory and initializes a magnetic_class object.

Parameters
[in]mdsig_iouAn instance of a the netcdf id of the open mdsig file.
[in]use_coil_responseToggle if the total signal contains the induced signal in addition to the plasma only signal.
[in]force_coil_reponseForce the coil response to be computed.
[in]use_3D_onlySubtract of the axisymmtric porition of the signal.
[in]svd_cut_offCutoff value for the number of singular values to retain when compressing the response function arrays.
Returns
A pointer to a constructed magnetic_class object.

◆ magnetic_destruct()

FINAL magnetic::magnetic_class::magnetic_destruct ( type (magnetic_class), intent(inout) this)
final

Deconstruct a magnetic_class object.

Deallocates memory and uninitializes a magnetic_class object.

Parameters
[in,out]thisA magnetic_class instance.

The documentation for this interface was generated from the following file: