V3FIT
Public Member Functions | Public Attributes | Private Member Functions | List of all members
mse::mse_class Interface Reference

Base class representing a mse signal. More...

Inheritance diagram for mse::mse_class:
signal::signal_class

Public Member Functions

PROCEDURE get_modeled_signal_last => mse_get_modeled_signal
 
PROCEDURE get_type => mse_get_type
 
PROCEDURE get_header => mse_get_header
 
FINAL mse_destruct
 
class(mse_class) function, pointer mse_construct_vec (point, view_start, view_end, beam_start, beam_end, in_degrees, is_ratio)
 Construct a mse_class object representing a motional stark effect diagnostic. More...
 
class(mse_class) function, pointer mse_construct_rad (point, alpha, omega, delta, theta, in_degrees, is_ratio)
 Construct a mse_class object representing a motional stark effect diagnostic. More...
 
- Public Member Functions inherited from signal::signal_class
PROCEDURE get_modeled_signal_cache => signal_get_modeled_signal_cache
 
PROCEDURE get_modeled_signal_last => signal_get_modeled_signal_last
 
GENERIC get_modeled_signal => get_modeled_signal_cache, get_modeled_signal_last
 
PROCEDURE get_observed_signal => signal_get_observed_signal
 
PROCEDURE get_g2 => signal_get_g2
 
PROCEDURE get_e => signal_get_e
 
PROCEDURE get_sigma2 => signal_get_sigma2
 
PROCEDURE get_type => signal_get_type
 
PROCEDURE get_header => signal_get_header
 
PROCEDURE get_gp_i => signal_get_gp_i
 
PROCEDURE get_gp_s => signal_get_gp_s
 
PROCEDURE get_gp_x => signal_get_gp_x
 
GENERIC get_gp => get_gp_i, get_gp_s, get_gp_x
 
PROCEDURE scale_and_offset => signal_scale_and_offset
 
PROCEDURE sync_child => signal_sync_child
 
PROCEDURE write_header => signal_write_header
 
PROCEDURE write => signal_write
 
PROCEDURE write_auxiliary => signals_write_auxiliary
 
PROCEDURE write_step_data => signal_write_step_data
 
FINAL signal_destruct
 

Public Attributes

real(rprec), dimension(3) point
 Intersection point of the viewing angle and the neutral beam.
 
real(rprec) alpha
 Angle between the toroidal direction and neutral beam.
 
real(rprec) omega
 Angle between the toroidal direction the view chord.
 
real(rprec) delta
 Pitch angle of the neutral beam with respect to the horizontal.
 
real(rprec) theta
 Pitch angle of the viewing chord with respect to the horizontal.
 
integer flags
 Control flags for the signal output.
 
- 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.
 

Private Member Functions

PROCEDURE, private angle_to_bt_proj => mse_angle_to_bt_proj
 

Detailed Description

Base class representing a mse signal.

Interface for the construction of mse_class types using mse_construct_vec or mse_construct_rad.

Super Class:
diagnostic

Definition at line 42 of file mse.f.

Member Function/Subroutine Documentation

◆ mse_construct_rad()

class (mse_class) function, pointer mse::mse_class::mse_construct_rad ( real (rprec), dimension(3), intent(in)  point,
real (rprec), intent(in)  alpha,
real (rprec), intent(in)  omega,
real (rprec), intent(in)  delta,
real (rprec), intent(in)  theta,
logical, intent(in)  in_degrees,
logical, intent(in)  is_ratio 
)

Construct a mse_class object representing a motional stark effect diagnostic.

Allocates memory and initializes a mse_class object. Uses angle representation.

Parameters
[in]pointMeasurement point of the mse diagnostic.
[in]omegaAngle between the neutral beam and the toroidal in the horizontal.
[in]alphaAngle between the view chord and the toroidal in the horizontal.
[in]deltaPitch angle to the horizontal and the neutral beam.
[in]thetaPitch angle to the horizontal and the view chord.
[in]in_degreesChannel measures degrees.
[in]is_ratioChannel measures ratio.
Returns
A pointer to a constructed mse_class object.

Definition at line 179 of file mse.f.

◆ mse_construct_vec()

class (mse_class) function, pointer mse::mse_class::mse_construct_vec ( real (rprec), dimension(3), intent(in)  point,
real (rprec), dimension(3), intent(in)  view_start,
real (rprec), dimension(3), intent(in)  view_end,
real (rprec), dimension(3), intent(in)  beam_start,
real (rprec), dimension(3), intent(in)  beam_end,
logical, intent(in)  in_degrees,
logical, intent(in)  is_ratio 
)

Construct a mse_class object representing a motional stark effect diagnostic.

Allocates memory and initializes a mse_class object. Uses vector representation.

Parameters
[in]pointMeasurement point of the mse diagnostic.
[in]view_startStarting point of the view vector.
[in]view_endEnding point of the view vector.
[in]beam_startStarting point of the beam vector.
[in]beam_endEnding point of the beam vector.
[in]in_degreesChannel measures degrees.
[in]is_ratioChannel measures ratio.
Returns
A pointer to a constructed mse_class object.

Definition at line 105 of file mse.f.


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