Package com.powsybl.openloadflow.equations

Class EquationTerm.MultiplyByScalarEquationTerm

java.lang.Object

com.powsybl.openloadflow.equations.EquationTerm.MultiplyByScalarEquationTerm

All Implemented Interfaces:

EquationTerm, Evaluable

Enclosing interface:

EquationTerm

public static class EquationTerm.MultiplyByScalarEquationTerm
extends Object
implements EquationTerm

Nested Class Summary

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

EquationTerm.MultiplyByScalarEquationTerm, EquationTerm.VariableEquationTerm

Method Summary

Modifier and Type	Method	Description
double	calculateSensi(com.powsybl.math.matrix.DenseMatrix x, int column)
double	der(Variable variable)	Get partial derivative.
double	eval()	Evaluate equation term.
int	getElementNum()
ElementType	getElementType()
Equation	getEquation()
List<Variable>	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 equation)
void	update(double[] x)	Update equation term using x variable values.
void	write(Writer writer)

Methods inherited from class java.lang.Object

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

Method Detail

getEquation

public Equation getEquation()

Specified by:

getEquation in interface EquationTerm

setEquation

public void setEquation(Equation equation)

Specified by:

setEquation in interface EquationTerm

setActive

public void setActive(boolean active)

Specified by:

setActive in interface EquationTerm

isActive

public boolean isActive()

Specified by:

isActive in interface EquationTerm

getElementType

public ElementType getElementType()

Specified by:

getElementType in interface EquationTerm

getElementNum

public int getElementNum()

Specified by:

getElementNum in interface EquationTerm

getVariables

public List<Variable> getVariables()

Description copied from interface: EquationTerm

Get the list of variable this equation term depends on.

Specified by:

getVariables in interface EquationTerm

Returns:

the list of variable this equation term depends on.

update

public void update(double[] x)

Description copied from interface: EquationTerm

Update equation term using x variable values.

Specified by:

update in interface EquationTerm

Parameters:

x - variables values vector

eval

public double eval()

Description copied from interface: EquationTerm

Evaluate equation term.

Specified by:

eval in interface EquationTerm

Specified by:

eval in interface Evaluable

Returns:

value of the equation term

der

public double der(Variable variable)

Description copied from interface: EquationTerm

Get partial derivative.

Specified by:

der in interface EquationTerm

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

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

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

write

public void write(Writer writer)
           throws IOException

Specified by:

write in interface EquationTerm

Throws:

IOException