Package pulse.problem.statements

Class ClassicalProblem

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.statements.Problem

pulse.problem.statements.ClassicalProblem

All Implemented Interfaces:

Serializable, Optimisable, Descriptive, Reflexive

Direct Known Subclasses:

ClassicalProblem2D, DiathermicMedium, NonlinearProblem, PenetrationProblem

public class ClassicalProblem
extends Problem

The simplest problem statement supported in PULsE, which is formulated in the dimensionless form and with linearised boundary conditions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClassicalProblem()
ClassicalProblem(Problem 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()
NumericProperty	getGeometricFactor()
void	initProperties()
void	initProperties(ThermalProperties properties)
boolean	isReady()
Set<NumericPropertyKeyword>	listedKeywords()	Listed parameters include: MAXTEMP, DIFFUSIVITY, THICKNESS, HEAT_LOSS_FRONT, HEAT_LOSS_REAR.
void	optimisationVector(ParameterVector output)	Calculates the vector argument defined on $$Rn to the scalar objective function for this Problem.
void	set(NumericPropertyKeyword type, NumericProperty value)	Used to change the parameter values of this Problem.
void	setGeometricFactor(NumericProperty bias)
String	toString()

Methods inherited from class pulse.problem.statements.Problem

areDetailsHidden, availableSolutions, discretePulseOn, estimateSignalRange, getBaseline, getBaselineDescriptor, getComplexity, getHeatingCurve, getProperties, getPulse, isEnabled, listedTypes, 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

ClassicalProblem

public ClassicalProblem()

ClassicalProblem

public ClassicalProblem(Problem p)

Method Detail

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 Problem

Returns:

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

defaultScheme

public Class<? extends DifferenceScheme> defaultScheme()

Specified by:

defaultScheme in class Problem

initProperties

public void initProperties()

Specified by:

initProperties in class Problem

initProperties

public void initProperties(ThermalProperties properties)

Specified by:

initProperties in class Problem

toString

public String toString()

Overrides:

toString in class Problem

isReady

public boolean isReady()

Specified by:

isReady in class Problem

copy

public Problem copy()

Specified by:

copy in class Problem

getGeometricFactor

public NumericProperty getGeometricFactor()

setGeometricFactor

public void setGeometricFactor(NumericProperty bias)

set

public void set(NumericPropertyKeyword type,
                NumericProperty value)

Description copied from class: Problem

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().

Overrides:

set in class Problem

Parameters:

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

value - the property, which contains new information.

See Also:

Problem.listedTypes()

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 Problem

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 Problem

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()