Template Class GeneratorBase

• Defined in File GeneratorBase.hpp

Inheritance Relationships

Base Type

• public GridKit::ModelEvaluatorImpl< ScalarT, IdxT > (Template Class ModelEvaluatorImpl)

Derived Types

• public GridKit::GeneratorPQ< ScalarT, IdxT > (Template Class GeneratorPQ)

• public GridKit::GeneratorPV< ScalarT, IdxT > (Template Class GeneratorPV)

• public GridKit::GeneratorSlack< ScalarT, IdxT > (Template Class GeneratorSlack)

Class Documentation

template<class ScalarT, typename IdxT>
class GeneratorBase : public GridKit::ModelEvaluatorImpl<ScalarT, IdxT>

Generator base class template.

Template Parameters:

• ScalarT – - Scalar type

• IdxT – - Matrix and vector index type

Subclassed by GridKit::GeneratorPQ< ScalarT, IdxT >, GridKit::GeneratorPV< ScalarT, IdxT >, GridKit::GeneratorSlack< ScalarT, IdxT >

Public Functions

inline virtual int setAbsoluteTolerance(RealT)

Compute the absolute tolerance for each variable in the model.

This represents a “noise” level close to zero for which pure relative error cannot be used.

Parameters:

rel_tol – The relative tolerance which can be used to pick the absolute tolerance.

Returns:

int 0 if successful, non-zero otherwise.