Package pulse.problem.schemes.rte.dom

Class DiscreteOrdinatesMethod

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.schemes.rte.RadiativeTransferSolver

pulse.problem.schemes.rte.dom.DiscreteOrdinatesMethod

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class DiscreteOrdinatesMethod
extends RadiativeTransferSolver

A class that manages the solution of the radiative transfer equation using the discrete ordinates method. The class provides an interface between the ODE adaptive integrator and the iterative solver, which are used together to solve to RTE.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DiscreteOrdinatesMethod(ParticipatingMedium problem, Grid grid)	Constructs a discrete ordinates solver using the parameters (emissivity, scattering albedo and optical thickness) declared by the problem object.

Method Summary

Modifier and Type	Method	Description
RTECalculationStatus	compute(double[] tempArray)	Launches a calculation of the radiative transfer equation.
String	getDescriptor()	If not null, will return the prefix, otherwise calls the superclass method.
AdaptiveIntegrator	getIntegrator()
InstanceDescriptor<AdaptiveIntegrator>	getIntegratorDescriptor()
IterativeSolver	getIterativeSolver()
InstanceDescriptor<IterativeSolver>	getIterativeSolverSelector()
InstanceDescriptor<PhaseFunction>	getPhaseFunctionSelector()
void	init(ParticipatingMedium problem, Grid grid)	Retrieves the parameters from p and grid needed to run the calculations.Resets the flux arrays.
List<Property>	listedTypes()	By default, collects a list of default properties corresponding to types defined by listedKeywords().
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	setIntegrator(AdaptiveIntegrator integrator)
void	setIterativeSolver(IterativeSolver solver)
String	toString()

Methods inherited from class pulse.problem.schemes.rte.RadiativeTransferSolver

addRTEListener, fireStatusUpdate, getFluxes, getPrefix, getRTEListeners, ignoreSiblings, interpolateTemperatureProfile, opticalCoordinateAt, setFluxes

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getListeners, initListeners, isListedNumericType, isListedParameter, listedKeywords, 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.util.Descriptive

describe

Constructor Detail

DiscreteOrdinatesMethod

public DiscreteOrdinatesMethod(ParticipatingMedium problem,
                               Grid grid)

Constructs a discrete ordinates solver using the parameters (emissivity, scattering albedo and optical thickness) declared by the problem object.

Parameters:

problem - the coupled problem statement

grid - the heat problem grid

Method Detail

compute

public RTECalculationStatus compute(double[] tempArray)

Description copied from class: RadiativeTransferSolver

Launches a calculation of the radiative transfer equation.

Specified by:

compute in class RadiativeTransferSolver

Parameters:

tempArray - the input temperature profile

Returns:

the status of calculation

getDescriptor

public String getDescriptor()

Description copied from class: PropertyHolder

If not null, will return the prefix, otherwise calls the superclass method.

Overrides:

getDescriptor in class PropertyHolder

Returns:

the descriptor

See Also:

Group.getSimpleName()

init

public void init(ParticipatingMedium problem,
                 Grid grid)

Description copied from class: RadiativeTransferSolver

Retrieves the parameters from p and grid needed to run the calculations.Resets the flux arrays.

Overrides:

init in class RadiativeTransferSolver

grid - the grid

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.

getIntegrator

public final AdaptiveIntegrator getIntegrator()

getIntegratorDescriptor

public final InstanceDescriptor<AdaptiveIntegrator> getIntegratorDescriptor()

setIntegrator

public final void setIntegrator(AdaptiveIntegrator integrator)

getIterativeSolver

public final IterativeSolver getIterativeSolver()

getIterativeSolverSelector

public final InstanceDescriptor<IterativeSolver> getIterativeSolverSelector()

setIterativeSolver

public final void setIterativeSolver(IterativeSolver solver)

getPhaseFunctionSelector

public final InstanceDescriptor<PhaseFunction> getPhaseFunctionSelector()

toString

public String toString()

Overrides:

toString in class Object

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.

Specified by:

set in class Accessible

Parameters:

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

property - the property, which contains new information.