More...

Inherits IDisposable.

Public Types

enum  EPageContr { EPageContr.NoPageContrWithPadding, EPageContr.FortranStyle, EPageContr.NoPageContrNoPadding, EPageContr.FormfeedCharNewPage }
 Output file page control option More...
 
enum  EAction {
  EAction.RestartAfterSolve, EAction.CompileOnly, EAction.ExecuteOnly, EAction.CompileAndExecute,
  EAction.GlueCodeGeneration, EAction.TraceReport
}
 GAMS processing request More...
 
enum  ELogLine { ELogLine.NoTracing, ELogLine.MinimumTracing, ELogLine.Automatic }
 Amount of line tracing to the log file More...
 
enum  EAppendOut { EAppendOut.Reset, EAppendOut.Append }
 Output file append option More...
 
enum  EStepSum { EStepSum.NoStepSummmary, EStepSum.StepSummary }
 Summary of computing resources used by job steps More...
 
enum  ESuppress { ESuppress.StandardCompilerListing, ESuppress.SuppressCompilerListing }
 Compiler listing option More...
 
enum  EDFormat { EDFormat.Slash, EDFormat.Dot, EDFormat.Dash }
 Date format More...
 
enum  ETFormat { ETFormat.Colon, ETFormat.Dot }
 Time format More...
 
enum  EIntVarUp { EIntVarUp.INF, EIntVarUp.Pass100ToSolver, EIntVarUp.INFandLog, EIntVarUp.Pass100ToSolverAndError }
 Set default upper bound on integer variables More...
 
enum  ECase { ECase.MixedCase, ECase.UpperCase }
 Output case option for LST file More...
 
enum  EDumpParms { EDumpParms.No, EDumpParms.AcceptedParameters, EDumpParms.FileOperationsAcceptedParameters }
 GAMS parameter logging More...
 
enum  EForceWork { EForceWork.NoTranslation, EForceWork.TryTranslation }
 Force GAMS systems to process save files for example with an execution error More...
 
enum  EDumpOpt {
  EDumpOpt.No, EDumpOpt.RefDataOriginalSetElementNames, EDumpOpt.RefDataNewSetElementNames, EDumpOpt.RefDataNewSetElementNamesDropSymbolText,
  EDumpOpt.RefSymbol, EDumpOpt.Deprecated_10, EDumpOpt.InputFileWOComments, EDumpOpt.Deprecated_12,
  EDumpOpt.Deprecated_19, EDumpOpt.Deprecated_20, EDumpOpt.InputFileWithComments
}
 Writes preprocessed input to the file input.dmp More...
 
enum  EErrMsg { EErrMsg.EndOfCompilerListing, EErrMsg.FollowingError, EErrMsg.Suppress }
 Placing of compilation error messages More...
 
enum  EStringChk { EStringChk.NoError, EStringChk.Error, EStringChk.NoErrorRemoveSymbol }
 String substitution options More...
 
enum  ECharSet { ECharSet.LimitedGAMSCharSet, ECharSet.AnyChar }
 Character set flag More...
 
enum  EKeep { EKeep.DeleteProcDir, EKeep.KeepProcDir }
 Controls keeping or deletion of process directory and scratch files More...
 
enum  ETraceOpt {
  ETraceOpt.SolverAndGAMSStepTraceWOHeaders, ETraceOpt.SolverAndGAMSStepTrace, ETraceOpt.SolverStepTraceOnly, ETraceOpt.TraceFileFormatGAMSPerformanceWorld,
  ETraceOpt.TraceFileFormatSupportingNLPEC, ETraceOpt.TraceFileWithAllAvailableTraceFields
}
 Trace file format option More...
 
enum  ESysOut { ESysOut.SuppressAdditionalSolverOutput, ESysOut.IncludeAdditionalSolverOutput }
 Solver Status file reporting option More...
 
enum  ESolPrint { ESolPrint.RemoveSolLstFollowingSolves, ESolPrint.IncludeSolLstFollowingSolves, ESolPrint.SuppressAllSolInfo }
 Solution report print option More...
 
enum  EHoldFixed { EHoldFixed.FixedVarsNotTreatedAsConstants, EHoldFixed.FixedVarsTreatedAsConstants }
 Treat fixed variables as constants More...
 
enum  EOn115 { EOn115.NoMessages, EOn115.IssueMessages }
 Generate errors for unknown unique element in an equation More...
 
enum  EExecMode {
  EExecMode.EverythingAllowed, EExecMode.InteractiveShellsProhibited, EExecMode.CallAndExecuteProhibited, EExecMode.EchoAndPutOnlyToWorkdir,
  EExecMode.EchoAndPutProhibited
}
 Limits on external programs that are allowed to be executed More...
 
enum  EInteractiveSolver { EInteractiveSolver.NoInteraction, EInteractiveSolver.AllowInteraction }
 Allow solver to interact via command line input More...
 
enum  EFileCase { EFileCase.DefaultCase, EFileCase.UpperCase, EFileCase.LowerCase }
 Casing of new file names (put, gdx, ref etc.) More...
 
enum  ESavePoint { ESavePoint.NoPointFile, ESavePoint.LastSolvePointFile, ESavePoint.EverySolvePointFile }
 Save solver point in GDX file More...
 
enum  ESolveLink {
  ESolveLink.ChainScript, ESolveLink.CallScript, ESolveLink.CallModule, ESolveLink.AsyncGrid,
  ESolveLink.AsyncSimulate, ESolveLink.LoadLibrary, ESolveLink.LoadLibraryAsync, ESolveLink.LoadLibraryAsyncSimulate
}
 Solver link option More...
 
