Package com.powsybl.openloadflow.equations

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

java.lang.Object

com.powsybl.openloadflow.equations.EquationTerm.MultiplyByScalarEquationTerm<V,E>

All Implemented Interfaces:

EquationTerm<V,E>, Evaluable

Enclosing interface:

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

public static class EquationTerm.MultiplyByScalarEquationTerm<V extends Enum<V> & Quantity,E extends Enum<E> & Quantity>
extends Object
implements EquationTerm<V,E>

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>

Method Summary

Modifier and Type	Method	Description
double	calculateSensi(com.powsybl.math.matrix.DenseMatrix x, int column)
double	der(Variable<V> variable)	Get partial derivative.
double	eval()	Evaluate equation term.
List<EquationTerm<V,E>>	getChildren()
int	getElementNum()
ElementType	getElementType()
Equation<V,E>	getEquation()
List<Variable<V>>	getVariables()	Get the list of variable this equation term depends on.
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.
void	write(Writer writer)

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

eval, minus, multiply, multiply

Method Details

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>

getElementType

public ElementType getElementType()

Specified by:

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

getElementNum

public int getElementNum()

Specified by:

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

getVariables

public List<Variable<V>> getVariables()

Description copied from interface: EquationTerm

Get the list of variable this equation term depends on.

Specified by:

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

Returns:

the list of variable this equation term depends on.

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

eval

public double eval()

Description copied from interface: EquationTerm

Evaluate equation term.

Specified by:

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

Specified by:

eval in interface Evaluable

Returns:

value of the equation term

der

public double der(Variable<V> variable)

Description copied from interface: EquationTerm

Get partial derivative.

Specified by:

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

Parameters:

variable - the variable the partial derivative is with respect to

Returns:

value of the partial derivative

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

calculateSensi

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

Specified by:

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

write

public void write(Writer writer)
           throws IOException

Specified by:

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

Throws:

IOException