Class SamplingSolution

java.lang.Object
  extended bySolution
      extended bySamplingSolution
Direct Known Subclasses:
MCSSolution

abstract class SamplingSolution
extends Solution

SamplingSolution -- Is an abstract class at the top of all the solvers that that evolve an expected solution by sampling possible realisation.

Version:
$Revision: 1.23 $
See Also:
Solution

Field Summary
protected  double[] currentState
          A vector with the current state of each realisation
protected  int numberOfRealisations
          The number of independent realisations to evolve
protected  java.util.Random random
          Random number generator
protected  double realisationWeight
          The weight or probability associated with each initial state
protected  boolean solutionUpToDate
          Whether the expected solution is up to date
 
Fields inherited from class Solution
df, dfm, dfp, dg, dgm, dgp, dh, dhm, dhp, dx, f, f0, fm, fp, g, gm, gp, h, hm, hp, ic, initialMoments, mesh, method, pde, s, scheme, sm, sp, time, x, x_0, x_1, xOffset, xSize, y_0, y_1, yOffset, ySize
 
Constructor Summary
SamplingSolution(RunData runData)
          Creates a SamplingSolution object.
 
Method Summary
 void discretize(ShapeFunction function)
          Discretize the initial Shape function and initialize the moments Initializes a new set of particles, the number being determined by the numerical scheme parameter.
protected  void expectedRealisation()
          Generates a probability distribution and an expectation from the set of sampled values.
 double getValue(double arg)
          Linear interpolation of the solution.
 double getValue(int index)
          Gives the value of the function for an index
 double[] limits()
          Calculates the limits of the solution.
 double momentsDeviation(int m)
          Calculates the deviation from the m:th initial moment.
 boolean previous(RunData runData, PhysData physData)
          Take the solution backward one step to initialize schemes with 3 time levels; not really appropriate in this context.
 
Methods inherited from class Solution
calculateMoments, getTime, getWinSize, hasOption, incTime, measure, next, output, plot, rescale, setIC, setMethod, setPde, setScheme, setTime, updateHeaders
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

numberOfRealisations

protected int numberOfRealisations
The number of independent realisations to evolve


realisationWeight

protected double realisationWeight
The weight or probability associated with each initial state


currentState

protected double[] currentState
A vector with the current state of each realisation


solutionUpToDate

protected boolean solutionUpToDate
Whether the expected solution is up to date


random

protected java.util.Random random
Random number generator

Constructor Detail

SamplingSolution

public SamplingSolution(RunData runData)
Creates a SamplingSolution object. Note that discretize must be called before next is called for the first time.

Parameters:
runData - The run time parameters
See Also:
Solution.next(RunData, PhysData), Solution.discretize(ShapeFunction)
Method Detail

previous

public boolean previous(RunData runData,
                        PhysData physData)
Take the solution backward one step to initialize schemes with 3 time levels; not really appropriate in this context.

Specified by:
previous in class Solution
Parameters:
runData - List of run parameters
Returns:
False since it is not used here
See Also:
RunData

discretize

public void discretize(ShapeFunction function)
Discretize the initial Shape function and initialize the moments Initializes a new set of particles, the number being determined by the numerical scheme parameter.

Specified by:
discretize in class Solution
Parameters:
function - The initial shape to be approximated
See Also:
Solution.setScheme(java.lang.String)

momentsDeviation

public double momentsDeviation(int m)
Calculates the deviation from the m:th initial moment.

Overrides:
momentsDeviation in class Solution
Parameters:
m - The order of the moment
Returns:
The deviation of the m:th moment from the beginning

limits

public double[] limits()
Calculates the limits of the solution.

Overrides:
limits in class Solution
Returns:
A vector consisting of {min(solution), max(solution)}

getValue

public double getValue(int index)
Gives the value of the function for an index

Overrides:
getValue in class Solution
Parameters:
index - The index for which to get the value
Returns:
The value of the distribution function at a given index

getValue

public double getValue(double arg)
Linear interpolation of the solution. Assumes a uniform mesh.

Overrides:
getValue in class Solution
Parameters:
arg - Argument
Returns:
A linear interpolation of the function for a given argument

expectedRealisation

protected void expectedRealisation()
Generates a probability distribution and an expectation from the set of sampled values. Assumes a uniform mesh.