Gekko User Manual > Gekko statements

The statement puts variables on an ignore-list, so that they do not influence convergence using Gauss-Seidel iterations regarding SIM.

Syntax

checkoff;
checkoff variables;
checkoff ?;

[empty]	If no variables are stated, i.e. a CHECKOFF without arguments, the list of non-checked variables is cleared.
variables	Variable names or list
?	Prints the list of currently ignored variables concerning convergence in Gauss-Seidel method.

Example

CHECKOFF accepts variable names or lists (including wildcards), for instance:

checkoff x;
checkoff {#m}; //where #m is a list of names (strings)

Currrently ignored variables can be seen with

checkoff ?;

There is no CHECKON statement. The CHECKOFF statement is non-accumulating (like the ENDO and EXO statements). To eliminate a CHECKOFF-variable, just remove it from the list given to the CHECKOFF statement. To clear the CHECKOFF-list, issue a CHECKOFF statement with no arguments. An alternative to this is setting option solve gauss conv ignorevars = no;. In that case the list will be ignored.

Note

In order for this statement to work, option solve gauss conv ignorevars must be set to yes (which is its default value).

CHECKOFF is also the related to the ITERSHOW statement. Sometimes a particular variable, or a type of variables, may postpone the convergence of the Gauss-Seidel algorithm. To avoid that, such variables may be put on the CHECKOFF list, and they will be ignored regarding convergence check.

Related statements

ITERSHOW, OPTION, SIM