Animation Commands

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide -> Menu Commands -> Graphics Commands -> Animation Graphics Commands

Graphics Command Summary Graphics |
Insert
Graphics |
Edit
Graphics |
Delete
Graphics |
Copy&Paste
Graphics |
Display
Graphics |
Animation
Graphics |
Symbol Management
Graphics |
Construct

Introduction

This is a subset of the graphics commands which are used to draw and manage SysCAD flowsheets.

Note: SysCAD must be in the Edit mode (stopped) for most of these commands to be accessed.

Annotation Table

Insert Annotation Table

Command Button InsertAnnotationButton.png
Command Path Graphics - Animation - Insert Annotation Table
Short Cut Key "Ctrl + Shift + N"

This command will allow a user to insert a table into a SysCAD flowsheet. The table displays of models, such as pipes, tanks, heat exchangers, etc, and measured variables in each model, such as Flow, Temperature, Duty, etc.

Before creating the Annotation Table, first open the access window of the model type you are interested in (eg, Pipe for stream table), that way you can see the valid variable tag names needed to create the annotation table.

To create the annotation table, select the Insert Annotation Table command to open the 'Insert Annotation' dialog box:

InsertAnnotation.png In Build139 and later,
variable tags can be added using the right click popup - Send to Annotation.
(During Step B).
Send to Annotation139.png
Step Description Notes
A Select the unit operation TAG(s)
  1. This can be typed in, separated by spaces, or selected by single left clicking on the unit operation(s) on the graphics window. (If a unit appears on a different Graphics Window, the tag must be typed in.)
  2. You can start with just ONE unit operation tag to first create the table, the rest can be added later using Update Annotation.
B Define the variable list.
  1. These variable names are separated by spaces, NOT commas.
  2. You can start with just ONE variable tag to first create the table; the rest can be added later using Update Annotation or use a pre-made list from the table below: Some Example Variable Lists for selected Unit Types.
  3. The variable can be typed in or pasted in using Copy Tag from the Access Window.
    • In Build139 and later, variable tags can be added using the right click popup - Send to Annotation option.
  4. Using Copy Tag or Send to Annotation (available in build 139 or later) will include engineering units for the variable.
    • In Build138 and earlier, Engineering units provided by the tags are not being used properly, where most are being ignored and replaced by default SI units. User needs to change the engineering units using Update Annotation.
    • In Build139 and later, Engineering units provided by the tags will be used correctly.
  5. Do NOT use variables from the Qi tabs of pipes, as these are not available for simple pipes. Always select variables from the Qo tab.
  6. Some variables tags will include the Tab name, such as Qo.LQm (for liquid mass flow in a stream) or Qo.Sf (solids fraction in a stream). Please see below for some typical variable lists.
    Hint: copy and paste pre-made list into the Variable List field when inserting the annotation table will keep the tables consistent for all flowsheets.
C Annotation Scale
  1. The default scale of the annotation block can be set in the Options-General-Drawings Tab.
    • NOTE: This option is on the Options-General-Graphics Tab for users using older SysCAD versions.
  2. Use a size of 3 (or greater) is usually good for A3 frame.
D Insert Annotation
  1. The Annotation table becomes visible on the graphics window and the mouse pointer changes to a X with 'POS' and a table and the 'Insert Annotation' button changes to 'Position Selected'. The user can now left click with the mouse button on the Graphics Window to position the table to a more appropriate position.
  2. The placement point of the annotation block is top left-hand corner of the table.
  3. The user may continue clicking on the graphics until they are happy with the position of the table.
  4. When the user is happy with the table position, press OK to close the 'Insert Annotation' dialog box.
E Editing Annotation Table
  1. After the annotation block is created, it can be moved with the Move Entity Command.
  2. The annotation block cannot be resized using the Scale/Rotate command. To change the Engineering units, number format, label of annotation block, use the Update Annotation command.

