Package com.powsybl.openloadflow.equations

Class AbstractEquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

java.lang.Object

com.powsybl.openloadflow.equations.AbstractEquationTerm<V,E>

All Implemented Interfaces:

EquationTerm<V,E>, Evaluable

Direct Known Subclasses:

AbstractNamedEquationTerm, VariableEquationTerm

public abstract class AbstractEquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>
extends Object
implements EquationTerm<V,E>

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.openloadflow.equations.EquationTerm

EquationTerm.MultiplyByScalarEquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

Field Summary

Fields

Modifier and Type	Field	Description
protected EquationTerm<V,E>	self
protected StateVector	sv

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEquationTerm()
protected	AbstractEquationTerm(boolean active)

Method Summary

Modifier and Type	Method	Description
double	calculateSensi(com.powsybl.math.matrix.DenseMatrix dx, int column)
List<EquationTerm<V,E>>	getChildren()
Equation<V,E>	getEquation()
boolean	hasRhs()	Check EquationTerm.rhs() can return a value different from zero.
boolean	isActive()
double	rhs()	Get part of the partial derivative that has to be moved to right hand side.
void	setActive(boolean active)
void	setEquation(Equation<V,E> equation)
void	setSelf(EquationTerm<V,E> self)
void	setStateVector(StateVector sv)	Set state vector to use for term evaluation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.openloadflow.equations.EquationTerm

der, eval, eval, getElementNum, getElementType, getVariables, minus, multiply, multiply, write

Field Details

sv

protected StateVector sv

self

protected EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity> self

Constructor Details

AbstractEquationTerm

protected AbstractEquationTerm()

AbstractEquationTerm

protected AbstractEquationTerm(boolean active)

Method Details

setStateVector

public void setStateVector(StateVector sv)

Description copied from interface: EquationTerm

Set state vector to use for term evaluation.

Specified by:

setStateVector in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

Parameters:

sv - the state vector

getChildren

public List<EquationTerm<V,E>> getChildren()

Specified by:

getChildren in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

getEquation

public Equation<V,E> getEquation()

Specified by:

getEquation in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

setEquation

public void setEquation(Equation<V,E> equation)

Specified by:

setEquation in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

setActive

public void setActive(boolean active)

Specified by:

setActive in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

isActive

public boolean isActive()

Specified by:

isActive in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

setSelf

public void setSelf(EquationTerm<V,E> self)

Specified by:

setSelf in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

calculateSensi

public double calculateSensi(com.powsybl.math.matrix.DenseMatrix dx,
 int column)

Specified by:

calculateSensi in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

hasRhs

public boolean hasRhs()

Description copied from interface: EquationTerm

Check EquationTerm.rhs() can return a value different from zero.

Specified by:

hasRhs in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

Returns:

true if EquationTerm.rhs() can return a value different from zero, false otherwise

rhs

public double rhs()

Description copied from interface: EquationTerm

Get part of the partial derivative that has to be moved to right hand side.

Specified by:

rhs in interface EquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>

Returns:

value of part of the partial derivative that has to be moved to right hand side