nce.base

Class DomainDecomposition

java.lang.Object

nce.base.DomainDecomposition

public class DomainDecomposition
extends java.lang.Object

Implements a grid of the type [variables][steps] where each variable assume a determined value at each step. A step can be viewed as a point within a calculation domain decomposition, eg. dx, dt, dQ, dA etc...

Version:

20160212

Author:

Carlo Tegano

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainDecomposition.GridDirection

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.util.HashMap<java.lang.Integer,java.lang.Double>>	variables

Constructor Summary

Constructors

Constructor and Description
DomainDecomposition()
DomainDecomposition(int noSteps, java.lang.String[] labels) Domain decomposition constructor
DomainDecomposition(int noSteps, java.lang.String[] labels, double initVal) Domain decomposition constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	evalAllAverageValues() On domain of 3 steps, sets mid step value to the average between first and last step for all variables
void	evalAverageValue(java.lang.String label) On domain of 3 steps, sets mid step value to the average between first and last step
void	evalBulkVariableFromInOutAverageAtAllSteps(java.lang.String bulkVarName, java.lang.String varName, DomainDecomposition.GridDirection dir, double extVal) Evaluates the bulk variable on a stage by taking the average between inlet and outlet values of another variable on the same stage, eg.
void	evalLinearProfileWithFinalExtVal(java.lang.String varName, double valStep0, double valExt)
void	evalLinearProfileWithStartExtVal(java.lang.String varName, double valExt, double valStepN)
double	getInletValue(java.lang.String label) Gets the value of variable "label" at first step of the domain (inlet)
java.lang.String	getLabel()
int	getNoSteps()
double	getOutletValue(java.lang.String label) Gets the value of variable "label" at last step of the domain (outlet)
double	getValue(java.lang.String label, int step) Returns the value of variable "label" at "step"
java.lang.String	printStepsID() Prints selected fields of the domain decomposition state
void	setInletValue(java.lang.String label, double val) Sets the value of variable "label" at first step of the domain (inlet)
void	setLabel(java.lang.String label)
void	setOutletValue(java.lang.String label, double val) Sets the value of variable "label" at last step of the domain (outlet)
void	setValue(java.lang.String label, int step, double val) Sets the value of variable "label" at step "step"
void	setValueAtAllSteps(java.lang.String label, double val) Sets the value of variable "label" at all steps
void	setValueFromAverageAtAllSteps(java.lang.String varName, java.lang.String varName1, DomainDecomposition d1, java.lang.String varName2, DomainDecomposition d2) Set a variable from the average of other 2 variables in the grid at the same step
java.lang.String	toStringFormat() Returns the domain decomposition state as a formatted string
java.lang.String	toStringFormat(java.lang.String field) Returns the domain decomposition field as a formatted string
java.lang.String	toStringFormat(java.lang.String label, java.lang.String varName, double inlVal, double outVal) Prints selected variable of the domain decomposition to stdout
java.lang.String	toStringFormatdWithConversion(java.lang.String field, java.lang.String name, java.lang.String units, double mul, double add) Prints the state of a domain decomposition field to NCEIO.vout applying the units conversion mul * (x + add)
java.lang.String	toStringFormatWithConversion(java.lang.String label, java.lang.String varName, double inlVal, double outVal, double factor, double delta) Prints selected variable of the domain decomposition to stdout allowing units conversion as (factor) * (variable + delta)
java.lang.String	toStringFormatWithConversion(java.lang.String field, java.lang.String name, java.lang.String units, double mul, double add, double extStartVal, double extFinalVal) Prints the state of a domain decomposition field to NCEIO.vout applying the units conversion mul * (x + add)
java.lang.String	toStringFormatWithConversionFinalBlank(java.lang.String field, java.lang.String name, java.lang.String units, double mul, double add, double extStartVal)
java.lang.String	toStringFormatWithConversionStartBlank(java.lang.String field, java.lang.String name, java.lang.String units, double mul, double add, double extFinalVal)
java.lang.String	toStringFormatWithConversionWithBlanks(java.lang.String field, java.lang.String name, java.lang.String units, double mul, double add)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

variables

public java.util.Map<java.lang.String,java.util.HashMap<java.lang.Integer,java.lang.Double>> variables

Constructor Detail

DomainDecomposition

public DomainDecomposition()

DomainDecomposition

public DomainDecomposition(int noSteps,
                   java.lang.String[] labels,
                   double initVal)

Domain decomposition constructor

Parameters:

noSteps - number of decomposition steps

labels - entries name

initVal - initial value for all entries

DomainDecomposition

public DomainDecomposition(int noSteps,
                   java.lang.String[] labels)

Domain decomposition constructor

Parameters:

noSteps -

labels -

Method Detail

getValue

public double getValue(java.lang.String label,
              int step)
                throws java.lang.RuntimeException

Returns the value of variable "label" at "step"

Parameters:

label - the name of the required variable

step - the step of interest

Returns:

variable value at step

Throws:

java.lang.RuntimeException

setValue

public void setValue(java.lang.String label,
            int step,
            double val)

Sets the value of variable "label" at step "step"

Parameters:

label - the name of the required variable

step - the step of interest

val - value

evalBulkVariableFromInOutAverageAtAllSteps

public void evalBulkVariableFromInOutAverageAtAllSteps(java.lang.String bulkVarName,
                                              java.lang.String varName,
                                              DomainDecomposition.GridDirection dir,
                                              double extVal)

Evaluates the bulk variable on a stage by taking the average between inlet and outlet values of another variable on the same stage, eg. bulk T from inlet and outlet T, bT = 0.5 * (iT + oT)