Some Example Variable Lists for selected Unit Types

NOTE: In the table below, there are two rows of tags per entry, the second row includes engineering units. In Build139 or later, user supplied engineering units will be displayed properly, therefore we recommend using tags with engineering units (2nd row). In Build138 and earlier, most engineering units are ignored and replaced by default SI units, so we recommend using tags without engineering units (1st row).

Unit Type Example List of Variables
Streams - Standard
  • Qo.Qm Qo.LQm Qo.Qv Qo.T Qo.P Qo.Rho Qo.Sf Qo.QM.H2O(l)
  • Qo.Qm (t/h) Qo.LQm (t/h) Qo.Qv (m^3/h) Qo.T (C) Qo.P (kPa) Qo.Rho (t/m^3) Qo.Sf (%) Qo.QM:Ph.H2O(l) (t/h)
Streams - Alumina
  • Qo.Qm Qo.LQm Qo.Qv Qo.T Qo.P Qo.Rho Qo.Sf Qo.QM.H2O(l) Qo.Props.A Qo.Props.C Qo.Props.S Qo.Props.A/C Qo.Props.C/S [email protected] Qo.Props.BPE
  • Qo.Qm (t/h) Qo.LQm (t/h) Qo.Qv (m^3/h) Qo.T (C) Qo.P (kPa) Qo.Rho (kg/m^3) Qo.Sf (%) Qo.QM:Ph.H2O(l) (t/h) Qo.Props.A (g/L) Qo.Props.C (g/L) Qo.Props.S (g/L) Qo.Props.A/C Qo.Props.C/S [email protected] (g/L) Qo.Props.BPE (dC)
Streams - Potash
  • Qo.Qm Qo.LQm Qo.SQm Qo.Sf Qo.Qv Qo.T Qo.P Qo.Rho Qo.QM.KCl(aq) Qo.QM.NaCl(aq) Qo.QM.MgCl2(aq) Qo.QM.CaSO4(aq) Qo.QM.H2O(l) Qo.Potash.KCl.SatFrac Qo.Potash.NaCl.SatFrac Qo.QM.KCl(s) Qo.QM.NaCl(s) Qo.QM.CaSO4.2H2O(s)
  • Qo.Qm (t/h) Qo.LQm (t/h) Qo.SQm (t/h) Qo.Sf (%) Qo.Qv (m^3/h) Qo.T (dC) Qo.P (kPag) Qo.Rho (t/m^3) Qo.QM.KCl(aq) (t/h) Qo.QM.NaCl(aq) (t/h) Qo.QM.MgCl2(aq) (t/h) Qo.QM.CaSO4(aq) (t/h) Qo.QM.H2O(l) (t/h) Qo.Potash.KCl.SatFrac (%) Qo.Potash.NaCl.SatFrac (%) Qo.QM.KCl(s) (t/h) Qo.QM.NaCl(s) (t/h) Qo.QM.CaSO4.2H2O(s) (t/h)
Streams - Sugar
  • Qo.Qm Qo.T Qo.Rho Qo.Props.Ws Qo.Props.Wds Qo.Props.Purity Qo.Props.SW Qo.Props.IW Qo.Props.BPE
  • Qo.Qm (t/h) Qo.T (C) Qo.Rho (t/m^3) Qo.Props.Ws (%) Qo.Props.Wds (%) Qo.Props.Purity (%) Qo.Props.SW Qo.Props.IW Qo.Props.BPE (C)
Heat Exchangers
  • LMTD UA Duty Pri.Qm Pri.Ti Pri.To Pri.dT Sec.Qm Sec.Ti Sec.To Sec.dT
  • LMTD (C) UA (kW/K) Duty (kW) Pri.Qm (t/h) Pri.Ti (C) Pri.To (C) Pri.dT (C) Sec.Qm (t/h) Sec.Ti (C) Sec.To (C) Sec.dT (C)
