Stellarator-Tools
Loading...
Searching...
No Matches
sxrem::sxrem_class Type Reference

Base class representing a soft x-ray signal. More...

Inheritance diagram for sxrem::sxrem_class:
signal::signal_class sxrem::sxrem_emiss_class sxrem::sxrem_ti_class

Public Member Functions

FINAL sxrem_destruct (this)
 Deconstruct a sxrem_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

type(vertex), pointer chord_path => null()
 The complete path of the chord.
 
integer profile_number
 Index of the soft x-ray emissivity profile for this chord.
 
- Public Attributes inherited from signal::signal_class
character(len=data_short_name_lengths_name
 Short name of the signal.
 
character(len=data_name_lengthl_name
 Long name of the signal.
 
character(len=data_short_name_lengthunits
 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 soft x-ray signal.

Super Class:
signal

Member Function/Subroutine Documentation

◆ sxrem_destruct()

FINAL sxrem::sxrem_class::sxrem_destruct ( type (sxrem_class), intent(inout)  this)
final

Deconstruct a sxrem_class object.

Deallocates memory and uninitializes a sxrem_class object.

Parameters
[in,out]thisA sxrem_class instance.

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