enum  ESys10 { ESys10.Disable, ESys10.Enable }
 Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer More...
 
enum  ESys11 { ESys11.AutomaticOptimization, ESys11.NoOptimization, ESys11.AlwaysOptimize }
 Dynamic resorting if indices in assignment/data statements are not in natural order More...
 
enum  EZeroResRep { EZeroResRep.NoWarning, EZeroResRep.IssueWarning }
 Report underflow as a warning when abs(results) LE ZeroRes and result set to zero More...
 
enum  EgdxCompress { EgdxCompress.DoNotCompressGDX, EgdxCompress.CompressGDX }
 Compression of generated GDX file More...
 
enum  EgdxConvert { EgdxConvert.Version5, EgdxConvert.Version6, EgdxConvert.Version7 }
 Version of GDX files generated (for backward compatibility) More...
 
enum  EAppendExpand { EAppendExpand.Reset, EAppendExpand.Append }
 Expand file append option More...
 
enum  ENoNewVarEqu { ENoNewVarEqu.AllowNewVarEqu, ENoNewVarEqu.DoNotAllowNewVarEqu }
 Triggers a compilation error when new equations or variable symbols are introduced More...
 
enum  EgdxUels { EgdxUels.squeezed, EgdxUels.full }
 Unload labels or UELs to GDX either squeezed or full More...
 
enum  EstrictSingleton { EstrictSingleton.FirstRecord, EstrictSingleton.Error }
 Error if assignment to singleton set has multiple elements More...
 
enum  EFDOpt {
  EFDOpt.GHAnalyticHNumericGradScale, EFDOpt.GHAnalyticHNumericFuncScale, EFDOpt.GAnalyticFHNumericGradScale, EFDOpt.GAnalyticFHNumericFuncScale,
  EFDOpt.FGHNumericScale, EFDOpt.GHAnalyticHNumericGradNoScale, EFDOpt.GHAnalyticHNumericFuncNoScale, EFDOpt.GAnalyticFHNumericGradNoScale,
  EFDOpt.GAnalyticFHNumericFuncNoScale, EFDOpt.FGHNumericNoScale
}
 Options for finite differences More...
 
enum  EPrefixLoadPath { EPrefixLoadPath.Off, EPrefixLoadPath.On }
 Prepend GAMS system directory to library load path More...
 
enum  EAsyncSolLst { EAsyncSolLst.Off, EAsyncSolLst.On }
 Print solution listing when asynchronous solve (Grid or Threads) is used More...
 
enum  EPySetup { EPySetup.Off, EPySetup.On }
 GAMS/Python Setup More...
 
enum  EPyMultInst { EPyMultInst.Single, EPyMultInst.Multi }
 GAMS/Python Multiple Instance Interpreter More...
 

Public Member Functions

void Export (string filePath)
 Write GAMSOptions into a parameter file More...
 
void Dispose ()
 Free unmanaged ressources. More...
 
void ResetToDefault ()
 Reset all GAMS options to default More...
 

Public Attributes

List< string > IDir
 Input file directories (up to 40 are allowed) More...
 
Dictionary< string, string > Defines
 GAMS Dash Options More...
 

Properties

string GDX [get, set]
 Gams data exchange file name More...
 
string Output [get, set]
 Listing file name More...
 
string Symbol [get, set]
 Symbol table file More...
 
string Expand [get, set]
 Expanded (include) input file name More...
 
int PageWidth [get, set]
 Output file page width More...
 
int PageSize [get, set]
 Output file page size (=0 no paging) More...
 
EPageContr PageContr [get, set]
 Output file page control option More...
 
EAction Action [get, set]
 GAMS processing request More...
 
string PutDir [get, set]
 Put file directory More...
 
string GridDir [get, set]
 Grid file directory More...
 
string ScriptExit [get, set]
 Program or script to be executed at the end of a GAMS run More...
 
ELogLine LogLine [get, set]
 Amount of line tracing to the log file More...
 
string Trace [get, set]
 Trace file name More...
 
EAppendOut AppendOut [get, set]
 Output file append option More...
 
EStepSum StepSum [get, set]
 Summary of computing resources used by job steps More...
 
ESuppress Suppress [get, set]
 Compiler listing option More...
 
EDFormat DFormat [get, set]
 Date format More...
 
ETFormat TFormat [get, set]
 Time format More...
 
int TabIn [get, set]
 Tab spacing More...
 
EIntVarUp IntVarUp [get, set]
 Set default upper bound on integer variables More...
 
ECase Case [get, set]
 Output case option for LST file More...
 
string License [get, set]
 Use alternative license file More...
 
EDumpParms DumpParms [get, set]
 GAMS parameter logging More...
 
int Profile [get, set]
 Execution profiling More...
 
string LibIncDir [get, set]
 LibInclude directory More...
 
string SysIncDir [get, set]
 SysInclude directory More...
 
string User1 [get, set]
 User string N More...
 
string User2 [get, set]
 User string N More...
 
string User3 [get, set]
 User string N More...
 
string User4 [get, set]
 User string N More...
 
string User5 [get, set]
 User string N More...
 
EForceWork ForceWork [get, set]
 Force GAMS systems to process save files for example with an execution error More...
 
int CErr [get, set]
 Compile time error limit More...
 
string FErr [get, set]
 Alternative error message file More...
 
int OptFile [get, set]
 Default option file More...
 
EDumpOpt DumpOpt [get, set]
 Writes preprocessed input to the file input.dmp More...
 