Shell and Tube Heat Exchangers
  • LMTD UA Duty Tube.Qm Tube.Ti Tube.To Tube.dT Shell.Qm Shell.Ti Shell.To Shell.dT
  • LMTD (C) UA (kW/K) Duty (kW) Tube.Qm (t/h) Tube.Ti (C) Tube.To (C) Tube.dT (C) Shell.Qm (t/h) Shell.Ti (C) Shell.To (C) Shell.dT (C)
Solid Liq Separators
  • UF.Qm UF.Qv UF.SQm UF.LQm UF.Sf UF.Rho UF.SolidConc UF.SolidConc25 OF.Qm OF.Qv OF.SQm OF.LQm OF.Sf OF.Rho OF.SolidConc OF.SolidConc25
  • UF.Qm (t/h) UF.Qv (m^3/h) UF.SQm (t/h) UF.LQm (t/h) UF.Sf (%) UF.Rho (t/m^3) UF.SolidConc (g/L) UF.SolidConc25 (g/L) OF.Qm (t/h) OF.Qv (m^3/h) OF.SQm (t/h) OF.LQm (t/h) OF.Sf (%) OF.Rho (t/m^3) OF.SolidConc (g/L) OF.SolidConc25 (g/L)
Precipitator3 - Alumina
  • On Cooling TankVol ResidenceTime Yield SuperSat THA.Precip Solids.Conc ACin ACout Ti To Total.Thermal.Loss
  • On Cooling TankVol (m^3) ResidenceTime (h) Yield (g/L) SuperSat THA.Precip (t/h) Solids.Conc (g/L) ACin ACout Ti (C) To (C) Total.Thermal.Loss (kW)

Update Annotation Table

Command Button UpdateAnnotationButton.png
Command Path Graphics - Animation - Update Annotation Table
Short Cut Key "Ctrl + Alt + N"

Once an annotation table is in place, user can use Update Annotation table to change the engineering units, number format and label of the unit and variable tags.

UpdateAnnotation.png
  1. To add a new Tag or Variable, press the Add button, this will create a duplicate of the Tag/Variable on the list. Edit the information of this duplicate tag to become the new tag/variable, this may include Tag/Variable name, display Label, variable format and conversions.
  2. You can assign a label to a tag as well as to a variable. These labels will be used in the annotation table.
  3. You can also customise the displayed numbers' format and conversion units in the update annotation dialog box.
  4. You can change the size (scale) of the annotation table using the Text Scale input box.
  5. Press OK when finished to update the annotation table.

NOTES:

  • Duplicate tag / variable will be discarded
  • Invalid tag / variable will be discarded

Refresh Annotation

Command Path Graphics - Animation - Refresh Annotation

This command updates the annotation table on the active Graphics Window.


Refresh All Annotation

Command Button RefreshAnnotationButton.png
Command Path Graphics - Animation - Refresh All Annotation

This command updates all annotation tables on all Graphics Windows.

Fill Area

Insert Fill Area

Command Button InsertFillButton.png
Command Path Graphics - Animation - Insert Fill Area

This command allows you to add dynamic fill animation to a graphics symbol. It is commonly used to observe parameters such as vessel level or temperature. To do this, the dynamic fill animation block needs to be added to a graphics symbol. On the dynamic fill dialog box:

CreateFill.png
Step Description Notes
A Select Variable The most common variable used is Level, Lvl (%), for a tank. However, the user could type in T (C), for Temperature, or any other measured variable.
B Range Define the Minimum and Maximum values.
For example, for a tank level Min = 0 and Max = 100%.
For Temperature the minimum and maximum would be defined by the user based on the expected temperature range.
C Colour Box This box allows the user to select a preferred colour. To change the colour click on the box and select a colour from the pallet.
D Apply to all identical entities 1. If this tick box is enabled then all of the existing symbols for the same model on the same Graphics Window will have a dynamic fill added.
2. This only applies to existing units on the same Graphics Window. If you add a unit with the same symbol AFTER you have added the fill annotation, it will not have the fill included.
E Select UNIT Once information is provided in the dynamic fill dialog box, the user may select the unit by clicking on the required unit in the graphics window.
The mouse cursor will display UNIT when moved over the Graphics Window.
F Select POINTS Once the UNIT has been selected the mouse cursor then changes to POINT. Click the mouse button to draw points to form a block. Note that lines do not snap to horizontal or vertical lines, and diagonal lines are allowed so that a cone can be drawn if required. Press OK on the dialog box to accept the dynamic fill or press Cancel to start again.

