java.lang.Object
- pulse.util.UpwardsNavigable
- - pulse.util.Group
  - - pulse.util.Accessible
    - - pulse.util.PropertyHolder
      - pulse.problem.statements.Problem

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

ClassicalProblem
```
public abstract class Problem
extends PropertyHolder
implements Reflexive, Optimisable
```
A Problem is an abstract class defining the general rules for handling heat conduction problems, and also providing access to the basic properties used in the calculation with one of the DifferenceSchemes. Most importantly, this class sets out the procedures for reading and writing the vector argument of the objective function for solving the optimisation problem.

See Also:

DifferenceScheme, Serialized Form

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`Problem()`	Creates a `Problem` with default parameters (as found in the .XML file).
	`Problem(Problem p)`	Copies all essential parameters from `p`, excluding the heating curve, which is created anew.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`areDetailsHidden()`	Checks whether some 'advanced' details should stay hidden by the GUI when customising the `Problem` statement.
`void`	`assign(ParameterVector params)`	Assigns parameter values of this `Problem` using the optimisation vector `params`.
`List<DifferenceScheme>`	`availableSolutions()`	Lists the available `DifferenceScheme`s for this `Problem`.
`abstract Problem`	`copy()`
`abstract Class<? extends DifferenceScheme>`	`defaultScheme()`
`DiscretePulse`	`discretePulseOn(Grid grid)`	Constructs a `DiscretePulse` on the specified `grid` using the `Pulse` corresponding to this `Problem`.
`void`	`estimateSignalRange(ExperimentalData c)`	The signal range is defined as $max{$ T(t) } - min{ T(t) }, where $max{...}$ and $min{...}$ are robust to outliers.
`Baseline`	`getBaseline()`	Return the `Baseline` of this `Problem`.
`InstanceDescriptor<? extends Baseline>`	`getBaselineDescriptor()`
`ProblemComplexity`	`getComplexity()`
`HeatingCurve`	`getHeatingCurve()`
`ThermalProperties`	`getProperties()`
`Pulse`	`getPulse()`
`abstract void`	`initProperties()`
`abstract void`	`initProperties(ThermalProperties properties)`
`boolean`	`isEnabled()`	Used for debugging.
`abstract boolean`	`isReady()`
`Set<NumericPropertyKeyword>`	`listedKeywords()`	Listed parameters include: `MAXTEMP, DIFFUSIVITY, THICKNESS, HEAT_LOSS_FRONT, HEAT_LOSS_REAR`.
`List<Property>`	`listedTypes()`	By default, collects a list of default properties corresponding to types defined by listedKeywords().
`void`	`optimisationVector(ParameterVector output)`	Calculates the vector argument defined on Rⁿ to the scalar objective function for this `Problem`.
`void`	`retrieveData(ExperimentalData c)`	This will use the data contained in `c` to estimate the detector signal span and the thermal diffusivity for this `Problem`.
`void`	`set(NumericPropertyKeyword type, NumericProperty value)`	Used to change the parameter values of this `Problem`.
`void`	`setBaseline(Baseline baseline)`	Sets a new baseline.
`void`	`setComplexity(ProblemComplexity complexity)`
`static void`	`setDetailsHidden(boolean b)`	Allows to either hide or display all 'advanced' settings for this `Problem`.
`void`	`setHeatingCurve(HeatingCurve curve)`
`void`	`setProperties(ThermalProperties properties)`
`void`	`setPulse(Pulse pulse)`	Sets the `pulse` of this `Problem` and assigns this `Problem` as its parent.
`String`	`toString()`

Methods inherited from class pulse.util.PropertyHolder
addListener, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, 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
  - Problem
```
protected Problem()
```
    Creates a Problem with default parameters (as found in the .XML file).
    First, invokes the super() constructor of PropertyHolder to initialise PropertyHolderListeners, then initialises the variables and creates default Pulse and HeatingCurve, setting this object as their parent.
  - Problem
```
public Problem(Problem p)
```
    Copies all essential parameters from p, excluding the heating curve, which is created anew.
    
    Parameters:
    
    p - the Problem to replicate
- Method Detail
  - copy
```
public abstract Problem copy()
```
  - setHeatingCurve
```
public final void setHeatingCurve(HeatingCurve curve)
```
  - availableSolutions
```
public final List<DifferenceScheme> availableSolutions()
```
    Lists the available DifferenceSchemes for this Problem.
    This is done utilising the Reflexive interface implemented by the class DifferenceSheme. This method dynamically locates any subclasses of the DifferenceScheme in the associated package (note this can be extended to include plugins) and checks whether any of the instances of those schemes return a non-null result when calling the solver(Problem) method.
    
    Returns:
    
    a List of available DifferenceSchemes for solving this Problem.
  - set
```
public void set(NumericPropertyKeyword type,
                NumericProperty value)
```
    Used to change the parameter values of this Problem. It is only allowed to use those types of NumericPropery that are listed by the listedParameters().
    
    Specified by:
    
    set in class Accessible
    
    Parameters:
    
    type - the type, which must be equal by definition to property.getType().
    
    value - the property, which contains new information.
    
    See Also:
    
    listedTypes()
  - getHeatingCurve
```
public final HeatingCurve getHeatingCurve()
```
  - getPulse
```
public final Pulse getPulse()
```
  - setPulse