EErrMsg ErrMsg [get, set]
 Placing of compilation error messages More...
 
EStringChk StringChk [get, set]
 String substitution options More...
 
string Reference [get, set]
 Symbol reference file More...
 
string OptDir [get, set]
 Option file directory More...
 
int ExecErr [get, set]
 Execution time error limit More...
 
int ErrorLog [get, set]
 Max error message lines written to the log for each error More...
 
int LimRow [get, set]
 Maximum number of rows listed in one equation block More...
 
int LimCol [get, set]
 Maximum number of columns listed in one variable block More...
 
ECharSet CharSet [get, set]
 Character set flag More...
 
EKeep Keep [get, set]
 Controls keeping or deletion of process directory and scratch files More...
 
ETraceOpt TraceOpt [get, set]
 Trace file format option More...
 
int IterLim [get, set]
 Iteration limit of solver More...
 
int DomLim [get, set]
 Domain violation limit solver default More...
 
double ResLim [get, set]
 Wall-clock time limit for solver More...
 
double OptCR [get, set]
 Relative Optimality criterion solver default More...
 
double OptCA [get, set]
 Absolute Optimality criterion solver default More...
 
ESysOut SysOut [get, set]
 Solver Status file reporting option More...
 
ESolPrint SolPrint [get, set]
 Solution report print option More...
 
double Bratio [get, set]
 Basis acceptance threshold More...
 
EHoldFixed HoldFixed [get, set]
 Treat fixed variables as constants More...
 
int NodLim [get, set]
 Node limit in branch and bound tree More...
 
double WorkFactor [get, set]
 Memory Estimate multiplier for some solvers More...
 
double WorkSpace [get, set]
 Work space for some solvers in MB More...
 
int ForLim [get, set]
 GAMS looping limit More...
 
int Seed [get, set]
 Random number seed More...
 
EOn115 On115 [get, set]
 Generate errors for unknown unique element in an equation More...
 
EExecMode ExecMode [get, set]
 Limits on external programs that are allowed to be executed More...
 
EInteractiveSolver InteractiveSolver [get, set]
 Allow solver to interact via command line input More...
 
string PLicense [get, set]
 Privacy license file name More...
 
string JobTrace [get, set]
 Job trace string to be written to the trace file at the end of a GAMS job More...
 
int Warnings [get, set]
 Number of warnings permitted before a run terminates More...
 
int TraceLevel [get, set]
 Solvestat threshold used in conjunction with action=GT More...
 
int Timer [get, set]
 Instruction timer threshold in milli seconds More...
 
EFileCase FileCase [get, set]
 Casing of new file names (put, gdx, ref etc.) More...
 
ESavePoint SavePoint [get, set]
 Save solver point in GDX file More...
 
ESolveLink SolveLink [get, set]
 Solver link option More...
 
ESys10 Sys10 [get, set]
 Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer More...
 
ESys11 Sys11 [get, set]
 Dynamic resorting if indices in assignment/data statements are not in natural order More...
 
int Sys12 [get, set]
 Pass model with generation errors to solver More...
 
double ZeroRes [get, set]
 The results of certain operations will be set to zero if abs(result) LE ZeroRes More...
 
EZeroResRep ZeroResRep [get, set]
 Report underflow as a warning when abs(results) LE ZeroRes and result set to zero More...
 
double HeapLimit [get, set]
 Maximum Heap size allowed in MB More...
 
EgdxCompress gdxCompress [get, set]
 Compression of generated GDX file More...
 
EgdxConvert gdxConvert [get, set]
 Version of GDX files generated (for backward compatibility) More...
 
EAppendExpand AppendExpand [get, set]
 Expand file append option More...
 
double ETLim [get, set]
 Elapsed time limit in seconds More...
 
double ProfileTol [get, set]
 Minimum time a statement must use to appear in profile generated output More...
 
string ProfileFile [get, set]
 Write profile information to this file More...
 
int MaxProcDir [get, set]
 Maximum number of 225* process directories More...
 
int Integer1 [get, set]
 Integer communication cell N More...
 
int Integer2 [get, set]
 Integer communication cell N More...
 
int Integer3 [get, set]
 Integer communication cell N More...
 
int Integer4 [get, set]
 Integer communication cell N More...
 
int Integer5 [get, set]
 Integer communication cell N More...
 
string GridScript [get, set]
 Grid submission script More...
 
int Threads [get, set]
 Number of threads to be used by a solver More...
 
ENoNewVarEqu NoNewVarEqu [get, set]
 Triggers a compilation error when new equations or variable symbols are introduced More...
 
int ForceOptFile [get, set]
 Overwrites other option file section mechanism More...
 
string SymPrefix [get, set]
 Prefix all symbols encountered during compilation by the specified string in work file More...
 
EgdxUels gdxUels [get, set]
 Unload labels or UELs to GDX either squeezed or full More...
 
string DumpParmsLogPrefix [get, set]
 Prefix of lines triggered by DumpParms>1 More...
 
EstrictSingleton strictSingleton [get, set]
 Error if assignment to singleton set has multiple elements More...
 
double FDDelta [get, set]
 Step size for finite differences More...
 
EFDOpt FDOpt [get, set]
 Options for finite differences More...
 
EPrefixLoadPath PrefixLoadPath [get, set]
 Prepend GAMS system directory to library load path More...
 
int ThreadsAsync [get, set]
 Number of threads to be used for asynchronous solve (solveLink=6) More...
 
