Template Class Inductor

Inheritance Relationships

Base Type

Class Documentation

template<class ScalarT, typename IdxT>
class Inductor : public GridKit::PowerElectronics::Component<ScalarT, IdxT>

Declaration of a Inductor class.

Public Functions

virtual int allocate() final

Allocates all of the internal buffers for the component. If a components needs a more specialized allocation (such as by having additional internal buffers), it should override this function and then call it in the body to ensure it stays up-to-date with new implementations.

Pre:

nnz_ and size_ must be set. Typically these are set by the child object in its constructor.

Returns:

An error code, or 0 if success

virtual int tagDifferentiable()

Fill the tag() vector with proper indicators.

Note

For some models, this may be a no-op, and the vector returned by tag() will still be empty.

Pre:

allocate() must have been called.

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.

virtual int evaluateInternalResidual() final

Evaluate all residuals for the component’s internal variables, writing them through f_int_.

Returns:

An error code, or 0 if successful.

virtual int evaluateExternalResidual() final

Evaluate all residual contributions for the component’s external variables, accumulating them through f_ext_.

Returns:

An error code, or 0 if successful.

virtual Component<ScalarT, IdxT> *clone() const

Create an independent copy of this component.

The clone preserves the component’s model configuration, parameters, topology, and structural data, but does not preserve bindings to system-owned state or residual storage.

Note

By default, the cloned component’s state, state-derivative, and residual pointers are not set. The user is responsible for setting these pointers to the appropriate storage before evaluating the residual.