Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: terminate generated equations with ~~| #120

Merged
merged 4 commits into from
Sep 27, 2021
Merged

fix: terminate generated equations with ~~| #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0928349
add ~~| to generated equations for compatibility with antlr4-vensim #7
ToddFincannon Sep 25, 2021
ddd2e09
run prettier
ToddFincannon Sep 25, 2021
ae7ebc0
build: revert to package-lock.json from develop, except preserve antl…
chrispcampbell Sep 27, 2021
e6af782
build: use antlr4-vensim@b7b90e3 (latest develop that includes fixes …
chrispcampbell Sep 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
},
"dependencies": {
"antlr4": "4.9.2",
"antlr4-vensim": "https://github.com/climateinteractive/antlr4-vensim#5baa4cf",
"antlr4-vensim": "https://github.com/climateinteractive/antlr4-vensim#b7b90e3",
"bufx": "^1.0.5",
"byline": "^5.0.0",
"chart.js": "^2.9.4",
Expand Down
28 changes: 15 additions & 13 deletions src/EquationReader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,9 @@ export default class EquationReader extends ModelReader {
let level = this.expandTrendFunction(fn, args)
let genSubs = this.genSubs(input, avgTime, init)
let aux = newAuxVarName()
this.addVariable(`${aux}${genSubs} = ZIDZ(${input} - ${level}${genSubs}, ${avgTime} * ABS(${level}${genSubs}))`)
this.addVariable(
`${aux}${genSubs} = ZIDZ(${input} - ${level}${genSubs}, ${avgTime} * ABS(${level}${genSubs})) ~~|`
)
this.var.trendVarName = canonicalName(aux)
this.var.references.push(this.var.trendVarName)
} else if (isNpvFunction(fn)) {
Expand All @@ -137,7 +139,7 @@ export default class EquationReader extends ModelReader {
let genSubs = this.genSubs(stream, discountRate, initVal, factor)
let aux = newAuxVarName()
// npv = (ncum + stream * TIME STEP * df) * factor
this.addVariable(`${aux}${genSubs} = (${level.ncum} + ${stream} * TIME STEP * ${level.df}) * ${factor}`)
this.addVariable(`${aux}${genSubs} = (${level.ncum} + ${stream} * TIME STEP * ${level.df}) * ${factor} ~~|`)
this.var.npvVarName = canonicalName(aux)
this.var.references.push(this.var.npvVarName)
} else if (isDelayFunction(fn)) {
Expand Down Expand Up @@ -388,7 +390,7 @@ export default class EquationReader extends ModelReader {
generateLookupArg(lookupArgCtx) {
// Generate a variable for a lookup argument found in the RHS.
let varName = newLookupVarName()
let eqn = `${varName}${lookupArgCtx.getText()}`
let eqn = `${varName}${lookupArgCtx.getText()} ~~|`
this.addVariable(eqn)
return canonicalName(varName)
}
Expand Down Expand Up @@ -455,7 +457,7 @@ export default class EquationReader extends ModelReader {
// If it has subscripts, the refId is still just the var name, because it is an apply-to-all array.
levelRefId = canonicalName(level)
}
let eqn = `${levelLHS} = INTEG((${input} - ${levelLHS}) / ${delay}, ${init})`
let eqn = `${levelLHS} = INTEG((${input} - ${levelLHS}) / ${delay}, ${init}) ~~|`
if (isSeparatedVar(this.var)) {
Model.addNonAtoAVar(canonicalName(level), [true])
}
Expand All @@ -482,7 +484,7 @@ export default class EquationReader extends ModelReader {
let genSubs = this.genSubs(input, avgTime, init)
let level = newLevelVarName()
let levelLHS = level + genSubs
let eqn = `${levelLHS} = INTEG((${input} - ${levelLHS}) / ${avgTime}, ${input} / (1 + ${init} * ${avgTime}))`
let eqn = `${levelLHS} = INTEG((${input} - ${levelLHS}) / ${avgTime}, ${input} / (1 + ${init} * ${avgTime})) ~~|`
this.addVariable(eqn)
// Add a reference to the new level var.
// If it has subscripts, the refId is still just the var name, because it is an apply-to-all array.
Expand All @@ -498,12 +500,12 @@ export default class EquationReader extends ModelReader {
// df = INTEG((-df * discount rate) / (1 + discount rate * TIME STEP), 1)
let df = newLevelVarName()
let dfLHS = df + genSubs
let dfEqn = `${dfLHS} = INTEG((-${dfLHS} * ${discountRate}) / (1 + ${discountRate} * TIME STEP), 1)`
let dfEqn = `${dfLHS} = INTEG((-${dfLHS} * ${discountRate}) / (1 + ${discountRate} * TIME STEP), 1) ~~|`
this.addVariable(dfEqn)
// ncum = INTEG(stream * df, init val)
let ncum = newLevelVarName()
let ncumLHS = ncum + genSubs
let ncumEqn = `${ncumLHS} = INTEG(${stream} * ${dfLHS}, ${initVal})`
let ncumEqn = `${ncumLHS} = INTEG(${stream} * ${dfLHS}, ${initVal}) ~~|`
this.addVariable(ncumEqn)
// Add references to the new level vars.
// If they have subscripts, the refIds are still just the var name, because they are apply-to-all arrays.
Expand Down Expand Up @@ -562,7 +564,7 @@ export default class EquationReader extends ModelReader {
if (isSeparatedVar(this.var)) {
Model.addNonAtoAVar(this.var.delayTimeVarName, [true])
}
let delayTimeEqn = `${delayTimeVarName}${genSubs} = ${delay}`
let delayTimeEqn = `${delayTimeVarName}${genSubs} = ${delay} ~~|`
this.addVariable(delayTimeEqn)
// Add a reference to the var, since it won't show up until code gen time.
this.var.references.push(canonicalVensimName(`${delayTimeVarName}${genSubs}`))
Expand Down Expand Up @@ -644,23 +646,23 @@ export default class EquationReader extends ModelReader {
this.generateDelayLevel(level2LHS, level2RefId, aux1LHS, aux2LHS, init)
this.generateDelayLevel(level1LHS, level1RefId, input, aux1LHS, init)
// Generate equations for the aux vars using the subs in the generated level var.
this.addVariable(`${aux1LHS} = ${level1LHS} / ${delay3}`)
this.addVariable(`${aux2LHS} = ${level2LHS} / ${delay3}`)
this.addVariable(`${aux3LHS} = ${level3LHS} / ${delay3}`)
this.addVariable(`${aux1LHS} = ${level1LHS} / ${delay3} ~~|`)
this.addVariable(`${aux2LHS} = ${level2LHS} / ${delay3} ~~|`)
this.addVariable(`${aux3LHS} = ${level3LHS} / ${delay3} ~~|`)
// Generate an aux var to hold the delay time expression.
this.var.delayTimeVarName = canonicalName(aux4)
if (isSeparatedVar(this.var)) {
Model.addNonAtoAVar(this.var.delayTimeVarName, [true])
}
this.addVariable(`${aux4LHS} = ${delay3}`)
this.addVariable(`${aux4LHS} = ${delay3} ~~|`)
// Add a reference to the var, since it won't show up until code gen time.
this.var.references.push(canonicalVensimName(`${aux4}${genSubs}`))
}
}
generateDelayLevel(levelLHS, levelRefId, input, aux, init) {
// Generate a level equation to implement DELAY.
// The parameters are model names. Return the refId of the generated level var.
let eqn = `${levelLHS} = INTEG(${input} - ${aux}, ${init})`
let eqn = `${levelLHS} = INTEG(${input} - ${aux}, ${init}) ~~|`
this.addVariable(eqn)
// Add a reference to the new level var.
this.refId = levelRefId
Expand Down