Template Class Component

Nested Relationships

public GridKit::Model::Evaluator< scalar_type, index_type > (Template Class Evaluator)

public GridKit::EMT::Bus< scalar_type, index_type > (Template Class Bus)
public GridKit::EMT::LoadZ< scalar_type, index_type > (Template Class LoadZ)
public GridKit::EMT::SystemModel< scalar_type, index_type > (Template Class SystemModel)
public GridKit::EMT::VectorFit< scalar_type, index_type > (Template Class VectorFit)

template<typename scalar_type, typename index_type> class Component : public GridKit::Model::Evaluator<scalar_type, index_type>

EMT component, which views its blocks of the system vectors.

The local variables are the internal variables, then the external variables of each port. Each has a value, a derivative and a residual.

Public Functions

template<typename PortT> int connect(PortT port, Component &component, IdxT offset = 0): Connect port to the local variables of component from offset.

template<typename PortT> int connect(PortT port, Component &component, std::vector<IdxT> indices): Connect port to the local variables of component at indices.

template<Utilities::SizedEnum VariableT> inline IdxT size(VariableT variable) const: Size of internal variable variable.

template<Utilities::SizedEnum VariableT> inline std::span<ScalarT> y(VariableT variable): Values of internal variable variable, once the system is allocated.

template<Utilities::SizedEnum VariableT> inline std::span<ScalarT> getResidual(VariableT variable): Residuals of internal variable variable, once the system is allocated.

template<Utilities::SizedEnum VariableT> inline std::span<ScalarT> absoluteTolerance(VariableT variable): Absolute tolerances of internal variable variable, once the system is allocated.

inline const std::string &id() const: Case id, or id.symbol for a submodel.

inline virtual int allocate() override: The system binds each component to its blocks.

inline virtual int tagDifferentiable() override

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.

inline virtual int setAbsoluteTolerance(RealT rel_tol) override: The relative tolerance, unless a model scales its own.

inline virtual int evaluateResidual() override

Evaluate the model’s residual function.

For models which can be appropriately modeled in semi-explicit form, this will evaluate

\[F(t, y, \dot{y}) = f(t,y) - M \dot{y},\]

where

\[M\]

is the mass matrix. For models which can be modeled in Hessenberg form,

\[M\]

should be a simple indicator function for if the variable is differential (if

\[\dot{y}\]

appears in its equation). This indicator should be given by tag().

virtual int evaluateJacobian() override: dF/dy + alpha dF/dy’ from the partials of the last tagging

inline virtual IdxT size() override: How many variables exist in the model.

inline virtual IdxT nnz() override

How many non-zero elements are in this model’s Jacobian.

This knowledge may be needed to allocate the buffers for the model’s Jacobian, so it it should not depend on allocate() having been called.