EAsyncSolLst AsyncSolLst [get, set]
 Print solution listing when asynchronous solve (Grid or Threads) is used More...
 
string FileStem [get, set]
 Sets the file stem for output files which use the input file name as stem by default More...
 
EPySetup PySetup [get, set]
 GAMS/Python Setup More...
 
EPyMultInst PyMultInst [get, set]
 GAMS/Python Multiple Instance Interpreter More...
 
string LP [get, set]
 Default LP solver More...
 
string MIP [get, set]
 Default MIP solver More...
 
string RMIP [get, set]
 Default RMIP solver More...
 
string NLP [get, set]
 Default NLP solver More...
 
string MCP [get, set]
 Default MCP solver More...
 
string MPEC [get, set]
 Default MPEC solver More...
 
string RMPEC [get, set]
 Default RMPEC solver More...
 
string CNS [get, set]
 Default CNS solver More...
 
string DNLP [get, set]
 Default DNLP solver More...
 
string RMINLP [get, set]
 Default RMINLP solver More...
 
string MINLP [get, set]
 Default MINLP solver More...
 
string QCP [get, set]
 Default QCP solver More...
 
string MIQCP [get, set]
 Default MIQCP solver More...
 
string RMIQCP [get, set]
 Default RMIQCP solver More...
 
string EMP [get, set]
 Default EMP solver More...
 
string AllModelTypes [set]
 Set default solver for all model types which the solver can handle More...
 

Detailed Description

The GAMSOptions class manages GAMS options (sometimes also called GAMS parameters since they correspond to the command line parameters of the GAMS executable) for a GAMSJob and GAMSModelInstance. There are integer (e.g. NodLim), double (e.g. ResLim), and string (e.g. PutDir) valued options. There are also a few list options (Defines to set string macros inside GAMS and IDir provide multiple search paths for include files) and a power option to set a solver for all suitable model types (AllModelTypes).

Some options known from other interfaces to GAMS that are of limited use or could even create problematic situations in the .NET environment are not settable through the GAMSOptions class.

For some options (e.g. Case) other GAMS interfaces use numeric values (e.g. 0,1) while the GAMSOptions class has enumerated types with proper names (e.g. MixedCase, UpperCase).

A GAMSOptions instance is connected to external resources and needs to be properly disposed before the .NET garbage collector can claim the instance.

Member Enumeration Documentation

◆ EAction

GAMS processing request

Enumerator
RestartAfterSolve 

Restart After Solve

CompileOnly 

CompileOnly

ExecuteOnly 

ExecuteOnly

CompileAndExecute 

Compile and Execute

GlueCodeGeneration 

Glue Code Generation

TraceReport 

Trace Report

◆ EAppendExpand

Expand file append option

Enumerator
Reset 

Reset expand file

Append 

Append to expand file

◆ EAppendOut

Output file append option

Enumerator
Reset 

Reset listing file

Append 

Append to listing file

◆ EAsyncSolLst

Print solution listing when asynchronous solve (Grid or Threads) is used

Enumerator
Off 

Do not print solution listing into lst file for asynchronous solves

On 

Print solution listing into lst file for asynchronous solves

◆ ECase

Output case option for LST file

Enumerator
MixedCase 

Write listing file in mixed case

UpperCase 

Write listing file in upper case only

◆ ECharSet

Character set flag

Enumerator
LimitedGAMSCharSet 

Use limited GAMS characters set

AnyChar 

Accept any character in comments and text items (foreign language characters)

◆ EDFormat

Date format

Enumerator
Slash 

Date as mm/dd/yy

Dot 

Date as dd.mm.yy

Dash 

Date as yy-mm-dy

◆ EDumpOpt

Writes preprocessed input to the file input.dmp

Enumerator
No 

No dumpfile

RefDataOriginalSetElementNames 

Extract referenced data from the restart file using original set element names

RefDataNewSetElementNames 

Extract referenced data from the restart file using new set element names

RefDataNewSetElementNamesDropSymbolText 

Extract referenced data from the restart file using new set element names and drop symbol text

RefSymbol 

Extract referenced symbol declarations from the restart file

Deprecated_10 

(Same as 11 and therefore hidden)

InputFileWOComments 

Write processed input file without comments

Deprecated_12 

(Same as 11 and therefore hidden)

Deprecated_19 

(Same as 21 and therefore hidden)

Deprecated_20 

(Same as 21 and therefore hidden)

InputFileWithComments 

Write processed input file with all comments

◆ EDumpParms

GAMS parameter logging

Enumerator
No 

No logging

AcceptedParameters 

Lists accepted/set parameters

FileOperationsAcceptedParameters 

Log of file operations plus list of accepted/set parameters

◆ EErrMsg

Placing of compilation error messages

Enumerator
EndOfCompilerListing 

Place error messages at the end of compiler listing

FollowingError 

Place error messages immediately following the line with the error

Suppress 

Suppress error messages

◆ EExecMode

Limits on external programs that are allowed to be executed

Enumerator
EverythingAllowed 

Everything allowed

InteractiveShellsProhibited 

Interactive shells in $call and execute commands are prohibited

CallAndExecuteProhibited 

Embedded Code and all $call and execute commands are prohibited

EchoAndPutOnlyToWorkdir 

$echo or put commands can only write to directories in or below the working or scratchdir

EchoAndPutProhibited 

$echo and put commands are not allowed

◆ EFDOpt

Options for finite differences

Enumerator
GHAnalyticHNumericGradScale 

All derivatives analytically, for numerical Hessian use gradient values, scale delta

GHAnalyticHNumericFuncScale 

