Package pulse.problem.schemes

Class CoupledImplicitScheme

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.ImplicitScheme

pulse.problem.schemes.CoupledImplicitScheme

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

Direct Known Subclasses:

ImplicitCoupledSolver, MixedCoupledSolver

public abstract class CoupledImplicitScheme
extends ImplicitScheme

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Class<? extends Problem>[]	domain()	Retrieves all problem statements that can be solved with this implementation of the difference scheme.
void	finaliseStep()	Overwrites previously calculated temperature values with the calculations made at the current time step
RTECalculationStatus	getCalculationStatus()
RadiativeTransferCoupling	getCoupling()
boolean	isAutoUpdateFluxes()
Set<NumericPropertyKeyword>	listedKeywords()	The superclass only lists the TIME_LIMIT property.
boolean	normalOperation()
void	setAutoUpdateFluxes(boolean auto)
void	setCalculationStatus(RTECalculationStatus calculationStatus)
void	setCoupling(RadiativeTransferCoupling coupling)

Methods inherited from class pulse.problem.schemes.ImplicitScheme

evalRightBoundary, firstBeta, getTridiagonalMatrixAlgorithm, leftBoundary, prepare, setTridiagonalMatrixAlgorithm, timeStep, toString

Methods inherited from class pulse.problem.schemes.OneDimensionalScheme

clearArrays, getCurrentSolution, getPreviousSolution, setSolutionAt, signal

Methods inherited from class pulse.problem.schemes.DifferenceScheme

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

Methods inherited from class pulse.util.PropertyHolder

addListener, 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

CoupledImplicitScheme

public CoupledImplicitScheme(NumericProperty N,
                             NumericProperty timeFactor)

CoupledImplicitScheme

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

Method Detail

finaliseStep

public void finaliseStep()
                  throws SolverException

Description copied from class: OneDimensionalScheme

Overwrites previously calculated temperature values with the calculations made at the current time step

Overrides:

finaliseStep in class OneDimensionalScheme

Throws:

SolverException - if the calculation failed

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: DifferenceScheme

The superclass only lists the TIME_LIMIT property.

Overrides:

listedKeywords in class DifferenceScheme

Returns:

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

normalOperation

public boolean normalOperation()

Overrides:

normalOperation in class DifferenceScheme

getCalculationStatus

public final RTECalculationStatus getCalculationStatus()

setCalculationStatus

public final void setCalculationStatus(RTECalculationStatus calculationStatus)
                                throws SolverException

Throws:

SolverException

getCoupling

public final RadiativeTransferCoupling getCoupling()

setCoupling

public final void setCoupling(RadiativeTransferCoupling coupling)

isAutoUpdateFluxes

public final boolean isAutoUpdateFluxes()

setAutoUpdateFluxes

public final void setAutoUpdateFluxes(boolean auto)

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.