Template Class Inductor

Inheritance Relationships

Base Type

Class Documentation

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

Declaration of a Inductor class.

Public Functions

Inductor(IdxT id, RealT L, NodeT *node1, NodeT *node2)

Constructor for a inductor.

Calls default ModelEvaluatorImpl constructor.

virtual int initialize()

Initialization of the grid model

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 evaluateInternalResidual() final

Compute the resisdual of the component.

virtual int evaluateExternalResidual() final

Evaluate all of the residuals of external variables of the component, modifying f_.

Returns:

An error code, or 0 if successful.

virtual int evaluateJacobian()

Evaluate the jacobian of the component.

Template Parameters:

  • ScalarT –

  • IdxT –

Returns:

int