All derivatives analytically, for numerical Hessian use function values, scale delta

GAnalyticFHNumericGradScale 

Gradient analytically, force Hessian numerically using gradient values, scale delta

GAnalyticFHNumericFuncScale 

Gradient analytically, force Hessian numerically using function values, scale delta

FGHNumericScale 

Force gradient and Hessian numerically, scale delta

GHAnalyticHNumericGradNoScale 

Same as 0, but no scale of delta

GHAnalyticHNumericFuncNoScale 

Same as 1, but no scale of delta

GAnalyticFHNumericGradNoScale 

Same as 2, but no scale of delta

GAnalyticFHNumericFuncNoScale 

Same as 3, but no scale of delta

FGHNumericNoScale 

Same as 4, but no scale of delta

◆ EFileCase

Casing of new file names (put, gdx, ref etc.)

Enumerator
DefaultCase 

Causes GAMS to use default casing

UpperCase 

Causes GAMS to upper case file names

LowerCase 

Causes GAMS to lower case file names

◆ EForceWork

Force GAMS systems to process save files for example with an execution error

Enumerator
NoTranslation 

No translation

TryTranslation 

Try translation

◆ EgdxCompress

Compression of generated GDX file

Enumerator
DoNotCompressGDX 

Do not compress GDX files

CompressGDX 

Compress GDX files

◆ EgdxConvert

Version of GDX files generated (for backward compatibility)

Enumerator
Version5 

Version 5 GDX file, does not support compression

Version6 

Version 6 GDX file

Version7 

Version 7 GDX file

◆ EgdxUels

Unload labels or UELs to GDX either squeezed or full

Enumerator
squeezed 

Write only the UELs to Universe, that are used by the exported symbols

full 

Write all UELs to Universe

◆ EHoldFixed

Treat fixed variables as constants

Enumerator
FixedVarsNotTreatedAsConstants 

Fixed variables are not treated as constants

FixedVarsTreatedAsConstants 

Fixed variables are treated as constants

◆ EInteractiveSolver

Allow solver to interact via command line input

Enumerator
NoInteraction 

Interaction with solvelink 0 is not supported

AllowInteraction 

Interaction with solvelink 0 is supported

◆ EIntVarUp

Set default upper bound on integer variables

Enumerator
INF 

Set default upper bound for integer variables to +INF

Pass100ToSolver 

Pass a value of 100 instead of +INF to the solver as upper bound for integer variables

INFandLog 

Same as 0 but writes a message to the log if the level of an integer variable is greater than 100

Pass100ToSolverAndError 

Same as 2 but issues an execution error if the level of an integer variable is greater than 100

◆ EKeep

Controls keeping or deletion of process directory and scratch files

Enumerator
DeleteProcDir 

Delete process directory

KeepProcDir 

Keep process directory

◆ ELogLine

Amount of line tracing to the log file

Enumerator
NoTracing 

No line tracing

MinimumTracing 

Minimum line tracing

Automatic 

Automatic and visually pleasing

◆ ENoNewVarEqu

Triggers a compilation error when new equations or variable symbols are introduced

Enumerator
AllowNewVarEqu 

AllowNewVarEqu

DoNotAllowNewVarEqu 

DoNotAllowNewVarEqu

◆ EOn115

Generate errors for unknown unique element in an equation

Enumerator
NoMessages 

No error messages

IssueMessages 

Issue error messages

◆ EPageContr

Output file page control option

Enumerator
NoPageContrWithPadding 

No page control, with padding

FortranStyle 

FORTRAN style line printer format

NoPageContrNoPadding 

No page control, no padding

FormfeedCharNewPage 

Formfeed character for new page

◆ EPrefixLoadPath

Prepend GAMS system directory to library load path

Enumerator
Off 

Do not set GAMS system directory at beginning of library load path

On 

Set GAMS system directory at beginning of library load path

◆ EPyMultInst

GAMS/Python Multiple Instance Interpreter

Enumerator
Single 

Use a single-session Python interpreter

Multi 

Use a multi-session Python interpreter

◆ EPySetup

GAMS/Python Setup

Enumerator
Off 

Rely on user setup of Python

On 

Use Python installation provided in GAMS system directory

◆ ESavePoint

Save solver point in GDX file

Enumerator
NoPointFile 

No point GDX file is to be saved

LastSolvePointFile 

A point GDX file from the last solve is to be saved

EverySolvePointFile 

A point GDX file from every solve is to be saved

◆ ESolPrint

Solution report print option

Enumerator
RemoveSolLstFollowingSolves 

Remove solution listings following solves

IncludeSolLstFollowingSolves 

Include solution listings following solves

SuppressAllSolInfo 

Suppress all solution information

◆ ESolveLink

Solver link option

Enumerator
ChainScript 

GAMS operates as it has for years

CallScript 

Solver is called from a shell and GAMS remains open

CallModule 

Solver is called with a spawn (if possible) or a shell (if spawn is not possible) and GAMS remains open

AsyncGrid 

GAMS starts the solution and continues in a Grid computing environment

AsyncSimulate 

GAMS starts the solution and wait (same submission process as 3) in a Grid computing environment

LoadLibrary 

The problem is passed to the solver in core without use of temporary files

LoadLibraryAsync 

The problem is passed to the solver in core without use of temporary files, GAMS does not wait for the solver to come back

LoadLibraryAsyncSimulate 

The problem is passed to the solver in core without use of temporary files, GAMS waits for the solver to come back but uses same submission process as 6

◆ EStepSum

