Package pulse.problem.schemes.rte.dom

Class StretchedGrid

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.problem.schemes.rte.dom.StretchedGrid

All Implemented Interfaces:

Serializable, Descriptive

public class StretchedGrid
extends PropertyHolder

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	StretchedGrid(double dimension)	Constructs a uniform grid where the dimension is set to the argument.
	StretchedGrid(NumericProperty gridDensity, double dimension)	Constructs a non-uniform grid where the dimension and the grid density are specified by the arguments.
protected	StretchedGrid(NumericProperty gridDensity, double dimension, NumericProperty stretchingFactor, boolean uniform)

Method Summary

Modifier and Type	Method	Description
void	generate(int n)
void	generateUniform(boolean scaled)
void	generateUniformBase(int n, boolean scaled)
int	getDensity()
String	getDescriptor()	If not null, will return the prefix, otherwise calls the superclass method.
double	getDimension()
double	getNode(int i)
double[]	getNodes()
NumericProperty	getStretchingFactor()
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	setStretchingFactor(NumericProperty p)
double	step(int i, double sign)
double	stepLeft(int i)
double	stepRight(int i)
double	tanh(double x, double stretchingFactor)
String	toString()

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, 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

StretchedGrid

public StretchedGrid(double dimension)

Constructs a uniform grid where the dimension is set to the argument. The stretching factor and grid density are set to a default value.

Parameters:

dimension - the dimension of the grid

StretchedGrid

public StretchedGrid(NumericProperty gridDensity,
                     double dimension)

Constructs a non-uniform grid where the dimension and the grid density are specified by the arguments. The stretching factor and grid density are set to a default value.

Parameters:

gridDensity - the grid density, which is a property of the DOM_GRID_DENSITY type

dimension - the dimension of the grid

StretchedGrid

protected StretchedGrid(NumericProperty gridDensity,
                        double dimension,
                        NumericProperty stretchingFactor,
                        boolean uniform)

Method Detail

generate

public void generate(int n)

generateUniform

public void generateUniform(boolean scaled)

generateUniformBase

public void generateUniformBase(int n,
                                boolean scaled)

getDensity

public int getDensity()

getStretchingFactor

public NumericProperty getStretchingFactor()

setStretchingFactor

public void setStretchingFactor(NumericProperty p)

getDimension

public double getDimension()

getNode

public double getNode(int i)

getNodes

public double[] getNodes()

step

public double step(int i,
                   double sign)

stepLeft

public double stepLeft(int i)

stepRight

public double stepRight(int i)

tanh

public double tanh(double x,
                   double stretchingFactor)

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.

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 PropertyHolder

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 Object

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