View source for Example PGM Files

[[Category:PGM]] [[Category:Examples]]
{{Navigation|[[User Guide]]|[[Getting Started]]}}<br>
<!--{{Tutorial Header Table |currentpage=12}}-->
----
{{PGM Example Header Tabs}}
{{User Defined Classes Example Header Table |HideLinks=yes}}
{{Latest SysCAD Version}}<br>
Related Links: [[PGMs]]<br>
----

The above tables contain some quick access links for examples listed below.  For more information and full example lists, please see below:
{{TOC}}
== Simple Example PGM Files ==

*[[PGM Examples - Simple PGM file | Basic PGM file]]

*[[PGM Examples - General Calculations |Simple Calculation]]

== Subroutine Examples ==

*[[Initialise PreStart Trigger Subroutine Examples]]

*[[Making multi-step configuration changes using trigger subroutines]]

*[[PGM Examples - Check Version, Error and Convergence]]
**[[PGM Examples - Check Version, Error and Convergence#Example PGM Subroutine to Check for Error and Pause Simulation|Subroutine to Check for Error and Pause Simulation]]
**[[PGM Examples - Check Version, Error and Convergence#Example: Check the Status of Project Convergence at the end of Project Solve|Check the Status of Project Convergence at the end of Project Solve]]

*[[Example PGM Files - Using Counter, While and Random functions]]
**[[Example PGM Files - Using Counter, While and Random functions#Sample PGM File (File layout when using counters)|File layout when using counters]]
**[[Example PGM Files - Using Counter, While and Random functions#Example: Using random for testing plant models|Using random for testing plant models]]
**[[Example PGM Files - Using Counter, While and Random functions#Example_PGM_File_-_Using_While_loop_to_set_user_defined_value_to_multiple_equipment|Using While loop to set user defined value to multiple equipment]]
**[[Example PGM Files - Using Counter, While and Random functions#Example PGM File - Using While loop to set Selection/Breakage Function Table values|Example PGM File - Using While loop to set Selection/Breakage Function Table values]]

* [[Example_PGM_File_-_Estimate Belt Filter Wash Loss Curve based on Washing Efficiency|Example Subroutine to Estimate Belt Filter Wash Loss Curve based on Washing Efficiency]]

*[[Bauxite Composition Example | 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:
*[[MP_Example_Files#Model_Procedure_Example:_Tank_Volume|Tank Volume]]
*[[MP_Example_Files#Model Procedure Example: Set Demand Flow as Volume Flow|Set Demand Flow as Volume Flow]]
*[[MP_Example_Files#Model Procedure Example: Agitator Power|Agitator Power]]
*[[MP_Example_Files#Model Procedure Example: Pipe Sizing|Pipe Sizing]]
*[[MP_Example_Files#Model Procedure Example: Thickener|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  ===
The Predefined Class: TagSelect can be used to generate some quick mass balance for the project:
* [[How to perform an Overall Mass Balance|Example overall mass balance at the end of project solve]]
* [[How to perform a Species Mass Balance#Use PGM file to perform mass balance|Example species mass balance at the end of project solve]]
* [[How to perform an Elemental Mass Balance|Example elemental mass balance at the end of project solve]]

=== Species Check  ===

The following PGM examples can be used to check species at the end of project solve, so that we can generate Species Lists based on "With Flow" and "No Flow". <br> NOTE that in Build139 or later, user can get the used/unused species list directly from [[Plant_Model_-_Species#SpUse_.28Species_Use.29|Plant Model - Species]] tab.  
*[[Example PGM - Species Check#Example 1 - Species with Flow List|How to generate a list of Species with Flow, useful for stream table reports]]   
*[[Example PGM - Species Check#Example 2 - Species with NO Flow List|How to check if a species is not used in the project (has no flow anywhere)]]  
*[[Example PGM - Species Check#Example 3 - Comparing Lists|How to compare two lists of string variables]] 

=== User Defined Class and Functions ===
[[Class]] and [[Defining a Function|Function]]/[[Defining_a_Subroutine|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 [[Class#Sharing_Classes_between_Projects|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.
* [[PGM Examples - PGM Class to Set Species Splits|Example Class to Set Species Splits]] 
* [[PGM Example - PGM Class to calculate the Agitator Power required in a Vessel|Example Class to calculate Agitator Power]]
* [[PGM Example - Reaction Finder Classes and Functions | Example Class to Find a user specified Reaction in a Reaction Block]]
<!--
* [[PGM Example - Relaxed Cross Page Connector | Example Class to transfer between cross page connectors using Relaxation]]
-->

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.
* [[Aqueous Feed Concentration Calculator|Example Class to set Aqueous Feeder based on concentration]]
* [[Example Evaporation Correlation|Example Class to set Evaporation based on user defined correlation]]
* [[Bayer Liquor Class |Example Class to calculate Alumina properties]]
* [[Example Class - Check Elemental Balance of a Process Unit Operation]]
* [[Data_Types#Example_:_using_Enum_Drop_list_and_Drop_List_in_a_class|Example Class - using Enum Drop list and Drop List in a class]]
* [[PGM Example - PGM Class to assist with solving sensitive PID control loops|Example Class - variable gain to assist with solving sensitive PID control loops]]
* [[PGM Example - Relaxed Cross Page Connector|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 ==
* [[Useful PGM code for Dynamic Projects | Startup actions for the dynamic project]]
* [[How_to_perform_an_Overall_Mass_Balance#Dynamic_Project_Overall_Mass_Balance|Example overall mass balance at the end of project solve]]