Home

JaamSim Manual (full)

1. Define ImageModel AusLogoModel Define OverlayImage AusLogo Define TextModel TitleTextModel ClockTextModel Define OverlayText Title Define OverlayClock Clock Define EntityGenerator Gen Define EntityConveyor GenToServ ServToSink Define Server Serv Define EntitySink Sink Define Queue ServQueue Define SimEntity Proto Define ExponentialDistribution GenIATDist GenIATDist UnitType TimeUnit Simulation Description Simulation run control inputs Simulation PauseTime Simulation RealTime TRUE Simulation ShowModelBuilder TRU Simulation ShowObjectSelector TRUE U Simulation ShowInputEditor TRU Simulation ShowOutputViewer TR Simulation ShowPropertyViewer FALSE Simulation ShowLogViewer FALSE Grid100x100 ColladaFile lt res gt shapes grid100x100 dae Axis ColladaFile lt res gt shapes axis text dae XY Grid Description Grid for the X Y plane 100 m x 100 m XY Grid Size 100 100 m XY Grid DisplayModel Grid100x100 XY Grid Movable FALSE C XYZ Axis Description Unit vectors XYZ Axis Alignment 0 4393409 0 4410096 0 4394292 XYZ Axis Size 1 125000 1 1568242 1 1266404 m XYZ Axis DisplayModel Axis XYZ Axis Show FALSE XYZ Axis Movable FALSE Viewl Description Default v
2. Open State Name Working idle Stopped Clearing_while Stopped 11 19 EntityContainer JaamSim User Manual Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below Entity last received by the Assemble object Number of entities received The total number of assembled parts that have been created The rate at which assembled parts have been created NumberProcessed Total Time The time at which the last entity was released Returns TRUE if entities are being processed Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open State Definitions Description Performing its normal service Available for senice but has no work to perform Senice has been suspended by the closure of one or more Thresholds The present senice activity is being completed before ceasing further operation The EntityContainer object is used to store a collection of entities for subsequent processing as a unit EntityContainer is a sub class of SimEntity and consequently includes the State output variable It can be passed to any object that can accept a SimEntity The Pack object is used to place entities in generated EntityContainers The Unpack object is used to remove the entities and to destroy the EntityContainer Default Graphic Keyword Description AttributeDefinitionList Spacing MaxPerLine O
3. Select the Title object and enter the following keyword under the Key Inputs tab in the Input Editor Changing the Model Title Object Keyword Value Title Format Getting Started with JaamSim O 2015 14 9 A n April 10 2015 usenc 2015 14 April 10 2015 JaamSim User Manual Changing the Model Title Defined Objects Simulation Controls Units Display Models Graphics Objects ou DisplayEntity P OverlayImage El OverlayText ee eile H QverlayClock a oon Tie for the natn mode C Getting Started with Jaamsim pt E a esem s e oO O O a lol x 2014 Jan 01 00 00 00 000 Input Editor Title Press Play again and Stop the simulation when ready to proceed Adjusting Model Graphics view Getting Started with JaamSim N A 2014 Jan 01 00 00 04 460 Au enco 2015 14 April 10 2015 JaamsSim User Manual 3 4 Step 4 Adding a Probability Distribution The simulation created thus far is not particularly interesting because the Proto entities are being generated in a uniform sequence To make the model more dynamic we will add a probability distribution to control when each Proto entity is generated From the Model Builder expand the Probability Distributions palette then create and rename an ExponentialDistr
4. Unlike other display objects the position of overlay objects is referenced to the corner of a view window and so the object does not move when the view is panned or zoomed These objects are useful for labelling view windows or displaying the model name and company logos Examples of Overlay Objects are the default Title Clock and Ausenco logo that are provided automatically when a new model is opened There are three types of overlay objects each corresponding to a different graphical object type The relationship between each overlay object its parent object type and its usage is summarized below Overlay Object and Usage Summary Overlay Object Parent Object Usage Overlaylmage DisplayEntity Static image Logos other graphics OverlayText Text Static or dynamic text Model name states rates OverlayClock Text Current time in the simulation model Each type of overlay object takes the keywords associated wih its parent object For instance the Format and TextHeight keywords must be supplied for an OverlayText object Additionally instead of the Basic Graphics keywords common to other display objects overlay objects have the following keywords Basic Graphics Inputs Keyword Description 7 A list of two numbers specifying the spacing in pixels between the left and top Sones comer of the View window and the object hee If TRUE the horizontal alignment is referenced to the right side of the vew window AlignRight instead of t
5. X Axis Keywords Description Title text for the x axis The unit to be used for the x axis The minimum value for the x axis The maximum value for the x axis The interval between x axis labels The Java format to be used for the tick mark values on the x axis A list of time values between StartTime and EndTime where vertical gridlines are inserted Colour of the vertical gridlines or a list corresponding to the colour of each gridline defined in XLines defined using a colour name or RGB values Y Axis Keywords Description Title text for the primary y axis The unit to be used for the primary y axis The minimum value for the y axis in units of the target method The maximum value for the y axis The interval between y axis labels The Java format to be used for the tick mark values on the y axis A list of values at which to insert horizontal gridlines Colour of the horizontal gridlines defined using a colour name or RGB values 30 Ausenc O 2015 14 April 10 2015 Keyword SecondaryY Axis Title SecondaryY AxisUnit SecondaryY AxisStart SecondaryY AxisEnd SecondaryY AxisInterval Secondary Y AxisLabelFormat 7 7 View JaamSim User Manual Secondary Y Axis Keywords Description Title text for the secondary y axis The unit to be used for the secondary y axis The minimum value for the secondary y axis The maximum value for the secondary y axis The interval between secondary y axis labels The Java
6. a Probability Distribution or an Expression The list of dimensionless coefficients for the polynomial function The scale to apply to the input value The scale can be a constant value or any entity that returns a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression i Ausenc O JaamSim User Manual Outputs Output Name Description SimTime The present simulation time Value The present output value for this Calculation Object 12 4 Integrator The Integrator object integrates the input value with respect to time by performing a right Riemann sum t 0 simulation time zero t 1 t n previous update times generated by the Controller dt i t i t i 1 InputValue i input value at update time t i Sum InputValue 1 dt 1 InputValue 2 dt 2 InputValue n dt n Value InitialValue Sum InputValue SimTime t n Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object Controller The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which SequenceNumber calculations are performed A calculation with a lower value is executed before the ones with higher values Unit Type The unit type for the value retume
7. aatres ea ge TT x Swatches He RSE 4 6 Output Viewer The Output Viewer displays the pre programmed outputs that are available for the selected object Output values are updated continuously as the simulation progresses In addition any user defined Attributes will also appear in Output Viewer Numerical outputs are displayed in SI units unless a particular unit is specified using the DisplayedUnit keyword for Simulation The output system provided by JaamSim is the basis for all model graphics and reports An object can be animated by connecting a pre defined Action in its DisplayModel see Display Models Palette to one of its Outputs The figure below shows the outputs provided for a Queue object Output Viewer Output Viewer Quewel 0 426809 h 0 0 0 0 0 0 rad 0 0 0 0 0 0 0 431764 0 365344 0 0 m 18 0000 16 0000 x E I8 oo ReleaseTme NaN 0 493151 2 431863 0 0 m 2 00000 0 728288 0 00000 3 00000 495447 0 836209 0 0172689 h 0 0104132 fs Quevel 22 43505128277 507 7627542121376 oaa Ausenc O 2015 14 April 10 2015 JaamsSim User Manual 5 Simulation Controls Palette The Simulation object named Simulation is used to store inputs used to define basic parameters of the model such as run duration The Simulation object is created automatically when a new model is started It does need to be dragged and dropped by the user and for this
8. d y km bbl mbbl mmbbl any volume unit h d y degrees rad h deg s deg h kWh kWh m kWh t kW MW h d t m kt m kPa psi P cP cm mm in h d w y Units are mandatory for most numerical inputs with the exception of pure numbers or ratios Inputs that are pure numbers are indicated by the DimensionlessUnit type All Unit objects have the same keywords Keyword ConversionFactorToSI Key Inputs Description Two numbers that specify the numerator and denominator respectively of the multiplicative factor to convert from the new unit to SI base units 24 Ausenc O 2015 14 April 10 2015 JaamSim User Manual 6 1 Defining a New Unit In addition to the pre existing unit types defined in JaamSim the user can specify new units using a Unit object A new unit object can be created by right clicking on an existing unit and selecting duplicate After the unit is renamed appropriately its ConversionFactorToSl input can be set to the desired value For example to create a new TimeUnit for fortnight two weeks the ConversionFactorToSI keyword should be set to 1209600 1 Once this has been done keyword values in units of time wil subsequently support the Fortnight unit when values are entered 6 2 Changing the Units for Model Outputs Model outputs are normally shown in the appropriate SI unit in the Output Viewer In many cases it is useful to show outputs in another unit F
9. 2015 JaamsSim User Manual FlowArea 0 25 PI Diameter 2 Velocity FlowRate FlowArea DynamicPressure 0 5 Density Velocity abs Velocity RenoldsNumber abs Velocity Diameter Density Viscosity Default Graphic Keyword Description Previous Diameter MaxFlowRate MaxPressure MaxPressureLoss SpeedController Output Name SimTime FlowArea Velocity InletPressure DynamicPressure ReynoldsNumber OutletPressure Key Inputs Description Optional free form text that describes the object The upstream flow component that feeds the tank The diameter of the cylindrical tank The maximum volumetric flow rate that the pump can generate The maximum static pressure that the pump can generate occurs at zero flow rate The maximum static pressure loss for the pump occurs at the maximum flow rate A Calculation entity that returns relative speed for the pump 0 0 zero speed 1 0 maximum speed Outputs Description The present simulation time Cross sectional area of the pump s outlet The velocity of the fluid through the pump The static pressure at the inlet to the pump The dynamic pressure for the fluid in the pump The Reynolds number for the fluid in the pump The static pressure at the outlet from the pump O 7 Ausenc 2015 14 April 10 2015 JaamsSim User Manual 14 Advanced Topics A number of more advanced features of JaamSim are discussed in this section List of
10. 250 250 255 255 252 255 255 255 245 255 210 222 227 244 255 237 255 255 255 107 142 128 255 255 250 248 250 245 255 230 236 232 183 207 215 165 134 102 250 245 245 240 235 239 235 230 228 228 222 222 218 180 184 168 164 153 145 128 125 97 89 47 35 240 224 210 220 205 220 140 139 170 107 87 32 11 31 240 238 230 230 215 213 205 201 196 181 173 179 185 140 135 105 96 18 33 Colour Name gray40 gray39 gray38 gray37 gray36 gray35 gray34 gray33 gray32 gray31 gray30 gray29 gray28 gray27 gray26 gray25 gray24 gray23 gray22 gray21 gray20 gray19 gray18 gray17 gray16 gray15 gray14 gray13 gray12 gray11 gray10 gray9 gray8 gray7 gray6 gray5 gray4 gray3 gray2 gray1 black JaamSsim User Manual Colour R 102 Ausenc G B 102 102 99 99 97 97 4 94 92 92 89 89 87 87 84 84 82 82 79 79 7 7 74 74 71 71 69 69 66 66 64 64 61 61 59 59 56 56 54 54 51 51 48 48 46 46 43 43 41 At 38 38 36 36 33 33 31 31 28 28 26 26 23 23 20 20 18 18 15 15 13 13 10 10 8 8 5 5 3 3 0 0 O JaamSim User Manual 16 Basic Example Input Configuration File RecordEdits Define ColladaModel Grid100x100 Axis Define DisplayEntity XY Grid XYZ Axis Define View Viewl
11. Graphic Ausenc O Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment AttributeAssignmentList Output Name State obj NumberAdded NumberProcessed ProcessingRate ReleaseTime 11 12 Branch JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which the received entity is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank The assignment equations to be performed on receipt of an entity Outputs Description Not used Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The Branch object directs an incoming entity to a destination that is chosen from a list of alternatives The value for the Choice keyword determines the destination that is chosen 1 first branch 2 second branch etc The input to Choice can be a constant value a DiscreteDistribution a TimeSeries or an Expression The use of an Expression allows the choice to
12. InputValue Value The MovingAverage object calculates the average value of the input over a given time interval t 0 simulation time zero t 1 t n previous update times generated by the Controller InputValue i input value at update time t 1 Value InputValue InputValue n InputValue n 1 InputValue n NumberOfSamples 2 InputValue NumberOfSamples Default Graphic Keyword Description Controller SequenceNumber Unit Type InoputValue NumberOfSamples Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher values The unit type for the value retumed by the calculation The input value for the present calculation The inputs can be a constant value or any entity that returns a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression The number of previous values over which to take the average i Ausencs 2015 14 April 10 2015 Output Name SimTime Value 12 9 SineWave JaamSim User Manual Outputs Description The present simulation time The present output val
13. JaamSim generates an input configuration file that contains all of the objects that have been created along with their input values JaamSim includes a number of built in palettes of objects Simulation Controls Units Display Models Graphics Objects Probability Distributions Basic Objects Process Flow Calculation Objects Fluid Objects The Simulation Controls Units and Display Models palettes contain objects that do not have a graphical representation and cannot be dragged and dropped by the user They appear in the Object Selector but not in the Model Builder The remaining palettes contain the standard objects that are needed for many simulation models A JaamSim application such as Ausenco s TLS will include additional palettes of objects created specifically for that application 4 4 Object Selector The Object Selector is an index of all the objects that have been created for the present model including ones that were created automatically by JaamSim Objects are grouped according to their palette and type in a tree format that mirrors the structure of the Model Builder A specific object can be selected either by clicking its node in the Object Selector or by clicking it in a view window The figure below shows the Object selector with the Graphics Objects and DisplayEntity nodes expanded 19 Ausenc O 2015 14 April 10 2015 JaamSsim User Manual Object Selector x Defined Objects W Simulation Controls E
14. The DisplayModel keyword determines the DisplayModel used by a DisplayEntity A 3D object will require a ColladaModel while a 2D picture will require a ImageModel The inputs for DisplayEntity determine the position size and orientation for the graphical object while the inputs for the DisplayModel determine the shape and appearance of the object One DisplayModel can be shared between multiple DisplayEntities This is an essential feature for the case of complex 3D content built from thousands or millions of triangles In this case a ColladaModel as subclass of DisplayModel stores 3D information that can be shared between multiple DisplayEntities The 3D content is loaded and stored only once even though it is displayed many times in various locations Even in the case of animated 3D content only one ColladaModel is needed to display a different animation state in each location The default appearance of a DisplayEntity is a grey cube lts appearance can be changed by right clicking the DisplayEntity in either a view window or the Object Selector and selecting Change Graphics The user can then select between the available DisplayModels or can create a new DisplayModel by importing a file in one of the supported 3D graphics formats The easiest way to create a new DisplayEntity for a 3D object or an image is to use the Import function provided in the Control Panel under File This method creates a new DisplayEntity that is connected to a new Di
15. appear as a single or multi segment line such as EntityConveyor and EntityDelay It cannot be used by other objects such as DisplayEntity that are intended for 3D or 2D graphics ScreenPointsModel has no inputs other than the standard ones for DisplayModels 8 5 ArrowModel The ArrowVodel is used to determine the graphics for the Arrow entity It has no inputs other than the standard ones for DisplayModels 8 6 GraphModel The GraphModel is used to determine the presentation style and proportions for various types of Graph objects To make the graph scalable to any size all length measurements are specified as fraction of the graph s total height O 34 Ausenc 2015 14 April 10 2015 JaamSim User Manual Key Inputs Keyword Description Title TextHeight Text height for the graph title Expressed as a fraction of the graph s total height XAxis Title TextHeight Text height for the x axis title Expressed as a fraction of the graph s total height YAxis Title TextHeight Text height for the y axis title Expressed as a fraction of the graph s total height Label TextHeight The text height for both x and y axis labels Expressed as a fraction of the graph s total height The gap between the graph title and the top of the graph Expressed as a fraction TitleGap of the graph s total height XAxisTitleGap The gap between the x axis labels and the y axis title Expressed as a fraction of the graph s total height XAxisLabelGap The
16. batch file using the command JaamSim exe runl cfg tags Here runl cfg is the name of the input file to be loaded and tags are the optional tags for the run Multiple tags must be separated by a space The following tags are supported Batch Mode Run Tags Tag Description Start the simulation immediately after the input file has been read and exit when the run has OE completed This tag is useful for batch file execution Minimize the graphical user interface making the simulation run faster when visualizations m or minimize are not required for instance in overnight simulation runs i Ausencs 2015 14 April 10 2015 JaamsSim User Manual A series of simulation runs can be executed one after the other by using a batch file that contains a series of these commands For example a batch file containing the following two lines would execute two runs runl cfg and run2 cfg JaamSim exe runl cfg fg b JaamSim exe run2 cfg b Note that the batch file and input configuration files must be in the same directory for this example to work 14 6 ScriptEntity The ScriptEntity object takes only one keyword which is the path to a script scr file Key Inputs Keyword Description Script Path to the file containing the scripting instructions to be loaded The script file contains sets of model configuration inputs preceded by the Time keyword belonging to the ScriptEntity object Originally develope
17. be a constant value a TimeSeries a Probability Distribution or an Expression The number of entities to be generated for each arrival time Can be a constant value a TimeSeries a Probability Distribution or an Expression The entity to be copied by the generator The maximum number of entities to be generated Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below Not used Not used The total number of entities that have been generated The rate at which entities are generated entities per second The time at which the last entity was released Returns TRUE if entities are being processed Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open The total number of entities generated by this generator Ausenc O 2015 14 April 10 2015 JaamSim User Manual State Definitions State Name Description Working Performing its normal service Idle Available for service but has no work to perform Stopped Service has been suspended by the closure of one or more Thresholds Clearing while Stopped The present senice activity is being completed before ceasing further operation 11 3 EntitySink The EntitySink object destroys an incoming entity Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefi
18. be made based on the attributes of the incoming entity Default Graphic Keyword Description AttributeDefinitionList TestEntity StateAssignment NextComponentList Choice 2015 14 April 10 2015 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank A list of possible objects to which an incoming entity can be passed A number that determines which downstream branch will be chosen for the incoming entity 1 first branch 2 second branch etc Can be a constant value a TimeSeries a Probability Distribution or an Expression A Ausencs Output Name State obj NumberAdded NumberProcessed ProcessingRate ReleaseTime 11 13 Duplicate JaamSim User Manual Outputs Description Not used Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The Duplicate object sends copies of the received entity to one or more objects Default Graphic lt Keyword Description Attr
19. commonly modelled in Ausenco s Transportation Logistics Simulator module shipping rail and terminal equipment The appearances of these objects are controlled by the additional DisplayModel keywords listed in the table below 35 Ausenc O 2015 14 April 10 2015 Keyword Shape FillColour OutlineColour Filled Dashed Bold JaamSim User Manual Key Inputs Description The graphical appearance of the object chosen from a selection of pre defined shapes The colour of the filled part of the display model defined by a colour keyword or RGB values The colour of the outline of the display model defined by a colour keyword or RGB values If TRUE the model will appear with a solid colour fill Otherwise the model will appear hollow If TRUE the display model outline will appear as a dashed line If TRUE the display model outline will appear thicker than normal 36 Ausenc O JaamsSim User Manual 9 Probability Distributions Palette The probability distributions palette provides a standard selection of theoretical distributions as well as user defined distributions 9 1 Theoretical Probability Distributions The following set of standard probability distributions are available The distributions were coded using algorithms adapted from Simulation Modeling amp Analysis 4th Edition by Averill M Law Random numbers for these distributions are generated by the Multiple Recursive Generator
20. developed by L Ecuyer Good Parameters and Implementations for Combined Multiple Recursive Random Number Generators Operations Res 47 159 164 1999a Supported Probability Distributions Distribution Name Description UniformDistribution oe samples with a constant probability between a minimum and maximum TriangularDistribution Generates samples from a triangular distribution between a minimum and maximum value The distribution peaks at its mode Normal Distribution Generates samples from a normal distribution ExponentialDistribution Generates samples from a negative exponential probability distribution ErlangDistribution Generates samples from an Erlang probability distribution GammabDistribution Generates samples from a Gamma probability distribution BetaDistribution Generates samples from a Beta probability distribution WeibullDistribution Generates samples from a Weibull probability distribution LogNormal Distribution Generates samples from a Log Normal probability distribution LogLogisticsDistribution Generates samples from a Log Logistics probability distribution 9 2 User Defined Probability Distributions Users can define a distribution point by point if required A user defined distribution can be either a continuously varying value or one of a discrete set of values User Defined Probability Distributions Distribution Name Description DiscreteDistribution Generates samples from a discrete set of values Continuous Dis
21. directly to the user s computer No special installation program is required Copy the JaamSim executable file to a working directory such as the directory containing the model input files Launch JaamSim by double clicking on the executable file TLS and other JaamSim based applications are stand alone executable files and are installed in the same way The executable file for example TLS exe for the Transportation Logistics Simulator can be copied directly to the folder containing the model run files and launched directly from there or by a shortcut It is not necessary to install JaamSim in addition to the application specific executable f Ausenc O JaamSim User Manual 3 Getting Started JaamSim Basic Example Welcome to JaamSim In this example users will be guided through building a basic model using the graphical user interface GUI that simulates entities being generated processed and consumed The finished model should look similar to the model below Finished JaamSim Basic Example JaamSim Basic Example File Tools Views Options Help BY Reame 14 Pause at Dl oon 0 2492 9 years left Speed Up 0 Position 4 596 5 109 0 000 m Model Builder x View1 i x M Graphics Objects 15 x d Probability Distributions Basic Objects B Process Flow Calculation Objects 4 J Fluid Objects Simulation Co
22. gap between the x axis and its labels Expressed as a fraction of the graph s total height YAxisTitleGap The gap between the y axis labels and the y axis title Expressed as a fraction of the graph s total height YAxisLabelGap The gap between the y axis and its labels Expressed as a fraction of the graph s total height TopMargin BottomMargin Size of the gaps between the respective edges of the outer pane and the graph LeftMargin Expressed as a fraction of the graph s total height RightMargin The TextModel used to determine the font colour and style for the graph title The Title TextModel dropshadow settings are ignored Black Verdana text is used if this input is left blank The TextModel used to determine the font colour and style for the x and y axis Axis Title TextModel titles The dropshadow settings are ignored Black Verdana text is used if this input is left blank The TextModel used to determine the font colour and style for the labels next to Label TextModel the x and y axis tick marks The dropshadow settings are ignored Black Verdana text is used if this input is left blank GraphColor The colour of the graph background BackgroundColor The colour of the outer pane background BorderColor The colour of the graph border 8 7 DisplayModelCompat JaamSim includes native DisplayModel objects see the Display Models Palette section that serve as default visual representations for objects including some graphics for entities
23. is used Zooms the camera in or out The camera is moved towards or away from the point Scroll Wheel of interest One click moves the camera 10 closer to or farther away from the point of interest XY plane pan The camera is moved in the xy plane from its present position so that the pointer stays fixed on the same object in the scene If no object is under Left Drag the pointer then the point on the xy plane is used The point of interest is reset to the pointer position Movement is restricted to no closer than 1 degree from the horizon to protect the user from an accidental trip to infinity Z axis pan The camera is moved along the z axis from its present position so that the pointer stays fixed on the same object in the scene If no object is under the pointer then the point on the xy plane is used The point of interest is reset to the pointer position Shift Left Drag Orbit The camera orbits left right and up down around the point of interest Right Drag following the mouse movement Shift Riaht Dra Look around The camera looks left right and up down following the mouse g 9 movement The point of interest is unchanged Moving and Re sizing Objects Individual objects can be moved around using mouse controls that are analogous to the camera controls To avoid moving an object accidentally it is necessary to press the Control key during any movement After selecting an object in the Object Selector or by clicking it in
24. match the various subclasses of DisplayEntity For example the Text object a subclass of DisplayEntity and the TextModel a subclass of DisplayModel work together to display text The text to be displayed is determined by the Text object while the style of the displayed text font bold italics colour etc is determined by the TextModel object In this case the TextModel plays the same role as a text style in word processing software The analyst can ensure that the same text style is used for multiple Text objects by sharing the same TextModel between all these objects Although DisplayModels determine the appearance of a DisplayEntity the DisplayModel has no graphics itself and therefore cannot be dragged and dropped in the normal manner To create a new DisplayModel simply duplicate an existing DisplayModel JaamSim starts with a pre defined example of each type of Display Model that can be used for this purpose Duplicate an example Display Model by right clicking its entry in the Object Selector and selecting Duplicate then edit its attributes and name as necessary A selection of DisplayModels can be found in the Display Models palette in the Object Selector Each of these subclasses of DisplayModel in intended for a particular subclass of DisplayEntity as noted below List of objects e ColladaModel e ImageModel e TextModel e ScreenPointsModel e ArrowVodel e GraphModel e DisplayModelCompat All of these various Di
25. organised and include comments to document to model design However once this material has been created the easiest way to position the objects and to add graphics such as titles labels etc is through the graphical user interface If the model was then saved all the formatting and comments would normally be lost JaamSim avoids this predicament with the RecordEdits statement On saving JaamSim copies all inputs before the RecordEdits statement line by line to the saved file and then saves all the changes to the model using computer written inputs The following example illustrates this structure Manually prepared inputs Everything before the RecordEdits statement is unchanged when JaamSim saves a file RecordEdits Computer written inputs Everything that appears after the RecordEdits statement is written by the computer The Save functionality in JaamSim is disabled when an input file is loaded without a RecordEdits statement In this case the Save As operation adds a RecordEdits statement to the end of the original configuration file and then writes out the new inputs 14 5 Launching in Batch Mode JaamSim models can be executed in batch mode with minimized graphics Batch mode is useful when only the output reports are required or when a series of runs are to be executed without user intervention The model can also be launched configured and started automatically from the command line or a
26. reason it does not appear in the Model Builder List of objects e Simulation 5 1 Simulation As with other objects the simulation parameters are changed using the Input Editor Keyword RunDuration InitializationDuration PrintReport ReportDirectory TickLength ExitAtStop GlobalSubstreamSeed Keyword DisplayedUnits Key Inputs Description Duration of the simulation run in which statistics will be recorded Duration of the initialization period from which the run statistics are discarded before the simulation is run for the time specified in RunDuration Allows the model to reach steady state before statistics are recorded The total length of the simulation run is the sum of InitializationDuration and RunDuration If TRUE a summary report will be written to an output file named lt run name gt rep The directory in which the output file will be created If left blank the default directory is the one in which the input file lt run name gt cfg is located The smallest time increment for JaamSim s internal integer based time keeping The default value of 1 microsecond will support simulation runs of more than 100 years If TRUE JaamSim will close all windows and exit when the simulation run is finished Global seed that sets the substream for each probability distribution Allows the random seed for each probability distribution to be changed with a single input GUI Description A list of units
27. received by this object NextComponent The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank WaitQusue A Queue object in which to hold entities that are waiting for sufficient Resource units to be available A list of threshold objects that must all be open for operation to proceed Operation Operaio INES aksi is stopped if any one of the thresholds is closed Resource A list of Resources to be seized A list containing the number of units of each Resource to be seized Each entry NumberOfUnits can be a constant value a TimeSeries a Probability Distribution or an Expression A decimal input will be truncated to an integer by the internal logic Outputs Output Name Description State Not used obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time ReleaseTime The time at which the last entity was released Working Returns TRUE if entities are being processed Open Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open 11 10 Release The Release object de allocates one or more units of a spe
28. value is executed before the ones with higher values Fluid The fluid being moved by the flow Source The source object for the flow Destination The destination object for the flow Outputs Output Name Description SimTime The present simulation time FlowAcceleration The time derivative of the volumetric flow rate Flowlnertia The sum of Density Length FlowArea for the hydraulic components in the flow 13 3 FluidFixedFlow The FluidFixedFlow object moves fluid between a source and destination at a fixed volumetric flow rate Default Graphic April 10 2015 Key Inputs Keyword Description Description Optional free form text that describes the object Controller The Controller object that provides the update signal for this object The sequence number used by the Controller to determine the order in which SequenceNumber calculations are performed A calculation with a lower value is executed before the ones with higher values Fluid The fluid being moved by the flow Source The source object for the flow Destination The destination object for the flow FlowRate The constant volumetric flow rate from the source to the destination Points The coordinates for the multi segment line representing the flow path Width The with in pixels of the multi segment line representing the flow path Colour The colour of the multi segment line representing the flow path Outputs Output Name Description SimTime The present simulation time FlowRate T
29. 8 gray89 227 227 227 midnightblue We 25 112 gray88 224 224 224 cobalt Wy a so 171 gray87 222 222 299 royalblue DW 65 105 205 gray86 219 219 219 comflowerblue 100 149 237 gray85 217 217 217 lightsteelblue 176 196 222 gray84 214 2144 214 lightslategray E 119 136 153 gray83 212 212 212 slategray Wy 2 128 144 gray82 209 209 209 dodgerblue 30 144 255 gray81 207 207 207 O 2015 14 87 A m April 10 2015 usenc JaamSim User Manual Colour Name Colour R G B Colour Name Colour R G B aliceblue 240 248 255 gray80 204 204 204 powderblue 176 224 230 gray79 201 201 201 lightblue 173 216 230 gray78 199 199 199 lightskyblue 135 206 250 gray77 196 196 196 skyblue 135 206 235 gray76 194 194 194 deepskyblue 0 191 255 gray75 191 191 191 peacock ee 51 161 201 gray74 189 189 189 steelblue DW 7 130 180 gray73 186 186 186 darkturquoise O 206 209 gray72 184 184 184 cadetblue A 5 158 160 gray71 181 181 181 azure 240 255 255 gray70 179 179 179 lightcyan 224 255 255 gray69 176 176 176 paleturquoise 187 255 255 gray68 173 173 173 cyan M o 255 255 gray67 1741 171 171 turquoise 6 amp 4 224 208 gray66 168 168 168 mediumturquoise 72 209 204 gray65 166 166 166 lightseagreen 32 178 170 gray64 j 163 163 163 manganeseblue ome 168 158 gray63 wa 161 161 161 teal a 128 128 gray62 158 158 158 darkslategray Wee 7 7 gray61 156 156 156 turquoiseblue Oo 19 140 gray60 Mee 153 153 153 aquamarine ey 127 255 212 gray5
30. 9 150 150 150 mintcream 245 255 250 gray58 148 148 148 mint 189 252 201 gray57 145 145 145 seagreen 84 255 159 gray56 E 143 143 143 mediumspringgreen SS 0 250 154 gray55 a 140 140 140 springgreen aa 255 127 gray54 a 138 138 138 emeraldgreen a 201 87 gray53 TO 135 135 135 mediumseagreen P 60 179 113 gray52 E 133 133 133 cobaltgreen Wy a 4 o4 gray51 E i30 130 130 darkseagreen 143 188 143 gray50 eee 27 127 127 honeydew 240 255 240 gray49 DT 12 125 125 palegreen 152 251 152 gray48 ee 22 12 12 lawngreen fee 124 252 0 gray47 DW 12 10 12 greenyellow Meee 173 255 47 gray46 ee 7 7 117 limegreen D o 25 50 gray45 ee 15 115 115 forestgreen Ws 20 3 gray44 ee 2 12 112 sapgreen Wy as 128 20 gray43 Dy 110 110 110 green a 128 0 gray42 Dy io 4107 107 darkgreen fa 100 0 gray41 E 105 105 105 O 2015 14 88 A 7 April 10 2015 usenc 2015 14 April 10 2015 Colour Name darkolivegreen olivedrab olive ivory lightyellow lightgoldenrodyellow comsilk lemonchiffon beige yellow khaki lightgoldenrod palegoldenrod darkkhaki banana gold goldenrod darkgoldenrod brick floralwhite seashell oldlace linen antiquewhite papayawhip blanchedalmond eggshell bisque moccasin navajowhite wheat peachpuff tan burlywood melon sandybrown cadmiumyellow carrot orange flesh cadmiumorange Colour R 85 107 128 255 255 250 255 255 245 255 240 255 238 189 227 255 218 184 156 255 255 253
31. End XAxisInterval XAxisLabelFormat XLines XLinesColor Keyword YAxisTitle YAxisUnit YAxisStart YAxisEnd YAxisInterval YAxisLabelFormat YLines YLinesColor JaamSim User Manual Key Inputs Description Text for the graph title enclosed in single quotes if it contains spaces The number of data points to be displayed on the graph This determines the resolution of the graph The type of units for each line specified by the DataSource input Must be specified BEFORE the DataSource input and the Y Axis inputs One or more sources of data to be graphed against the primary y axis Specified as a series of Expressions each enclosed by braces A list of colours for the data series to be displayed For multiple colours each colour must be enclosed in braces as each colour can be itself defined as a list of RGB values A list of widths in pixels for the data series to be displayed The type of units for each line specified by the SecondaryDataSource input Must be specified BEFORE the SecondaryDataSource input and the Secondary Y Axis inputs One or more sources of data to be graphed against the secondary y axis Specified as a series of Expressions each enclosed by braces A list of colours for the data series to be displayed For multiple colours each colour must be enclosed in braces as each colour can be itself defined as a list of RGB values A list of widths in pixels for the data series to be displayed
32. User Manual Ihe forefront of simulation 2015 14 April 10 2015 JaamsSim User Manual 1 Introduction JaamSim Java Animation Modelling and Simulation is a discrete event simulation software package developed by Ausenco as the foundation of all our simulation applications JaamSim includes a drag and drop graphical user interface 3D animation and a full set of built in objects for model building It is object oriented extremely fast and scalable to the largest of applications Windows Linux and OSX are all supported JaamSim represents the lessons learned from simulation projects we have performed around the world for more than 35 years Further background information on JaamSim can be found in the JaamSim blog www jaamsim com blog JaamSim is free open source software licensed under GPLv3 The latest version of the software and manuals can be downloaded from the JaamSim website wwv jaamsim com The source code is published on GitHub www github com AusencoSimulation JaamSim Presentations and tutorials for JaamSim can be found at www youtube com user javasimulation This User Manual documents the user interface and basic objects provided wth JaamSim These features are common to all simulation models created wih this software Documentation for application specific objects such as those found in Ausenco s Transportation Logistics Simulator TLS is found in the manuals for the corresponding modules JaamSim pro
33. a view window its position size and orientation can be manipulated interactively by pressing the Control key and dragging the entire object a corner of the object or its rotation handle using the mouse By default dragging an object moves it in the xy plane An object can be moved in the z direction by holding down both the Control and Shift keys and dragging the object up and down These actions are described in more detail in the following table Moving and Re sizing Objects Mouse Keyboard Action Effect on the Object Selects the object The object under the pointer is selected for input output viewing and for re positioning re sizing or rotating The selected object is indicated by a green rectangle that encompassed the object Green handles are also provided to allow the object to be re sized or rotated Left Click Moves the object parallel to the xy plane holding its z coordinate constant ee E LEIE DAG following the pointer Moves the object parallel to the z axis holding its x and y coordinates constant Shift Control Left Drag following the pointer Control Left Drag on a Resizes rotates the object The selected object is re sized or rotated using the Handle selected handle Moving and Re shaping Linear Objects In addition to the standard controls described above linear objects such as an Arrow can be re shaped by adding and removing points and by moving individual points The actions for linear objects are des
34. aamSim User Manual Gen InterArrivalTime GenIATDist Gen PrototypeEntity Proto Gen Position 2 234651 3 249747 0 000000 m GenToServ NextComponent Serv GenToServ TravelTime 1 s GenToServ Points 1 149 3 250 0 000 m 0 149 3 250 0 000 m _ GenToServ Position 1 149286 3 249747 0 000000 m GenToServ Alignment 0 0 0 0 0 5 ServToSink NextComponent Sink ServToSink TravelTime 1 5 s ServToSink Points 1 322 3 349 0 000 m 2 322 3 349 0 000 m ServToSink Position 1 321349 3 349715 0 000000 m ServToSink Alignment 0 0 0 0 0 5 Serv NextComponent ServToSink Serv WaitQueue ServQueue Serv ServiceTime 1 s Serv Position 0 507324 3 321153 0 000000 m Sink Position 2 949394 3 321153 0 000000 m ServQueue Position 0 450198 4 492204 0 000000 m Proto Position 4 452180 0 540587 0 000000 m Proto Alignment 0 0 0 0 0 5 GenIATDist MinValue O s GenIATDist MaxValue 10 s GenIATDist Mean 2 s GenIATDist Position 1 492032 0 493496 0 000000 m GenIATDist Size 1 000 1 000 0 0 m O 91 A ae 2015 Au SENCO C
35. ample View1 indicates the vew window View1 created automatically by JaamSim Object outputs Specified by an object name and an output name e g Queue1 QueueLength is the output named QueueLength for the queue object Queue The use of Time Formats and Expressions are described in the Advanced Topics section of this manual Curly braces are used to delineate distinct entries in a list For example a list of two points would be entered as 0 0 1 00 0 m 1 0 1 0 0 0 m When an input has only one set of inner braces it can be entered without the inner braces e g 12 3 can be entered as 1 2 3 A drop down menu is available for many types of inputs For a Boolean input the user is offered a choice of TRUE or FALSE For an object input the user is offered a list of all the objects of the appropriate type Similar drop down menus are provided for most other types of inputs Colour Selection For readability it is often preferable to specify a colour input using a colour keyword instead of an RGB value e g pink instead of 255 192 203 A table of standard colour keywords is provided in the last section of this manual Alternatively the Input Editor provides a pop up menu containing a graphical palette shown in the figure below to aid colour selection The user can select a colour or adjust the RGB values via slider controls Ausenc O 2015 14 April 10 2015 JaamSim User Manual Colour Selection Pop up Window
36. and XYZ Axis objects are intended as visual aids for placing new objects and as such they are regular static graphics DisplayEntity objects The Movable keyword is set to FALSE for both objects so that they cannot be moved accidentally and do not respond to mouse clicks The other three objects are the Ausenco wordmark a place holder title for the model and calendar and clock to show simulation time These objects are Overlay Objects Overlaylmage OverlayText and OverlayClock respectively that appear in a fixed position on the view window and are not part of the 3D scene The position and format of the default objects can be modified through the Input Editor or deleted using the Object Selector Moving the Camera The basic camera movements are zoom pan and orbit The user can zoom the camera by using the mouse wheel and pan the camera by clicking and dragging the mouse cursor around the view window Dragging the mouse with the right button depressed causes the camera to orbit around the current point of interest These movements are described in more detail below along with a number of other useful camera manipulations O 7 Ausenc 2015 14 April 10 2015 JaamSim User Manual View Camera Controls Mouse Keyboard Action Effect on the Camera Selects Point of Interest The point on the surface of the object under the pointer Left Click becomes the point of interest If no object is under the pointer then the point on the xy plane
37. ank Measured relative to the bottom of the tank Outputs Description The present simulation time Cross sectional area of the tank The velocity of the fluid in the tank The static pressure at the inlet to the tank The dynamic pressure for the fluid in the tank The Reynolds number for the fluid in the tank The static pressure at the outlet from the tank The FluidPipe object represents a cylindrical pipe for transporting fluid FlowArea 0 25 PI Diameter 2 Velocity FlowRate FlowArea DynamicPressure 0 5 Density Velocity abs Velocity RenoldsNumber abs Velocity Diameter Density Viscosity 7 Ausenc O 2015 14 April 10 2015 LaminarFrictionFactor TurbulentFrictionFactor 2 51 ReynoldsNumber X JaamsSim User Manual 64 ReynoldsNumber 1 X 2 where X 2 Logl0 Roughness 3 7 Diameter calculated iteratively For ReynoldsNumber lt 2300 DarcyFrictionFactor LaminarFrictionFactor For ReynoldsNumber gt 4000 DarcyFrictionFactor TurbulentFrictionFactor For ReynoldsNumber between 2300 and 4000 DarcyFrictionFactor 0 5 LaminarFrictionFactor TurbulentFrictionFactor InletPressure OutletPressure for previous component PressureLoss DarcyFrictionFactor Length Diameter DynamicPressure PressureLossCoefficient DynamicPressure FlowAcceleration Density Length FlowArea OutletPressure InletPressure HeightChange Density Gravity PressureLoss Default Graphic Ke
38. are stored while they wait to be unpacked A list of Threshold objects which must be open for the unpacking operation to proceed The time required to unpack each entity Can be a constant value a TimeSeries a Probability Distribution or an Expression O Ausenc 2015 14 April 10 2015 JaamSim User Manual Outputs Output Name Description The present state for this object used for statistics collection Definitions for the State ion various states are given in the table below obj Entity last received NumberAdded Number of EntityContainers received NumberProcessed The total number of entities that have been unpacked ProcessingRate The rate at which entities have been unpacked NumberProcessed Total Time Release Time The time at which the last entity was released Working Returns TRUE if entities are being processed Open festa TRUE if all the thresholds specified by the Operating ThresholdList eyword are open State Definitions State Name Description Working Performing its normal service Idle Available for senice but has no work to perform Stopped Service has been suspended by the closure of one or more Thresholds Clearing_while_Stopped The present service activity is being completed before ceasing further operation 11 22 AddTo The AddTo object is used to add a given number of entities to a received EntityContainer The number of entities to be added each EntityContainer is determined by the Numbe
39. cified set of Resources on receiving an incoming entity All of the Resources are released simultaneously On release of one or more units of a Resource the Seize block with the entity that has waited the longest for the Resource is notified to process this entity Default Graphic vs 2015 14 52 April 10 2015 Ausenc O 2015 14 April 10 2015 JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity The prototype entity used to generate the stream of entities received by this object NextComponent The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank Resource A list of the Resources to be released A list containing the number of units of each Resource to be released Each entry can be a constant value a TimeSeries a Probability Distribution or an NumberOfUnits ara Expression A decimal input will be truncated to an integer value by the internal logic Outputs Output Name Description State Not used obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate Relea
40. cribed in the following table O 17 Ausenc 2015 14 April 10 2015 Mouse Keyboard Action Left Click on the Line Control Left Drag on the Line Shift Control Left Drag on the Line Control Left Drag on a Handle Shift Control Left Drag on a Handle Alt Control Left Click on the Line Shift Alt Control Left Click on a Handle Context Menu JaamSim User Manual Moving and Re shaping Linear Objects Effect on the Object Selects the line The line under the pointer is selected for input output viewing and for re positioning re sizing or rotating The selected line turns green indicating it has been selected and green handles appear at each point in the line Moves the entire line in the xy plane The selected line is moved in a plane parallel to the xy plane following the pointer Moves the entire line along the z axis The selected line is moved along the Z axis following the pointer Moves location of the point in the xy plane The lines on either side of the point adjust to following the point Moves the location of the point along the z axis Adds a new point and Handle to the line Deletes the point and re connects the points on either side of the deleted point Right clicking in the view window generates a menu listing all objects whose graphical representation lies under the mouse cursor Selecting an object here or in the case that there is only one object underneath the mouse cur
41. d by the calculation The input value for the present calculation The inputs can be a constant value or InputValue any entity that retums a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression Initial Value The output value at zero simulation time Outputs Output Name Description SimTime The present simulation time Value The present output value for this Calculation Object 12 5 Differentiator The Differentiator object calculates the time derivative of the input value t 1 t n previous update times generated by the Controller InputValue i input value at update time t i Value InputValue InputValue n SimTime t n Default Graphic O 2015 14 70 A April 10 2015 usenc 2015 14 April 10 2015 Keyword Description Controller SequenceNumber Unit Type InputValue Output Name SimTime Value 12 6 PiDController JaamSim User Manual Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher values The unit type for the value retumed by the calculation The input value for the pre
42. d for video capture a script can be used to change window views to create automatic zooming and panning and to turn on and off video capture during a run Furthermore keywords defined in the script file can be used to modify simulation and object parameters initially defined in the input configuration file Key Inputs for scr file Keyword Description Time The simulated time at which the subsequent inputs are executed Example The following inputs can be entered into a scr file and then referenced by a ScriptEntity object in order to slow down the model at a given point in the simulation run ScriptEntityl Time 24 0 h Simulation RealTime TRUE Simulation RealTimeFactor 1200 ScriptEntityl Time 30 0 h Simulation RealTime FALSE 14 7 VideoRecorder JaamSim includes functionality to capture still images or videos of simulation models via the VideoRecorder object The length and playback speed of the video is governed by three keywords e CaptureStartTime is the simulated time at which video capture begins e CaptureFrames is the number of frames to capture e Capturelnterval is the simulated time elapsed between frames The video recorder output frame rate is fixed at 30 frames per second The video recorder naturally composites the selected views from CaptureViews onto a surface with dimensions specified in CaptureArea with windows borders not rendered The example inputs below illustrate th
43. e l i i movable objects do not respond to mouse interactions in the View windows 7 2 Text The Text object is used to define static or dynamic text to be displayed in a view window Text objects are used for labelling various parts of the model and for monitoring the status of the model The text displayed by the Text object is determined primarily by its Format keyword Dynamic text can be introduced by including a Java format code such as s in the Format input and specifying the variable to be displayed with the OutputName keyword Use the Output Viewer to identify the outputs that are available for each object If the output is a number with Units the value can be converted from SI to a specified unit through the Unit keyword The appearance and style of the text is determined by the TextModel specified by the DisplayModel keyword The default style DefaultTextModel is black Verdana text A new text style can be created through the following steps e Create a new TextModel by right clicking on the DefaultT extModel object in the Object Selector and selecting Duplicate e Rename the new TextModel object by doubling clicking on the name in the Object Selector entering the new name and pressing Return key e Use the Input Editor to specify the characteristics for the new TextModel such as font italics bold colour etc e Use the Input Editor to select the new TextModel for the Text object s DisplayModel keyword A Text object
44. e capture of a 20 second long video in 1080p resolution spanning 600 hours of simulated time Define VideoRecorder VideoRecorderl VideoRecorderl VideoCapture TRUE VideoRecorderl CapturelInterval 1h VideoRecorderl CaptureStartTime 0h VideoRecorderl CaptureFrames 600 VideoRecorderl CaptureArea 1920 1080 VideoRecorderl SaveVideo TRUE VideoRecorderl CaptureViews Overview VideoRecorderl VideoBackgroundColor skyblue 35 Ausenc O 2015 14 April 10 2015 JaamSim User Manual The file produced can be viewed with a video player that supports a wide range of codecs such as VLC ww videolan org The default Windows Media Player will not play the video The captured video is largely uncompressed Use a video transcoder such as Handbrake ww handbrake fr to compress the video Keyword CaptureStart Time VideoBackgroundColor CaptureFrames Capturelnterval Savelmages SaveVideo CaptureArea CaptureViews VideoName Key Inputs Description The simulated time at which video capture begins The background colour for parts of the video frame not covered by a view window The number of frames to capture The amount of simulated time elapsed between captured frames If TRUE individual screen captures are made for each frame and output to image files If TRUE video capture is enabled and an AVI file is output by the video recorder The size of the rendered image or
45. e fluid Default Graphic Keyword Description Density Viscosity Colour Gravity 13 2 FluidF low Key Inputs Description Optional free form text that describes the object The density of the fluid Defaults to the density of water The dynamic viscosity of the fluid Defaults to the viscosity for water The colour used to represent the fluid The acceleration of gravity to be used in the fluid flow calculations The FluidFlow object calculates the flow rate between a source and destination by solving the unsteady Bernoulli equation FCi the i th component in the flow path FC1 Source FCn Destination Hj path of the fluid Length n FlowArea n Default Graphic MALA J ff if IJ I Id nn EIAN gt 2015 14 April 10 2015 Flow path FC1 gt FC2 gt sss Length i length of the i th flow component measured along the path of the fluid lowArea i cross sectional area of the i th flow component measured perpendicular to the gt FCn FlowInertia Density Length 1 FlowArea 1 Length 2 FlowArea 2 k Ausenc O JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object Controller The Controller object that provides the update signal for this object The sequence number used by the Controller to determine the order in which SequenceNumber calculations are performed A calculation with a lower
46. e keyword EntityContainers are passed to another object once the specified number of entities have been unpacked i Ausencs April 10 2015 Default Graphic v Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment Operating ThresholdList WaitQueue ServiceTime NumberOfentities NextForContainers Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time Working Open State Name Working Idle Stopped Clearing_while_Stopped JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which the removed entities are passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank A list of Threshold objects which must be open for the entity removal operation to proceed The Queue in which the arriving EntityContainers are stored while they wait to be processed The time required to remove each entity Can be a constant value a TimeSeries a Probability Distribution or an Expression The number of entities to remove from a received EntityContainer Can be a constant value a TimeSeries a Probabili
47. e recommended option for this input The file path must be enclosed in single quotes if it contains spaces A list of animation Actions and the object Outputs to which they are to be connected in the format Action1 Output Action2 Output2 In this Actions example the actions Action1 and Action2 must be available for the graphical asset specified by the ColladaFile input The outputs Output1 and Output2 must be valid outputs for the entity to which this ColladaModel is assigned Animation is only available for 3D objects in the JSM format The following outputs are provided for ColladaModels Outputs Output Name Description Actions A list of the actions that are provided in the JSM file Vertices The number of unique vertices that are specified in the 3D model Triangles The number of unique triangles that are specified in the 3D model VeteharRatio The ratio number of triangles number of vertices V3 Equal to 1 0 if every vertex is used in only one triangle 8 2 ImageModel ImageModel objects are used to display custom 2D graphics in a simulation model such as a picture or a map Both DisplayEntity and Overlaylmage can accept an ImageModel object as an input Image file types currently supported by JaamSim include BMP GIF JPG PCX and PNG files or a ZIP file containing any one of these file types The table below describes the additional inputs for ImageModel objects DisplayModel Inputs Keyword Descript
48. ed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The Resource object provides a pool of units that can be seized and released by the Seize and Release objects The capacity of a Resource is modelled as a dimensionless integer value 30 Ausenc O 2015 14 April 10 2015 Keyword Description AttributeDefinitionList Capacity Output Name UnitsSeized UnitsReleased UnitsInUse Units InUseAverage Units InUseStandardDewation UnitsInUseMinimum UnitsInUseMaximum UnitsInUseDistribution JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The number of units that can be seized Can be a constant value a TimeSeries a Probability Distribution or an Expression A decimal input will be truncated to an integer by the internal logic Outputs Description The total number of units that have been seized to date The total number of units that have been released to date The present number of units that are in use The average number of units that have been in use to date The standard deviation of the number of units that are in use The fewest number of units that have been in use at any time The largest number of units that have been in use at any time A list of decimal values summing to 1 0 The first entry is the fraction of time that no units were in
49. ed ProcessingRate Release Time 11 17 SignalThreshold JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank The Signal Threshold object whose state will be changed by this EntitySignal The state to be set for the SignalThreshold TRUE open FALSE closed Outputs Description Not used Entity last received by the EntitySignal Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The SignalThreshold object varies its state between open and closed when instructed to do so by one or more EntitySignal objects SignalThreshold has no internal logic of its own for changing state Default Graphic Keyword Description AttributeDefinitionList Keyword OpenColour ClosedColour ShowWhenOpen ShowWhenClosed Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this ent
50. efined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a packed EntityContainers is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank A list of Threshold objects which must be open for the packing operation to proceed The EntityContainer whose copies will be packed The Queue in which the arriving entities are stored while they wait to be packed The number of entities to pack into each EntityContainer Can be a constant value a TimeSeries a Probability Distribution or an Expression The time required to pack each entity Can be a constant value a TimeSeries a Probability Distribution or an Expression Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below Entity last received Number of entities received The total number of EntityContainers that have been created The rate at which EntityContainers have been created NumberProcessed Total Time The time at which the last entity was released Returns TRUE if entities are being processed Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open The EntityContainer that is be
51. entity from the Queue Outputs Output Name Description State The present state for this object used for statistics collection Definitions for the various states are given in the table below obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time ReleaseTime The time at which the last entity was released Working Returns TRUE if entities are being processed Open ue TRUE if all the thresholds specified by the Operating ThresholdList eyword are open State Definitions State Name Description Working Performing its normal service Idle Available for service but has no work to perform Stopped Service has been suspended by the closure of one or more Thresholds Clearing while Stopped The present senice activity is being completed before ceasing further operation 11 16 EntitySignal The EntitySignal object sets the state of a SignalThreshold object when it receives an incoming entity The SignalThreshold and its new state are specified by the TargetSignalThreshold and NewState keywords respectively Default Graphic iy _ 7 Ausenc O 2015 14 April 10 2015 Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment TargetSignal Threshold NewState Output Name State obj NumberAdded NumberProcess
52. er Close All Tools Closes all of the tools that are open Model Builder Drag and drop creation and placement of simulation objects Object Selector Tree listing of all objects in the present simulation model Input Editor View and edit keyword inputs for the selected simulation object Output Viewer Key output values of the selected object Property Viewer Detailed list of the internal properties of the selected object Log Viewer Console for vewing input warnings and error messages The Property Viewer is typically used by programmers who are developing and debugging JaamSim applications and so its usage is beyond the scope of this manual Views A View is a window showing a graphical 3D representation of the model The Views entry displays a menu containing a list of currently defined view windows and provides the ability to create new views Views Menu Entry Description View Opens the window for View1 Does nothing if the window has already been opened Define new View Creates a new View object and displays its window Options Clicking on the Options entry in the menu bar generates a menu containing the following entries Options Menu Entry Description Shaw Aves oo coordinate axes are displayed at the origin 0 0 0 of the coordinate Show Grid If checked the coordinate grid is displayed on the x y plane Always On Top If checked the control panel will always remain on top of other windows If checked information on video mem
53. er of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time Release Time The time at which the last entity was released Working Returns TRUE if entities are being processed Open fice TRUE if all the thresholds specified by the OperatingThresholdList eyword are open State Definitions State Name Description Working Performing its normal service Idle Available for senice but has no work to perform Stopped Service has been suspended by the closure of one or more Thresholds Clearing_while_Stopped The present senice activity is being completed before ceasing further operation 11 5 Queue A Queue object defines a location for simulation entities to wait for processing by other simulation entities Unlike many other objects in this palette an entity received by a Queue is not passed automatically to the next object It must wait in the Queue until it is removed by some other object Queues are used in this way by the Server Seize EntityGate Assemble Pack Unpack AddTo and RemoveFrom objects Whenever an entity is added to a Queue all the objects that use this Queue will be notified that a new entity is available The first object that is ready to start work will remove the entity from the Queue and processing it Ausencs 2015 14 April 10 2015 Default Graphic JaamsSim User Manual Key Inputs Keyword Description Description Optional free
54. er of run controls and output displays to monitor and control the progress of a simulation run The control panel for an example simulation run is shown in the figure below JaamSim Control Panel mS ee al S79 h Oo 4 hours left Sped Linc 2 048 Posiian LESS 7 424 0 00 m The panel is divided into two rows consisting of the menu bar and the tool bar which are described in the following sections Menu Bar File Clicking on the File entry displays a menu with actions related to saving and loading model input configuration files File Menu Entry Description New Launches a new blank model with no objects defined Open Loads a saved configuration from file Save Saves the model under the present input configuration file name Save As Saves the current model as a new input configuration file Imports one or more 3D models or images Creates both the Import ColladaModels ImageModels containing the graphics and the corresponding DisplayEntities Print Input Report Prints the present inputs in a standard file format inp Exit Closes all windows and exits JaamSim Tools Clicking on the Tools entry displays a menu allowing the user to bring up each of the windows that make up the JaamSim graphical user interface i Ausenc O 2015 14 April 10 2015 JaamSim User Manual Tools Menu Entry Description Show Basic Tools Shows the four main tools Model Builder Object Selector Input Editor and Output View
55. er of the group Certain keywords also accept Group objects as values Considerable caution must be exercised when using Group objects because they do not behave in the same way as other JaamSim objects Although they are defined in the same way as other objects they are used only as an input convenience When JaamSim reads the configuration file it replaces each group by its list of objects Groups are ignored once the configuration file has been read O 2015 14 83 A Js April 10 2015 usenc 2015 14 April 10 2015 JaamsSim User Manual Key Inputs Keyword Description List A list of names of the objects included in the list enclosed by braces Example The following example demonstrates the use of groups Define Arrow Arrowl Arrow2 Arrow3 Define Group ArrowList ArrowList List Arrowl Arrow2 Arrow3 ArrowList Colour black In this example a group of three Arrow objects is created and used to assign the colour black to each Arrow By using the List keyword a fourth Arrow can be added to the Group Define Arrow Arrow4 ArrowList List ArrowList Arrow4 ArrowList Colour black RecordEdits Statement The RecordEdits statement is used to preserve the organisation and formatting of a configuration file that has been prepared manually by the user It is usually best to construct a complex model manually using a text editor These inputs are carefully formatted and
56. er to operate However if a Threshold closes while the Server is processing an entity it will complete its work on that entity before ceasing further operation Default Graphic i Ausencs 2015 14 April 10 2015 a JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity The prototype entity used to generate the stream of entities received by this object NextComponent The next object to which the received entity is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank WaitQueue A Queue object in which to hold entities that are waiting to be processed A list of threshold objects that must all be open for operation to proceed Operation Operating areshioetist is stopped if any one of the thresholds is closed Senice The time required to process the incoming entity Can be a constant value a TimeSeries a Probability Distribution or an Expression Outputs Output Name Description The present state for this object used for statistics collection Definitions for the State es various states are given in the table below obj Entity last received NumberAdded Number of entities received NumberProcessed The total numb
57. ers can create custom outputs called attributes for individual objects Attributes appear in the Output Viewer immediately after being defined through the AttributeDefinitionList keyword and as such can be referenced through the ObjectName OutputName format except replacing the OutputName with the desired attribute name Attributes are added using the AttributeDefinitionList keyword in the Key Inputs tab for an entity using the format AttributeName1 InitialValue1 Unit1 AttributeNameN InitialValueN UnitN For example the inputs to create two new attributes AttributeA and AttributeB with initial values of 1 km and 9 dimensionless are AttributeA 1 km AttributeB 9 Attributes are used in expressions in the same way as an outputs For instance if the above AttributeA was defined for Entity1 then it is referenced by Entityl AttributeA Once an attribute has been defined only the Assign object can modify its value 14 4 Editing the Configuration File The easiest way to create a simple model in JaamSim is to use the Graphical User Interface For more complex models it is often easier to create or edit the configuration file cfg file in a text editor The configuration file is saved in plain text and has been designed be human readable There are many advantages to a readable input file in plain text e Input audits Complex models often have thousands of inputs The only way to have confidence
58. following a process flow diagram These types of models are often used to simulate a manufacturing process where the entities represent parts that are moved between processing stations List of objects SimEntity EntityGenerator EntitySink Server Queue EntityConveyor EntityDelay Resource Seize Release Assign Branch Duplicate SetGraphics EntityGate EntitySignal SignalThreshold Assemble EntityContainer Pack Unpack AddTo RemoveFrom EntityLogger Statistics 11 1 SimEntity The SimEntity object is the basic entity that is passed through a process flow type model The main feature of SimEntity is its output named State that indicates what activity the SimEntity is performing at the present time Its state can be set whenever it enters a new object using the StateAssignment keyword for that object The user is free to choose the appropriate state names to use Note however that state names cannot include any blanks or special characters A SimEntity tracks the time its spends in each state during the simulation run This information appears can be logged for each SimEntity by the EntityLogger object Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity Outputs Output Name Description State The present user defined activity being performed by the SimEntity ij Ausenco 11 2 EntityGe
59. for a specific graphical entity can be generated automatically by right clicking the object in a view window and selecting Add Label The Format keyword will be automatically populated with the name of the target entity and will have its RelativeEntity keyword set so that the label follows the target entity when it is moved The Text object has the following keywords in addition to those from DisplayEntity O 2015 14 27 A 7 April 10 2015 usenc 2015 14 April 10 2015 JaamSim User Manual Key Inputs Keyword Description The fixed and variable text to be displayed If spaces are included enclose the text in single quotes If variable text is to be displayed using the OutputName keyword include the appropriate Java format in the text e g s will display a text output and 6f will display a number with six decimals of accuracy Format The output value chain that returns the variable text to be displayed If more than one output value is given all outputs but the last should point to an entity output to query for the next output For example Tank 1 Product Name returns the name of the product in Tank 1 The unit in which to express the output value Required only for outputs that return a number OutputName Unit TextHeight The size of the font as displayed in the view window 7 3 Overlay Objects Overlay objects are special versions of other objects that are used for graphical display in a simulation model
60. form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank The priority for positioning a received entity in the queue Priority is integer valued Priority and a lower numerical value indicates a higher priority Can be a constant value a TimeSeries a Probability Distribution or an Expression FIFO The order in which entities are placed in the queue TRUE indicates first in first out order FIFO FALSE indicates last in first out order LIFO Spacing The amount of graphical space between objects in the queue MaxPerLine Maximum number of objects in each row of the queue Outputs Output Name Description State Not used NumberAdded The total number of objects that have been added to the queue NumberProcessed The total number of objects that have been removed from the queue ProcessingRate The rate at which entities have been processed NumberProcessed Total Time Release Time Not used QueueLength The present number of objects in the queue QueueLengthAverage The average number of objects in the queue QueueLengthStandardDewation The standard deviation of the number of objects in the queue QueueLengthMinimum The fewest number of objects in the queue QueueLengthMaxim
61. format to be used for the tick mark values on the secondary y axis When the Views menu is selected from the menu bar a list of View objects is displayed Each View object consists of an imaginary camera positioned in the world and a window in which to display the image Clicking one of these objects will display the View in a new window or bring the view window into focus if already displayed The graphical positions of objects are not used by any of the simulation model calculations All graphics are for display purposes only Keyword ViewCenter ViewPosition WindowSize WindowPosition TitleBar Text ShowWindow Key Inputs Description The position in space that the View window is looking at The position in space that the View window is looking from The size of the view window in pixels The position of the vew window in pixels with respect to the upper left hand comer of the computer screen Text to place in the title bar of the vew window If TRUE the view window is displayed on screen O 31 Ausenc 2015 14 April 10 2015 JaamSim User Manual 8 Display Models Palette The graphical appearance of a DisplayEntity and its subclasses is determined by its DisplayModel The two objects work together to generate an object s display In general the DisplayEntity determines what is displayed while its DisplayModel determines how it is displayed A number of different subclasses of DisplayModel are available to
62. ghtedSum Polynomial Integrator Differentiator PIDController Lag MovingAverage SineWave 12 1 Controller The Controller object generates the update signals for the individual objects in a continuous type model that are managed by this Controller Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object Sampling Time Interval between update signals to the objects managed by this Controller Outputs Output Name Description SimTime The present simulation time 12 2 WeightedSum The WeightedSum object adds two or more input values A set of dimensionless constants can be provided to multiply each input value prior to addition Value CoefficientList 1 InputValueList 1 CoefficientList 2 InputValueList 2 Default Graphic O 2015 14 68 A a April 10 2015 usenc Keyword Description Controller SequenceNumber UnitType InoputValueList CoefficientList Output Name SimTime Value 12 3 Polynomial JaamSim User Manual Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher va
63. he TimeSeries object simulates a numerical value that varies with time Many JaamSim keywords are structured to accept a constant value a Probability Distribution a TimeSeries or an Expression which makes TimeSeries a powerful and flexible component for building simulation models The data for the object consists of a series of time stamps and values as specified by the Value keyword The time stamps can be irregularly spaced and it is possible to repeat the time series over and over again during the simulation using the CycleTime keyword The value returned by a TimeSeries object has a specific unit type specified by the UnitT ype keyword To maintain consistency the UnitType must be specified prior to any other input Once specified it cannot be changed Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity Unit Type One of the pre defined unit types within JaamSim Once set this input cannot be changed by the user A series of timestamps along with the associated value for the TimeSeries at the Value given time e g 0s 100 m 1s 150m 2s 50 m The input for UnitType must be set before entering the input for Value When the time series will repeat from the start By default the TimeSeries object ERG does not cycle Outputs Output Name Description PresentValue The value for the TimeSeries at t
64. he arrow line segments in pixels Aone A set of x y z numbers that define the size of the arrowhead in those directions at the end of the connector Color The colour of the arrow defined using a colour keyword or RGB values Arrows and other graphical objects that use the Points keyword ignore the Position Alignment and Orientation keywords since their placement is defined completely by their Points coordinates 7 6 Graph The Graph object is a real time visual representation of one or more output values displaying its current value in the context of its recent history The figure below shows an example of a graph with keywords related to formatting its appearance labelled directly on the graph The formatting is applied by specifying a GraphModel object to the DisplayModel keyword Sample Graph with Formatting Keywords Defined Graphically i i Background YAxisLabelGap e Title ae j m TitleGap 10 E Graph g F Gg YAxisLines l i 3 i u x Line a h e i E 4 r e a T 2 Labels rs ay mn KAxisLabelGap gt 24h 16h El Now BottomMargin 8h h O 29 Ausenc April 10 2015 Keyword Title NumberOfPoints UnitType DataSource LineColours LineWidths SecondaryUnitType SecondaryDataSource SecondaryLineColours SecondaryLineWidths Keyword XAxis Title XAxisUnit XAxisStart XAxis
65. he left l If TRUE the vertical alignment is referenced to the bottom side of the view window AlignBottom instead of the top 7 4 BillboardText A BillboardText object is similar to a normal Text object except that the text is always oriented towards the view window and its height is given in pixels instead of metres BillboardText retains its coordinates in 3 space and in this way differs from the OverlayText object Both static and dynamic text can be dispayed by a BillboardText object using the same keywords as Text a Ausencs 2015 14 April 10 2015 JaamSim User Manual The keywords for BillboardText are identical to those for Text and have the same meaning except for the TextHeight keyword which now gives the height of the text in pixels instead of metres At the present time this input must include the units of metres m even though it is interpreted as pixels This deficiency will corrected in a future version of the software 7 5 Arrow An Arrow object consists of a line possibly multiple line segments and an arrowhead It can be used to point out objects in a view window In addition to the Basic Graphics keywords the table below describes keywords used for this object in particular Arrow Graphics Inputs Keyword Description Points A list of points in x y z coordinates defining the line segments that make up the arrow When two coordinates are given it is assumed that z 0 Width The width of t
66. he present simulation time The time stamps can be entered in the normal fashion e g O s 5 h etc or in various year month day formats The latter formats are described in the Advanced Topics section The first timestamp must be zero seconds i e 0 s or January 1 00 00 of some year If a non zero year is used say 2010 01 01 then for the purpose of the time series this date is taken to be zero seconds of simulation time and all other time stamps are offset accordingly The value for the time series is constant between one timestamp and the next If the simulation time is greater than the CycleTime the time series will repeat from the beginning of the Value list Example Define TimeSeries TS 39 Ausenc O JaamsSim User Manual TS UnitType SpeedUnit TS Value 2014 01 01T00 00 00 0 00 km h 2014 01 03T00 00 00 0 76 km h 2014 01 11T00 00 00 0 24 km h TS CycleTime 14 d In this example if the simulation started on 2014 01 01 it would take on the new values on January 3 0 76 km h and then January 11 0 24 km h On 2014 01 15 the first value of the list would be read again and the returned value from the TimeSeries would be 0 km h The TimeSeries would take on new values on January 17 and 25 and this 14 day cycle would repeat until the end of the simulation run An equivalent input for the Value keyword is TS Value 0 d 0 00 km h 2 d 0 76 km h 10 d 0 24 km h 10 2 T
67. he volumetric flow rate re Ausenc O 2015 14 April 10 2015 13 4 FluidTank JaamsSim User Manual The FluidTank object represents a cylindrical storage tank containing a fluid Tanks are modelled as a large diameter pipe so that the velocity and inertia of the fluid is captured by the calculations t 0 simulation time zero t 1 t n previous update times generated by the Controller FluidVolume FluidVolume n FlowRate SimTime t i FluidLevel FluidVolume FlowArea InletPressure AmbientPressure Density Gravity max 0 FuildLevel InletHeight OutletPressure AmbientPressure Density Gravity max 0 FuildLevel OutletHeight Velocity FlowRate FlowArea DynamicPressure 0 5 Density Velocity abs Velocity RenoldsNumber abs Velocity Diameter Density Viscosity Default Graphic Keyword Description Previous Diameter Capacity Initial Volume AmbientPressure InletHeight Output Name SimTime FlowArea Velocity InletPressure DynamicPressure ReynoldsNumber OutletPressure 13 5 FluidPipe Key Inputs Description Optional free form text that describes the object The upstream flow component that feeds the tank The diameter of the cylindrical tank The volumetric capacity of the tank The volume of fluid in the tank at the start of the simulation run The atmospheric pressure acting on the surface of the fluid in the tank The height of the flow feeding the t
68. ibuteDefinitionList TestEntity NextComponent StateAssignment TargetComponentList Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time 11 14 SetGraphics Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank A list of the objects to which a copy of the received entity will be sent Outputs Description Not used Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The SetGraphic object is used to change the graphical appearance of a specified entity Default Graphic 2015 14 April 10 2015 O Ausenc 2015 14 April 10 2015 3 Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment TargetEntity GraphicsList Choice Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time 11 15 EntityGate Defaul
69. ibution object Renaming the ExponentialDistribution Model Builder Palette Object Name Probability Distributions ExponentialDistribution GenlATDist Also set the following keywords for GenlAT Dist GenlATDist Inputs Tab Keyword Value Key Inputs UnitType TimeUnit Key Inputs MinValue Os Key Inputs MaxValue 10s Key Inputs Mean 2s Now change the InterArrivalT ime for Gen to be GenlAT Dist Gen Inputs Tab Keyword Value Key Inputs InterArrival Time GenlATDist Save the model again and press Play Observe that Proto entities are generated randomly and there are now times where Proto entities are waiting in ServQueue to be processed Ausenc O JaamSim User Manual Simulation with a Probability Distribution Viewl1 d mife o x Model Title An 2014 Jan 01 00 01 22 721 Au enco Congratulations you have successfully constructed a JaamSim simulation model O 12 A ae 2015 Au SENCO 2015 14 April 10 2015 JaamSim User Manual 4 Graphical User Interface The graphical user interface GUI for JaamSim is also used by TLS and by any other simulation software based on JaamSim The interface consists of the Control Panel one or more view windows the Model Builder the Object Selector the Input Editor and the Output Viewer List of interface elements Control Panel View Windows Model Builder Object Selector Input Editor Output Viewer 4 1 Control Panel The Control Panel provides a numb
70. iew window Viewl ViewCenter 0 193139 3 142639 2 866544 m Viewl ViewPosition 0 193139 3 142640 11 526798 m Viewl ShowWindow TRUE Viewl SkyboxImage lt res gt images sky map 2048x1024 jpg AusLogoModel ImageFile lt res gt images auslogo small png AusLogoModel Transparent TRUE AusLogo Description Ausenco wordmark AusLogo DisplayModel AusLogoModel AusLogo ScreenPosition 10 10 AusLogo AlignRight TRUE A AusLogo AlignBottom TRUE AusLogo ImageSize 200 45 TitleTextModel Description Text style for the Title TitleTextModel FontColour 150 23 46 TitleTextModel FontStyle BOLD ClockTextModel Description Text style for the Clock ClockTextModel FontColour 51 51 51 ClockTextModel FontStyle ITALIC Fy Title Description Title for the simulation model Title Format Model Title Title TextHeight 18 Title DisplayModel TitleTextModel itle ScreenPosition 15 15 J lock Description Simulation date and time no leap years or leap seconds lock TextHeight 10 lock StartingYear 2014 lock DateFormat yyyy MMM dd HH mm ss SSS lock DisplayModel ClockTextModel lock ScreenPosition 15 15 lock AlignBottom TRUE AQAAAAAN Gen NextComponent GenToServ O 2015 14 90 A n April 10 2015 usenc J
71. ii Simulation i Display Models Fl Graphics Objects Er W View OverlayImage OverlayText OverlayClock Objects that have been created using the Model Builder can be renamed or deleted using the Object Selector Once an object has been selected it can be renamed by clicking on its entry in the Object Selector or by pressing F2 similar to the convention in Windows It can be deleted by pressing the Delete key or by right clicking the object in a view window or the Object Selector and selecting Delete 4 5 Input Editor The Input Editor allows the user to modify inputs for objects already defined in the model or to assign inputs to newy defined objects When an object is selected its parameters appear in the Input Editor window grouped under a number of tabs If a keyword has a default value assigned it is shown in the Default column Hovering the mouse cursor over a keyword will display a tooltip containing a brief description of the Keyword and an example input The figure below shows the Input Editor with the tooltip for Size Input Editor with Keyword Tooltip Mouseover Input Editor queu g X The example input shown in the figure is given in the format when Editing the Configuration File The entry to place in the Input Editor is the text appearing between the braces For the example shown in the figure the entry would be 15 12 0 m Entering and Editing Keyword Inputs 7 Ausencs 2015 14 Apr
72. il 10 2015 JaamSim User Manual Keywords are modified by clicking the Value column and entering a new value with the appropriate units from the Units Palette Numbers must be entered without spaces or commas and Boolean keywords must take the value TRUE or FALSE case sensitive If an entry is made in the Value column it will overwrite the default If an input is not valid an error message will be displayed showing the cause of the error Depending on the object different keyword values will have different data types outlined in the following table Input Data Types Data Type Description Numbers without units Specified with or without a decimal point e g 5 5 0 and 5 are equivalent entries A pre defined unit must be included e g 1000 mm 1 0 m and 0 001 km are Numbers with units i equivalent entries Times can be entered as a number and unit e g 5 2 s in a year month day format e g 2015 02 28 or in an hour minute second format e g 01 35 20 5 Specified using object outputs and mathematical operators e g 1 2 Time Formats Expressions Entity1 OutputB Booleans Indicated as either TRUE or FALSE case sensitive Colours Specified by a colour keyword or by an RGB value e g pink and 255 192 203 are equivalent entries Citas The text must be enclosed in single quotes if it contains any spaces e g a b c g Note that abc and abc are equivalent entries Obiects Specified by an object name For ex
73. ill be run1 EntityLogger1 log A pre existing file with this name will be overwritten once the simulation run is started Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity NextComponent The next object to which a received entity is passed Outputs Output Name Description State Not used obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate Release Time LogTime The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The simulation time at which the last entity was logged 11 25 Statistics The Statistics object collects statistical information on the entities it receives The quantity to be tracked is specified using the SampleValue keyword which accepts an Expression Some typical examples for this input are e this obj A the sample value is the attribute A carried by the received entity e this SimTime this obj t the sample value is the simulation time that has elapsed since the attribute t for the received entity was set to the simulation time at some earlier point in the model Default Graphic 6 Ausenc O 2015 14 April 10 2015 Keyword Description TestEntity NextComponent SampleValue Out
74. imeSeriesThreshold The TimeSeriesThreshold object varies its state between open and closed depending on the present value for a TimeSeries object The TimeSeries to be monitored is specified by the TimeSeries keyword Trigger levels are determined by its MinOpenLimit and MaxOpenLimit keywords For the TimeSeriesThreshold to be open the present value for the TimeSeries must be within the range specified by these two keywords The LookAhead and Offset keywords provide additional flexibility e f a non zero value is specified for the LookAhead keyword then the value for the TimeSeries must be within the range specified by the MinOpenLimit and MaxOpenLimit keywords over the entire LookAhead duration starting from the present time e f anon zero value is specified for the Offset keyword then the above rule is modified so that the LookAhead duration begins at the present time plus the offset Default Graphic Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity Unit Type The Unit Type for the threshold e g DistanceUnit TimeUnit Mass Unit TimeSeries The name of the TimeSeries object to be monitored MaxOpenLimit The limit over which the threshold is closed MinOpenLimit The limit under which the threshold is closed receanesn The amount of time that the threshold must remain within MinOpenLimit and MaxOpenLimit to be con
75. in the accuracy of the simulation results is to perform a careful audit of the model inputs by a someone who is not part of the project team e Change control Standard software for change control such as GIT can be used to track model inputs With two or more people a project team it can be difficult to ensure that everyone is working on the latest version of the model Even wih only one simulation analyst it can be challenging to document all the changes to a model and the reason for each change e Front ends Software for performing simulation experiments and optimisation can be developed by third parties in other programming languages such as Python There is no need for these tools to be build into the simulation software itself causing clutter in the user interface and locking users into a restricted set of options We recommend the use of Notepad an open source editor available for download at ww notepad plus plus org Basic Structure A JaamSim input configuration file consists of a series of lines akin to a scripting language Each line consists of a combination of object names keywords and values contained within braces One or more spaces are used to separate these elements Braces are also used to denote sets of arguments within the outer braces required for arguments in general Blank lines and extra whitespace are ignored by JaamSim n Ausencs JaamsSim User Manual Comments beginning wth a double quote can be used to docu
76. ing filled at present 1 Ausenc O 2015 14 April 10 2015 State Name Working Idle Stopped Clearing while Stopped 11 21 Unpack JaamSim User Manual State Definitions Description Performing its normal service Available for service but has no work to perform Service has been suspended by the closure of one or more Thresholds The present senice activity is being completed before ceasing further operation The Unpack object is used to remove the entities from incoming EntityContainers Entities are unpacked one by one from the EntityContainer in same order as they were packed The time to unpack each entity is specified by the Service Time keyword The received EntityContainer is destroyed once it has been unpacked Default Graphic 3 Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment WaitQueue Operating ThresholdList ServiceTime Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which the unpacked entities are passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank The Queue in which the arriving EntityContainers
77. ion A file path to the image file to be used for this display model Must be enclosed in agente single quotes if the path contains spaces Transparent If TRUE transparency is enabled for supported image types GIF and PNG CompressedTexture If TRUE image compression is applied in order to allevate memory issues with large images Ausenc O 2015 14 April 10 2015 JaamSim User Manual 8 3 TextModel TextModel objects specify the general appearance of Text objects and of Overlay Objects that display text OverlayText and OverlayClock as well as BillboardText A TextModel object can therefore be used as a style class with all instances of these text objects that have the same style sharing the same TextModel The table below describes the additional inputs for TextModel objects Key Inputs Keyword Description Fontane The font face to be used for text with this TextModel selectable via a drop down menu FontColour The colour of the text defined by a colour keyword or RGB values FontStyle Styles BOLD ITALIC to be applied to the font selectable via a pop up menu DropShadow If TRUE a drop shadow is displayed below the text DropShadowColour The colour of the drop shadow defined by a colour keyword or RGB values DropShadowOfiset The spacing between the text and its drop shadow specified in x y z coordinates 8 4 ScreenPointsModel The ScreenPointsModel is used to determine the graphics for entities that
78. ity Graphics Inputs Description The colour to display when the Signal Threshold is open The colour to display when the SignalThreshold is closed If TRUE the SignalThreshold is displayed when it it open If FALSE it is hidden when open If TRUE the SignalThreshold is displayed when it it closed If FALSE it is hidden when closed j Ausencs 2015 14 April 10 2015 JaamSim User Manual Outputs Output Name Description The present state for this object used for statistics collection Definitions for the various states are given in the table below TRUE if the SignalThreshold has been set to Open FALSE if the Signal Threshold State Spean has been set to closed OpenFraction The fraction of total time during which the Signal Threshold is open ClosedFraction The fraction of total time during which the Signal Threshold is closed State Definitions State Name Description Open The SignalThreshold is open Closed The SignalThreshold is closed 11 18 Assemble The Assemble object combines a number of sub components into an assembled part Sub components waiting for processing are collected into a series of Queue objects identified by the WaitQueueList keyword one for each type of sub component Incoming sub components must be sent directly to the appropriate queue not to the Assemble object itself If necessary a Branch object can be used to direct incoming entities to the various queues The assembly proce
79. ive the viewer a sense of depth in all dimensions Note that both of these view options provide full 3D perspective graphics Only the camera position is changed when a button is clicked Run Status The right hand side of the Tool Bar consists of indicators to illustrate the progress and status of the simulation run Status Bar Item Simulation Time Progress Bar Time Remaining Speed Up Position 4 2 View Windows Run Status Description The present simulation time displayed in the Preferred Unit for time Percentage of the simulation run that has been completed Wall clock time remaining until the simulation run is completed The ratio of elapsed simulated time to wall clock time Location of the mouse cursor in the active view window expressed in x y Z coordinates View windows similar to the figure below display a graphical representation of a simulation Multiple view windows can be defined depicting different parts of a model Each view window is an instance of a View object and can be modified interactively i Ausenc O 2015 14 April 10 2015 JaamsSim User Manual View Window with Default Graphical Entities Model Title Se ti La Ausen nat Default Objects When a new model is created a default view window shown in the above figure is created wth some default graphical objects that appear in this window XY Grid XYZ Axis AusLogo Title and Clock The XY Grid
80. lack Width 2 Inner curly braces are used for keywords that accept multiple input values Arrowl Points 0 0 0m 111M Include Statements The user can store input data in multiple files and then refer to these files in an input configuration file using Include statements These statements refer to other input configuration files by filename and path surrounded by single quotes Include Base File InputFile cfg Include statements are particularly useful in studies where the analyst wishes to vary only a few inputs across many simulation runs Using Include statements the analyst can create a base case configuration file and then use Include statements to create simple incremental configuration files for the additional runs Include Base File Basecase cfg Arrowl Width 2 0 This example includes the contents of Basecase cfg and modifies the already defined object Arrow1 keyword Width value to 2 0 Note that the changes from the base case configuration must appear after the Include statement These simple configuration files are useful because it is easy to tell exactly how the configuration differs from the base case configuration Group Objects Group objects bundle multiple objects together to simplify inputs Instead of referring to a long list of objects a single group is used instead The group may be used to set the value for the keyword for all members instead of setting the value for each memb
81. lity Distributions Palette 10 Basic Objects Palette 11 Process Flow Palette 12 Calculation Objects Palette 13 Fluid Objects Palette 14 Advanced Topics 15 Colour Name Index wth RGB Values 16 Basic Example Input Configuration File OONDOABRWNDN Ausenc O 2015 14 April 10 2015 JaamsSim User Manual 2 Installing JaamSim 2 1 System Requirements JaamSim runs under Windows Linux and OSX on most modern computers Support is required for OpenGL graphics version 3 0 or later OpenGL 2 1 is also supported with some degraded functionality These specifications are provided by typical laptop computers with Intel Core 13 i5 and i7 series processors with integrated graphics second generation Sandybridge processors and later For models wth high end graphics we recommend a NVIDIA GeForce graphics card It is not necessary to use the more expensive NVIDIA Quadro workstation type graphics cards Although it is possible to use a computer with an AMD graphics card we find that NVIDIA cards provide better support for OpenGL graphics and are preferred for JaamSim 2 2 Installing Java JaamSim requires a recent Version 7 or later installation of the Java Runtime Environment JRE available for download free of charge from www oracle com The 64 bit version of the JRE is preferred for 64 bit operating systems 2 3 Installing and Launching JaamSim JaamSim consists of a single executable that can be copied
82. lues The unit type for the value retumed by the calculation The list of inputs to the weighted sum The inputs can be a constant value or any entity that returns a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression The list of dimensionless multiplicative factors to be applied to the values provide by the inputs Outputs Description The present simulation time The present output value for this Calculation Object The Polynomial object evaluates a specified polynomial for the present input value x InputValue Scale Value CoefficientList 0 CoefficientList 1 x CoefficientList 2 x 2 Default Graphic 1 Keyword Description Controller SequenceNumber UnitType InputValue CoefficientList Scale 2015 14 April 10 2015 Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher values The unit type for the value retumed by the calculation The input value for the present calculation The inputs can be a constant value or any entity that returns a number such as a Calculation Object a TimeSeries
83. ment the input files There is no need to use a double quote mark to end the comment since JaamSim automatically recognizes the end of a comment with the end of the line If a comment extends for several lines each line must start wth a double quote Object Definitions In JaamSim an object is initialized by a Define statement The statement contains Define followed by the object type and the object name enclosed by braces Multiple objects can be defined at the same time provided that they are of the same type For instance the following two lines define respectively a single Arrow object and three Arrow objects Define Arrow SingleArrow Define Arrow Arrowl Arrow2 Arrow3 JaamSim ignores extraneous whitespace allowing the object definition to span multiple lines provided that all objects are surrounded by braces Object instances can only be referenced after they have been defined Object Inputs Once an object is defined its keyword values can be set using a command of the following form lt object name gt lt keyword gt lt valuel gt lt value2 gt where value value2 is the list of values for the keyword separated by one or more spaces For instance the following line sets the colour of the Arrow1 object to be black Arrowl Colour black Multiple parameters for an object can be set in one line containing the object name followed by keyword and value pairs Arrowl Colour b
84. mum of the samples returned by the distribution SampleMean The average of the samples retumed by the distribution SampleStandardDewation The standard deviation of the samples retumed by the distribution 9 4 Changing the Random Seed Each distribution includes the keyword RandomSeed which permits a different pseudo random sequence of values to be generated for each separate distribution Often a simulation model is executed multiple times called replications using different random seeds to determine the statistical accuracy of the output parameters One way to achieve multiple replications is to change the random seed for each distribution however this can be a tedious exercise when large numbers of distributions are used in a model The GlobalSubstreamSeed keyword for Simulation provides an easier way to accomplish the same result Changing the input for this keyword causes every distribution in the model to generate a different random sequence In effect the random seed for each distribution is the combination of the two inputs RandomSeed and GlobalSubstreamSeed O 2015 14 38 A Js April 10 2015 usenc 2015 14 April 10 2015 JaamsSim User Manual 10 Basic Objects Palette The Basic Objects palette contains a number of powerful objects that can be used wth any type of simulation model List of objects TimeSeries TimeSeries Threshold ExpressionT hreshold EntitlementSelector J J J J 10 1 TimeSeries T
85. n or an Expression 2015 14 49 April 10 2015 Ausenc O 2015 14 April 10 2015 Default Graphic Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment Duration Animation Points Width Color Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time 11 8 Resource Default Graphic e JaamsSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a received entity will be passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank The time required to process the incoming entity Can be a constant value a TimeSeries a Probability Distribution or an Expression If TRUE entities are moved along the specified path to represent their progression through the delay activity The coordinates for the start intermediate joints and end of the EntityDelay The with of the line representing the delay in pixels The colour of the line representing the delay Outputs Description Not used Entity last received Number of entities received The total number of entities that have been process
86. n the range 1 N except that instead of returning a random selection based on probabilities it makes its choice using an entitlement algorithim based on proportions The entitlement algorithm chooses the index that minimizes the difference between the actual number returned for each index and the expected number based on the proportions The ProportionList keyword is used to specify the relative proportions for the N choices 1 N O Ausenc 2015 14 April 10 2015 Keyword Description AttributeDefinitionList ProportionList Output Name SampleCount SampleDifference Value NumberOfSamples JaamsSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity A list of N numbers equal to the relative proportion for each of the N indices Must sum to 1 0 Outputs Description The number of times each of the N indices has been selected The difference between the number of times each index has been selected and the expected number calculated from the proportions The last index that was selected The total number of times that an index has been selected i Ausenc O 2015 14 April 10 2015 JaamsSim User Manual 11 Process Flow Palette The Process Flow palette contains all the objects needed to create process flow type models These models are characterized by a passive entity that is passed from one object to another
87. nThreshold is displayed when it it open If FALSE it is hidden when open If TRUE the ExpressionThreshold is displayed when it it closed If FALSE it is hidden when closed The colour to display when the when the threshold condition is true but the Expression Threshold object has not be updated yet and its state is still closed The colour to display when the threshold condition is false but the Expression Threshold object has not be updated yet and its state is still open If TRUE the states PendingOpen and PendingClosed will be displayed when appropriate Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below The fraction of total time during which the threshold condition is true The fraction of total time during which the threshold condition is false TRUE if the threshold condition is true FALSE if the threshold condition is false Evaluated on demand when used by another expression State Definitions Description The threshold condition is true The threshold condition is false The threshold condition is true but the ExpressionThreshold object has not be updated yet and its state is still closed The threshold condition is false but the ExpressionThreshold object has not be updated yet and is state is still open The EntitlementSelector object is similar to the DiscreteDistribution object in that it returns an index i
88. nerator JaamsSim User Manual The EntityGenerator object creates a series of entities that are passed to the next object in a process The PrototypeEntity keyword identifies the entity to be copied This entity can be any type of object no matter how complex Copies retain both the graphics of the prototype as well as the values of all its inputs The rate at which entities are generated is determined by the InterArrivalT ime and FirstArrivalTime keywords These inputs have units of time and can be a constant value a TimeSeries a Probability Distribution or an Expression Default Graphic e Keyword Description AttributeDefinitionList NextComponent Operating ThresholdList FirstArrival Time InterArrival Time EntitiesPerArrival PrototypeEntity MaxNumber Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time Working Open NumberGenerated 2015 14 April 10 2015 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The next object to which the generated entity is passed A list of threshold objects that must all be open for operation to proceed Operation is stopped if any one of the thresholds is closed The time at which the first entity is to be generated Can be a constant value a TimeSeries a Probability Distribution or an Expression The elapsed time between one generated entity and the next Can
89. nitionList User defined outputs to be added to this entity Outputs Output Name Description State Not used obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time ReleaseTime The time at which the last entity was released 11 4 Server The Server object processes an incoming entity and then passes it to the next object Entities that are waiting to be processed are held by a Queue object identified by the keyword WaitQueue All entities received by the Server first pass through this Queue object even if the Server is idle Entities can also be sent directly to the Queue specified by the WaitQueue keyword Whenever an entity is added to a Queue all the Servers that specified this Queue as its WaitQueue will be notified The first Server that is available will then remove the entity for processing The rate at which entities are processed is determined by the ServiceTime keyword This input has units of time and accepts a constant value a TimeSeries a Probability Distribution or an Expression The Server can be stopped under various circumstances using the OperatingThresholdList keyword which specifies a list of Threshold objects such as SignalThreshold TimeSeriesThreshold or ExpressionThreshold All of the specified Threshold objects must be open for the Serv
90. ntrols E a Simulation Simulation Units i Display Models A AA i aos 2014 Jan 01 P usenco Process Flow EntityGenerator dD EntityConveyor Input Editor Serv E Output Viewer Serv xj rU Server Key Inputs Basic Graphics output Fag r Description 0 000564444 h Serv Queue A SimEntity AttributeDefinitionList J Probability Distributions StateGraphics TestEntity NextComponent StateAssignment WaitQueue OperatingThresholdList 0 50633 1 798123 0 0 m 1 0 10 10m 0 0 0 0 0 0 rad 0 0 0 0 0 0 _ Working ServiceTime j Gen_2 NumberProcessed 1 00000 ProcessingRate 0 492126 s NumberAdded 2 00000 ReleaseTime 0 000555556 h Le This example will be divided into four steps e Step 1 Creating Model Objects e Step 2 Putting the Objects Together e Step 3 Changing Model Graphics e Step 4 Adding a Probability Distribution 3 1 Step 1 Creating Model Objects After launching JaamSim the following windows will appear Control Panel provides a number of run control features View Window displays a graphical representation of the model Model Builder offers a selection of objects that can be added to the model Object Selector lists the objects present in the model Input Editor allows for editing of keywo
91. om in or out O i Ausenc Jaamsim User Manual Example of a Configured View View1 x Model Title o 2014 Jan 01 00 00 00 000 Create the rest of the objects for this model from the Process Flow palette in the Model Builder in the following order from left to right EntityGenerator EntityConveyor Server EntityConveyor EntitySink and rename them using the same method as for the Proto entity Renamed Objects Object Name EntityGenerator1 Gen EntityConveyor1 GenToServ Server Serv EntityConveyor2 ServloSink EntitySink1 Sink Queue SenQueue The re positioning of these objects will be covered in a later step The model so far should look similar to the Model Layout below depending on how the viewing position was adjusted Save the model from the File menu on the Control Panel with the name JaamSimBasicExample cfg when prompted We recommend saving regularly when building models O 2015 14 5 A n April 10 2015 usenc JaamSim User Manual Model Layout Viewl1 Model T itle e H 01 00 00 00 3 2 Step 2 Putting the Objects Together Now that the objects have been placed in the model they need to be set to interact with one another to generate Gen transport GenToServ ServToSink process Serv and consume Sink Proto entities This is done by assigning values to the appropriate keywords for each object First connect the appropriate objec
92. on exp Exponential function In Natural logarithm log Base 10 logarithm Examples of valid expressions that use functions are 2 max 3 4 x I 2 max 1 this OutputA 3 Entityl OutputB wa Logical Operations Logical operations can also be performed in expressions using the standard Java symbols Logical Operators Keyword Description Equal to I Not equal to lt Less than lt Less than or equal to gt Greater than gt Greater than or equal to amp amp Logical AND operation Logical OR operation Logical NOT operation Conditionals For conditional operations all non zero results are interpreted as TRUE while zero is interpreted as FALSE The following are examples of syntactically valid logical expressions this OutputA gt 1 this OutputA gt 1 amp amp Entity1 OutputB 0 i Ausencs 2015 14 April 10 2015 JaamsSim User Manual Conditional operations are also implemented using the ternary operator using the following syntax condition_expression true_expression false_expression Examples of the conditional operator are W 2 gt 1 5 4 this OutputA gt 2 Entityl OutputB 1 0 There is no limit to the length or complexity of an expression Conditional operators can be mixed freely with any other mathematical operations in an expression 14 3 Attributes In addition to the pre programmed outputs us
93. one at time separated by a delay determined by the ReleaseDelay keyword This delay does not apply to entities that arrive when the EntityGate is open However if queued entries are still being released an incoming entity is placed at the end of the queue even though the EntityGate is open The EntityGate s state either open or closed is determined by the input to the Operating ThresholdList keyword which specifies a list of Threshold objects such as SignalThreshold TimeSeriesThreshold or ExpressionThreshold All of the specified Threshold objects must be open for the EntityGate to be open O j Ausenc 2015 14 April 10 2015 JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity The prototype entity used to generate the stream of entities received by this object NextComponent The next object to which a received entities is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank A Queue object in which to hold incoming entities that are blocked when WaitQueue EntityGate is closed OperatingThresholdList pn H Threshold objects that determine whether the EntityGate is open or ReleaseDelay The time required to remove each
94. or example it might be better to view time outputs in terms of hours instead of seconds the Sl unit for time and distance outputs in terms of kilometres instead of metres the SI unit for distance These changes can be accomplished by setting the input to the DisplayedUnit keyword for Simulation to h km The DisplayedUnit keyword allows all the desired units to be specified in one place O i Ausenc 2015 14 April 10 2015 JaamSim User Manual 7 Graphics Objects Palette Graphical Objects are used to create 3D objects pictures text graphs arrows and other visual components needed to visualise and monitor a simulation List of objects DisplayEntity Text Overlay Objects Billboard T ext Arrow Graph View 7 1 DisplayEntity The DisplayEntity is the basic 3D graphical object in JaamSim All JaamSim objects that have graphics are sub classes of DisplayEntity A DisplayEntity dragged and dropped from the Model Builder can be used to display a static object such as a 3D shape or a 2D picture The graphical appearance of a DisplayEntity and its subclasses is determined by its DisplayModel see the Display Models Palette section The two objects work together to generate an object s display In general the DisplayEntity determines what is displayed while its DisplayModel determines how it is displayed A number of different subclasses of DisplayModel are available to match the various subclasses of DisplayEntity
95. ory usage and rendering time will be shown Graphic Debug Info as an overlay on the view windows Help Clicking on the Help entry in the menu bar displays a single menu option that shows the software version number and copyright information Tool Bar The left hand side of the Tool Bar contains controls for manipulating the simulation run and the 3D view for the active display window The right hand side shows the status of the simulation run such as the elapsed simulation time Run Controls Ausenc O 2015 14 April 10 2015 Tool Bar Item Run Pause Simulation Stop Simulation Real Time Real Time Multiplier Pause at View Controls JaamSim User Manual Run Controls Description Starts pauses and resumes the simulation run Stops the simulation run and prepares it for re starting at time Zero If pressed the simulation speed is held to a constant multiple of wall clock time The ratio of simulated time to wall clock time that is used when the Real Time feature is active The time at which the software automatically pauses the simulation Accepts numbers with time units e g 500 h 1 y or date time format yyyy mm dd hh mm ss s Two buttons are provided to adjust the camera position Tool Bar Item 2D 3D View Controls Description Moves the camera for the active vew window to give a bird s eye view directly above the x y plane of the simulation Moves the camera for the active vew window to g
96. plex 3D objects to be loaded much faster than is possible with the DAE and OBJ formats A JSB file can be exported by right clicking on a ColladaModel in the Object Selector and selecting Export 3D Binary File jsb A present the ColladaModel must have been created from a DAE file Support for OBJ and JSM files will be added in a future version of the software Note that the Ausencs 2015 14 April 10 2015 JaamsSim User Manual exported JSB will look for the same textures as the DAE file and that these should be located in the same relative position to the JSB file as they were to the DAE file Managing 3D assets can be complicated because of the large file sizes and the need to provide separate files for the textures We recommend that the user place each 3D asset and its texture files in its own ZIP file This approach greatly reduces the number and size of the files being handled and ensures that the files can be moved between computers without breaking the file paths Note that it is often necessary to edit the DAE file with a text editor such as Notepad to convert any absolute file paths for texture file to relative ones The table below describes the additional inputs for ColladaModel objects DisplayModel Inputs Keyword Description A file path to the DAE OBJ JSM and JSB file to be used for this display model A ZP file containing one of these files and its related texture files can also be ColladaFile used and is th
97. put Name State obj NumberAdded NumberProcessed ProcessingRate Release Time SampleMinimum SampleMaximum SampleAverage SampleStandardDewvation StandardDeviationOfTheMean JaamSim User Manual Key Inputs Description Optional free form text that describes the object The prototype entity used to generate the entities received by the Statistics object The next object to which a received entity is passed An Expression that returns the sample value whose statistics are to be collected Outputs Description Not used Entity last received by the Statistics object Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The smallest value that was observed The largest value that was observed The average of the values that were observed The standard deviation of the values that were observed The estimated standard deviation of the sample average a Ausenc O JaamsSim User Manual 12 Calculation Objects Palette The Calculations Objects palette contains objects for building continuous type models and mixed discrete event continuous models As the name suggests a continuous model changes state continuously as time advances JaamSim is able to model this type of behaviour very efficiently using Outputs Attributes and Expressions List of objects Controller Wei
98. quenceNumber calculations are performed A calculation with a lower value is executed before the ones with higher values Unit Type The unit type for the value retumed by the calculation SetPointUnitType The unit type for the set point and the process variable The set point for the PID controller The set point can be a constant value or any SetPoint entity that returns a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression The process variable feedback to the PID controller The process variable can be a ProcessVariable constant value or any entity that returns a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression ProportionalGain The coefficient applied to the proportional feedback loop Integral Time The coefficient applied to the integral feedback loop Derivative Time The coefficient applied to the differential feedback loop OutputLow The lower limit for the output signal OutputHigh The upper limit for the output signal Outputs Output Name Description SimTime The present simulation time Value The present output value for this Calculation Object ProportionalValue The proportional component of the output value IntegralValue The integral component of the output value DerivativeValue The derivative component of the output value Error The value for SetPoint ProcessVariable 12 7 Lag The Lag object calculates the lag operation used in electronic cont
99. rOfEntities keyword Once the specified number of entities are available in the Queue and there is an EntityContainer waiting in its Queue they are added one by one to the EntityContainer in same order as the Queue The time to add each entity is specified by the ServiceTime keyword Default Graphic y Ausenc O 2015 14 April 10 2015 Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment WaitQueue Operating ThresholdList NumberOfentities Service Time ContainerQueue Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time Working Open Container State Name Working Idle Stopped Clearing while Stopped 11 23 RemoveFrom JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a processed EntityContainer is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank The Queue in which the arriving entities are stored while they wait to be added A list of Threshold objects which must be open for the adding operation to proceed The number of entities to add to each En
100. rds for a selected object Output Viewer displays outputs for a selected object O 2015 14 3 A n April 10 2015 usenc 2015 14 April 10 2015 JaamSim User Manual In the Model Builder expand the Process Flow palette and then drag and drop a SimEntity into the View Window View1 This creates a SimEntity object with a default name SimEntity1 and shape Sphere and automatically selects it denoted by green highlighting as seen below i Queue This object will serve as the prototype for entities that will be handled in the model In the Object Selector select SimEntity1 and press F2 or triple click it to rename the object Note that when renaming an object the Enter button must be pressed when finished otherwise the change will not be completed Objects to Create Model Builder Palette Object Name ProcessFlow SimEntity Proto Renaming an Object REE di Defined Objects H Simulation Controls Fl Units Fl Display Models Graphics Objects ft DisplayEntity Ee View ie w Viewl E OverlayClock FI Basic Objects Fl SimEntity epo E OverlayImage OverlayText Since the model graphics will be 2 D aside from the Proto entity click the 2D button on the Control Panel so that the view becomes bird s eye Then adjust the viewing position as desired using the following actions View Adjustments Mouse Keyboard Action Effect on Viewing Position Left Drag Pan in the XY plane Scroll Wheel Zo
101. rol systems t 0 simulation time zero t 1 t n previous update times generated by the Controller dt i t i t 4 1 InputValue i input value at update time t 1 Error i InputValue i Value i Sum Error 1 dt 1 Brror 2 detZ Error n dt n Value 1 LagTime Sum InputValue Value n SimTime t n Default Graphic amp 2 Ausenc O 2015 14 April 10 2015 Keyword Description Controller SequenceNumber Unit Type InputValue LagTime Output Name SimTime Value Error 12 8 MovingAverage JaamSim User Manual Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher values The unit type for the value retumed by the calculation The input value for the present calculation The inputs can be a constant value or any entity that retums a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression A value with units of time used in the lag calculations Outputs Description The present simulation time The present output value for this Calculation Object The value for
102. se Time The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released 11 11 Assign The Assign object performs one or more Attribute assignments whenever it receives an incoming entity The Assign object is the only place where an attribute s value can be modified Attributes can be assigned for the Assign object itself the received entity or for any other entity in the model Once the assignments have been performed the received entity is passed to the next object wthout delay The attribute assignment to be performed are specified by the AttributeAssignmentList keyword Examples of the inputs to this keyword are e this A this A 1 e this obj B this obj B 1 e Entity1 C Entity1 C 1 In this example the entries A B and C are the dimensionless attributes of the Assign object the entity received and Entity1 respectively The right hand side of each assignment equation is an Expression to be evaluated The left hand side identifies the attribute whose value is to be modified using using the same syntax as an expression Note that only attributes can be assigned it is not possible to assign a new value to an output The unit type for the expression must match the unit type for the attribute that was defined as part of the input to the AttributeDefinitionList keyword See the Units Palette section for more information about units Default
103. sent calculation The inputs can be a constant value or any entity that retums a number such as a Calculation Object a TimeSeries a Probability Distribution or an Expression Outputs Description The present simulation time The present output value for this Calculation Object The PlDController object simulates the Proportional Integral Differential PID type controller that is widely used in electronic control systems t t dt 0 simulation time zero 1 t n previous update times generated by the Controller i t i t i 1 Error SetPoint ProcessVariable Integral Error 1 dt 1 Error 2 dt 2 se Error n dt n Breor SimTime t n Derivative Error Error n SimTime t n ProportionalValue ProportionalGain Error IntegralValue ProportionalGain Integral IntegralTime DerivativeValue ProportionalGain Derivative DerivativeTime Value max OutputLow min OutputHigh ProportionalValue IntegralValue DerivativeValue Default Graphic d gt E Ausenc O 2015 14 April 10 2015 JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object Controller The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which Se
104. sidered open Offset The amount of time that the TimeSeries Threshold adds to the present time for each TimeSeries lookup O 2015 14 40 A 7 April 10 2015 usenc 2015 14 April 10 2015 Keyword OpenColour ClosedColour ShowWhenOpen ShowWhenClosed Output Name State Open OpenFraction ClosedFraction State Name Open Closed 10 3 ExpressionThreshold JaamSim User Manual Graphics Inputs Description The colour to display when the TimeSeries Threshold is open The colour to display when the TimeSeries Threshold is closed If TRUE the TimeSeries Threshold is displayed when it it open If FALSE it is hidden when open If TRUE the TimeSeries Threshold is displayed when it it closed If FALSE it is hidden when closed Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below TRUE if the TimeSeries Threshold is Open FALSE if the the TimeSeries Threshold is closed The fraction of total time during which the TimeSeries Threshold is open The fraction of total time during which the TimeSeries Threshold is closed State Definitions Description The TimeSeries Threshold is open The TimeSeries Threshold is closed The ExpressionThreshold object varies its state between open and closed depending on the value returned by an Expression The Expression to be evaluated is specified by the OpenCondition ke
105. sor generates a submenu wih the following entries Menu Item Input Editor Output Viewer Property Viewer Duplicate Delete Change Graphics Add Label Center in View 4 3 Model Builder Context Menu Entries Description Selects the object and opens its Input Editor window Selects the object and opens its Output Viewer window Selects the object and opens its Property Viewer window Creates a copy of the selected object in the current view window Deletes the selected object Opens a dialog box to select a new DisplayModel graphical representation for the selected object Creates a Text object with its name and RelativeEntity keywords set to the selected object Selects the object and centers the current View on it The Model Builder provides palettes of objects that can be dragged and dropped to construct a new model or to modify an existing one The figure below shows the Model Builder with the Graphical Objects palette opened ready for dragging and dropping k Ausenc O 2015 14 April 10 2015 JaamsSim User Manual Model Builder Model Builder X El Graphics Objects DisplayEntity PER OverlayImage 3 abc OverlayText OverlayClock abc BillboardText 2 oe Graph ee Probability Distributions j Basic Objects Once an object has been created by dragging and dropping it from the Model Builder into a view window its inputs are entered using the Input Editor When a model is saved
106. splay Model objects have the same Basic Graphics keywords described below that control optional rendering and scaling at different drawing ranges Basic Graphics Inputs Keyword Description VisibleViews A list of Views for which this Display Model is shown If empty the model appears on all vews DrawRanae A list of two values for the minimum and maximum distance from the camera this g object is visible ModelScale A list of three multiplicative factors by which to scale the model in the x y and z dimensions respectively 8 1 ColladaModel ColladaModel objects are used to display custom 3D graphics in a simulation model The COLLADA file format DAE is an interchange file format used for 3D graphics Any 3D object such as a DisplayEntity and most of its sub classes can accept a ColladaModel as its DisplayModel see the Display Models Palette section A number of other 3D formats can be used in addition to Collada At the present time JaamSim supports DAE OBJ JSM and JSB formats as well as zipped versions of these files ZIP The JSM and JSB formats are specific to JaamSim e The JSM format was introduced to allow 3D objects to be animated These files can be created using a plug in for Blender an open source 3D graphics program Animation is still in the early stages of development at the present time Please contact us for more information if you wish to use this feature e The JSB format is a binary format that allows com
107. splayModel with the imported 3D object or image All objects intended for visualization in a model display window in JaamSim have a set of Basic Graphics keywords used to define their appearance These are found in the Basic Graphics tab of the Input Editor when the object is selected 2 Ausenc O JaamSim User Manual Basic Graphics Inputs Keyword Description Position The point in the region at which the alignment point of the object is positioned The point within the object about which its Position keyword is defined expressed Alignment with respect to a unit box centered about 0 0 0 The size of the object in x y z coordinates When two coordinates are given it Size is assumed that z 0 When the size is changed the coordinates of the center are held fixed and the eight comers are moved Orientation The three Euler angles defining the rotation of the object An object with respect to which the Position keyword is referenced If that object is Reset moved any object connected to it by RelativeEntity will also move DisplavModel The graphical representation of the object Accepts a list of multiple Display Model pay objects for compatibility with level of detail and optional rendering Active If TRUE then the object is active and used in the simulation run Show If TRUE then the object is shown in the simulation vew windows If TRUE then the object can be positioned by dragging with the mouse Non Movabl
108. ss begins when there is at least one sub component entity in each of the queues When this occurs the first sub component in each queue is removed and destroyed and a new assembled part is created by copying the object specified by the PrototypeEntity keyword The time required to complete the assembly process is given by the ServiceTime keyword Default Graphic S Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity The prototype entity used to generate the stream of entities received by this object NextComponent The next object to which the assembled part is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank Operating ThresholdList A list of Threshold objects which must be open for the assembly operation to proceed The time required to complete the assembly process Can be a constant value a Service Time e i TimeSeries a Probability Distribution or an Expression WaitQueueList A set of Queue objects one for each type of sub component to be assembled PrototypeEntity The entity whose copies will represent the assembled part Ausencs Output Name State obj NumberAdded NumberProcessed ProcessingRate ReleaseTime Working
109. t intermediate joints and end of the EntityConveyor Width The with of the line representing the conveyor in pixels Color The colour of the line representing the conveyor Outputs Output Name Description State The present state for this object used for statistics collection Definitions for the various states are given in the table below obj Entity last received NumberAdded Number of entities received NumberProcessed The total number of entities that have been processed ProcessingRate The rate at which entities have been processed NumberProcessed Total Time Release Time The time at which the last entity was released Working Returns TRUE if entities are being processed Open Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open State Definitions State Name Description Working Performing its normal service Idle Available for service but has no work to perform 11 7 EntityDelay The EntityDelay object delays an incoming entity by a variable duration before passing it to the next object The delay is represented as motion along a line that is similar in appearance to the EntityConveyor object It differs however in that the entities moving along the line can pass one another due to their having different delay times The duration of each entity s delay is determined by the Duration keyword This input has units of time and accepts a constant value a TimeSeries a Probability Distributio
110. t Graphic JaamSim User Manual Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The prototype entity used to generate the stream of entities received by this object The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this keyword is blank The entity whose graphics are to be changed Defaults to the received entity A list of DisplayEntities whose graphics can be copied to the received entity The index 1 N of the DisplayEntity whose graphics are to be copied to the received entity Can be a constant value a TimeSeries a Probability Distribution or an Expression Outputs Description Not used Entity last received Number of entities received The total number of entities that have been processed The rate at which entities have been processed NumberProcessed Total Time The time at which the last entity was released The EntityGate object allows incoming entities to be blocked temporarily When the EntityGate is open and the queue is empty incoming entities pass through without delay When it is closed incoming entities are directed to a Queue where they are held until such time as the EntityGate opens When the EntityGate opens the queued entities are released
111. time elapses in the model The default Real Time Factor is 1 meaning each second watching the model corresponds to one simulated second It can be changed by using the arrows on the Real Time Factor or by entering a desired value Real Time Factor To continue working on the model either Pause the model which allows the simulation to later resume starting from the time Paused or Stop the model which resets the simulation 3 3 Step 3 Changing Model Graphics A few graphical adjustments will now be made to improve the appearance of the model While the changes in this step will not impact the functionality of the model graphics are invaluable when confirming proper operation in larger models Objects can be moved and resized by selecting them and holding down Control and left dragging If a handle is selected during this process the object will be resized otherwise it will move following the cursor These two techniques are illustrated using a cube in the figures below JaamSim User Manual Moving an Object Resizing an Object 2 3 j Use these methods to move and resize components as necessary Since the XYZ Axis marker isn t beneficial to this model hiding it will make the model less cluttered To do this select the Options from the Control Panel and click on the Show Axes entry to de select it Lastly change the Model Title in the View Window by returning to Object Selector and expanding the OverlayText palette
112. tityContainer Can be a constant value a TimeSeries a Probability Distribution or an Expression The time required to add each entity Can be a constant value a TimeSeries a Probability Distribution or an Expression The Queue in which the arriving EntityContainers are stored while they wait for processing Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below Entity last received Number of entities received The total number of EntityContainers that have been created The rate at which EntityContainers have been created NumberProcessed Total Time The time at which the last EntityContainer was passed to the next object Returns TRUE if entities are being processed Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open The EntityContainer to which entities are being added State Definitions Description Performing its normal service Available for senice but has no work to perform Service has been suspended by the closure of one or more Thresholds The present senice activity is being completed before ceasing further operation The RemoveFrom object is used to remove a given number of entities from an incoming EntityContainer Entities are removed one by one from the EntityContainer in same order as they were packed The time to unpack each entity is specified by the ServiceTim
113. to be used for displaying outputs from the simulation If no unit is specified for a given unit type then outputs for that type are given in SI units i Ausenc O 2015 14 April 10 2015 JaamSim User Manual 6 Units Palette JaamSim performs all internal calculations in SI units meters kilograms seconds etc However many quantities employed by simulation users are more conveniently specified in other unit systems To this end JaamSim natively supports a number of commonly used units shown in table below Unit Type Dimensionless Unit TimeUnit DistanceUnit SpeedUnit AccelerationUnit Mass Unit MassFlowuUnit VolumeUnit VolumeFlowUnit AngleUnit AngularSpeedUnit EnergyUnit EnergyDensity Unit SpecificEnergyUnit PowerUnit CostUnit CostRateUnit LinearDensity Unit LinearDensity VolumeUnit DensityUnit PressureUnit ViscosityUnit AreaUnit RateUnit Supported Unit Types and Units Default Unit seconds s meters m meters per second m s meters per squared second m s kilograms kg kilograms per second kg s cubic meters m cubic meters per second nv s radians rad radians per second rad s joules J joules per cubic meter J m joules per kilogram J kg watts W dollars dollars per second s kg m m m kg m Pa Pa s m Is Supported Units min h d w y mS us ns m km nmi mi ft in mm m s km h knots mph ft s tonnes kt Mt any mass unit h
114. topics and objects e Time Formats Expressions Attributes Editing the Configuration File Launching in Batch Mode ScriptEntity VideoRecorder 14 1 Time Formats Inputs of time can be entered in the normal fashion e g 5 s 12 h etc or they can be entered in a year month day format Both the ISO 8601 standard and the full RFC8601 format are supported Supported Time Formats Format Example Description YYYY MM DD 2013 08 25 August 25 2013 YYYY MM DDTHH mm SS 2013 08 25T04 25 00 4 25 AM on August 25 2013 YYYY MM DD HH mm SS 2013 08 25 04 25 00 4 25 AM on August 25 2013 aes Jee 0 1 seconds past 4 25 AM on YYYY MM DDTHH mm SS dddddd 2013 08 25T04 25 00 1 August 25 2013 HHHHHHHH mm SS dddddd 50000 00 00 000001 omnes eeege January 1 of year 0 0000 01 01 is taken to be to zero simulation time For example an input of 0001 01 01 is equivalent to 8760 h 14 2 Expressions Expressions are mathematical statements that are evaluated by JaamSim Many keywords that expect a number can also accept an object that returns a number such as a Probability Distribution a TimeSeries and an Expression Basics Mathematical expressions are entered using the following syntax an expression is enclosed in single quotes if it contains any spaces object names are enclosed by square brackets spaces in an expression are optional outputs and attributes of an object are referenced using a dot notation e g ObjectName O
115. tribution Generates samples over a continuous range of values 9 3 Keywords for Probability Distributions Each of the distributions uses the following standard keywords in addition to the ones that are specific to an individual distribution O 2015 14 37 A 7 April 10 2015 usenc JaamsSim User Manual Key Inputs Keyword Description The unit type for the value retumed by the distribution e g TimeUnit To keep the a units consistent for other inputs this input must be set first RandomSeed The random seed to be used by the random number generator The minimum value that can be returned by the distribution A value less than the MinValue ae ad ee minimum is rejected and re sampled from the distribution The maximum value that can be returned by the distribution A value greater than MaxValue the maximum is rejected and re sampled from the distribution A number of outputs are standard to all distributions Outputs Output Name Description The mean value for the distribution calculated directly from the inputs Ignores the CalculatedMean values entered for the MinValue and MaxValue keywords The standard deviation for the distribution calculated directly from the inputs CalculatedStandardDevation Ignores the values entered for the MinValue and MaxValue keywords NumberOfSamples The total number of samples returned by the distribution SampleMin The minimum of the samples returned by the distribution SampleMax The maxi
116. ts together by setting the following keywords Object Connections Object Keyword Value Gen NextComponent GenToServ GenToServ NextComponent Serv Serv NextComponent ServloSink ServloSink NextComponent Sink As a note hovering the cursor over keywords in the Input Editor will display a brief description of the keyword The mouseover for NextComponent is shown below 2 2015 14 6 A April 10 2015 Ausencs 2015 14 April 10 2015 JaamSim User Manual Mouseover Keyword Tips Description J o Description AttributeDefinitionList Set the time at which Proto entities will be added to the model by Gen and the time they will spend at each stage Transit and Handling Durations Object Keyword Value Gen InterArrival Time 2s GenToServ TravelTime 1s Serv ServiceTime 1s ServloSink Travel Time 1 55 The Server object requires a Queue object for entities waiting to be processed Set the following keyword to associate ServQueue with Serv Serv Inputs Tab Keyword Value Key Inputs WaitQueue ServQueue Lastly configure Gen to produce copies of Proto which is done by setting the following keyword Gen Inputs Tab Keyword Value Key Inputs PrototypeEntity Proto Save the model and press Play to run the simulation Ausenc O 2015 14 April 10 2015 JaamSsim User Manual Simulation Screenshot Viewl1 Model T itle e H 01 00 00 20 406 The Real Time Factor controls how fast the simulated
117. ty Distribution or an Expression The object to which a processed EntityContainer will be passed Outputs Description The present state for this object used for statistics collection Definitions for the various states are given in the table below Entity last received Number of EntityContainers received The total number of entities that have been removed The rate at which entities have been removed NumberProcessed Total Time The time at which the last EntityContainer was passed to the next object Returns TRUE if entities are being processed Returns TRUE if all the thresholds specified by the Operating ThresholdList keyword are open State Definitions Description Performing its normal service Available for senice but has no work to perform Service has been suspended by the closure of one or more Thresholds The present service activity is being completed before ceasing further operation Ausenc O 2015 14 April 10 2015 JaamsSim User Manual 11 24 EntityLogger The EntityLogger object records the outputs attributes and state data for each entity that it receives The output log file is created automatically when the simulation run begins The output file is named lt configation file name gt lt EntityLogger name gt log to ensure that it is unique for the simulation run For example if the configuration file is named run1 cfg and the EntityLogger s name is EntityLogger1 then the name of the log file w
118. ue for this Calculation Object The SineWave object generates a sine wave output Value Offset Amplitude sin 2 PI SimTime Period PhaseAngle Default Graphic Keyword Description Controller SequenceNumber Unit Type Amplitude Period PhaseAngle Offset Output Name SimTime Value Key Inputs Description Optional free form text that describes the object The Controller object that provides the update signal for this object If a Controller is not specified the output value is calculated asynchronously on demand The sequence number used by the Controller to determine the order in which calculations are performed A calculation with a lower value is executed before the ones with higher values The unit type for the value retumed by the calculation The height of the sine wave measured from zero The time interval over which the sine wave repeats The angle by which the sine wave is shifted in time An absolute shift of the sine wave up or down Outputs Description The present simulation time The present output value for this Calculation Object O 7 Ausenc JaamsSim User Manual 13 Fluid Objects Palette The Fluid Objects palette contains objects building dynamic models of fluid flow involving tanks pipes pumps etc List of objects Fluid FluidFlow FluidFixedFlow Fluid Tank FluidPipe FluidCentrifugalPump 13 1 Fluid The Fluid object defines the basic properties of th
119. um The largest number of objects in the queue A list of decimal values summing to 1 0 The first entry is the fraction of time that QueuelengthDistribution the queue is empty The second entry is the fraction of time that the queue contains one object and so on The number of entries is equal to the maximum queue length plus one AverageQueueTime The average time each entity waited in the queue Calculated as total accumulated queue time divided by the number of entities added to the queue 11 6 EntityConveyor The EntityConveyor object moves an incoming entity along a path at a fixed speed and then passes it to the next object The travel time for the EntityConveyor is determined by the TravelTime keyword This time must be a constant value i Ausenc O Default Graphic JaamsSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity h ea a entity used to generate the stream of entities received by this NextComponent The next object to which a received entity is passed The state to be assigned to a SimEntity when it is first received by this object The StateAssignment state name can be chosen freely by the user The SimEntity s state is unchanged if the value for this Keyword is blank TravelTime The time required convey an entity from the start to the end Points The coordinates for the star
120. use The second entry is the fraction of time that one unit was in use and so on The number of entries is equal to the maximum number of units that have been in use at any time plus one 11 9 Seize The Seize object allocates one or more units of a specified set of Resources on receiving an incoming entity If any of the Resources have insufficient units available the received entity is directed to a Queue object identified by the keyword WaitQueue All entities received by the Seize object first pass through this Queue object even if sufficient units of the Resources are available Entities can be sent directly to the Queue specified by the WaitQueue keyword Whenever an entity is added to the Queue all the Seize objects that specified this Queue as their WaitQueue will be notified The first Seize block that has sufficient resource units available will then remove the entity for processing Entities waiting for the same Resoures at more than one Seize object are processed on a first in first out basis Alll of the specified Resources must be available before any are seized Once all of them are available they are seized simultaneously Default Graphic j Ausenc O JaamSim User Manual Key Inputs Keyword Description Description Optional free form text that describes the object AttributeDefinitionList User defined outputs to be added to this entity TestEntity The prototype entity used to generate the stream of entities
121. utput Name State Count 2015 14 April 10 2015 Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity The amount of graphical space between entities in the EntityContainer Maximum number of entities contained in each row of the EntityContainer Outputs Description The present user defined activity being performed by the EntityContainer The present number of entities inside the container 7 Ausenc O 11 20 Pack JaamsSim User Manual The Pack object is used to generate EntityContainers and fill them with incoming entities EntityContainers are created automatically on demand by the Pack object The number of entities to be packed in each EntityContainer is determined by the NumberOfEntities keyword Once the specified number of entities are available in the Queue they are packed one by one in the EntityContainer in same order as the Queue The time to pack each entity is specified by the ServiceTime keyword Default Graphic d Keyword Description AttributeDefinitionList TestEntity NextComponent StateAssignment Operating ThresholdList PrototypeEntityContainer WaitQueue NumberOfentities ServiceTime Output Name State obj NumberAdded NumberProcessed ProcessingRate Release Time Working Open Container 2015 14 April 10 2015 Key Inputs Description Optional free form text that describes the object User d
122. utputName output and attributes can be chained when necessary using the format ObjectName OutputName1 OutputName2 the reserved string this is used to refer to the object evaluating the expression rules for mathematical order of operation are respected units are enclosed by square brackets all calculations must respect Units For example two values must have the same unit type if they are to be added e unit conversions are performed automatically For example a distance divided by a time results in a speed The following are examples of syntactically valid expressions They assume that the present object has an output OutputA and another entity Entity1 has an output OutputB OutputA and OutputB are both dimensionless 11 23 1 2 342 Ausencs 2015 14 April 10 2015 JaamsSim User Manual TI 2 this OutputA 11 2 Entityl OutputB 1 m 2 km 2 m 4 s Functions The following mathematical functions can be used in expressions Mathematical Functions Keyword Description PI Mathematical constant pi E Mathematical constant e min Minimum of a list of values max Maximum of a list of values abs Absolute value sin Sine of an angle or dimensionless number COS Cosine of an angle or dimensionless number tan Tangent of an angle or dimensionless number asin Arcsine function acos Arccosine function atan Arctangent function atan2 Two argument arctangent functi
123. video in pixels A list of views to include in the video or image The name of the video output file Ausenc O JaamSim User Manual 15 Colour Name Index with RGB Values Colour Name Colour R G B Colour Name R G B lavenderblush 255 240 245 chocolate 210 105 30 pink 255 192 203 rawsienna 199 97 20 lightpink 255 182 193 sienna 160 82 45 palevioletred 219 112 147 brown 138 54 15 hotpink L 255 105 180 lightsalmon 255 160 122 deeppink Wy a5 20 147 darksalmon 233 150 122 violetred Dy 208 32 144 salmon 250 128 114 mediumvioletred DI 9 2 133 lightcoral 240 128 128 raspberry WO is 3s 87 coral 255 114 86 thistle 216 191 216 tomato 255 99 71 plum 221 160 221 orangered 255 69 orchid Meee 218 112 214 red 255 0 violet 238 130 238 crimson 220 20 60 magenta 255 o 255 firebrick 178 A4 A purple E iz o 128 indianred 176 23 31 mediumorchid D ie 85 211 burntumber 138 51 36 darkorchid Dy ts3 50 204 maroon 128 0 O darkviolet E s o 21 sepia 4 38 18 blueviolet Dy x8 43 22 white 255 255 255 indigo Wes o 130 gray99 252 252 252 mediumpurple a 112 219 gray98 250 250 250 lightslateblue ee 132 112 255 gray97 247 247 247 mediumslateblue 123 104 238 gray96 245 245 245 slateblue DW 106 90 205 gray95 242 242 242 darkslateblue E 2 a 139 gray94 240 240 240 ghostwhite 248 248 255 gray93 237 237 237 lavender 230 230 250 gray92 235 235 235 blue a 255 gray91 232 232 232 darkblue a 139 gray90 229 229 229 naw oa 12
124. vides all the key functions needed for any simulation model Controls for launching and manipulating simulation runs Drag and drop user interface 3D interactive graphics Input and output processing Model development tools and editors It also provides a full suite of basic objects for model building Objects for process flow type models Server Queue etc Text objects for labelling and documentation Graphs for visualizing simulation outputs Probability distributions for random sampling Graphical objects for background maps and logos Advanced users can create additional palettes of high level objects for their applications New objects created in this way become extensions of JaamSim and automatically acquire the same features as the built in objects Coding for new objects is done in Java using standard development tools such as Eclipse There is no need for the proprietary programming languages process flow diagrams or scripting languages used by commercial off the shelf simulation software Model logic can be coded directly in either an event or process oriented style using a few simple classes and methods provided by JaamSim This document is separated into multiple stand alone chapters for easier reference Introduction Installing JaamSim Getting Started JaamSim Basic Example Graphical User Interface Simulation Controls Palette Units Palette Graphics Objects Palette Display Models Palette Probabi
125. yword Description Previous Diameter Length HeightChange Roughness PressureLossCoefficient Output Name SimTime FlowArea Velocity InletPressure DynamicPressure ReynoldsNumber OutletPressure 13 6 FluidCentrifugalPump Key Inputs Description Optional free form text that describes the object The upstream flow component that feeds the tank The diameter of the cylindrical tank The length of the pipe The change in elevation between the pipe s inlet and outlet The roughness height for the inside surface of the pipe Used to calculate the Darcy friction factor The pressure loss coefficient or K factor for the pipe The factor multiplies the dynamic pressure and is applied as a loss at the pipe s outlet Outputs Description The present simulation time Cross sectional area of the pipe The velocity of the fluid in the pipe The static pressure at the inlet to the pipe The dynamic pressure for the fluid in the pipe The Reynolds number for the fluid in the pipe The static pressure at the outlet from the pipe The FluidCentrifugalPump object models the performance of a centrifugal pump Speed relative speed input from the SpeedContoller object 0 0 zero speed 1 0 maximum speed FlowFactor FlowRate MaxFlowRate InletPressure OutletPressure for previous component OutletPressure InletPressure MaxPressure Speed 2 MaxPressureLoss FlowFactor abs FlowFactor r8 Ausenc O 2015 14 April 10
126. yword It is re evaluated with every time advance of the model and on demand when the output Open is used by another expression Expressions that change between TRUE and FALSE based on simulated time output this SimTime must be avoided because the change in state wil not be detected until an event occurs The correct way to obtain this type of behaviour is to use a TimeSeries and a TimeSeriesThreshold The states PendingOpen and PendingClosed are used to indicate the situation where an ExpressionThreshold is being used inappropriately These states can only be detected when a View window is open Default Graphic Keyword Description AttributeDefinitionList OpenCondition Key Inputs Description Optional free form text that describes the object User defined outputs to be added to this entity A mathematical expression that returns a boolean value TRUE or 1 open FALSE or 0 closed E Ausenc O 2015 14 April 10 2015 Keyword OpenColour ClosedColour ShowWhenOpen ShowWhenClosed PendingOpenColour PendingClosedColour ShowPendingStates Output Name State OpenFraction ClosedFraction Open State Name Open Closed PendingOpen PendingClosed 10 4 EntitlementSelector Default Graphic JaamSim User Manual Graphics Inputs Description The colour to display when the ExpressionThreshold is open The colour to display when the ExpressionThreshold is closed If TRUE the Expressio

JaamSim Manual (full)

Contents

Download Pdf Manuals

Related Search

Related Contents