Package pulse.problem.statements.model

Class AbsorptionModel

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.statements.model.AbsorptionModel

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

BeerLambertAbsorption, Insulator

public abstract class AbsorptionModel
extends PropertyHolder
implements Reflexive, Optimisable

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbsorptionModel()
protected	AbsorptionModel(AbsorptionModel c)

Method Summary

Modifier and Type	Method	Description
abstract double	absorption(SpectralRange range, double x)
void	assign(ParameterVector params)	Assigns parameter values of this Optimisable using the optimisation vector params.
abstract AbsorptionModel	copy()
NumericProperty	getAbsorptivity(SpectralRange spectrum)
NumericProperty	getCombinedAbsorptivity()
NumericProperty	getLaserAbsorptivity()
NumericProperty	getThermalAbsorptivity()
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
void	optimisationVector(ParameterVector output)	Calculates the vector argument defined on $$Rn to the scalar objective function for this Optimisable.
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setAbsorptivity(SpectralRange range, NumericProperty a)
void	setCombinedAbsorptivity(NumericProperty a)
void	setLaserAbsorptivity(NumericProperty a)
void	setThermalAbsorptivity(NumericProperty a)
String	toString()

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbsorptionModel

protected AbsorptionModel()

AbsorptionModel

protected AbsorptionModel(AbsorptionModel c)

Method Detail

absorption

public abstract double absorption(SpectralRange range,
                                  double x)

getLaserAbsorptivity

public NumericProperty getLaserAbsorptivity()

getThermalAbsorptivity

public NumericProperty getThermalAbsorptivity()

getCombinedAbsorptivity

public NumericProperty getCombinedAbsorptivity()

getAbsorptivity

public NumericProperty getAbsorptivity(SpectralRange spectrum)

setAbsorptivity

public void setAbsorptivity(SpectralRange range,
                            NumericProperty a)

setLaserAbsorptivity

public void setLaserAbsorptivity(NumericProperty a)

setThermalAbsorptivity

public void setThermalAbsorptivity(NumericProperty a)

setCombinedAbsorptivity

public void setCombinedAbsorptivity(NumericProperty a)

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Specified by:

set in class Accessible

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.

toString

public String toString()

Overrides:

toString in class Object

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: PropertyHolder

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

Overrides:

listedKeywords in class PropertyHolder

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

optimisationVector

public void optimisationVector(ParameterVector output)

Description copied from interface: Optimisable

Calculates the vector argument defined on $$Rⁿ to the scalar objective function for this Optimisable.

Specified by:

optimisationVector in interface Optimisable

Parameters:

output - the output vector where the result will be stored

assign

public void assign(ParameterVector params)
            throws SolverException

Description copied from interface: Optimisable

Assigns parameter values of this Optimisable using the optimisation vector params. Only those parameters will be updated, the types of which are listed as indices in the params vector.

Specified by:

assign in interface Optimisable

Parameters:

params - the optimisation vector, containing a similar set of parameters to this Problem

Throws:

SolverException - if params contains invalid parameter values

copy

public abstract AbsorptionModel copy()