Template Class SystemModel

Defined in File SystemModel.hpp

Inheritance Relationships

Base Type

public GridKit::PhasorDynamics::Component< scalar_type, index_type > (Template Class Component)

Class Documentation

template<typename scalar_type, typename index_type> class SystemModel : public GridKit::PhasorDynamics::Component<scalar_type, index_type>

Prototype for a system model class.

This class maps component data to system data and implements Model::Evaluator for the system model. This is still work in progress and code is not optimized.

Todo:: Address thread safety for the system model methods.

Public Functions

virtual bool hasJacobian() override

Todo:: Remove this method. It should be part of DynamicSolver class.

virtual void startMonitor() override: Get monitor ready for output.

virtual void stopMonitor() override: Tell monitor to wrap up.

virtual bool monitoring() const override: Is there something to monitor? Defaults to false

virtual void printMonitoredVariables() const override: Print variables at current state.

virtual int setAbsoluteTolerance(RealT rel_tol) override

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.