```
public final void setPulse(Pulse pulse)
```
    Sets the pulse of this Problem and assigns this Problem as its parent.
    
    Parameters:
    
    pulse - a Pulse object
  - retrieveData
```
public void retrieveData(ExperimentalData c)
```
    This will use the data contained in c to estimate the detector signal span and the thermal diffusivity for this Problem. Note these estimates may be very rough.
    
    Parameters:
    
    c - the ExperimentalData object
  - estimateSignalRange
```
public void estimateSignalRange(ExperimentalData c)
```
    The signal range is defined as $max{$ T(t) } - min{ T(t) }, where $max{...}$ and $min{...}$ are robust to outliers. This calls the maxTemperature method of c and uses the baseline value at 0 as the $min{...}$ value.
    
    Parameters:
    
    c - the ExperimentalData object
  - optimisationVector
```
public void optimisationVector(ParameterVector output)
```
    Calculates the vector argument defined on Rⁿ to the scalar objective function for this Problem. To fill the vector with data, only those parameters from this Problem will be used which are defined by the flags, e.g. if the flag associated with the HEAT_LOSS keyword is set to false, its value will be skipped when creating the vector.
    
    Specified by:
    
    optimisationVector in interface Optimisable
    
    Parameters:
    
    output - the output vector where the result will be stored
    
    See Also:
    
    listedTypes()
  - assign
```
public void assign(ParameterVector params)
            throws SolverException
```
    Assigns parameter values of this Problem 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
    
    See Also:
    
    listedTypes()
  - areDetailsHidden
```
public boolean areDetailsHidden()
```
    Checks whether some 'advanced' details should stay hidden by the GUI when customising the Problem statement.
    
    Overrides:
    
    areDetailsHidden in class PropertyHolder
    
    Returns:
    
    true if the user does not want to see the details (by default), false otherwise.
  - setDetailsHidden
```
public static final void setDetailsHidden(boolean b)
```
    Allows to either hide or display all 'advanced' settings for this Problem.
    
    Parameters:
    
    b - true if the user does not want to see the details, false otherwise.
  - isEnabled
```
public boolean isEnabled()
```
    Used for debugging. Initially, the nonlinear and two-dimensional problem statements are disabled, since they have not yet been thoroughly tested
    
    Returns:
    
    true if this problem statement has been enabled, false otherwise
  - discretePulseOn
```
public DiscretePulse discretePulseOn(Grid grid)
```
    Constructs a DiscretePulse on the specified grid using the Pulse corresponding to this Problem.
    
    Parameters:
    
    grid - the grid
    
    Returns:
    
    a DiscretePulse objects constructed for this Problem and the grid
  - listedKeywords
```
public Set<NumericPropertyKeyword> listedKeywords()
```
    Listed parameters include: MAXTEMP, DIFFUSIVITY, THICKNESS, HEAT_LOSS_FRONT, HEAT_LOSS_REAR.
    
    Overrides:
    
    listedKeywords in class PropertyHolder
    
    Returns:
    
    a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.
  - listedTypes
```
public List<Property> listedTypes()
```
    Description copied from class: PropertyHolder
    
    By default, collects a list of default properties corresponding to types defined by listedKeywords(). However, this method is overridable to include non-numeric properties.
    
    Overrides:
    
    listedTypes in class PropertyHolder
    
    Returns:
    
    a list of Property instances, which have been explicitly marked as a listed parameter for this PropertyHolder.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getComplexity
```
public final ProblemComplexity getComplexity()
```
  - setComplexity
```
public final void setComplexity(ProblemComplexity complexity)
```
  - getBaseline
```
public Baseline getBaseline()
```
    Return the Baseline of this Problem.
    
    Returns:
    
    the baseline
  - setBaseline
```
public final void setBaseline(Baseline baseline)
```
    Sets a new baseline. Calls apply(baseline) on the HeatingCurve when done and sets the parent of the baseline to this object.
    
    Parameters:
    
    baseline - the new baseline.
  - getBaselineDescriptor
```
public final InstanceDescriptor<? extends Baseline> getBaselineDescriptor()
```
  - getProperties
```
public final ThermalProperties getProperties()
```
  - setProperties
```
public final void setProperties(ThermalProperties properties)
```
  - initProperties
```
public abstract void initProperties()
```
  - initProperties
```
public abstract void initProperties(ThermalProperties properties)
```
  - defaultScheme
```
public abstract Class<? extends DifferenceScheme> defaultScheme()
```
  - isReady
```
public abstract boolean isReady()
```

Class Problem

Constructor Summary

Method Summary

Methods inherited from class pulse.util.PropertyHolder

Methods inherited from class pulse.util.Accessible

Methods inherited from class pulse.util.Group

Methods inherited from class pulse.util.UpwardsNavigable

Methods inherited from class java.lang.Object

Constructor Detail

Problem

Problem

Method Detail

copy

setHeatingCurve

availableSolutions

set

getHeatingCurve

getPulse

setPulse

retrieveData

estimateSignalRange

optimisationVector

assign

areDetailsHidden

setDetailsHidden

isEnabled

discretePulseOn

listedKeywords

listedTypes

toString

getComplexity

setComplexity

getBaseline

setBaseline

getBaselineDescriptor

getProperties

setProperties

initProperties

initProperties

defaultScheme

isReady