Package pulse.problem.statements

Class PenetrationProblem

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.statements.Problem

pulse.problem.statements.ClassicalProblem

pulse.problem.statements.PenetrationProblem

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

TwoTemperatureModel

public class PenetrationProblem
extends ClassicalProblem

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PenetrationProblem()
PenetrationProblem(PenetrationProblem p)

Method Summary

Modifier and Type	Method	Description
void	assign(ParameterVector params)	Assigns parameter values of this Problem using the optimisation vector params.
Problem	copy()
Class<? extends DifferenceScheme>	defaultScheme()
AbsorptionModel	getAbsorptionModel()
InstanceDescriptor<AbsorptionModel>	getAbsorptionSelector()
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 $$Rn to the scalar objective function for this Problem.
void	setAbsorptionModel(AbsorptionModel model)
String	toString()

Methods inherited from class pulse.problem.statements.ClassicalProblem

getGeometricFactor, initProperties, initProperties, isReady, set, setGeometricFactor

Methods inherited from class pulse.problem.statements.Problem

areDetailsHidden, availableSolutions, discretePulseOn, estimateSignalRange, getBaseline, getBaselineDescriptor, getComplexity, getHeatingCurve, getProperties, getPulse, isEnabled, retrieveData, setBaseline, setComplexity, setDetailsHidden, setHeatingCurve, setProperties, setPulse

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

PenetrationProblem

public PenetrationProblem()

PenetrationProblem

public PenetrationProblem(PenetrationProblem p)

Method Detail

getAbsorptionModel

public AbsorptionModel getAbsorptionModel()

setAbsorptionModel

public void setAbsorptionModel(AbsorptionModel model)

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 Problem

Returns:

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

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: Problem

Listed parameters include: MAXTEMP, DIFFUSIVITY, THICKNESS, HEAT_LOSS_FRONT, HEAT_LOSS_REAR.

Overrides:

listedKeywords in class ClassicalProblem

Returns:

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

getAbsorptionSelector

public InstanceDescriptor<AbsorptionModel> getAbsorptionSelector()

optimisationVector

public void optimisationVector(ParameterVector output)

Description copied from class: Problem

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

Overrides:

optimisationVector in class ClassicalProblem

Parameters:

output - the output vector where the result will be stored

See Also:

Problem.listedTypes()

assign

public void assign(ParameterVector params)
            throws SolverException

Description copied from class: Problem

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

Overrides:

assign in class ClassicalProblem

Parameters:

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

Throws:

SolverException - if params contains invalid parameter values

See Also:

Problem.listedTypes()

defaultScheme

public Class<? extends DifferenceScheme> defaultScheme()

Overrides:

defaultScheme in class ClassicalProblem

toString

public String toString()

Overrides:

toString in class ClassicalProblem

copy

public Problem copy()

Overrides:

copy in class ClassicalProblem