Parameters:

bulkVarName - name of the bulk variable

varName - name of the variable to be averaged

dir - direction of the calculation respect to the grid

extVal - value of averaged variable in the point outside the grid

evalLinearProfileWithFinalExtVal

public void evalLinearProfileWithFinalExtVal(java.lang.String varName,
                                    double valStep0,
                                    double valExt)

Parameters:

varName -

valStep0 -

valExt -

evalLinearProfileWithStartExtVal

public void evalLinearProfileWithStartExtVal(java.lang.String varName,
                                    double valExt,
                                    double valStepN)

Parameters:

varName -

valExt -

valStepN -

setValueFromAverageAtAllSteps

public void setValueFromAverageAtAllSteps(java.lang.String varName,
                                 java.lang.String varName1,
                                 DomainDecomposition d1,
                                 java.lang.String varName2,
                                 DomainDecomposition d2)

Set a variable from the average of other 2 variables in the grid at the same step

Parameters:

varName - Name of Calculated variable from the average of var1 var2

varName1 - Name of Variable 1

d1 - DomainDecomposition of var1

varName2 - Name of Variable 2

d2 - DomainDecomposition of var2

evalAverageValue

public void evalAverageValue(java.lang.String label)

On domain of 3 steps, sets mid step value to the average between first and last step

evalAllAverageValues

public void evalAllAverageValues()

On domain of 3 steps, sets mid step value to the average between first and last step for all variables

setInletValue

public void setInletValue(java.lang.String label,
                 double val)

Sets the value of variable "label" at first step of the domain (inlet)

Parameters:

label - variable name

setOutletValue

public void setOutletValue(java.lang.String label,
                  double val)

Sets the value of variable "label" at last step of the domain (outlet)

Parameters:

label - variable name

getInletValue

public double getInletValue(java.lang.String label)

Gets the value of variable "label" at first step of the domain (inlet)

Parameters:

label - variable name

Returns:

variable value

getOutletValue

public double getOutletValue(java.lang.String label)

Gets the value of variable "label" at last step of the domain (outlet)

Parameters:

label - variable name

Returns:

variable value

setValueAtAllSteps

public void setValueAtAllSteps(java.lang.String label,
                      double val)

Sets the value of variable "label" at all steps

Parameters:

label -

val -

toStringFormat

public java.lang.String toStringFormat()

Returns the domain decomposition state as a formatted string

toStringFormat

public java.lang.String toStringFormat(java.lang.String field)

Returns the domain decomposition field as a formatted string

toStringFormat

public java.lang.String toStringFormat(java.lang.String label,
                              java.lang.String varName,
                              double inlVal,
                              double outVal)

Prints selected variable of the domain decomposition to stdout

Parameters:

label - Printed name of the variable

varName - Variable ID in the grid

inlVal - Value before entering in the grid (optional)

outVal - Value after exiting the grid (optional)

toStringFormatdWithConversion

public java.lang.String toStringFormatdWithConversion(java.lang.String field,
                                             java.lang.String name,
                                             java.lang.String units,
                                             double mul,
                                             double add)

Prints the state of a domain decomposition field to NCEIO.vout applying the units conversion mul * (x + add)

Parameters:

field - variable to be printed

name - filed printed name (string)

units - units printed name (string)

mul - multiplier

add - addition term

toStringFormatWithConversion

public java.lang.String toStringFormatWithConversion(java.lang.String field,
                                            java.lang.String name,
                                            java.lang.String units,
                                            double mul,
                                            double add,
                                            double extStartVal,
                                            double extFinalVal)

Prints the state of a domain decomposition field to NCEIO.vout applying the units conversion mul * (x + add)

Parameters:

field - variable to be printed

name - filed printed name (string)

units - units printed name (string)

mul - multiplier

add - addition term

extStartVal - value external to grid at step -1

extFinalVal - value external to grid at step N

toStringFormatWithConversionWithBlanks

public java.lang.String toStringFormatWithConversionWithBlanks(java.lang.String field,
                                                      java.lang.String name,
                                                      java.lang.String units,
                                                      double mul,
                                                      double add)

Parameters:

field -

name -

units -

mul -

add -

toStringFormatWithConversionStartBlank

public java.lang.String toStringFormatWithConversionStartBlank(java.lang.String field,
                                                      java.lang.String name,
                                                      java.lang.String units,
                                                      double mul,
                                                      double add,
                                                      double extFinalVal)

Parameters:

field -

name -

units -

mul -

add -

extFinalVal -

toStringFormatWithConversionFinalBlank

public java.lang.String toStringFormatWithConversionFinalBlank(java.lang.String field,
                                                      java.lang.String name,
                                                      java.lang.String units,
                                                      double mul,
                                                      double add,
                                                      double extStartVal)

Parameters:

field -

name -

units -

mul -

add -

extStartVal -

printStepsID

public java.lang.String printStepsID()

Prints selected fields of the domain decomposition state

toStringFormatWithConversion

public java.lang.String toStringFormatWithConversion(java.lang.String label,
                                            java.lang.String varName,
                                            double inlVal,
                                            double outVal,
                                            double factor,
                                            double delta)

Prints selected variable of the domain decomposition to stdout allowing units conversion as (factor) * (variable + delta)

Parameters:

label - Printed name of the variable

varName - Variable ID in the grid

inlVal - Value before entering in the grid (optional)

outVal - Value after exiting the grid (optional)

factor -

delta -

getNoSteps

public int getNoSteps()

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)