Template Class GeneratorPV
Defined in File GeneratorPV.hpp
Inheritance Relationships
Base Type
public GridKit::GeneratorBase< ScalarT, IdxT >(Template Class GeneratorBase)
Class Documentation
-
template<class ScalarT, typename IdxT>
class GeneratorPV : public GridKit::GeneratorBase<ScalarT, IdxT> Implementation of a PV generator.
Public Functions
-
virtual int allocate()
Allocate all internal memory used by the model.
- Post:
Changing the model by changing its internal topology (i.e. size(), nnz(), sparsity pattern in getCsrJacobian(), etc.) may invalidate the model until
allocate()is called again. Calling any function that requiresallocate()to be called in between modifying the model and reallocating may invoke undefined behaviour.
-
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 evaluateResidual()
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 allocate()