NOTES: 1. We recommend that you zoom into the unit to which the FILL is being added so that you can accurately follow the unit lines.
2. To delete the dynamic fill, use Update Fill Area

G Running The dynamic fill will be animated when run is started. Check configurations option in Tools - General Options - Graphics.

WARNING: Before using the Fill command, make sure the correct Graphics Window is the active window.

Update Fill Area

Command Button UpdateFillButton.png
Command Path Graphics - Animation - Update Fill Area

Once a fill area is in place, it can be updated using the Update Fill Area command.

Updatefill.png
  1. Move the mouse over to the Graphics Window and the mouse cursor will display UNIT, click on the fill area you wish to update, and the fill area dialogue box will open, this time it has an extra button delete.
  2. You can change the variable and minimum/maximum values as per inserting a fill area.
  3. If you are using 'Lvl' (without the engineering units), the Max value should be 1, not 100.
  4. A fill area can be removed by pressing delete.
    • If the Apply to all identical entities option is on, all fill areas for that unit type will be deleted.
    • The graphics for the fill area block will not be deleted. See below for how to remove the unwanted dynamic fill graphics.
  5. If you have pressed update fill area and could not find a fill area, you can exit out of the option by either right clicking on the Graphics Window or choosing another option like redraw.


Hints on removing unwanted Dynamic Fill graphics:

If the dynamic fill is drawn incorrectly and user wish to reapply the dynamic fill to the exact same symbol, follow these steps to clear and reapply the dynamic fill:

  1. Use Change Symbol to choose a new temporary symbol (this can be whatever as we will change it back to the current symbol in step 5). If there are multiple "incorrect symbols" on the current flowsheet, change them all.
  2. Save the project as is.
  3. Close the Exit SysCAD. (These three steps should force SysCAD to delete any unused symbol in the graphics file)
  4. Start SysCAD and Open the project.
  5. Use Change Symbol to change the symbol back to the Correct Symbol.
  6. Use Insert Fill Area as usual.

Dynamic Bars

Insert Dynamic Bars

Command Button InsertDynBarButton.png
Command Path Graphics - Animation - Insert Dynamic Bars


This command will insert bar(s) with animation to indicate changing variables. The variables could be Levels, Temperatures, concentration, on/off status or user defined pgm variables.

InsertDynamicBar.png


Step Description Notes
A Select the unit operation TAG(s)
  1. This can be typed in, separated by spaces, or selected by single left clicking on the unit operation(s) on the graphics window.
  2. If a unit appears on a separate Graphics Window, the tag must be typed in.
B Define the variable list.
  1. These variable names are separated by spaces, NOT commas.
  2. You can start with just ONE variable tag to first create the Dynamic Bar; the rest can be added later using Update Dynamic Bars.
  3. The variable can be typed in or pasted in using Copy Tag from the Access Window.
    • The variable entered MUST NOT contain engineering units. This is because the engineering units supplied will be ignored and be replaced by SI units, but the text labels will be using these as displays, which can cause confusion.
  4. Do NOT use variables from the Qi tabs of pipes, as these are not available for simple pipes. Always select variables from the Qo tab.