Summary of computing resources used by job steps

Enumerator
NoStepSummmary 

No step summary

StepSummary 

Step summary printed

◆ EstrictSingleton

Error if assignment to singleton set has multiple elements

Enumerator
FirstRecord 

Take first record if assignment to singleton set has multiple elements

Error 

Error if assignment to singleton set has multiple elements

◆ EStringChk

String substitution options

Enumerator
NoError 

No substitution if symbol undefined and no error

Error 

Error if symbol undefined

NoErrorRemoveSymbol 

Remove entire symbol reference if undefined and no error

◆ ESuppress

Compiler listing option

Enumerator
StandardCompilerListing 

Standard compiler listing

SuppressCompilerListing 

Suppress compiler listing

◆ ESys10

Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer

Enumerator
Disable 

Disable conversion

Enable 

Enable conversion

◆ ESys11

Dynamic resorting if indices in assignment/data statements are not in natural order

Enumerator
AutomaticOptimization 

Automatic optimization/restructuring of data

NoOptimization 

No optimization

AlwaysOptimize 

Always optimize/restructure

◆ ESysOut

Solver Status file reporting option

Enumerator
SuppressAdditionalSolverOutput 

Suppress additional solver generated output

IncludeAdditionalSolverOutput 

Include additional solver generated output

◆ ETFormat

Time format

Enumerator
Colon 

Time as hh:mm:ss

Dot 

Time as hh.mm.ss

◆ ETraceOpt

Trace file format option

Enumerator
SolverAndGAMSStepTraceWOHeaders 

Solver and GAMS step trace without headers

SolverAndGAMSStepTrace 

Solver and GAMS step trace

SolverStepTraceOnly 

Solver step trace only

TraceFileFormatGAMSPerformanceWorld 

Trace file format used for GAMS performance world

TraceFileFormatSupportingNLPEC 

Trace file format supporting NLPEC

TraceFileWithAllAvailableTraceFields 

Trace file with all available trace fields

◆ EZeroResRep

Report underflow as a warning when abs(results) LE ZeroRes and result set to zero

Enumerator
NoWarning 

No warning when a rounding occurs because of ZeroRes

IssueWarning 

Issue warnings whenever a rounding occurs because of ZeroRes

Member Function Documentation

◆ Dispose()

void GAMS.GAMSOptions.Dispose ( )
inline

Free unmanaged ressources.

◆ Export()

void GAMS.GAMSOptions.Export ( string  filePath)
inline

Write GAMSOptions into a parameter file

Parameters
filePathThe path used to write the parameter file. A relative path is relative to the GAMS working directory.

◆ ResetToDefault()

void GAMS.GAMSOptions.ResetToDefault ( )
inline

Reset all GAMS options to default

Member Data Documentation

◆ Defines

Dictionary<string, string> GAMS.GAMSOptions.Defines

GAMS Dash Options

◆ IDir

List<string> GAMS.GAMSOptions.IDir

Input file directories (up to 40 are allowed)

Property Documentation

◆ Action

EAction GAMS.GAMSOptions.Action
getset

GAMS processing request

◆ AllModelTypes

string GAMS.GAMSOptions.AllModelTypes
set

Set default solver for all model types which the solver can handle

◆ AppendExpand

EAppendExpand GAMS.GAMSOptions.AppendExpand
getset

Expand file append option

◆ AppendOut

EAppendOut GAMS.GAMSOptions.AppendOut
getset

Output file append option

◆ AsyncSolLst

EAsyncSolLst GAMS.GAMSOptions.AsyncSolLst
getset

Print solution listing when asynchronous solve (Grid or Threads) is used

◆ Bratio

double GAMS.GAMSOptions.Bratio
getset

Basis acceptance threshold

◆ Case

ECase GAMS.GAMSOptions.Case
getset

Output case option for LST file

◆ CErr

int GAMS.GAMSOptions.CErr
getset

Compile time error limit

◆ CharSet

ECharSet GAMS.GAMSOptions.CharSet
getset

Character set flag

◆ CNS

string GAMS.GAMSOptions.CNS
getset

Default CNS solver

◆ DFormat

EDFormat GAMS.GAMSOptions.DFormat
getset

Date format

◆ DNLP

string GAMS.GAMSOptions.DNLP
getset

Default DNLP solver

◆ DomLim

int GAMS.GAMSOptions.DomLim
getset

Domain violation limit solver default

◆ DumpOpt

EDumpOpt GAMS.GAMSOptions.DumpOpt
getset

Writes preprocessed input to the file input.dmp

◆ DumpParms

EDumpParms GAMS.GAMSOptions.DumpParms
getset

GAMS parameter logging

◆ DumpParmsLogPrefix

string GAMS.GAMSOptions.DumpParmsLogPrefix
getset

Prefix of lines triggered by DumpParms>1

◆ EMP

string GAMS.GAMSOptions.EMP
getset

Default EMP solver

◆ ErrMsg

EErrMsg GAMS.GAMSOptions.ErrMsg
getset

Placing of compilation error messages

◆ ErrorLog

int GAMS.GAMSOptions.ErrorLog
getset

Max error message lines written to the log for each error

◆ ETLim

double GAMS.GAMSOptions.ETLim
getset

Elapsed time limit in seconds

◆ ExecErr

int GAMS.GAMSOptions.ExecErr
getset

Execution time error limit

◆ ExecMode

EExecMode GAMS.GAMSOptions.ExecMode
getset

Limits on external programs that are allowed to be executed

◆ Expand

string GAMS.GAMSOptions.Expand
getset

