whatIf? Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Projecting Share Variables into Simulation Time ======

Projecting share variables from history into the simulation time using a saturating projection is a common way to create the business as usual data for these variables.  

To find the sub-routine related files look in:
\\maxwell\whatif\whatifdocs\toolSubroutines\satProj


===== Example call to the sub-routine =====

There is a subroutine which can be hooked into your model and then called from views which does saturated projections with several parameters. 

Here's some reference code you would put in your view to call the sub routine and below that is the code for the sub routine itself:

<code>
! NOTE these informants should be put into your model then these lines should not be included when calling the sub routine
skipto afterInformants
localinformant yearInfoSet[] = create (; object=set, \
	desc="defaults wrt projection year", \
	elemName1 = "min", \
	elemName2 = "max", \
	elemName3 = "default", \
	elemName4 = "timeDimNum")
localinformant boundsInfoSet[] = create (; object=set, \
	desc="defaults wrt bounds checking", \
	elemName1 = "setMax", \
	elemName2 = "maxVal", \
	elemName3 = "setMin", \
	elemName4 = "minVal")
localinformant normInfoSet[] = create (; object=set, \
	desc="defaults wrt normalizing", \
	elemName1 = "doRenorm", \
	elemName2 = "normDimNum") 		
afterInformants:

local varHis[upperdims,timeseq] = newSizeShrPU[cr,vcld,t][1]
local varResult[upperdims,timeseq] = newSizeShrPU[cr,vcld,t][3]

local yearInfoForProj[yearInfoSet] = create (; dim=yearInfoSet, dataType=integer)
yearInfoForProj[yearInfoSet] = insert (1982; yearInfoSet:min)
yearInfoForProj[yearInfoSet] = insert (2000; yearInfoSet:max)
yearInfoForProj[yearInfoSet] = insert (1982; yearInfoSet:default)
yearInfoForProj[yearInfoSet] = insert (3; yearInfoSet:timeDimNum)

local boundsChecking[boundsInfoSet] = create (; dim=boundsInfoSet)
boundsChecking[boundsInfoSet] = insert (1.0; boundsInfoSet:setMax)
boundsChecking[boundsInfoSet] = insert (1.0; boundsInfoSet:maxVal)
boundsChecking[boundsInfoSet] = insert (1.0; boundsInfoSet:setMin)
boundsChecking[boundsInfoSet] = insert (0.0; boundsInfoSet:minVal)

local normInfo[normInfoSet] = create (; dim=normInfoSet, dataType=integer)
normInfo[yearInfoSet] = insert (1; normInfoSet:doRenorm)
normInfo[yearInfoSet] = insert (2; normInfoSet:normDimNum)

local percentChgFromLYHis[] = create (; data=50.0)

local defaultJoin[] = create (; data=2) ! join trend 

tool $informPath/satProjFromHist.t \
		yearInfoForProj[yearInfoSet] \
		boundsChecking[boundsInfoSet] \
		normInfo[normInfoSet] \
		percentChgFromLYHis[] \
		defaultJoin[] \
		varHis[upperdims,timeseq] \
		varResult[upperdims,timeseq] 

newSizeShrPU[cr,vcld,t][3] = varResult[upperdims,timeseq]

newPUVehShr[cr,vcld->vpsld,ts][3] = mapcat (newSizeShrPU[cr,vcld,t][3] * \
	newEngineShrPU[cr,vcld,vpsld,th][2]; category=vcldCOvpsld, \
desc=$viewMenuChoices)


</code>

===== How to load =====
Go to your informants window in SAMM and load the informs.samm file from your sub-routine directory
whatIf? Wiki

User Tools

Site Tools

Page Tools
