Package pulse.problem.schemes.solvers

Class ExplicitNonlinearSolver

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.schemes.DifferenceScheme

pulse.problem.schemes.OneDimensionalScheme

pulse.problem.schemes.ExplicitScheme

pulse.problem.schemes.solvers.ExplicitNonlinearSolver

All Implemented Interfaces:

Serializable, FixedPointIterations, Solver<NonlinearProblem>, Descriptive, Reflexive

public class ExplicitNonlinearSolver
extends ExplicitScheme
implements Solver<NonlinearProblem>, FixedPointIterations

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExplicitNonlinearSolver()
ExplicitNonlinearSolver(NumericProperty N, NumericProperty timeFactor)
ExplicitNonlinearSolver(NumericProperty N, NumericProperty timeFactor, NumericProperty timeLimit)

Method Summary

Modifier and Type	Method	Description
DifferenceScheme	copy()	Creates a DifferenceScheme, which is an exact copy of this object.
Class<? extends Problem>[]	domain()	Retrieves all problem statements that can be solved with this implementation of the difference scheme.
NumericProperty	getNonlinearPrecision()
void	iteration(int m)	Performs an iteration at time m
List<Property>	listedTypes()	By default, collects a list of default properties corresponding to types defined by listedKeywords().
void	prepare(Problem problem)	Contains preparatory steps to ensure smooth running of the solver.This includes creating a DiscretePulseobject and adjusting the grid of this scheme to match the DiscretePulsecreated for this problem Finally, a heating curve is cleared from the previously calculated values.
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	setNonlinearPrecision(NumericProperty nonlinearPrecision)
void	solve(NonlinearProblem problem)	Calculates the solution of the t and stores it in the respective HeatingCurve.
void	timeStep(int m)

Methods inherited from class pulse.problem.schemes.ExplicitScheme

explicitSolution, phi, toString

Methods inherited from class pulse.problem.schemes.OneDimensionalScheme

clearArrays, finaliseStep, getCurrentSolution, getPreviousSolution, setSolutionAt, signal

Methods inherited from class pulse.problem.schemes.DifferenceScheme

areDetailsHidden, copyFrom, getCurrentPulseValue, getDiscretePulse, getGrid, getTimeInterval, getTimeLimit, initFrom, listedKeywords, normalOperation, prepareStep, pulse, runTimeSequence, runTimeSequence, scaleSolution, setDetailsHidden, setGrid, setTimeInterval, setTimeLimit

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

Methods inherited from interface pulse.problem.schemes.FixedPointIterations

doIterations, finaliseIteration

Constructor Detail

ExplicitNonlinearSolver

public ExplicitNonlinearSolver()

ExplicitNonlinearSolver

public ExplicitNonlinearSolver(NumericProperty N,
                               NumericProperty timeFactor)

ExplicitNonlinearSolver

public ExplicitNonlinearSolver(NumericProperty N,
                               NumericProperty timeFactor,
                               NumericProperty timeLimit)

Method Detail

prepare

public void prepare(Problem problem)
             throws SolverException

Description copied from class: DifferenceScheme

Contains preparatory steps to ensure smooth running of the solver.This includes creating a DiscretePulseobject and adjusting the grid of this scheme to match the DiscretePulsecreated for this problem Finally, a heating curve is cleared from the previously calculated values.

All subclasses of DifferenceScheme should override and explicitly call this superclass method where appropriate.

Overrides:

prepare in class DifferenceScheme

Parameters:

problem - the heat problem to be solved

Throws:

SolverException

timeStep

public void timeStep(int m)
              throws SolverException

Specified by:

timeStep in class DifferenceScheme

Throws:

SolverException

iteration

public void iteration(int m)

Description copied from interface: FixedPointIterations

Performs an iteration at time m

Specified by:

iteration in interface FixedPointIterations

Parameters:

m - time step

solve

public void solve(NonlinearProblem problem)
           throws SolverException

Description copied from interface: Solver

Calculates the solution of the t and stores it in the respective HeatingCurve.

Specified by:

solve in interface Solver<NonlinearProblem>

Parameters:

problem - - an accepted instance of T

Throws:

SolverException

copy

public DifferenceScheme copy()

Description copied from class: DifferenceScheme

Creates a DifferenceScheme, which is an exact copy of this object.

Specified by:

copy in class DifferenceScheme

Returns:

an exact copy of this DifferenceScheme.

domain

public Class<? extends Problem>[] domain()

Description copied from class: DifferenceScheme

Retrieves all problem statements that can be solved with this implementation of the difference scheme.

Specified by:

domain in class DifferenceScheme

Returns:

an array containing subclasses of the Problem class which can be used as input for this difference scheme.

getNonlinearPrecision

public NumericProperty getNonlinearPrecision()

setNonlinearPrecision

public void setNonlinearPrecision(NumericProperty nonlinearPrecision)

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.

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.

Overrides:

set in class DifferenceScheme

Parameters:

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

property - the property, which contains new information.