Example PGM Files

Navigation: User Guide ➔ Getting Started ➔ Example PGM Files

Getting Started and Installation				Training		Tutorial		Guidelines and Examples
Getting Started	Download Software	Installation Instructions	SysCAD Files	Training Information	Training Preparation	Tutorial Overview	Tutorial Videos	Modelling Guidelines	Example Projects	Example Reports	Example PGM Files	FAQ

Latest SysCAD Version: 17 January 2023 - SysCAD 9.3 Build 139.32335

Related Links: PGMs

---

Simple Example PGM Files

• Basic PGM file

• Simple Calculation

Subroutine Examples

• Initialise PreStart Trigger Subroutine Examples

• Making multi-step configuration changes using trigger subroutines

• PGM Examples - Check Version, Error and Convergence
  • Subroutine to Check for Error and Pause Simulation
  • Check the Status of Project Convergence at the end of Project Solve

• Example PGM Files - Using Counter, While and Random functions
  • File layout when using counters
  • Using random for testing plant models
  • Using While loop to set user defined value to multiple equipment
  • Example PGM File - Using While loop to set Selection/Breakage Function Table values

• Example Subroutine to Estimate Belt Filter Wash Loss Curve based on Washing Efficiency

• Example PGM for Setting Feeder Ore Composition (converting Lab results to SysCAD species)

• Example PGM to create a Unit Tag List

Example Model Procedure files

MP Example Files:

• Tank Volume
• Set Demand Flow as Volume Flow
• Agitator Power
• Pipe Sizing
• Thickener

PGM Files using Class and Functions

Using Array and Matrix

• Table lookup using Array and Matrix
• Set A Table of Values Using Matrix Class
• Solving a tridiagonal system of equations

Quick Mass balance using Predefined Class: TagSelect

• Example overall mass balance at the end of project solve

• Example species mass balance at the end of project solve

• Example elemental mass balance at the end of project solve

Species Check - Generate Species Lists based on "With Flow" and "No Flow"

The following PGM examples can be used to check species at the end of project solve,
NOTE that in Build139 or later, user can get the used/unused species list directly from Plant Model - Species tab.

• How to generate a list of Species with Flow, useful for stream table reports
• How to check if a species is not used in the project (has no flow anywhere)
• How to compare two lists of string variables

User Defined Class and Functions

Class and Function/Subroutine can be written as part of the main PGM file OR separately in its own file. If the Class or function/subroutine can be used by multiple PGM or projects, it is best to store the code in a separate file, so it can be re-used easily. Please see Sharing Classes between Projects for more information.

In the following examples, the Class definition is stored in a separate pgm file, the class pgm file is inserted using the include file syntax when it is required.

• Example Class to Set Species Splits
• PGM Example - PGM Class to calculate the Agitator Power required in a Vessel
• Example Class to Find a user specified Reaction in a Reaction Block

In the following examples, the Class is written as part of the PGM code. User may copy the class definition into its own file if required.

• Example Class to set Aqueous Feeder based on concentration
• Example Class to set Evaporation based on user defined correlation
• Example Class to calculate Alumina properties
• Example Class - Check Elemental Balance of a Process Unit Operation
• Example Class - using Enum Drop list and Drop List in a class
• Example Class to assist with solving sensitive PID control loops
• Example Class - Relaxed Cross Page Connector - example class to allow a graduate transfer of data across the cross-page connection. Useful for breaking sensitive loops, allowing a slower and smoother change between sections of the plant.

Example - For Dynamic Projects

• Startup actions for the dynamic project
• Example overall mass balance at the end of project solve