Package pulse.problem.schemes.rte.dom

Class SuccessiveOverrelaxation

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.schemes.rte.dom.IterativeSolver

pulse.problem.schemes.rte.dom.SuccessiveOverrelaxation

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class SuccessiveOverrelaxation
extends IterativeSolver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SuccessiveOverrelaxation()

Method Summary

Modifier and Type	Method	Description
RTECalculationStatus	doIterations(AdaptiveIntegrator integrator)	De-facto solves the radiative transfer problem iteratively.
NumericProperty	getRelaxationParameter()
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
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	setRelaxationParameter(NumericProperty p)
String	toString()

Methods inherited from class pulse.problem.schemes.rte.dom.IterativeSolver

getIterationError, getIterationErrorTolerance, getMaxIterations, sanityCheck, setIterationErrorTolerance, setMaxIterations

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

SuccessiveOverrelaxation

public SuccessiveOverrelaxation()

Method Detail

doIterations

public RTECalculationStatus doIterations(AdaptiveIntegrator integrator)

Description copied from class: IterativeSolver

De-facto solves the radiative transfer problem iteratively.

Specified by:

doIterations in class IterativeSolver

Parameters:

integrator - the integerator embedded in the iterative approach

Returns:

a calculation status

getRelaxationParameter

public NumericProperty getRelaxationParameter()

setRelaxationParameter

public void setRelaxationParameter(NumericProperty p)

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 IterativeSolver

Parameters:

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

property - the property, which contains new information.

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 IterativeSolver

Returns:

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

toString

public String toString()

Overrides:

toString in class IterativeSolver