stateVector.couplingInfo
Return organized information about coupled variables
Syntax
Description
info = obj.couplingInfo
Returns a struct with information about coupled variables in the current state vector
Output Arguments
info
.sets (struct vector [nSets]): Information about each set of coupled variables .vars (vector, linear indices [nVariables]): The indices of variables in a set of coupled variables .ensDims (string vector [nDimensions]): The names of the ensemble dimensions in the coupling set .dims (matrix, linear indices [nVariables x nDimensions]): The indices of the ensemble dimensions for the variables in the set
.variables (struct vector [nVariables]): Coupling information for each variable .whichSet (scalar, linear index): The index of the coupling set to which the variable belongs .dims (vector, linear indices [nDimensions]): The indices of the ensemble dimensions in the variable