Skip to content

Commit

Permalink
Added missing descriptions for opt. modules
Browse files Browse the repository at this point in the history
  • Loading branch information
@lochel @OpenModelica-Hudson
lochel authored and OpenModelica-Hudson committed Sep 18, 2015
1 parent 707bc0b commit 8d8549f
Showing 1 changed file with 42 additions and 41 deletions.
83 changes: 42 additions & 41 deletions Compiler/Util/Flags.mo
View file
Expand Up @@ -687,38 +687,39 @@ constant ConfigFlag PRE_OPT_MODULES = CONFIG_FLAG(12, "preOptModules",
"encapsulateWhenConditions"
}),
SOME(STRING_DESC_OPTION({
("addInitialStmtsToAlgorithms", Util.gettext("Expands all algorithms with initial statements for outputs.")),
("clockPartitioning", Util.gettext("Does the clock partitioning.")),
("comSubExp", Util.gettext("replaces common sub expressions")),
("CSE_EachCall", Util.gettext("Common Function Call Elimination")),
("unitChecking", Util.gettext("advanced unit checking: 1. calculation of unspecified unit information for variables; 2. unit consistency check for equations")),
("removeSimpleEquations", removeSimpleEquationDesc),
("inlineArrayEqn", Util.gettext("This module expands all array equations to scalar equations.")),
("evaluateFinalParameters", Util.gettext("Structural parameters and parameters declared as final are evalutated and replaced with their value in other vars. They may no longer be changed in the init file.")),
("dumpDAE", Util.gettext("dumps the DAE representation of the current transformation state")),
("dumpDAEXML", Util.gettext("dumps the DAE as xml representation of the current transformation state")),
("encapsulateWhenConditions", Util.gettext("This module replaces each when condition with a boolean variable.")),
("evalFunc", Util.gettext("evaluates functions partially")),
("evaluateAllParameters", Util.gettext("Evaluates all parameters to increase simulation speed.")),
("evaluateEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateFinalParameters", Util.gettext("Structural parameters and parameters declared as final are evalutated and replaced with their value in other vars. They may no longer be changed in the init file.")),
("evaluateReplaceEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceProtectedFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final or protected are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateAllParameters", Util.gettext("Evaluates all parameters to increase simulation speed.")),
("removeEqualFunctionCalls", Util.notrans("DESCRIBE ME")),
("expandDerOperator", Util.notrans("Expands der(expr) using Derive.differentiteExpTime.")),
("findStateOrder", Util.notrans("Sets derivative information to states.")),
("inlineArrayEqn", Util.gettext("This module expands all array equations to scalar equations.")),
("inputDerivativesForDynOpt", Util.gettext("Allowed derivatives of inputs in dyn. optimization.")),
("introduceDerAlias", Util.notrans("Adds for every der-call an alias equation e.g. dx = der(x).")),
("removeEqualFunctionCalls", Util.notrans("Detects equal function calls of the form a=f(b) and c=f(b) and substitutes them to get speed up.")),
("removeProtectedParameters", Util.gettext("Replace all parameters with protected=true in the system.")),
("removeSimpleEquations", removeSimpleEquationDesc),
("removeUnusedParameter", Util.gettext("Strips all parameter not present in the equations from the system.")),
("removeUnusedVariables", Util.gettext("Strips all variables not present in the equations from the system.")),
("clockPartitioning", Util.gettext("Does the clock partitioning.")),
("stateMachineElab", Util.gettext("Does the elaboration of state machines.")),
("expandDerOperator", Util.notrans("DESCRIBE ME")),
("findStateOrder", Util.notrans("DESCRIBE ME")),
("introduceDerAlias", Util.notrans("Adds for every der-call an alias equation e.g. dx = der(x).")),
("inputDerivativesForDynOpt", Util.gettext("Allowed derivatives of inputs in dyn. optimization.")),
("simplifyIfEquations", Util.gettext("Tries to simplify if equations by use of information from evaluated parameters.")),
("replaceEdgeChange", Util.gettext("Replace edge(b) = b and not pre(b) and change(b) = v <> pre(v).")),
("residualForm", Util.gettext("Transforms simple equations x=y to zero-sum equations 0=y-x.")),
("addInitialStmtsToAlgorithms", Util.gettext("Expands all algorithms with initial statements for outputs.")),
("resolveLoops", Util.gettext("resolves linear equations in loops")),
("evalFunc", Util.gettext("evaluates functions partially")),
("comSubExp", Util.gettext("replaces common sub expressions")),
("dumpDAE", Util.gettext("dumps the DAE representation of the current transformation state")),
("dumpDAEXML", Util.gettext("dumps the DAE as xml representation of the current transformation state")),
("encapsulateWhenConditions", Util.gettext("This module replaces each when condition with a boolean variable."))
("simplifyIfEquations", Util.gettext("Tries to simplify if equations by use of information from evaluated parameters.")),
("sortEqnsVars", Util.notrans("Heuristic sorting for equations and variables. This module requires +d=sortEqnsAndVars.")),
("stateMachineElab", Util.gettext("Does the elaboration of state machines.")),
("unitChecking", Util.gettext("advanced unit checking: 1. calculation of unspecified unit information for variables; 2. unit consistency check for equations"))
})),
Util.gettext("Sets the pre optimization modules to use in the back end. See --help=optmodules for more info."));