Expanded (include) input file name

◆ FDDelta

double GAMS.GAMSOptions.FDDelta
getset

Step size for finite differences

◆ FDOpt

EFDOpt GAMS.GAMSOptions.FDOpt
getset

Options for finite differences

◆ FErr

string GAMS.GAMSOptions.FErr
getset

Alternative error message file

◆ FileCase

EFileCase GAMS.GAMSOptions.FileCase
getset

Casing of new file names (put, gdx, ref etc.)

◆ FileStem

string GAMS.GAMSOptions.FileStem
getset

Sets the file stem for output files which use the input file name as stem by default

◆ ForceOptFile

int GAMS.GAMSOptions.ForceOptFile
getset

Overwrites other option file section mechanism

◆ ForceWork

EForceWork GAMS.GAMSOptions.ForceWork
getset

Force GAMS systems to process save files for example with an execution error

◆ ForLim

int GAMS.GAMSOptions.ForLim
getset

GAMS looping limit

◆ GDX

string GAMS.GAMSOptions.GDX
getset

Gams data exchange file name

◆ gdxCompress

EgdxCompress GAMS.GAMSOptions.gdxCompress
getset

Compression of generated GDX file

◆ gdxConvert

EgdxConvert GAMS.GAMSOptions.gdxConvert
getset

Version of GDX files generated (for backward compatibility)

◆ gdxUels

EgdxUels GAMS.GAMSOptions.gdxUels
getset

Unload labels or UELs to GDX either squeezed or full

◆ GridDir

string GAMS.GAMSOptions.GridDir
getset

Grid file directory

◆ GridScript

string GAMS.GAMSOptions.GridScript
getset

Grid submission script

◆ HeapLimit

double GAMS.GAMSOptions.HeapLimit
getset

Maximum Heap size allowed in MB

◆ HoldFixed

EHoldFixed GAMS.GAMSOptions.HoldFixed
getset

Treat fixed variables as constants

◆ Integer1

int GAMS.GAMSOptions.Integer1
getset

Integer communication cell N

◆ Integer2

int GAMS.GAMSOptions.Integer2
getset

Integer communication cell N

◆ Integer3

int GAMS.GAMSOptions.Integer3
getset

Integer communication cell N

◆ Integer4

int GAMS.GAMSOptions.Integer4
getset

Integer communication cell N

◆ Integer5

int GAMS.GAMSOptions.Integer5
getset

Integer communication cell N

◆ InteractiveSolver

EInteractiveSolver GAMS.GAMSOptions.InteractiveSolver
getset

Allow solver to interact via command line input

◆ IntVarUp

EIntVarUp GAMS.GAMSOptions.IntVarUp
getset

Set default upper bound on integer variables

◆ IterLim

int GAMS.GAMSOptions.IterLim
getset

Iteration limit of solver

◆ JobTrace

string GAMS.GAMSOptions.JobTrace
getset

Job trace string to be written to the trace file at the end of a GAMS job

◆ Keep

EKeep GAMS.GAMSOptions.Keep
getset

Controls keeping or deletion of process directory and scratch files

◆ LibIncDir

string GAMS.GAMSOptions.LibIncDir
getset

LibInclude directory

◆ License

string GAMS.GAMSOptions.License
getset

Use alternative license file

◆ LimCol

int GAMS.GAMSOptions.LimCol
getset

Maximum number of columns listed in one variable block

◆ LimRow

int GAMS.GAMSOptions.LimRow
getset

Maximum number of rows listed in one equation block

◆ LogLine

ELogLine GAMS.GAMSOptions.LogLine
getset

Amount of line tracing to the log file

◆ LP

string GAMS.GAMSOptions.LP
getset

Default LP solver

◆ MaxProcDir

int GAMS.GAMSOptions.MaxProcDir
getset

Maximum number of 225* process directories

◆ MCP

string GAMS.GAMSOptions.MCP
getset

Default MCP solver

◆ MINLP

string GAMS.GAMSOptions.MINLP
getset

Default MINLP solver

◆ MIP

string GAMS.GAMSOptions.MIP
getset

Default MIP solver

◆ MIQCP

string GAMS.GAMSOptions.MIQCP
getset

Default MIQCP solver

◆ MPEC

string GAMS.GAMSOptions.MPEC
getset

Default MPEC solver

◆ NLP

string GAMS.GAMSOptions.NLP
getset

Default NLP solver

◆ NodLim

int GAMS.GAMSOptions.NodLim
getset

Node limit in branch and bound tree

◆ NoNewVarEqu

ENoNewVarEqu GAMS.GAMSOptions.NoNewVarEqu
getset

Triggers a compilation error when new equations or variable symbols are introduced

◆ On115

EOn115 GAMS.GAMSOptions.On115
getset

Generate errors for unknown unique element in an equation

◆ OptCA

double GAMS.GAMSOptions.OptCA
getset

Absolute Optimality criterion solver default

◆ OptCR

double GAMS.GAMSOptions.OptCR
getset

Relative Optimality criterion solver default

◆ OptDir

string GAMS.GAMSOptions.OptDir
getset

Option file directory

◆ OptFile

int GAMS.GAMSOptions.OptFile
getset

Default option file

◆ Output

string GAMS.GAMSOptions.Output
getset

Listing file name

◆ PageContr

EPageContr GAMS.GAMSOptions.PageContr
getset

Output file page control option

◆ PageSize

int GAMS.GAMSOptions.PageSize
getset

Output file page size (=0 no paging)

◆ PageWidth

