Package pulse.properties
Enum NumericPropertyKeyword
- java.lang.Object
-
- java.lang.Enum<NumericPropertyKeyword>
-
- pulse.properties.NumericPropertyKeyword
-
- All Implemented Interfaces:
Serializable,Comparable<NumericPropertyKeyword>
public enum NumericPropertyKeyword extends Enum<NumericPropertyKeyword>
Contains a list of NumericProperty types recognised by the constituent modules of PULsE.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ATOLAbsolute tolerance (atol) for RK calculations (RTE).AXIAL_COATING_THICKNESSNot implemented yet.BASELINE_AMPLITUDEAmplitude of the sinusoidal baseline.BASELINE_FREQUENCYFrequency of the sinusoidal baseline.BASELINE_INTERCEPTThe baseline intercept value.BASELINE_PHASE_SHIFTPhase shift of the sinusoidal baseline.BASELINE_SLOPEThe baseline slope (for linear baselines).BUFFER_SIZEThe buffer size that is used to establish whether results are converging.COATING_DIFFUSIVITYNot implemented yet.COMBINED_ABSORPTIVITYA directive to the optimiser informing both front and rear side absorptivities must be equal.CONDUCTIVITYThermal conductivity.CORRELATION_THRESHOLDThreshold above which properties are thought to be strongly correlated.DAMPING_RATIOLevenberg-Marquardt damping ratio.DENSITYDensity of the sample.DETECTOR_GAINThe detector gain (amplification).DETECTOR_IRISThe detector iris (aperture).DIAMETERSample diameter.DIATHERMIC_COEFFICIENTA dimensionless coefficient in the radiation flux expression for the radiative heat transfer between the front and the rear (coated) surfaces.DIFFUSIVITYThe thermal diffusivity of the sample.DOM_DIRECTIONSNumber of independent directions (DOM).DOM_GRID_DENSITYInternal DOM grid density (RTE).DOM_ITERATION_ERRORIteration error tolerance in DOM calculations.EMISSIVITYEmissivity of the sample (nonlinear problems).ERROR_TOLERANCEThe total error tolerance.FOV_INNERThe inner field of view diameter for the detector sighting.FOV_OUTERThe outer field of view diameter for the detector sighting.GAS_EXCHANGE_COEFFICIENTEnergy exchange coefficient in the two-temperature model (g').GRADIENT_RESOLUTIONThe accuracy of gradient calculation.GRID_DENSITYGrid (space partitioning) density.GRID_SCALING_FACTORGrid scaling factor.GRID_STRETCHING_FACTORGrid stretching factor (RTE).HEAT_LOSSThe coefficient of heat losses from the front and rear surfaces of the sample (1D and 2D problems).HEAT_LOSS_COMBINEDA directive for the optimiser to maintain equal heat losses on all surfaces of the sample.HEAT_LOSS_CONVECTIVEThe convective heat loss in diathermic and participating medium problems.HEAT_LOSS_GASHeat loss for the gas in the 2T-model.HEAT_LOSS_SIDEThe coefficient of heat losses from the side surface of the sample (two-dimensional problems).IDENTIFIERTask identifier.INCIDENT_INTENSITYIntensity of incident radiation.INTEGRATION_CUTOFFCutoff for numeric integration.INTEGRATION_SEGMENTSNumber of subdivisions for numeric integration.ITERATIONSearch iteration.ITERATION_LIMITIteration limit for reverse problem solution.LAGUERRE_SOLVER_ERRORError tolerance for the Laguerre solver (RTE).LASER_ABSORPTIVITYDimensionless coefficient of laser energy absorption (γ0).LASER_ENERGYAbsorbed energy (nonlinear problems).LINEAR_RESOLUTIONThe resolution of linear search.LOWER_BOUNDLower calculation bound for optimiser.MAX_HIGH_FREQ_WAVESMax.MAX_LOW_FREQ_WAVESMax.MAXTEMPThe maximum temperature, or the signal height -- if a relative temperature scale is used.MODEL_CRITERIONModel selection criterion (AIC, BIC, etc.).MODEL_WEIGHTA weight indicating how good a calculation model is.NONLINEAR_PRECISIONThe precision parameter used to solve nonlinear problems.NUMPOINTSThe number of points in theHeatingCurve.OBJECTIVE_FUNCTIONValue of objective function.OPTICAL_THICKNESSThe optical thickness of a material, equal to a product of its geometric thickness and the absorptivity.OPTIMISER_STATISTICOptimiser statistic (usually, RSS).PLANCK_NUMBERThe Planck number.PULSE_WIDTHPulse width (time).QUADRATURE_POINTSNumber of quadrature points (RTE).RADIAL_COATING_THICKNESSNot implemented yet.REFLECTANCEReflectance of the sample (0 < R ≤ 1).RELAXATION_PARAMETERRelaxation parameter of iterative solver (RTE).RTE_INTEGRATION_TIMEOUTMaximum allowed time spent on integration (RTE).RTE_MAX_ITERATIONSIteration threshold for RTE calculations.RTOLRelative tolerance (atol) for RK calculations (RTE).SCATTERING_ALBEDOAlbedo of single scattering.SCATTERING_ANISOTROPYAnisotropy coefficient for the phase function of scattering.SCHEME_WEIGHTWeight of the semi-implicit finite-difference scheme.SHELL_GRID_DENSITYNot implemented yet.SIGNIFICANCEStatistical significance for calculating the critical value.SKEW_LAMBDAλ parameter for skewed normal distribution.SKEW_MUμ parameter for skewed normal distribution.SKEW_SIGMAσ parameter for skewed normal distribution.SOLID_EXCHANGE_COEFFICIENTEnergy exchange coefficient in the two-temperature model (g).SOURCE_GEOMETRIC_FACTORDetermines how much weight is attributed to the front-face light source compared to rear face.SPECIFIC_HEATSpecific heat ().SPOT_DIAMETERLaser spot diameter.TAU_FACTORThe factor used to convert squared grid spacing to time step.TEST_STATISTICTest statistic (e.g.TEST_TEMPERATURETest temperature, at which the laser was fired at the sample.THERMAL_ABSORPTIVITYDimensionless coefficient of thermal radiation absorption.THICKNESSSample thickness.TIME_LIMITCalculation time limit.TIME_SHIFTTime shift (pulse sync).TRAPEZOIDAL_FALL_PERCENTAGEPercentage of final (fall) segment of the pulse trapezoid.TRAPEZOIDAL_RISE_PERCENTAGEPercentage of initial (rise) segment of the pulse trapezoid.UPPER_BOUNDUpper calculation bound for optimiser.WINDOWAveraging window.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Optional<NumericPropertyKeyword>findAny(String key)static NumericPropertyKeywordvalueOf(String name)Returns the enum constant of this type with the specified name.static NumericPropertyKeyword[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DIFFUSIVITY
public static final NumericPropertyKeyword DIFFUSIVITY
The thermal diffusivity of the sample.
-
COATING_DIFFUSIVITY
public static final NumericPropertyKeyword COATING_DIFFUSIVITY
Not implemented yet.
-
THICKNESS
public static final NumericPropertyKeyword THICKNESS
Sample thickness.
-
DIAMETER
public static final NumericPropertyKeyword DIAMETER
Sample diameter.
-
MAXTEMP
public static final NumericPropertyKeyword MAXTEMP
The maximum temperature, or the signal height -- if a relative temperature scale is used.
-
NUMPOINTS
public static final NumericPropertyKeyword NUMPOINTS
The number of points in theHeatingCurve.
-
NONLINEAR_PRECISION
public static final NumericPropertyKeyword NONLINEAR_PRECISION
The precision parameter used to solve nonlinear problems.
-
PULSE_WIDTH
public static final NumericPropertyKeyword PULSE_WIDTH
Pulse width (time).
-
SPOT_DIAMETER
public static final NumericPropertyKeyword SPOT_DIAMETER
Laser spot diameter.
-
TIME_LIMIT
public static final NumericPropertyKeyword TIME_LIMIT
Calculation time limit.
-
GRID_DENSITY
public static final NumericPropertyKeyword GRID_DENSITY
Grid (space partitioning) density.
-
SHELL_GRID_DENSITY
public static final NumericPropertyKeyword SHELL_GRID_DENSITY
Not implemented yet.
-
AXIAL_COATING_THICKNESS
public static final NumericPropertyKeyword AXIAL_COATING_THICKNESS
Not implemented yet.
-
RADIAL_COATING_THICKNESS
public static final NumericPropertyKeyword RADIAL_COATING_THICKNESS
Not implemented yet.
-
SPECIFIC_HEAT
public static final NumericPropertyKeyword SPECIFIC_HEAT
Specific heat ().
-
CONDUCTIVITY
public static final NumericPropertyKeyword CONDUCTIVITY
Thermal conductivity.
-
EMISSIVITY
public static final NumericPropertyKeyword EMISSIVITY
Emissivity of the sample (nonlinear problems).
-
DENSITY
public static final NumericPropertyKeyword DENSITY
Density of the sample.
-
LASER_ENERGY
public static final NumericPropertyKeyword LASER_ENERGY
Absorbed energy (nonlinear problems).
-
TEST_TEMPERATURE
public static final NumericPropertyKeyword TEST_TEMPERATURE
Test temperature, at which the laser was fired at the sample.
-
LINEAR_RESOLUTION
public static final NumericPropertyKeyword LINEAR_RESOLUTION
The resolution of linear search.
-
GRADIENT_RESOLUTION
public static final NumericPropertyKeyword GRADIENT_RESOLUTION
The accuracy of gradient calculation.
-
BUFFER_SIZE
public static final NumericPropertyKeyword BUFFER_SIZE
The buffer size that is used to establish whether results are converging.
-
ERROR_TOLERANCE
public static final NumericPropertyKeyword ERROR_TOLERANCE
The total error tolerance.
-
FOV_OUTER
public static final NumericPropertyKeyword FOV_OUTER
The outer field of view diameter for the detector sighting.
-
FOV_INNER
public static final NumericPropertyKeyword FOV_INNER
The inner field of view diameter for the detector sighting.
-
BASELINE_SLOPE
public static final NumericPropertyKeyword BASELINE_SLOPE
The baseline slope (for linear baselines).
-
BASELINE_FREQUENCY
public static final NumericPropertyKeyword BASELINE_FREQUENCY
Frequency of the sinusoidal baseline.
-
BASELINE_PHASE_SHIFT
public static final NumericPropertyKeyword BASELINE_PHASE_SHIFT
Phase shift of the sinusoidal baseline.
-
BASELINE_AMPLITUDE
public static final NumericPropertyKeyword BASELINE_AMPLITUDE
Amplitude of the sinusoidal baseline.
-
BASELINE_INTERCEPT
public static final NumericPropertyKeyword BASELINE_INTERCEPT
The baseline intercept value.
-
TAU_FACTOR
public static final NumericPropertyKeyword TAU_FACTOR
The factor used to convert squared grid spacing to time step.
-
DETECTOR_GAIN
public static final NumericPropertyKeyword DETECTOR_GAIN
The detector gain (amplification).
-
DETECTOR_IRIS
public static final NumericPropertyKeyword DETECTOR_IRIS
The detector iris (aperture).
-
HEAT_LOSS_SIDE
public static final NumericPropertyKeyword HEAT_LOSS_SIDE
The coefficient of heat losses from the side surface of the sample (two-dimensional problems).
-
HEAT_LOSS
public static final NumericPropertyKeyword HEAT_LOSS
The coefficient of heat losses from the front and rear surfaces of the sample (1D and 2D problems).
-
HEAT_LOSS_CONVECTIVE
public static final NumericPropertyKeyword HEAT_LOSS_CONVECTIVE
The convective heat loss in diathermic and participating medium problems.
-
HEAT_LOSS_COMBINED
public static final NumericPropertyKeyword HEAT_LOSS_COMBINED
A directive for the optimiser to maintain equal heat losses on all surfaces of the sample. Note that the dimensionless heat losses, i.e. Biot numbers, will differ due to different areas of the side and front/rear surfaces.
-
ITERATION
public static final NumericPropertyKeyword ITERATION
Search iteration.
-
IDENTIFIER
public static final NumericPropertyKeyword IDENTIFIER
Task identifier.
-
ITERATION_LIMIT
public static final NumericPropertyKeyword ITERATION_LIMIT
Iteration limit for reverse problem solution.
-
LASER_ABSORPTIVITY
public static final NumericPropertyKeyword LASER_ABSORPTIVITY
Dimensionless coefficient of laser energy absorption (γ0).
-
THERMAL_ABSORPTIVITY
public static final NumericPropertyKeyword THERMAL_ABSORPTIVITY
Dimensionless coefficient of thermal radiation absorption.
-
COMBINED_ABSORPTIVITY
public static final NumericPropertyKeyword COMBINED_ABSORPTIVITY
A directive to the optimiser informing both front and rear side absorptivities must be equal.
-
REFLECTANCE
public static final NumericPropertyKeyword REFLECTANCE
Reflectance of the sample (0 < R ≤ 1).
-
DIATHERMIC_COEFFICIENT
public static final NumericPropertyKeyword DIATHERMIC_COEFFICIENT
A dimensionless coefficient in the radiation flux expression for the radiative heat transfer between the front and the rear (coated) surfaces. Used by theDiathermicMaterialProblem.
-
PLANCK_NUMBER
public static final NumericPropertyKeyword PLANCK_NUMBER
The Planck number.
-
OPTICAL_THICKNESS
public static final NumericPropertyKeyword OPTICAL_THICKNESS
The optical thickness of a material, equal to a product of its geometric thickness and the absorptivity.
-
TIME_SHIFT
public static final NumericPropertyKeyword TIME_SHIFT
Time shift (pulse sync).
-
SIGNIFICANCE
public static final NumericPropertyKeyword SIGNIFICANCE
Statistical significance for calculating the critical value.
-
OPTIMISER_STATISTIC
public static final NumericPropertyKeyword OPTIMISER_STATISTIC
Optimiser statistic (usually, RSS).
-
MODEL_CRITERION
public static final NumericPropertyKeyword MODEL_CRITERION
Model selection criterion (AIC, BIC, etc.).
-
TEST_STATISTIC
public static final NumericPropertyKeyword TEST_STATISTIC
Test statistic (e.g. normality test criterion).
-
LOWER_BOUND
public static final NumericPropertyKeyword LOWER_BOUND
Lower calculation bound for optimiser.
-
UPPER_BOUND
public static final NumericPropertyKeyword UPPER_BOUND
Upper calculation bound for optimiser.
-
WINDOW
public static final NumericPropertyKeyword WINDOW
Averaging window.
-
INCIDENT_INTENSITY
public static final NumericPropertyKeyword INCIDENT_INTENSITY
Intensity of incident radiation.
-
CORRELATION_THRESHOLD
public static final NumericPropertyKeyword CORRELATION_THRESHOLD
Threshold above which properties are thought to be strongly correlated.
-
INTEGRATION_SEGMENTS
public static final NumericPropertyKeyword INTEGRATION_SEGMENTS
Number of subdivisions for numeric integration.
-
INTEGRATION_CUTOFF
public static final NumericPropertyKeyword INTEGRATION_CUTOFF
Cutoff for numeric integration.
-
SCHEME_WEIGHT
public static final NumericPropertyKeyword SCHEME_WEIGHT
Weight of the semi-implicit finite-difference scheme.
-
QUADRATURE_POINTS
public static final NumericPropertyKeyword QUADRATURE_POINTS
Number of quadrature points (RTE).
-
SCATTERING_ALBEDO
public static final NumericPropertyKeyword SCATTERING_ALBEDO
Albedo of single scattering.
-
SCATTERING_ANISOTROPY
public static final NumericPropertyKeyword SCATTERING_ANISOTROPY
Anisotropy coefficient for the phase function of scattering.
-
DOM_ITERATION_ERROR
public static final NumericPropertyKeyword DOM_ITERATION_ERROR
Iteration error tolerance in DOM calculations.
-
DOM_DIRECTIONS
public static final NumericPropertyKeyword DOM_DIRECTIONS
Number of independent directions (DOM).
-
LAGUERRE_SOLVER_ERROR
public static final NumericPropertyKeyword LAGUERRE_SOLVER_ERROR
Error tolerance for the Laguerre solver (RTE).
-
ATOL
public static final NumericPropertyKeyword ATOL
Absolute tolerance (atol) for RK calculations (RTE).
-
RTOL
public static final NumericPropertyKeyword RTOL
Relative tolerance (atol) for RK calculations (RTE).
-
GRID_SCALING_FACTOR
public static final NumericPropertyKeyword GRID_SCALING_FACTOR
Grid scaling factor.
-
DOM_GRID_DENSITY
public static final NumericPropertyKeyword DOM_GRID_DENSITY
Internal DOM grid density (RTE).
-
GRID_STRETCHING_FACTOR
public static final NumericPropertyKeyword GRID_STRETCHING_FACTOR
Grid stretching factor (RTE).
-
RELAXATION_PARAMETER
public static final NumericPropertyKeyword RELAXATION_PARAMETER
Relaxation parameter of iterative solver (RTE).
-
RTE_MAX_ITERATIONS
public static final NumericPropertyKeyword RTE_MAX_ITERATIONS
Iteration threshold for RTE calculations.
-
RTE_INTEGRATION_TIMEOUT
public static final NumericPropertyKeyword RTE_INTEGRATION_TIMEOUT
Maximum allowed time spent on integration (RTE).
-
TRAPEZOIDAL_RISE_PERCENTAGE
public static final NumericPropertyKeyword TRAPEZOIDAL_RISE_PERCENTAGE
Percentage of initial (rise) segment of the pulse trapezoid.
-
TRAPEZOIDAL_FALL_PERCENTAGE
public static final NumericPropertyKeyword TRAPEZOIDAL_FALL_PERCENTAGE
Percentage of final (fall) segment of the pulse trapezoid.
-
SKEW_MU
public static final NumericPropertyKeyword SKEW_MU
μ parameter for skewed normal distribution.
-
SKEW_SIGMA
public static final NumericPropertyKeyword SKEW_SIGMA
σ parameter for skewed normal distribution.
-
SKEW_LAMBDA
public static final NumericPropertyKeyword SKEW_LAMBDA
λ parameter for skewed normal distribution.
-
MODEL_WEIGHT
public static final NumericPropertyKeyword MODEL_WEIGHT
A weight indicating how good a calculation model is.
-
DAMPING_RATIO
public static final NumericPropertyKeyword DAMPING_RATIO
Levenberg-Marquardt damping ratio. A zero value presents pure Levenberg damping. A value of 1 gives pure Marquardt damping.
-
SOURCE_GEOMETRIC_FACTOR
public static final NumericPropertyKeyword SOURCE_GEOMETRIC_FACTOR
Determines how much weight is attributed to the front-face light source compared to rear face. Can be a number between zero and unity.
-
MAX_HIGH_FREQ_WAVES
public static final NumericPropertyKeyword MAX_HIGH_FREQ_WAVES
Max. no. of high-frequency waves in the sinusoidal baseline.
-
MAX_LOW_FREQ_WAVES
public static final NumericPropertyKeyword MAX_LOW_FREQ_WAVES
Max. no. of low-frequency waves in the sinusoidal baseline.
-
SOLID_EXCHANGE_COEFFICIENT
public static final NumericPropertyKeyword SOLID_EXCHANGE_COEFFICIENT
Energy exchange coefficient in the two-temperature model (g).
-
GAS_EXCHANGE_COEFFICIENT
public static final NumericPropertyKeyword GAS_EXCHANGE_COEFFICIENT
Energy exchange coefficient in the two-temperature model (g').
-
HEAT_LOSS_GAS
public static final NumericPropertyKeyword HEAT_LOSS_GAS
Heat loss for the gas in the 2T-model.
-
OBJECTIVE_FUNCTION
public static final NumericPropertyKeyword OBJECTIVE_FUNCTION
Value of objective function.
-
-
Method Detail
-
values
public static NumericPropertyKeyword[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NumericPropertyKeyword c : NumericPropertyKeyword.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NumericPropertyKeyword valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
findAny
public static Optional<NumericPropertyKeyword> findAny(String key)
-
-