Expand Down Expand Up @@ -800,15 +801,15 @@ constant ConfigFlag POST_OPT_MODULES = CONFIG_FLAG(16, "postOptModules",
}),
SOME(STRING_DESC_OPTION({
("addInitialStmtsToAlgorithms", Util.gettext("Expands all algorithms with initial statements for outputs.")),
("addScaledVars", Util.notrans("DESCRIBE ME")),
("addScaledVars", Util.notrans("added var_norm = var/nominal, where var is state")),
("addTimeAsState", Util.gettext("Experimental feature: this replaces each occurrence of variable time with a new introduced state $time with equation der($time) = 1.0")),
("calculateStateSetsJacobians", Util.gettext("Generates analytical Jacobian for dynamic state selection sets.")),
("calculateStrongComponentJacobians", Util.gettext("Generates analytical Jacobian for non-linear strong components.")),
("constantLinearSystem", Util.gettext("Evaluates constant linear systems (a*x+b*y=c; d*x+e*y=f; a,b,c,d,e,f are constants) at compile-time.")),
("countOperations", Util.gettext("Count the mathematical operations of the system.")),
("CSE", Util.gettext("Common Sub-expression Elimination")),
("detectJacobianSparsePattern", Util.gettext("Detects the sparse pattern for Jacobian A.")),
("dumpComponentsGraphStr", Util.notrans("DESCRIBE ME")),
("dumpComponentsGraphStr", Util.notrans("Dumps the assignment graph used to determine strong components to format suitable for Mathematica")),
("dumpDAE", Util.gettext("dumps the DAE representation of the current transformation state")),
("dumpDAEXML", Util.gettext("dumps the DAE as xml representation of the current transformation state")),
("evaluateEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
Expand All @@ -817,32 +818,32 @@ constant ConfigFlag POST_OPT_MODULES = CONFIG_FLAG(16, "postOptModules",
("evaluateReplaceEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceProtectedFinalEvaluateParameters", Util.notrans("DESCRIBE ME")),
("evaluateReplaceProtectedFinalEvaluateParameters", Util.notrans("Structural parameters and parameters declared as final and protected parameters are removed and replaced with their value. They may no longer be changed in the init file.")),
("extendDynamicOptimization", Util.gettext("Move loops to constraints.")),
("generateSymbolicJacobian", Util.gettext("Generates symbolic Jacobian matrix, where der(x) is differentiated w.r.t. x. This matrix can be used to simulate with dasslColorSymJac.")),
("generateSymbolicLinearization", Util.gettext("Generates symbolic linearization matrices A,B,C,D for linear model:\n\t\t:math:`\\dot{x} = Ax + Bu`\n\t:math:`ty = Cx +Du`")),
("inlineArrayEqn", Util.gettext("This module expands all array equations to scalar equations.")),
("inputDerivativesUsed", Util.gettext("Checks if derivatives of inputs are need to calculate the model.")),
("lateInlineFunction", Util.gettext("Perform function inlining for function with annotation LateInline=true.")),
("partlintornsystem",Util.notrans("partitions linear torn systems.")),
("recursiveTearing", Util.notrans("DESCRIBE ME")),
("reduceDynamicOptimization", Util.notrans("DESCRIBE ME")),
("relaxSystem", Util.notrans("DESCRIBE ME")),
("recursiveTearing", Util.notrans("inline and repeat tearing")),
("reduceDynamicOptimization", Util.notrans("Removes equations which are not needed for the calculations of cost and constraints. This module requires +d=reduceDynOpt.")),
("relaxSystem", Util.notrans("relaxation from gausian elemination")),
("removeConstants", Util.gettext("Remove all constants in the system.")),
("removeEqualFunctionCalls", Util.notrans("DESCRIBE ME")),
("removeEqualFunctionCalls", Util.notrans("Detects equal function calls of the form a=f(b) and c=f(b) and substitutes them to get speed up.")),
("removeInitializationStuff", Util.gettext("Does simplifications by removing initialization information like homotopy(..) and initial().")),
("removeSimpleEquations", removeSimpleEquationDesc),
("removeUnusedParameter", Util.gettext("Strips all parameter not present in the equations from the system.")),
("removeUnusedVariables", Util.notrans("DESCRIBE ME")),
("removeUnusedParameter", Util.gettext("Strips all parameter not present in the equations from the system to get speed up for compilation of target code.")),
("removeUnusedVariables", Util.notrans("Strips all variables not present in the equations from the system to get speed up for compilation of target code.")),
("reshufflePost", Util.gettext("Reshuffles algebraic loops.")),
("simplifyComplexFunction", Util.notrans("DESCRIBE ME")),
("simplifyConstraints", Util.notrans("DESCRIBE ME")),
("simplifyLoops", Util.notrans("DESCRIBE ME")),
("simplifyComplexFunction", Util.notrans("Some simplifications on complex functions (complex refers to the internal data structure)")),
("simplifyConstraints", Util.notrans("Rewrites nonlinear constraints into box constraints if possible. This module requires +gDynOpt.")),
("simplifyLoops", Util.notrans("Simplifies algebraic loops. This modules requires +simplifyLoops.")),
("simplifyTimeIndepFuncCalls", Util.gettext("Simplifies time independent built in function calls like pre(param) -> param, der(param) -> 0.0, change(param) -> false, edge(param) -> false.")),
("simplifysemiLinear", Util.gettext("Simplifies calls to semiLinear.")),
("solveLinearSystem", Util.notrans("DESCRIBE ME")),
("solveSimpleEquations", Util.notrans("DESCRIBE ME")),
("symEuler", Util.notrans("DESCRIBE ME")),
("solveLinearSystem", Util.notrans("solve linear system with newton step")),
("solveSimpleEquations", Util.notrans("Solves simple equations")),
("symEuler", Util.notrans("Rewrites the ode system for implicit Euler method. This module requires +symEuler.")),
("tearingSystem", Util.notrans("For method selection use flag tearingMethod."))
})),
Util.gettext("Sets the post optimization modules to use in the back end. See --help=optmodules for more info."));
Expand Down Expand Up @@ -1163,12 +1164,12 @@ constant ConfigFlag INIT_OPT_MODULES = CONFIG_FLAG(78, "initOptModules",
("constantLinearSystem", Util.gettext("Evaluates constant linear systems (a*x+b*y=c; d*x+e*y=f; a,b,c,d,e,f are constants) at compile-time.")),
("extendDynamicOptimization", Util.gettext("Move loops to constraints.")),
("inputDerivativesUsed", Util.gettext("Checks if derivatives of inputs are need to calculate the model.")),
("recursiveTearing", Util.notrans("DESCRIBE ME")),
("reduceDynamicOptimization", Util.notrans("DESCRIBE ME")),
("simplifyComplexFunction", Util.notrans("DESCRIBE ME")),
("simplifyConstraints", Util.notrans("DESCRIBE ME")),
("simplifyLoops", Util.notrans("DESCRIBE ME")),
("solveSimpleEquations", Util.notrans("DESCRIBE ME")),
("recursiveTearing", Util.notrans("inline and repeat tearing")),
("reduceDynamicOptimization", Util.notrans("Removes equations which are not needed for the calculations of cost and constraints. This module requires +d=reduceDynOpt.")),
("simplifyComplexFunction", Util.notrans("Some simplifications on complex functions (complex refers to the internal data structure)")),
("simplifyConstraints", Util.notrans("Rewrites nonlinear constraints into box constraints if possible. This module requires +gDynOpt.")),
("simplifyLoops", Util.notrans("Simplifies algebraic loops. This modules requires +simplifyLoops.")),
("solveSimpleEquations", Util.notrans("Solves simple equations")),
("tearingSystem", Util.notrans("For method selection use flag tearingMethod."))
})),
Util.gettext("Sets the initialization optimization modules to use in the back end. See --help=optmodules for more info."));
Expand Down

0 comments on commit 8d8549f

Please sign in to comment.