Template Class NodeBase

• Defined in File NodeBase.hpp

Inheritance Relationships

Base Type

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

Derived Types

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

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

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

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

Class Documentation

template<typename ScalarT, typename IdxT>
class NodeBase : public GridKit::Model::Evaluator<ScalarT, IdxT>

Subclassed by GridKit::PowerElectronics::Bus< ScalarT, IdxT >, GridKit::PowerElectronics::GroundedBus< ScalarT, IdxT >, GridKit::PowerElectronics::MicrogridBus< ScalarT, IdxT >, GridKit::PowerElectronics::SignalNode< ScalarT, IdxT >

Public Functions

inline virtual bool hasJacobian() final

Is the Jacobian defined. Used in IDA to determine wether DQ is used or not.

Returns:

true

Returns:

false

inline virtual VectorT &absoluteTolerance() final

Get the absolute tolerance for each variable in the model.

Returns:

a reference to the absolute tolerance vector.

Pre:

setAbsoluteTolerance must have been called first.

inline virtual const VectorT &absoluteTolerance() const final

Get the absolute tolerance for each variable in the model.

Returns:

a const reference to the absolute tolerance vector.

Pre:

setAbsoluteTolerance must have been called first.

inline int setExternalConnectionNodes(IdxT local_index, IdxT global_index)

Create the mappings from local to global indices.

Parameters:

• local_index –

• global_index –

Returns:

int

inline IdxT getNodeConnection(IdxT local_index) const

Given the location of value in the local vector map to global index.

f(local_index) = global_index

Parameters:

local_index – index of local value in vector

Returns:

IdxT Index of the same value in the global vector

inline virtual int setAbsoluteTolerance(RealT rel_tol) final

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.

Template Parameters:

• ScalarT – Scalar data type

• IdxT – Index data type

Returns:

int 0 if successful, non-zero otherwise.