C Range Define the Minimum and Maximum values, the range specified here will be applied to ALL the variables. User can use Update Dynamic Bars later to change individual ranges if required.
In this example, on/off range would be 0 and 1.
D Text Scale The scale can be changed now or later using Update Dynamic Bars.
E Colour Box This box allows the user to select a preferred colour. To change the colour click on the box and select a colour from the pallet.
The colour selection here will apply to all variables, user can use Update Dynamic Bars later to change individual colours if required.
F Insert Dynamic Bars 1. The Dynamic Bars graphic becomes visible on the graphics window and the mouse pointer changes to a X with 'POS' and the 'Insert Dynamic Bars' button changes to 'Position Selected'. The user can now left click with the mouse button on the Graphics Window to position the Dynamic Bars to a more appropriate position.
2. The placement point of the Dynamic Bars is bottom left-hand corner of the Dynamic Bars.
3. The user may continue clicking on the graphics until they are happy with the position of the Dynamic Bars.
4. When the user is happy with the Dynamic Bars position, press OK to close the 'Insert Dynamic Bars' dialog box.
G Adding More Dynamic Bars When the position of the previous Dynamic Bars is finalised, you can press OK to finish or Position selected to start creating another Dynamic Bar entity.
H Editing Dynamic Bars 1. After a Dynamic Bar is created, it can be moved with the Move Entity Command.
2. The Dynamic Bars cannot be resized using the Scale/Rotate command. To change or update the Dynamic Bars, the Update Dynamic Bars command must be used.

WARNING: If a dynamic bar is applied to a unit, changing the unit name will result in the loss of the dynamic bar information.

Update Dynamic Bars

Command Button UpdateDynBarButton.png
Command Path Graphics - Animation - Update Dynamic Bars

Once a dynamic bar is in place, it can be updated using the Update Dynamic Bars option.

UpdateDynamicBar.png
  1. Move the mouse cursor over to the graphics page and click on the dynamic bars entity you wish to update. This opens the Update Dynamic Bars dialog box.
  2. To update an entry, highlight it in the list and change the variable in the editing boxes towards the bottom, just above the scale box. Tags can be added or deleted.
  3. To add a new entry, click on an existing tag, press add, edit it to represent the new tag, and then click on the tag list section to accept the tag in the list.
  4. The order of the tags can be adjusted using the move up and move down button.
  5. Each tag on the dynamic bar list can have a different colour, to change the colour, just click on the tag, then change the colour box on the bottom right hand corner. Once ready, press OK to update the colour.
  6. User can use the X and Y Scales to size the width and height of the Dynamic bars.
  7. Sizing is also done relative to a Text Scale, based on the text required (width of sum of characters) and the text scale it then sizes the graphics. Because of this, Dynamic bars with different length of text string would appear in different sizes even though the text scale is the same for all of them.
  8. The Display Option can be used to not display the labels, which results in a more compact graphical symbol.
  9. The Dynamic bar is a graphics entity and it can be repositioned using the Graphics - entities - Move function.

Example of Dynamic Bar with Text Label showing:

UpdateDynamicBar2.png

Toggle

Insert Toggle

Command Button InsertToggleButton.png
Command Path Graphics - Animation - Insert Toggle

The procedure in creating a toggle is similar to that of Insert Dynamic Bars.

CreateToggle.png

NOTES:

  1. A Toggle is used to animate variables that are only True or False and can thus be switched On or Off by a toggle. This is commonly used for valve open and close or pump on and off.
  2. Once inserted, double clicking on the toggle graphics can toggle the variables.
  3. The Toggle is always RED, you cannot change the colour.
  4. If you have more than one tag on a toggle entity, double clicking on the graphic entity will toggle all tags in the same entity.
  5. If a toggle is applied to a unit, changing the unit name will result in the loss of the toggle animation information.

Update Toggle

Command Button UpdateToggleButton.png
Command Path Graphics - Animation - Update Toggle

Once a toggle entity is in place, it can be updated. The procedure in updating the toggle entity is as per Update Dynamic Bars.