int GAMS.GAMSOptions.PageWidth
getset

Output file page width

◆ PLicense

string GAMS.GAMSOptions.PLicense
getset

Privacy license file name

◆ PrefixLoadPath

EPrefixLoadPath GAMS.GAMSOptions.PrefixLoadPath
getset

Prepend GAMS system directory to library load path

◆ Profile

int GAMS.GAMSOptions.Profile
getset

Execution profiling

◆ ProfileFile

string GAMS.GAMSOptions.ProfileFile
getset

Write profile information to this file

◆ ProfileTol

double GAMS.GAMSOptions.ProfileTol
getset

Minimum time a statement must use to appear in profile generated output

◆ PutDir

string GAMS.GAMSOptions.PutDir
getset

Put file directory

◆ PyMultInst

EPyMultInst GAMS.GAMSOptions.PyMultInst
getset

GAMS/Python Multiple Instance Interpreter

◆ PySetup

EPySetup GAMS.GAMSOptions.PySetup
getset

GAMS/Python Setup

◆ QCP

string GAMS.GAMSOptions.QCP
getset

Default QCP solver

◆ Reference

string GAMS.GAMSOptions.Reference
getset

Symbol reference file

◆ ResLim

double GAMS.GAMSOptions.ResLim
getset

Wall-clock time limit for solver

◆ RMINLP

string GAMS.GAMSOptions.RMINLP
getset

Default RMINLP solver

◆ RMIP

string GAMS.GAMSOptions.RMIP
getset

Default RMIP solver

◆ RMIQCP

string GAMS.GAMSOptions.RMIQCP
getset

Default RMIQCP solver

◆ RMPEC

string GAMS.GAMSOptions.RMPEC
getset

Default RMPEC solver

◆ SavePoint

ESavePoint GAMS.GAMSOptions.SavePoint
getset

Save solver point in GDX file

◆ ScriptExit

string GAMS.GAMSOptions.ScriptExit
getset

Program or script to be executed at the end of a GAMS run

◆ Seed

int GAMS.GAMSOptions.Seed
getset

Random number seed

◆ SolPrint

ESolPrint GAMS.GAMSOptions.SolPrint
getset

Solution report print option

◆ SolveLink

ESolveLink GAMS.GAMSOptions.SolveLink
getset

Solver link option

◆ StepSum

EStepSum GAMS.GAMSOptions.StepSum
getset

Summary of computing resources used by job steps

◆ strictSingleton

EstrictSingleton GAMS.GAMSOptions.strictSingleton
getset

Error if assignment to singleton set has multiple elements

◆ StringChk

EStringChk GAMS.GAMSOptions.StringChk
getset

String substitution options

◆ Suppress

ESuppress GAMS.GAMSOptions.Suppress
getset

Compiler listing option

◆ Symbol

string GAMS.GAMSOptions.Symbol
getset

Symbol table file

◆ SymPrefix

string GAMS.GAMSOptions.SymPrefix
getset

Prefix all symbols encountered during compilation by the specified string in work file

◆ Sys10

ESys10 GAMS.GAMSOptions.Sys10
getset

Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer

◆ Sys11

ESys11 GAMS.GAMSOptions.Sys11
getset

Dynamic resorting if indices in assignment/data statements are not in natural order

◆ Sys12

int GAMS.GAMSOptions.Sys12
getset

Pass model with generation errors to solver

◆ SysIncDir

string GAMS.GAMSOptions.SysIncDir
getset

SysInclude directory

◆ SysOut

ESysOut GAMS.GAMSOptions.SysOut
getset

Solver Status file reporting option

◆ TabIn

int GAMS.GAMSOptions.TabIn
getset

Tab spacing

◆ TFormat

ETFormat GAMS.GAMSOptions.TFormat
getset

Time format

◆ Threads

int GAMS.GAMSOptions.Threads
getset

Number of threads to be used by a solver

◆ ThreadsAsync

int GAMS.GAMSOptions.ThreadsAsync
getset

Number of threads to be used for asynchronous solve (solveLink=6)

◆ Timer

int GAMS.GAMSOptions.Timer
getset

Instruction timer threshold in milli seconds

◆ Trace

string GAMS.GAMSOptions.Trace
getset

Trace file name

◆ TraceLevel

int GAMS.GAMSOptions.TraceLevel
getset

Solvestat threshold used in conjunction with action=GT

◆ TraceOpt

ETraceOpt GAMS.GAMSOptions.TraceOpt
getset

Trace file format option

◆ User1

string GAMS.GAMSOptions.User1
getset

User string N

◆ User2

string GAMS.GAMSOptions.User2
getset

User string N

◆ User3

string GAMS.GAMSOptions.User3
getset

User string N

◆ User4

string GAMS.GAMSOptions.User4
getset

User string N

◆ User5

string GAMS.GAMSOptions.User5
getset

User string N

◆ Warnings

int GAMS.GAMSOptions.Warnings
getset

Number of warnings permitted before a run terminates

◆ WorkFactor

double GAMS.GAMSOptions.WorkFactor
getset

Memory Estimate multiplier for some solvers

◆ WorkSpace

double GAMS.GAMSOptions.WorkSpace
getset

Work space for some solvers in MB

◆ ZeroRes

double GAMS.GAMSOptions.ZeroRes
getset

The results of certain operations will be set to zero if abs(result) LE ZeroRes

◆ ZeroResRep

EZeroResRep GAMS.GAMSOptions.ZeroResRep
getset

Report underflow as a warning when abs(results) LE ZeroRes and result set to zero